PriceRecordBatchItem

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bigcommerce/main/json-schema/bigcommerce-price-record-batch-item-schema.json",
  "title": "PriceRecordBatchItem",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/bigcommerce-price-lists-records-api-openapi.yml#/components/schemas/PriceRecordBatchItem",
  "type": "object",
  "properties": {
    "price_list_id": {
      "type": "integer",
      "description": "The price list ID the price record is associated with."
    },
    "variant_id": {
      "type": "integer",
      "description": "The price list with which the price record is associated. Either `variant_id` or `sku` is required."
    },
    "sku": {
      "type": "string",
      "description": "The SKU for the variant with which this price record is associated. Either `sku` or `variant_id` is required."
    },
    "currency": {
      "type": "string",
      "description": "The 3-letter country code with which this price record is associated.",
      "format": "ISO:4217"
    },
    "items": {
      "$ref": "#/$defs/PriceRecordBase"
    }
  },
  "$defs": {
    "BulkPricingTier": {
      "type": "object",
      "properties": {
        "quantity_min": {
          "type": "integer",
          "description": "The cart's minimum quantity of associated variants needed to qualify for this tier's pricing."
        },
        "quantity_max": {
          "type": "integer",
          "description": "The cart's maximum allowed quantity of associated variants to qualify for this tier's pricing."
        },
        "type": {
          "type": "string",
          "description": "The type of adjustment that is made. \nAcceptable values: \n* price – the adjustment amount per product \n* percent – the adjustment as a percentage of the original price \n* fixed – the adjusted absolute price of the product",
          "enum": [
            "fixed",
            "price",
            "percent"
          ]
        },
        "amount": {
          "type": "number",
          "description": "The price adjustment amount. This value and the type will decide the price per variant for the pricing tier.",
          "format": "double"
        }
      }
    },
    "PriceRecordBase": {
      "type": "object",
      "properties": {
        "price": {
          "type": "number",
          "description": "The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product. If empty, the sale price will be treated as not being set on this variant.",
          "format": "double"
        },
        "sale_price": {
          "type": "number",
          "description": "The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant.",
          "format": "double"
        },
        "retail_price": {
          "type": "number",
          "description": "The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product.  If empty, the retail price will be treated as not being set on this variant.",
          "format": "double"
        },
        "map_price": {
          "type": "number",
          "description": "The MAP (Minimum Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the `map_ price` will be treated as not being set on this variant.",
          "format": "double"
        },
        "bulk_pricing_tiers": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/BulkPricingTier"
          }
        }
      },
      "description": "Common Price Record properties."
    }
  }
}