GET /pricelists
Returns a list of Price Lists. Optional parameters can be passed in.
Servers
- https://api.bigcommerce.com/stores/{store_hash}/v3
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 |
---|---|---|---|
date_modified |
String | No |
Filter items by date_modified. For example |
name:like |
String | No | |
date_created:max |
String | No | |
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 | |
id:in[] |
Array | No | |
page |
Integer | No |
Specifies the page number in a limited (paginated) list of products. |
date_modified:min |
String | No | |
name |
String | No |
Filter items by name. |
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. |
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. |
date_created:min |
String | No | |
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.