PricingRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PricingRequest",
  "title": "PricingRequest",
  "type": "object",
  "properties": {
    "channel_id": {
      "type": "integer",
      "description": "The channel ID that pricing evaluates within. The default BigCommerce storefront is channel 1.",
      "example": 1
    },
    "currency_code": {
      "type": "string",
      "description": "The currency of prices to be returned for this request.",
      "example": "USD"
    },
    "customer_group_id": {
      "type": "integer",
      "description": "The customer group relevant for any customer group pricing, tax values, etc."
    },
    "items": {
      "type": "array",
      "description": "The items for which to fetch prices.",
      "items": {
        "type": "object",
        "properties": {
          "product_id": {
            "type": "integer",
            "description": "The (required) product ID of the item."
          },
          "variant_id": {
            "type": "number",
            "description": "The (optional) variant ID of the item."
          },
          "options": {
            "type": "array",
            "description": "The (optional) option configuration of the product. May be \"partially\" configured for estimates.",
            "items": {
              "type": "object",
              "properties": {
                "option_id": {
                  "type": "integer",
                  "description": "The ID of the variant option or modifier option being configured for this product."
                },
                "value_id": {
                  "type": "integer",
                  "description": "The ID of the value matching the option being configured. \n\n**Note:** This must be the ID, not the value.\n "
                }
              }
            }
          }
        },
        "description": "Details/configuration for the product to request a price for."
      }
    }
  },
  "x-internal": false
}