Add or update items in a shopping list
Once a shopping list is created, shoppers can add new item to it or update existing ones. This endpoint is used to add and update items in a list.
- If the specified sku is not in the list, a new item is added to the list with the given quantity.
- If the specified sku is already in the list, its current quantity is updated based on the given incQuantity.
Note: At least one item must be in the request body.
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
Path Parameters
24-character system-generated shopping list ID returned in the response of Create list endpoint - POST /lists
Body
Details to create or update a list
Response
User defined custom attributes. This is a placeholder for addition info (in key: value pairs)
Time of shopping list creation (UTC)
A unique item identifier similar to sku
24-character system-generated list ID
Item quantity
x > 0Stock keeping unit (SKU), a unique item identifier
Time of last update to shopping list (UTC)
Was this page helpful?