Thanks for being patient while we implement your feedback to improve the developer experience.

Get Prices (Batch)

POST /pricing/products

Request

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

Parameters

  • store_hash in path - string

Body

object | application/json

  • channel_id    integer
    required

    The channel context that pricing should be evaluated within. The default BC storefront is channel 1

    Example: 1

  • currency_code    string
    required

    The currency of prices to be returned for this request

    Example: USD

  • customer_group_id    integer
    required

    The customer group relevant for any customer group pricing, tax values, etc.

  • items    array[object]
    required

    The items to fetch prices for

example

{
  "channel_id": 1,
  "currency_code": "USD",
  "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.

  • data    array[object]

  • meta    object

    Response metadata.

example

{
  "data": [
    {
      "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
      },
      "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"
        }
      ]
    }
  ],
  "meta": {}
}