Skip to navigation
RESTB2BManagementShopping List

Create Shopping List

Create a shopping list for a user

Authentication

X-Auth-Tokenstring
HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

X-Store-Hashstring
HeaderArgumentDescription
X-Store-Hashstore_hashThe unique store hash associated with a BigCommerce store that has B2B Edition enabled.

Request

This endpoint expects an object.
namestringRequired
descriptionstringOptional
Description information for shopping list
statusenumOptional

status of shopping list, (0: approved, 20: deleted, 30: draft, 40: ready for approval)

Allowed values:
userIdintegerOptional

B2B Edition buyer user ID (one of userId and customerId must be passed, and only one of them can be passed).

customerIdintegerOptional

BigCommerce customer ID(one of userId and customerId must be passed, and only one of them can be passed).

channelIdintegerOptional
BigCommerce channel ID
itemslist of objectsOptional

Response

OK
codeintegerOptional
Response code of success request.
metaobjectOptional
dataobjectOptional

Errors

422
Unprocessable Entity Error