BigCommerce · Schema

PriceRecordBase

Common Price Record properties.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
price number 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.
sale_price number 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.
retail_price number 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 var
map_price number 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
bulk_pricing_tiers array
View JSON Schema on GitHub

JSON Schema

bigcommerce-pricerecordbase-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PriceRecordBase",
  "title": "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",
      "example": 0
    },
    "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",
      "example": 0
    },
    "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",
      "example": 0
    },
    "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",
      "example": 0
    },
    "bulk_pricing_tiers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BulkPricingTier"
      }
    }
  },
  "description": "Common Price Record properties."
}