For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
      • Storefront
          • Authentication
          • Catalog
          • Company
          • Orders
          • Request for Quote
          • Sales Rep
          • Shopping List
            • GETList Shopping Lists
            • POSTCreate Shopping List
            • PUTUpdate Shopping List
            • GETGet Shopping List ID and Name
            • POSTAdd Shopping List Items
            • PUTUpdate Shopping List Items
            • GETList Shopping List Items Extension
            • DELDelete Shopping List Item
            • DELDelete Shopping List
            • POSTDuplicate Shopping List
          • Store Settings
      • Management
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
RESTB2BStorefrontShopping List

Update Shopping List

PUT
https://api-b2b.bigcommerce.com/api/v2/shoppinglists
PUT
/api/v2/shoppinglists
$curl -X PUT https://api-b2b.bigcommerce.com/api/v2/shoppinglists \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "Office Supplies List",
>  "description": "List of items needed for the new office setup",
>  "status": 0,
>  "id": "442"
>}'
200example-1
1{
2  "code": 200,
3  "message": "SUCCESS",
4  "data": {
5    "shoplistId": 442
6  }
7}
Update a shopping list. Equivalent Storefront GraphQL API Mutation: `shoppingListsUpdate`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground).
Was this page helpful?
Previous

Create Shopping List

Next

Get Shopping List ID and Name

Built with

Update a shopping list. Equivalent Storefront GraphQL API Mutation: shoppingListsUpdate. For more information, see the GraphQL Playground.

Authentication

AuthorizationBearer

Authentication header

HeaderArgumentDescription
AuthorizationBearer {{B2B_JWT_TOKEN}}You can obtain this token using the steps described in the REST Storefront API section[…]

Request

namestringRequired>=1 character
Shopping list name
descriptionstringRequired>=1 character
Description of this shopping list
statusdoubleRequired

0: Approved 20: Deleted 30: Draft 40: Ready for approval

idstringRequired>=1 character

Shopping list’s ID

Response

OK
codedouble
messagestring>=1 character
dataobject