Products
Get Prices (Batch)
POST https://api.bigcommerce.com/stores/{store_hash}/v3/pricing/productsRequest
Calculate batch pricing for products for a specific channel, currency, and customer group.
Limits
- Limit of 50 concurrent requests.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
Body
object | application/json
channel_idinteger
requiredThe channel ID that pricing evaluates within. The default BigCommerce storefront is channel 1.Example: 1currency_codestring
requiredThe currency code of prices this request returns.Example: USDcountry_codestring
An ISO 3166-1 alpha-2 shopper's country code representing a country or special geographic area.Example: UScustomer_group_idinteger
requiredThe customer group ID that's relevant for any customer group pricing, tax values, etc.itemsarray[object]
requiredThe items for which to fetch prices.
example
{
"channel_id": 1,
"currency_code": "USD",
"country_code": "US",
"customer_group_id": 0,
"items": [
{
"product_id": 0,
"variant_id": 0,
"options": [
{
"option_id": 0,
"value_id": 0
}
]
}
]
}
Response
OK
Body
object | application/json
Note that a storeʼs tax settings may affect the calculations for
tax_inclusive
and tax_exclusive
prices.dataarray[object]
example
{
"data": [
{
"product_id": 1,
"variant_id": 1,
"options": [
{
"option_id": 1,
"value_id": 1
}
],
"reference_request": {
"product_id": 1,
"variant_id": 1,
"options": [
{
"option_id": 1,
"value_id": 1
}
]
},
"retail_price": {
"as_entered": 1.5,
"entered_inclusive": true,
"tax_exclusive": 1.1,
"tax_inclusive": 1.5
},
"sale_price": {
"as_entered": 1.5,
"entered_inclusive": true,
"tax_exclusive": 1.1,
"tax_inclusive": 1.5
Did you find what you were looking for?