Get Prices (batch)

POST

https://api.bigcommerce.com/stores/:store_hash/v3/pricing/products

POST

/stores/:store_hash/v3/pricing/products

curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/pricing/products \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "channel_id": 1,
  "currency_code": "USD",
  "items": [
    {}
  ]
}'

200Response

{
  "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
      },
      "minimum_advertised_price": {
        "as_entered": 1.5,
        "entered_inclusive": true,
        "tax_exclusive": 1.1,
        "tax_inclusive": 1.5
      },
      "saved": {
        "as_entered": 1.5,
        "entered_inclusive": true,
        "tax_exclusive": 1.1,
        "tax_inclusive": 1.5
      },
      "price": {
        "as_entered": 1.5,
        "entered_inclusive": true,
        "tax_exclusive": 1.1,
        "tax_inclusive": 1.5
      },
      "calculated_price": {
        "as_entered": 1.5,
        "entered_inclusive": true,
        "tax_exclusive": 1.1,
        "tax_inclusive": 1.5
      },
      "price_range": {
        "minimum": {
          "as_entered": 1.5,
          "entered_inclusive": true,
          "tax_exclusive": 1.1,
          "tax_inclusive": 1.5
        },
        "maximum": {
          "as_entered": 1.5,
          "entered_inclusive": true,
          "tax_exclusive": 1.1,
          "tax_inclusive": 1.5
        }
      },
      "retail_price_range": {
        "minimum": {
          "as_entered": 1.5,
          "entered_inclusive": true,
          "tax_exclusive": 1.1,
          "tax_inclusive": 1.5
        },
        "maximum": {
          "as_entered": 1.5,
          "entered_inclusive": true,
          "tax_exclusive": 1.1,
          "tax_inclusive": 1.5
        }
      },
      "bulk_pricing": [
        {
          "minimum": 1,
          "maximum": 1,
          "discount_amount": 1,
          "discount_type": "percent",
          "tax_discount_amount": [
            {
              "as_entered": 10,
              "tax_inclusive": 10,
              "tax_exclusive": 10,
              "entered_inclusive": false
            }
          ]
        }
      ]
    }
  ],
  "meta": {}
}

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-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Products	read-only	`store_v2_products_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.

channel_idintegerRequired

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

currency_codestringRequired

The currency code of prices this request returns.

itemslist of objectsRequired

The items for which to fetch prices.

country_codestringOptional

An ISO 3166-1 alpha-2 shopper’s country code representing a country or special geographic area.

customer_group_idintegerOptional

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

customer_idintegerOptional

The ID of the customer for whom to fetch prices.

Response

datalist of objectsOptional

metaobjectOptional

Response metadata.