GET /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.

Servers

https://api.bigcommerce.com/stores/{store_hash}/v3

Path parameters

Name	Type	Required	Description
`price_list_id`	Integer	Yes	The ID of the `Price List` requested.

Request headers

Name Type Required Description

Name	Type	Required	Description
`Accept`	String	Yes	The MIME type of the response body. Default value: "application/json"

Accept

String

Yes

The MIME type of the response body.

Default value: "application/json"

Query parameters

Name	Type	Required	Description
`sku:in[]`	Array	No
`product_id:in[]`	Array	No	A comma-separated list of IDs for one or more products for which prices were requested.
`retail_price`	Number	No	Filter items by retail_price.
`sale_price:max`	Number	No
`date_created:max`	String	No
`currency`	String	No	Filter items by currency.
`before`	String	No	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.
`date_modified:max`	String	No
`date_modified:min`	String	No
`limit`	Integer	No	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.
`sku`	String	No	Filter items by SKU.
`include[]`	Array	No	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.
`currency:in[]`	Array	No
`after`	String	No	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.
`calculated_price:max`	Number	No
`price:max`	Number	No
`date_created:min`	String	No
`retail_price:min`	Number	No
`map_price:min`	Number	No
`variant_id:in[]`	Array	No	A comma-separated list of IDs for one or more variants for which prices were requested.
`price`	Number	No	Filter items by price.
`date_modified`	String	No	Filter items by date_modified. For example `v3/catalog/products?date_last_imported:min=2022-06-15`
`calculated_price:min`	Number	No
`price:min`	Number	No
`sale_price:min`	Number	No
`map_price:max`	Number	No
`retail_price:max`	Number	No
`page`	Integer	No	Specifies the page number in a limited (paginated) list of products.
`map_price`	Number	No	Filter items by map_price.
`calculated_price`	Number	No	Filter items by calculated_price.
`sale_price`	Number	No	Filter items by sale_price.
`date_created`	String	No	Filter items by date_created.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.