GET /pricelists/{price_list_id}/records/{variant_id}
Returns Price List Records using the variant ID. Will also contain currency records.
Notes
- Supports up to 40 simultaneous GET requests. Running more than the allowed number of requests concurrently on the same store will result in a
429status 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 |
variant_id |
Integer | Yes |
ID of the variant on a product, or on an associated Price List Record. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Accept |
String | Yes |
The MIME type of the response body. Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page |
Integer | No |
Specifies the page number in a limited (paginated) list of products. |
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. |
include[] |
Array | No |
Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include |
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. |
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. |
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.