List Shopping List Items Extension

GET

https://api-b2b.bigcommerce.com/api/v2/shoppinglists/items-extension

GET

/api/v2/shoppinglists/items-extension

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

200example-1

{
  "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.

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