Get one personal shopping list
get
/fscmRestApi/resources/11.13.18.05/personalShoppingLists/{PersonalShoppingListHeaderId}
Request
Path Parameters
-
PersonalShoppingListHeaderId(required): integer(int64)
Value that uniquely identifies the personal shopping list.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : personalShoppingLists-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the shopping list. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the shopping list was created. -
ImageURL: string
Maximum Length:
1000
URL that locates the image representing the personal shopping list. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the shopping list was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the shopping list. -
lines: array
Lines
Title:
Lines
The Lines resource manages items added to a personal shopping list. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonalShoppingList: string
Title:
Shopping List Name
Maximum Length:80
Name that uniquely identifies the personal shopping list. -
PersonalShoppingListHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the personal shopping list.
Nested Schema : Lines
Type:
array
Title:
Lines
The Lines resource manages items added to a personal shopping list.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personalShoppingLists-lines-item-response
Type:
Show Source
object
-
Amount: number
Total amount of the shopping list line item in the currency of the buying company.
-
BPAPriceUserOverrideFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the blanket purchase agreement price attribute referenced by the personal shopping list line has been updated by user. If false, then the blanket purchase agreement price attribute hasn't been updated by user. The default value is false. This attribute isn't currently used. -
CategoryId: integer
(int64)
Value that uniquely identifies the purchasing category of the shopping list line.
-
CategoryName: string
Maximum Length:
2400
Name that uniquely identifies the purchasing category of the personal shopping list line. -
ConversionRate: number
Type of rate used to determine the currency conversion rate for the purchase requisition.
-
ConversionRateDate: string
(date)
Date from when the conversion rate is used to convert an amount into another currency.
-
ConversionRateType: string
Maximum Length:
30
Type of rate used to determine the currency conversion rate for the purchase requisition. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the shopping list line. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the shopping list line was created. -
Currency: string
Title:
Currency Name
Maximum Length:80
Name of the shopping list line currency. -
CurrencyCode: string
Maximum Length:
15
Abbreviation that identifies the shopping list line currency. -
InventoryOrganization: string
Title:
Organization
Maximum Length:240
Name of the inventory organization that's the source for the master item used on the personal shopping list line. -
InventoryOrganizationCode: string
Maximum Length:
18
Abbreviation that uniquely identifies the inventory organization that's the source for the master item on the personal shopping list line. -
InventoryOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization that's the source for the master item on the personal shopping list line.
-
Item: string
Maximum Length:
300
Abbreviation that uniquely identifies the item on the shopping list line. -
ItemDescription: string
Maximum Length:
240
Description of the goods or services on the shopping list line. -
ItemId: integer
(int64)
Value that uniquely identifies the item on the shopping list line.
-
ItemRevision: string
Maximum Length:
18
Number that identifies the revision of the item. -
ItemSource: string
Maximum Length:
25
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the shopping list line was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the shopping list line. -
LineImageURL: string
Title:
Image URL
Read Only:true
Image URL of the goods or services on the personal shopping list line. -
LineType: string
Title:
Type
Maximum Length:30
Name that uniquely identifies type that indicates whether the shopping list line is for goods or services. -
LineTypeId: integer
(int64)
Value that uniquely identifies type that indicates whether the shopping list line is for goods or services.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManufacturerId: number
Value that uniquely identifies the manufacturer of the item on the shopping list line.
-
ManufacturerName: string
Maximum Length:
240
Name that uniquely identifies the manufacturer of the item on the personal shopping list line. -
ManufacturerPartNumber: string
Maximum Length:
700
Number that uniquely identifies the item as provided by the manufacturer. -
NegotiatedByPreparerFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the price of the item on the shopping list line is agreed on in advance between the buying company and the supplier. If false, then the price isn't agreed on in advance. This attribute doesn't have a default value. -
NegotiationRequiredFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then an request for quotation is required prior to placing the requisition line on a purchase order. If false, then an request for quotation isn't required. This attribute doesn't have a default value. -
NewSupplierFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the supplier on the shopping list line is a new supplier. If false, then the supplier on the shopping list line is an existing supplier. This attribute doesn't have a default value. -
PersonalShoppingListHeaderId: integer
(int64)
Value that uniquely identifies the personal shopping list.
-
PersonalShoppingListLineId: integer
(int64)
Value that uniquely identifies the personal shopping list line.
-
PublicShoppingListHeaderId: integer
(int64)
Value that uniquely identifies the public shopping list.
-
PunchoutCatalog: string
Read Only:
true
Maximum Length:30
Name of the punchout catalog referenced by the shopping list line. -
PunchoutCatalogId: integer
(int64)
Value that uniquely identifies the punchout catalog referenced by the shopping list line.
-
RequisitioningBU: string
Title:
Business Unit
Maximum Length:240
Name of the requisitioning business unit referenced by the shopping list line. -
RequisitioningBUId: integer
(int64)
Value that uniquely identifies the requisitioning business unit referenced by the shopping list line.
-
SmartFormId: integer
(int64)
Value that uniquely identifies the smart form referenced by the shopping list line.
-
SmartFormName: string
Maximum Length:
250
Name that uniquely identifies the smart form referenced by the personal shopping list line. -
SourceAgreement: string
Title:
Agreement
Maximum Length:30
Number that uniquely identifies the source agreement referenced by the shopping list line. -
SourceAgreementHeaderId: integer
(int64)
Value that uniquely identifies the source agreement referenced by the shopping list line.
-
SourceAgreementLineId: integer
(int64)
Value that uniquely identifies the source agreement line for a given source agreement.
-
SourceAgreementLineNumber: number
Title:
Agreement Line
Number that identifies the line of the source agreement referenced by the shopping list line. -
SuggestedQuantity: number
Default quantity for the personal shopping list line.
-
SuggestedSupplier: string
Maximum Length:
360
Name of the new supplier suggested on the shopping list line for fulfillment of the ordered goods and services. -
SuggestedSupplierContact: string
Maximum Length:
80
Name of the person representing the new supplier involved in supporting the customer relationship. -
SuggestedSupplierContactEmail: string
Maximum Length:
1000
Email address of the person representing the new supplier. -
SuggestedSupplierContactFax: string
Maximum Length:
30
Fax number of the person representing the new supplier. -
SuggestedSupplierContactPhone: string
Maximum Length:
30
Phone number of the person representing the new supplier. -
SuggestedSupplierItemNumber: string
Maximum Length:
300
Number that uniquely identifies the item as provided by the suggested supplier. -
SuggestedSupplierSite: string
Maximum Length:
240
Value that uniquely identifies the new supplier. -
Supplier: string
Maximum Length:
360
Name of the supplier tasked with fulfillment of the shopping list line goods or services. -
SupplierContact: string
Maximum Length:
4000
Name of the person representing the supplier with regards to communication with the buying company. -
SupplierContactEmail: string
Read Only:
true
Maximum Length:2000
Email address of the person representing the supplier. -
SupplierContactFax: string
Read Only:
true
Maximum Length:255
Fax number of the person representing the supplier. -
SupplierContactId: integer
(int64)
Value that uniquely identifies the supplier contact.
-
SupplierContactPhone: string
Read Only:
true
Maximum Length:255
Phone number of the person representing the supplier. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplierSite: string
Title:
Supplier Site
Maximum Length:240
Name of the supplier location from where the shopping list line goods or services are purchased. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
-
UnitPrice: number
Price of the shopping list line item in the currency of the buying company.
-
UOM: string
Title:
UOM Name
Maximum Length:25
Unit of measure of the item quantity. -
UOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- lines
-
Operation: /fscmRestApi/resources/11.13.18.05/personalShoppingLists/{PersonalShoppingListHeaderId}/child/linesParameters:
- PersonalShoppingListHeaderId:
$request.path.PersonalShoppingListHeaderId
The Lines resource manages items added to a personal shopping list. - PersonalShoppingListHeaderId:
Examples
This example describes how to get one personal shopping list.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/personalShoppingLists/personalShoppingLists_Id"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "PersonalShoppingListHeaderId": 300100583495664, "PersonalShoppingList": "Quarterly Office Supplies", "CreatedBy": [user], "CreationDate": "2023-05-04T17:50:09+00:00", "LastUpdatedBy": [user], "LastUpdateDate": "2023-05-04T17:50:09.252+00:00", "ImageURL": "https://commons.wikimedia.org/wiki/File:Fountain_Pen_Graphic.png", "links": [] }