> 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. # List Price List Records GET https://api.bigcommerce.com/stores/{store_hash}/v3/pricelists/{price_list_id}/records Returns a list of *Price List Records* associated with a *Price List*. **Notes** * Supports up to 10 simultaneous GET requests. Running more than the allowed number of requests concurrently on the same store will result in a `429` status error and your additional requests will fail. * Store Pricelist Records data to reduce the number of calls and maximize performance. Reference: https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/price-lists/price-lists-records/get-price-list-records ## 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 - `price_list_id` (integer, required) — The ID of the `Price List` requested. - `store_hash` (string, required) — Permanent ID of the BigCommerce store. ### Query parameters - `variant_id:in` (list of integer, optional) — A comma-separated list of IDs for one or more variants for which prices were requested. - `product_id:in` (list of integer, optional) — A comma-separated list of IDs for one or more products for which prices were requested. - `currency` (string, optional) — Filter items by currency. - `page` (integer, optional) — Specifies the page number in a limited (paginated) list of products. - `limit` (integer, optional) — Controls the number of items per page in a limited (paginated) list of products. If you provide only a limit, the API returns both paginations while applying that limit. - `before` (string, optional) — A cursor that can be used for backwards pagination. Will fetch results before the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'after' query parameter. - `after` (string, optional) — A cursor that can be used for forwards pagination. Will fetch results after the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'before' query parameter. - `include` (list of enum, optional) — Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include `bulk_pricing_tiers` and `sku`. Other values will be ignored. - Allowed values: `bulk_pricing_tiers`, `sku` - `price` (double, optional) — Filter items by price. - `sale_price` (double, optional) — Filter items by sale_price. - `retail_price` (double, optional) — Filter items by retail_price. - `map_price` (double, optional) — Filter items by map_price. - `calculated_price` (double, optional) — Filter items by calculated_price. - `date_created` (datetime, optional) — Filter items by date_created. - `date_modified` (datetime, optional) — Filter items by date_modified. For example `v3/catalog/products?date_last_imported:min=2022-06-15` - `sku` (string, optional) — Filter items by SKU. - `sku:in` (list of string, optional) — Filter results to those whose SKU is in this list. - `currency:in` (list of string, optional) — Filter results to those whose currency is in this list. - `price:max` (double, optional) — Filter results to those whose price is less than or equal to this value. - `price:min` (double, optional) — Filter results to those whose price is greater than or equal to this value. - `sale_price:max` (double, optional) — Filter results to those whose sale price is less than or equal to this value. - `sale_price:min` (double, optional) — Filter results to those whose sale price is greater than or equal to this value. - `retail_price:max` (double, optional) — Filter results to those whose retail price is less than or equal to this value. - `retail_price:min` (double, optional) — Filter results to those whose retail price is greater than or equal to this value. - `map_price:max` (double, optional) — Filter results to those whose MAP (minimum advertised price) is less than or equal to this value. - `map_price:min` (double, optional) — Filter results to those whose MAP (minimum advertised price) is greater than or equal to this value. - `calculated_price:max` (double, optional) — Filter results to those whose calculated price is less than or equal to this value. - `calculated_price:min` (double, optional) — Filter results to those whose calculated price is greater than or equal to this value. - `date_created:max` (string, optional) — Filter results to those created on or before this date. - `date_created:min` (string, optional) — Filter results to those created on or after this date. - `date_modified:max` (string, optional) — Filter results to those modified on or before this date. - `date_modified:min` (string, optional) — Filter results to those modified on or after this date. ### 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. ## Response ### 200 OK - `data` (list of PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaDataItems, optional) - `meta` (PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMeta, optional) — 'Contains data about paginating the response via cursors. If no pagination details are specified or if you only provide a limit, then both properties will be present. When a 'before' or 'after' cursor is provided, only the 'cursor_pagination' property will be present. When a 'page' parameter is provided, only the offset based 'pagination' property will be present.' ## Errors ### 429 Too Many Requests Error Allowed number of requests exceeded. - `status` (integer, optional) — The HTTP status code. - `title` (string, optional) — The error title describing the particular error. - `type` (string, optional) - `instance` (string, optional) - `errors` (ErrorResponseErrors, optional) ## Types ### PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaDataItems The Price Record object. - `calculated_price` (double, optional) — The price of the variant as seen on the storefront if a price record is in effect. It will be equal to the `sale_price`, if set, and the `price` if there is not a `sale_price`. Read only. - `date_created` (datetime, optional) — The date on which the Price entry was created. - `date_modified` (datetime, optional) — The date on which the Price entry was created. - `product_id` (integer, optional) — The ID of the `Product` this `Price Record`ʼs `variant_id` is associated with. Read only. - `price_list_id` (integer, optional) — The Price List with which this price set is associated. - `variant_id` (integer, optional) — The variant with which this price set is associated. Either `variant_id` or `sku` is required. - `sku` (string, optional) — The SKU code associated with this `Price Record` if requested and it exists. - `currency` (string, optional) — The 3-letter currency code with which this price set is associated. - `price` (double, optional) — The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product. - `sale_price` (double, optional) — The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant. - `retail_price` (double, optional) — The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product. If empty, the retail price will be treated as not being set on this variant. - `map_price` (double, optional) — The MAP (Minimum Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the MAP price will be treated as not being set on this variant. - `bulk_pricing_tiers` (list of PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaDataItemsBulkPricingTiersItems, optional) ### PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMeta 'Contains data about paginating the response via cursors. If no pagination details are specified or if you only provide a limit, then both properties will be present. When a 'before' or 'after' cursor is provided, only the 'cursor_pagination' property will be present. When a 'page' parameter is provided, only the offset based 'pagination' property will be present.' - `pagination` (PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMetaPagination, optional) — Data about the response, including pagination and collection totals. - `cursor_pagination` (PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMetaCursorPagination, optional) ### ErrorResponseErrors ### PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaDataItemsBulkPricingTiersItems - `quantity_min` (integer, optional) — The minimum quantity of associated variant in the cart needed to qualify for this tier's pricing. - `quantity_max` (integer, optional, nullable) — The maximum allowed quantity of associated variant in the cart to qualify for this tier's pricing. `null` indicates that there is no maximum allowed quantity for this tier. - `type` (enum, optional) — The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product. - Allowed values: `fixed`, `price`, `percent` - `amount` (double, optional) — The price adjustment amount. This value along with the type will decide the price per variant for the pricing tier. ### PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMetaPagination Data about the response, including pagination and collection totals. - `total` (integer, optional) — Total number of items in the result set. - `count` (integer, optional) — Total number of items in the collection response. - `per_page` (integer, optional) — The amount of items returned in the collection per page, controlled by the limit parameter. - `current_page` (integer, optional) — The page you are currently on within the collection. - `total_pages` (integer, optional) — The total number of pages in the collection. ### PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMetaCursorPagination - `count` (integer, optional) — Total number of items in the collection response. - `per_page` (integer, optional) — The number of items that can be returned per page, determined by the limit parameter—whether explicitly set, defaulted, or capped at the maximum limit. - `start_cursor` (string, optional) — A string representing the starting point of the current page in the collection. - `end_cursor` (string, optional) — A string representing the ending point of the current page in the collection. - `links` (PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMetaCursorPaginationLinks, optional) — Pagination links for the previous and next parts of the whole collection. ### PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMetaCursorPaginationLinks Pagination links for the previous and next parts of the whole collection. - `previous` (string, optional) — Link to the previous page returned in the response. - `current` (string, optional) — Link to the current page returned in the response. - `next` (string, optional) — Link to the next page returned in the response. ## Examples **Response** ```json { "data": [ { "calculated_price": 25.48, "date_created": "2022-09-17T20:33:14Z", "date_modified": "2022-09-17T20:33:14Z", "product_id": 187, "price_list_id": 3, "variant_id": 358, "currency": "usd", "price": 25.48, "sale_price": 18.57, "retail_price": 25.48, "map_price": 18.57, "bulk_pricing_tiers": [] }, { "calculated_price": 31.31, "date_created": "2022-09-17T20:33:14Z", "date_modified": "2022-09-17T20:33:14Z", "product_id": 188, "price_list_id": 3, "variant_id": 359, "currency": "usd", "price": 31.31, "sale_price": 31.31, "retail_price": 31.31, "map_price": 31.31, "bulk_pricing_tiers": [] }, { "calculated_price": 18.57, "date_created": "2022-09-17T20:33:14Z", "date_modified": "2022-09-17T20:33:14Z", "product_id": 189, "price_list_id": 3, "variant_id": 360, "currency": "usd", "price": 18.57, "sale_price": 18.57, "retail_price": 18.57, "map_price": 18.57, "bulk_pricing_tiers": [] }, { "calculated_price": 22.54, "date_created": "2022-09-17T20:33:14Z", "date_modified": "2022-09-17T20:33:14Z", "product_id": 190, "price_list_id": 3, "variant_id": 361, "currency": "usd", "price": 22.54, "sale_price": 22.54, "retail_price": 22.54, "map_price": 22.54, "bulk_pricing_tiers": [] }, { "calculated_price": 27.39, "date_created": "2022-09-17T20:33:14Z", "date_modified": "2022-09-17T20:51:26Z", "product_id": 191, "price_list_id": 3, "variant_id": 362, "currency": "usd", "price": 27.39, "sale_price": 27.39, "retail_price": 27.39, "map_price": 27.39, "bulk_pricing_tiers": [ { "quantity_min": 10, "quantity_max": 19, "type": "percent", "amount": 1 }, { "quantity_min": 20, "quantity_max": 29, "type": "percent", "amount": 3 }, { "quantity_min": 30, "quantity_max": 2147483647, "type": "percent", "amount": 5 } ] }, { "calculated_price": 9.8, "date_created": "2022-09-17T20:33:14Z", "date_modified": "2022-09-17T20:33:14Z", "product_id": 192, "price_list_id": 3, "variant_id": 382, "currency": "usd", "price": 9.8, "sale_price": 9.8, "retail_price": 9.8, "map_price": 9.8, "bulk_pricing_tiers": [] }, { "calculated_price": 24.5, "date_created": "2022-09-17T20:33:14Z", "date_modified": "2022-09-17T20:33:14Z", "product_id": 192, "price_list_id": 3, "variant_id": 383, "currency": "usd", "price": 24.5, "sale_price": 24.5, "retail_price": 24.5, "map_price": 24.5, "bulk_pricing_tiers": [] }, { "calculated_price": 24.5, "date_created": "2022-09-17T20:33:14Z", "date_modified": "2022-09-17T20:33:14Z", "product_id": 192, "price_list_id": 3, "variant_id": 384, "currency": "usd", "price": 24.5, "sale_price": 24.5, "retail_price": 24.5, "map_price": 24.5, "bulk_pricing_tiers": [] }, { "calculated_price": 9.8, "date_created": "2022-09-17T20:33:14Z", "date_modified": "2022-09-17T20:33:14Z", "product_id": 193, "price_list_id": 3, "variant_id": 385, "currency": "usd", "price": 9.8, "sale_price": 9.8, "retail_price": 9.8, "map_price": 9.8, "bulk_pricing_tiers": [] }, { "calculated_price": 10.78, "date_created": "2022-09-17T20:33:14Z", "date_modified": "2022-09-17T20:33:14Z", "product_id": 194, "price_list_id": 3, "variant_id": 386, "currency": "usd", "price": 10.78, "sale_price": 10.78, "retail_price": 10.78, "map_price": 10.78, "bulk_pricing_tiers": [] }, { "calculated_price": 10.78, "date_created": "2022-09-17T20:33:14Z", "date_modified": "2022-09-17T20:35:42Z", "product_id": 195, "price_list_id": 3, "variant_id": 388, "currency": "usd", "price": 10.78, "sale_price": 10.78, "retail_price": 10.78, "map_price": 10.78, "bulk_pricing_tiers": [ { "quantity_min": 2, "quantity_max": 9, "type": "percent", "amount": 1 }, { "quantity_min": 10, "quantity_max": 19, "type": "percent", "amount": 2 }, { "quantity_min": 20, "quantity_max": 2147483647, "type": "percent", "amount": 3 } ] }, { "calculated_price": 18.62, "date_created": "2022-09-17T20:33:14Z", "date_modified": "2022-09-17T20:35:42Z", "product_id": 195, "price_list_id": 3, "variant_id": 389, "currency": "usd", "price": 18.62, "sale_price": 18.62, "retail_price": 18.62, "map_price": 18.62, "bulk_pricing_tiers": [ { "quantity_min": 2, "quantity_max": 9, "type": "percent", "amount": 1 }, { "quantity_min": 10, "quantity_max": 19, "type": "percent", "amount": 2 }, { "quantity_min": 20, "quantity_max": 2147483647, "type": "percent", "amount": 3 } ] }, { "calculated_price": 10.78, "date_created": "2022-09-17T20:33:14Z", "date_modified": "2022-09-17T20:35:42Z", "product_id": 195, "price_list_id": 3, "variant_id": 390, "currency": "usd", "price": 10.78, "sale_price": 10.78, "retail_price": 10.78, "map_price": 10.78, "bulk_pricing_tiers": [ { "quantity_min": 2, "quantity_max": 9, "type": "percent", "amount": 1 }, { "quantity_min": 10, "quantity_max": 19, "type": "percent", "amount": 2 }, { "quantity_min": 20, "quantity_max": 2147483647, "type": "percent", "amount": 3 } ] }, { "calculated_price": 10.78, "date_created": "2022-09-17T20:33:14Z", "date_modified": "2022-09-17T20:35:42Z", "product_id": 195, "price_list_id": 3, "variant_id": 391, "currency": "usd", "price": 10.78, "sale_price": 10.78, "retail_price": 10.78, "map_price": 10.78, "bulk_pricing_tiers": [ { "quantity_min": 2, "quantity_max": 9, "type": "percent", "amount": 1 }, { "quantity_min": 10, "quantity_max": 19, "type": "percent", "amount": 2 }, { "quantity_min": 20, "quantity_max": 2147483647, "type": "percent", "amount": 3 } ] } ], "meta": { "pagination": { "total": 14, "count": 14, "per_page": 50, "current_page": 1, "total_pages": 1 }, "cursor_pagination": { "count": 1, "per_page": 50, "start_cursor": "MTUsMjEx", "end_cursor": "MTUsMjEx", "links": {} } } } ``` **SDK Code** ```python Response import requests url = "https://api.bigcommerce.com/stores/store_hash/v3/pricelists/1/records" headers = { "Accept": "application/json", "X-Auth-Token": "" } response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript Response const url = 'https://api.bigcommerce.com/stores/store_hash/v3/pricelists/1/records'; const options = { method: 'GET', headers: {Accept: 'application/json', 'X-Auth-Token': ''} }; 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" "net/http" "io" ) func main() { url := "https://api.bigcommerce.com/stores/store_hash/v3/pricelists/1/records" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Accept", "application/json") req.Header.Add("X-Auth-Token", "") 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/1/records") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Accept"] = 'application/json' request["X-Auth-Token"] = '' 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.get("https://api.bigcommerce.com/stores/store_hash/v3/pricelists/1/records") .header("Accept", "application/json") .header("X-Auth-Token", "") .asString(); ``` ```php Response request('GET', 'https://api.bigcommerce.com/stores/store_hash/v3/pricelists/1/records', [ 'headers' => [ 'Accept' => '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/1/records"); var request = new RestRequest(Method.GET); request.AddHeader("Accept", "application/json"); request.AddHeader("X-Auth-Token", ""); IRestResponse response = client.Execute(request); ``` ```swift Response import Foundation let headers = [ "Accept": "application/json", "X-Auth-Token": "" ] let request = NSMutableURLRequest(url: NSURL(string: "https://api.bigcommerce.com/stores/store_hash/v3/pricelists/1/records")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers 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() ```