GET
/
lists
/
{listId}
/
list-items

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

Query Parameters

offset
integer
default: 0

Number of records to skip before returning records. For example, offset=20, limit=10 returns records 21-30.

limit
integer
default: 10

Maximum number of records per page

Required range: 1 < x < 100

Response

200 - application/json

Item details and pagination specifications

data
object[]
pagination
object

Pagination response