Create shopping list
Shoppers often choose to save their desired products in shopping lists to purchase later when they are ready or to take advantage of discounts when they are available.
This endpoint creates a new shopping list. The response includes a list ID, which is required for subsequent calls to get, update, or delete this shopping list.
Note: Items can’t be added when the shopping list is initially created. To add items, use the Add items to list endpoint - POST /lists/{listId}/actions/add-or-update-list-items.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.
Unique request ID
Body
Details to create shopping list
Shopping list name
Unique identifier of a logged-in user, from Identity service. Note: Only a logged-in user can create shopping lists.
User defined custom attributes. This is a placeholder for addition info (in key: value pairs)
List type
Additional info, if any
Response
Shopping list details
Shopping list name
Unique identifier of a logged-in user, from Identity service. Note: Only a logged-in user can create shopping lists.
User defined custom attributes. This is a placeholder for addition info (in key: value pairs)
Time of shopping list creation (UTC)
Number of items in a list
x > 024-character system-generated list ID
List type
Additional info, if any
Time of last update to shopping list (UTC)
Was this page helpful?