RESTAdminManagementPrice Lists

Create Price List

Creates a Price List.

Required Fields

  • name

Authentication

X-Auth-Tokenstring
### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Products | modify | `store_v2_products` | | Products | read-only | `store_v2_products_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Request

Specifies the Common Price List properties.
namestringRequired
The unique name of the Price List. Required in a POST request.
activebooleanOptional

Boolean value that specifies whether this Price List and its prices are active or not. Defaults to true.

Response

dataobject
Specifies the Common Price List properties.
metaobject
Response metadata.

Errors

409
Conflict Error
422
Unprocessable Entity Error