> This page is for Developer. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.bigcommerce.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server. # Create Price List POST https://api.bigcommerce.com/stores/{store_hash}/v3/pricelists Content-Type: application/json Creates a *Price List*. **Required Fields** * name Reference: https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/price-lists/create-price-list ## Authentication - `X-Auth-Token` header (required) — ### 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-fundamentals/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-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/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 ### Path parameters - `store_hash` (string, required) — Permanent ID of the BigCommerce store. ### Headers - `Accept` (string, required, default: application/json) — The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. ### Body (application/json) This endpoint expects an object. - `name` (string, required) — The unique name of the Price List. Required in a POST request. - `active` (boolean, optional) — Boolean value that specifies whether this `Price List` and its prices are active or not. Defaults to `true`. - `layers` (list of LayerItem, optional) — Fallback price lists to assign on creation. Maximum five items. ## Response ### 200 OK - `data` (PricelistsPostResponsesContentApplicationJsonSchemaData, optional) — Specifies the Common Price List properties. - `meta` (Meta, optional) — Response metadata. ## Errors ### 409 Conflict Error `Price List` conflicts with another Price List. This is the result of duplicate unique values, such as `name`. - `errors` (PricelistsPostResponsesContentApplicationJsonSchemaErrors, optional) - `instance` (string, optional) - `status` (integer, optional) — The HTTP status code. - `title` (string, optional) — The error title describing the particular error. - `type` (string, optional) ### 422 Unprocessable Entity Error `Price List` is not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - `errors` (PricelistsPostResponsesContentApplicationJsonSchemaErrors, optional) - `instance` (string, optional) - `status` (integer, optional) — The HTTP status code. - `title` (string, optional) — The error title describing the particular error. - `type` (string, optional) ## Types ### LayerItem A fallback price list layer. - `price_list_id` (integer, optional) — The ID of the fallback price list. ### PricelistsPostResponsesContentApplicationJsonSchemaData Specifies the Common Price List properties. - `name` (string, required) — The unique name of the Price List. Required in a POST request. - `id` (integer, optional) — The unique numeric ID of the `Price List`; this number increments sequentially. - `date_created` (datetime, optional) — The date on which the `Price List` was created. - `date_modified` (datetime, optional) — The date on which the `Price List` was created. - `active` (boolean, optional) — Boolean value that specifies whether this `Price List` and its prices are active or not. Defaults to `true`. - `layers` (list of LayerItem, optional) — Fallback price lists evaluated in order when a price record is not found in this price list. Maximum five layers. Inactive layers are skipped during price resolution but remain assigned. ### Meta Response metadata. ### PricelistsPostResponsesContentApplicationJsonSchemaErrors ## Examples **Request** ```json { "name": "Wholesale" } ``` **Response** ```json { "data": { "name": "Wholesale Group - Trade Show", "id": 4, "date_created": "2022-09-17T18:41:59Z", "date_modified": "2022-09-17T18:41:59Z", "active": false, "layers": [] }, "meta": {} } ``` **SDK Code** ```python Response import requests url = "https://api.bigcommerce.com/stores/store_hash/v3/pricelists" payload = { "name": "Wholesale" } headers = { "Accept": "application/json", "X-Auth-Token": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Response const url = 'https://api.bigcommerce.com/stores/store_hash/v3/pricelists'; const options = { method: 'POST', headers: { Accept: 'application/json', 'X-Auth-Token': '', 'Content-Type': 'application/json' }, body: '{"name":"Wholesale"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Response package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.bigcommerce.com/stores/store_hash/v3/pricelists" payload := strings.NewReader("{\n \"name\": \"Wholesale\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Accept", "application/json") req.Header.Add("X-Auth-Token", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Response require 'uri' require 'net/http' url = URI("https://api.bigcommerce.com/stores/store_hash/v3/pricelists") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Accept"] = 'application/json' request["X-Auth-Token"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"name\": \"Wholesale\"\n}" response = http.request(request) puts response.read_body ``` ```java Response import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.bigcommerce.com/stores/store_hash/v3/pricelists") .header("Accept", "application/json") .header("X-Auth-Token", "") .header("Content-Type", "application/json") .body("{\n \"name\": \"Wholesale\"\n}") .asString(); ``` ```php Response request('POST', 'https://api.bigcommerce.com/stores/store_hash/v3/pricelists', [ 'body' => '{ "name": "Wholesale" }', 'headers' => [ 'Accept' => 'application/json', 'Content-Type' => 'application/json', 'X-Auth-Token' => '', ], ]); echo $response->getBody(); ``` ```csharp Response using RestSharp; var client = new RestClient("https://api.bigcommerce.com/stores/store_hash/v3/pricelists"); var request = new RestRequest(Method.POST); request.AddHeader("Accept", "application/json"); request.AddHeader("X-Auth-Token", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"name\": \"Wholesale\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Response import Foundation let headers = [ "Accept": "application/json", "X-Auth-Token": "", "Content-Type": "application/json" ] let parameters = ["name": "Wholesale"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.bigcommerce.com/stores/store_hash/v3/pricelists")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```