Docs
Management API
Pricing
Products

Products

Get Prices (Batch)

POST /pricing/products

Request

Calculate batch pricing for products for a specific channel, currency, and customer group.

The rounded prices in this endpoint's response will align with the currency's decimal precision as defined in the currency settings page.

Limits

  • Limit of 50 concurrent requests.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string

Body

object | application/json

  • channel_id    integer
    required

    The channel ID that pricing evaluates within. The default BigCommerce storefront is channel 1.
    Example: 1

  • currency_code    string
    required

    The currency code of prices this request returns.
    Example: USD

  • country_code    string

    An ISO 3166-1 alpha-2 shopper's country code representing a country or special geographic area.
    Example: US

  • customer_group_id    integer
    required

    The customer group ID that's relevant for any customer group pricing, tax values, etc.

  • items    array[object]
    required

    The items for which to fetch prices.

example

Response

OK

Body

object | application/json
Note that a storeʼs tax settings may affect the calculations for tax_inclusive and tax_exclusive prices.

  • data    array[object]

  • meta    object

    Response metadata.

example

Did you find what you were looking for?
PricingGet Prices (Batch)