List Shopping List Items Extension

curl https://api-b2b.bigcommerce.com/api/v2/shoppinglists/items-extension \
     -H "Authorization: Bearer <token>"

{
  "code": 200,
  "message": "SUCCESS",
  "data": {
    "name": "shopping list name",
    "description": "Shopping list desc",
    "status": 0,
    "isOwner": "1",
    "products": [
      {
        "itemId": 1558,
        "productId": "107",
        "baseSku": "DPB",
        "variantSku": "d1-1",
        "qty": 5,
        "basePrice": 34.95,
        "productUrl": "/sample-dustpan-brush/",
        "variantId": "130",
        "productName": "[Sample] Dustpan & Brush",
        "updatedAt": 1622603634,
        "createdAt": 1622603183,
        "optionsList": [
          {
            "option_id": "attribute[145]",
            "option_value": "95"
          }
        ],
        "primaryImage": {
          "urlThumbnail": "https://cdn11.bigcommerce.com/s-1i6zpxpe3g/products/107/images/351/dustpan1.1554505753.220.290.jpg?c=2"
        }
      },
      {
        "itemId": 1557,
        "productId": "93",
        "baseSku": "SLLPJ",
        "variantSku": "SLLPJ-6088C959",
        "qty": 2,
        "basePrice": 7,
        "productUrl": "/1-l-le-parfait-jar/",
        "variantId": "46",
        "productName": "[Sample] 1 L Le Parfait Jar",
        "updatedAt": 1622603542,
        "createdAt": 1622602889,
        "optionsList": [
          {
            "option_id": "attribute[112]",
            "option_value": "95"
          }
        ],
        "primaryImage": {
          "urlThumbnail": "https://cdn11.bigcommerce.com/s-1i6zpxpe3g/products/93/images/311/leparfaitmedium3.1554505753.220.290.jpg?c=2"
        }
      }
    ],
    "customerInfo": {
      "firstName": "Jo",
      "lastName": "Sweet"
    },
    "grandTotal": 188.75,
    "pagination": {
      "totalCount": 2,
      "offset": 0,
      "limit": 100
    }
  }
}

curl https://api-b2b.bigcommerce.com/api/v2/shoppinglists/items-extension \
     -H "Authorization: Bearer <token>"

{
  "code": 200,
  "message": "SUCCESS",
  "data": {
    "name": "shopping list name",
    "description": "Shopping list desc",
    "status": 0,
    "isOwner": "1",
    "products": [
      {
        "itemId": 1558,
        "productId": "107",
        "baseSku": "DPB",
        "variantSku": "d1-1",
        "qty": 5,
        "basePrice": 34.95,
        "productUrl": "/sample-dustpan-brush/",
        "variantId": "130",
        "productName": "[Sample] Dustpan & Brush",
        "updatedAt": 1622603634,
        "createdAt": 1622603183,
        "optionsList": [
          {
            "option_id": "attribute[145]",
            "option_value": "95"
          }
        ],
        "primaryImage": {
          "urlThumbnail": "https://cdn11.bigcommerce.com/s-1i6zpxpe3g/products/107/images/351/dustpan1.1554505753.220.290.jpg?c=2"
        }
      },
      {
        "itemId": 1557,
        "productId": "93",
        "baseSku": "SLLPJ",
        "variantSku": "SLLPJ-6088C959",
        "qty": 2,
        "basePrice": 7,
        "productUrl": "/1-l-le-parfait-jar/",
        "variantId": "46",
        "productName": "[Sample] 1 L Le Parfait Jar",
        "updatedAt": 1622603542,
        "createdAt": 1622602889,
        "optionsList": [
          {
            "option_id": "attribute[112]",
            "option_value": "95"
          }
        ],
        "primaryImage": {
          "urlThumbnail": "https://cdn11.bigcommerce.com/s-1i6zpxpe3g/products/93/images/311/leparfaitmedium3.1554505753.220.290.jpg?c=2"
        }
      }
    ],
    "customerInfo": {
      "firstName": "Jo",
      "lastName": "Sweet"
    },
    "grandTotal": 188.75,
    "pagination": {
      "totalCount": 2,
      "offset": 0,
      "limit": 100
    }
  }
}

Get a shopping list detail information. Equivalent Storefront GraphQL API Query: shoppingList. For more information, see the GraphQL Playground.

Get a shopping list detail information. Equivalent Storefront GraphQL API Query: `shoppingList`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground).

Authentication

AuthorizationBearer

Authentication header

Header	Argument	Description
`Authorization`	`Bearer {{B2B_JWT_TOKEN}}`	You can obtain this token using the steps described in the REST Storefront API section[…]

Query parameters

idstringOptional

Shopping list ID

offsetstringOptionalDefaults to 0

Pagination offset

limitstringOptionalDefaults to 100

Pagination limit

sortByenumOptional

the field to sort by

Response

codedouble

messagestring>=1 character

dataobject

$	curl https://api-b2b.bigcommerce.com/api/v2/shoppinglists/items-extension \
>	-H "Authorization: Bearer <token>"

1	{
2	"code": 200,
3	"message": "SUCCESS",
4	"data": {
5	"name": "shopping list name",
6	"description": "Shopping list desc",
7	"status": 0,
8	"isOwner": "1",
9	"products": [
10	{
11	"itemId": 1558,
12	"productId": "107",
13	"baseSku": "DPB",
14	"variantSku": "d1-1",
15	"qty": 5,
16	"basePrice": 34.95,
17	"productUrl": "/sample-dustpan-brush/",
18	"variantId": "130",
19	"productName": "[Sample] Dustpan & Brush",
20	"updatedAt": 1622603634,
21	"createdAt": 1622603183,
22	"optionsList": [
23	{
24	"option_id": "attribute[145]",
25	"option_value": "95"
26	}
27	],
28	"primaryImage": {
29	"urlThumbnail": "https://cdn11.bigcommerce.com/s-1i6zpxpe3g/products/107/images/351/dustpan1.1554505753.220.290.jpg?c=2"
30	}
31	},
32	{
33	"itemId": 1557,
34	"productId": "93",
35	"baseSku": "SLLPJ",
36	"variantSku": "SLLPJ-6088C959",
37	"qty": 2,
38	"basePrice": 7,
39	"productUrl": "/1-l-le-parfait-jar/",
40	"variantId": "46",
41	"productName": "[Sample] 1 L Le Parfait Jar",
42	"updatedAt": 1622603542,
43	"createdAt": 1622602889,
44	"optionsList": [
45	{
46	"option_id": "attribute[112]",
47	"option_value": "95"
48	}
49	],
50	"primaryImage": {
51	"urlThumbnail": "https://cdn11.bigcommerce.com/s-1i6zpxpe3g/products/93/images/311/leparfaitmedium3.1554505753.220.290.jpg?c=2"
52	}
53	}
54	],
55	"customerInfo": {
56	"firstName": "Jo",
57	"lastName": "Sweet"
58	},
59	"grandTotal": 188.75,
60	"pagination": {
61	"totalCount": 2,
62	"offset": 0,
63	"limit": 100
64	}
65	}
66	}