BigCommerce · Schema

PriceRecordBatchItem

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
price_list_id integer The price list ID the price record is associated with.
variant_id integer The price list with which the price record is associated. Either `variant_id` or `sku` is required.
sku string The SKU for the variant with which this price record is associated. Either `sku` or `variant_id` is required.
currency string The 3-letter country code with which this price record is associated.
items object
View JSON Schema on GitHub

JSON Schema

bigcommerce-pricerecordbatchitem-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PriceRecordBatchItem",
  "title": "PriceRecordBatchItem",
  "type": "object",
  "properties": {
    "price_list_id": {
      "type": "integer",
      "description": "The price list ID the price record is associated with.",
      "example": 1
    },
    "variant_id": {
      "type": "integer",
      "description": "The price list with which the price record is associated. Either `variant_id` or `sku` is required.",
      "example": 5
    },
    "sku": {
      "type": "string",
      "description": "The SKU for the variant with which this price record is associated. Either `sku` or `variant_id` is required.",
      "example": "SKU-001"
    },
    "currency": {
      "type": "string",
      "description": "The 3-letter country code with which this price record is associated.",
      "format": "ISO:4217",
      "example": "usd"
    },
    "items": {
      "$ref": "#/components/schemas/PriceRecordBase"
    }
  }
}