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.

POST

lists

curl --request POST \
  --url https://api.fabric.inc/v3/lists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "attributes": {
    "key": "value"
  },
  "listType": "type1",
  "name": "list1",
  "notes": "note11",
  "userId": "user1"
}'

{
  "attributes": {
    "key": "value"
  },
  "createdAt": "2022-11-22T10:26:38Z",
  "itemCount": 1,
  "listId": "62fa3796841ea417fa71d2a9",
  "listType": "type1",
  "name": "list1",
  "notes": "note11",
  "updatedAt": "2022-11-22T10:26:38Z",
  "userId": "user1"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Details to create shopping list

Response

201

application/json

Created

Shopping list details

Update a shopping list by ID Get a shopping list by ID

curl --request POST \
  --url https://api.fabric.inc/v3/lists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "attributes": {
    "key": "value"
  },
  "listType": "type1",
  "name": "list1",
  "notes": "note11",
  "userId": "user1"
}'

{
  "attributes": {
    "key": "value"
  },
  "createdAt": "2022-11-22T10:26:38Z",
  "itemCount": 1,
  "listId": "62fa3796841ea417fa71d2a9",
  "listType": "type1",
  "name": "list1",
  "notes": "note11",
  "updatedAt": "2022-11-22T10:26:38Z",
  "userId": "user1"
}