Get a shopping list by ID

Get details of a shopping list by ID, along with the number of items in it.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-fabric-tenant-id

string

required

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

string

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.

x-fabric-request-id

string

Unique request ID

Path Parameters

listId

string

required

24-character system-generated shopping list ID returned in the response of Create list endpoint - POST /lists

Response

200 - application/json

Shopping list details

name

string

required

Shopping list name

userId

string

required

Unique identifier of a logged-in user, from Identity service. Note: Only a logged-in user can create shopping lists.

attributes

object

User defined custom attributes. This is a placeholder for addition info (in key: value pairs)

createdAt

string

Time of shopping list creation (UTC)

itemCount

integer

Number of items in a list

Required range: x > 0

listId

string

24-character system-generated list ID

listType

string

List type

notes

string

Additional info, if any

updatedAt

string

Time of last update to shopping list (UTC)