{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PricingResponse",
  "title": "PricingResponse",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "product_id": {
            "type": "integer",
            "description": "The (required) product ID of the item."
          },
          "variant_id": {
            "type": "integer",
            "description": "The (optional) variant ID of the item."
          },
          "options": {
            "type": "array",
            "description": "The optional product option configuration this price was generated for",
            "items": {
              "type": "object",
              "properties": {
                "option_id": {
                  "type": "integer",
                  "description": "The ID of the variant option or modifier option configured for this price"
                },
                "value_id": {
                  "type": "integer",
                  "description": "The selected value ID for the configured option."
                }
              }
            }
          },
          "retail_price": {
            "type": "object",
            "properties": {
              "as_entered": {
                "type": "number",
                "description": "The price provided by the merchant as entered in their catalog/price list; may include or exclude tax."
              },
              "entered_inclusive": {
                "type": "boolean",
                "description": "Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction."
              },
              "tax_exclusive": {
                "type": "number",
                "description": "The estimated tax exclusive price for this product based on the provided customer group."
              },
              "tax_inclusive": {
                "type": "number",
                "description": "The estimated tax inclusive price for this product based on the provided customer group."
              }
            },
            "description": "The (optional) RRP/retail price configured for this product."
          },
          "sale_price": {
            "type": "object",
            "properties": {
              "as_entered": {
                "type": "number",
                "description": "The price provided by the merchant as entered in their catalog/price list; may include or exclude tax."
              },
              "entered_inclusive": {
                "type": "boolean",
                "description": "Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction."
              },
              "tax_exclusive": {
                "type": "number",
                "description": "The estimated tax exclusive price for this product based on the provided customer group."
              },
              "tax_inclusive": {
                "type": "number",
                "description": "The estimated tax inclusive price for this product based on the provided customer group."
              }
            },
            "description": "The price for a product including estimates for tax."
          },
          "minimum_advertised_price": {
            "type": "object",
            "properties": {
              "as_entered": {
                "type": "number",
                "description": "The price provided by the merchant as entered in their catalog/price list; may include or exclude tax."
              },
              "entered_inclusive": {
                "type": "boolean",
                "description": "Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction."
              },
              "tax_exclusive": {
                "type": "number",
                "description": "The estimated tax exclusive price for this product based on the provided customer group."
              },
              "tax_inclusive": {
                "type": "number",
                "description": "The estimated tax inclusive price for this product based on the provided customer group."
              }
            },
            "description": "The price for a product including estimates for tax."
          },
          "price": {
            "type": "object",
            "properties": {
              "as_entered": {
                "type": "number",
                "description": "The price provided by the merchant as entered in their catalog/price list; may include or exclude tax."
              },
              "entered_inclusive": {
                "type": "boolean",
                "description": "Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction."
              },
              "tax_exclusive": {
                "type": "number",
                "description": "The estimated tax exclusive price for this product based on the provided customer group."
              },
              "tax_inclusive": {
                "type": "number",
                "description": "The estimated tax inclusive price for this product based on the provided customer group."
              }
            },
            "description": "The price for a product including estimates for tax."
          },
          "calculated_price": {
            "type": "object",
            "properties": {
              "as_entered": {
                "type": "number",
                "description": "The price provided by the merchant as entered in their catalog/price list; may include or exclude tax."
              },
              "entered_inclusive": {
                "type": "boolean",
                "description": "Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction."
              },
              "tax_exclusive": {
                "type": "number",
                "description": "The estimated tax exclusive price for this product based on the provided customer group."
              },
              "tax_inclusive": {
                "type": "number",
                "description": "The estimated tax inclusive price for this product based on the provided customer group."
              }
            },
            "description": "The price for a product including estimates for tax."
          },
          "price_range": {
            "type": "object",
            "properties": {
              "minimum": {
                "type": "object",
                "properties": {
                  "as_entered": {
                    "type": "number",
                    "description": "The price provided by the merchant as entered in their catalog/price list; may include or exclude tax."
                  },
                  "entered_inclusive": {
                    "type": "boolean",
                    "description": "Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction."
                  },
                  "tax_exclusive": {
                    "type": "number",
                    "description": "The estimated tax exclusive price for this product based on the provided customer group."
                  },
                  "tax_inclusive": {
                    "type": "number",
                    "description": "The estimated tax inclusive price for this product based on the provided customer group."
                  }
                },
                "description": "The price for a product including estimates for tax."
              },
              "maximum": {
                "type": "object",
                "properties": {
                  "as_entered": {
                    "type": "number",
                    "description": "The price provided by the merchant as entered in their catalog/price list; may include or exclude tax."
                  },
                  "entered_inclusive": {
                    "type": "boolean",
                    "description": "Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction."
                  },
                  "tax_exclusive": {
                    "type": "number",
                    "description": "The estimated tax exclusive price for this product based on the provided customer group."
                  },
                  "tax_inclusive": {
                    "type": "number",
                    "description": "The estimated tax inclusive price for this product based on the provided customer group."
                  }
                },
                "description": "The price for a product including estimates for tax."
              }
            },
            "description": "For estimated prices, the minimum/maximum price that will typically apply to this product."
          },
          "retail_price_range": {
            "type": "object",
            "properties": {
              "minimum": {
                "type": "object",
                "properties": {
                  "as_entered": {
                    "type": "number",
                    "description": "The price provided by the merchant as entered in their catalog/price list; may include or exclude tax."
                  },
                  "entered_inclusive": {
                    "type": "boolean",
                    "description": "Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction."
                  },
                  "tax_exclusive": {
                    "type": "number",
                    "description": "The estimated tax exclusive price for this product based on the provided customer group."
                  },
                  "tax_inclusive": {
                    "type": "number",
                    "description": "The estimated tax inclusive price for this product based on the provided customer group."
                  }
                },
                "description": "The price for a product including estimates for tax."
              },
              "maximum": {
                "type": "object",
                "properties": {
                  "as_entered": {
                    "type": "number",
                    "description": "The price provided by the merchant as entered in their catalog/price list; may include or exclude tax."
                  },
                  "entered_inclusive": {
                    "type": "boolean",
                    "description": "Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction."
                  },
                  "tax_exclusive": {
                    "type": "number",
                    "description": "The estimated tax exclusive price for this product based on the provided customer group."
                  },
                  "tax_inclusive": {
                    "type": "number",
                    "description": "The estimated tax inclusive price for this product based on the provided customer group."
                  }
                },
                "description": "The price for a product including estimates for tax"
              }
            },
            "description": "For estimated prices, the minimum/maximum price that will typically apply to this product."
          },
          "bulk_pricing": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "minimum": {
                  "type": "integer",
                  "description": "The minimum quantity required to trigger this bulk pricing discount."
                },
                "maximum": {
                  "type": "integer",
                  "description": "The maximum quantity (or 0 for unlimited) to trigger this bulk pricing discount."
                },
                "discount_amount": {
                  "type": "number",
                  "description": "The price reduction set by the merchant for this bulk pricing discount."
                },
                "discount_type": {
                  "type": "string",
                  "enum": [
                    "price",
                    "percent",
                    "fixed"
                  ],
                  "description": "The format of the price reduction set by the merchant for this bulk pricing discount."
                },
                "tax_discount_amount": {
                  "type": "array",
                  "description": "Formats the `bulk_pricing.discount_amount` into the tax price amounts.",
                  "items": {
                    "type": "object",
                    "properties": {
                      "as_entered": {
                        "type": "number",
                        "description": "The price provided by the merchant as entered in their catalog/price list; may include or exclude tax."
                      },
                      "tax_inclusive": {
                        "type": "number",
                        "description": "The estimated tax inclusive price for this product based on the provided customer group."
                      },
                      "tax_exclusive": {
                        "type": "number",
                        "description": "The estimated tax exclusive price for this product based on the provided customer group."
                      },
                      "entered_inclusive": {
                        "type": "boolean",
                        "description": "Determines whether the 'as_entered' price is inclusive or exclusive of tax based on the store's tax jurisdiction."
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "properties": {},
      "additionalProperties": true,
      "description": "Response metadata."
    }
  },
  "x-internal": false
}