/** * This file was auto-generated by openapi-typescript and ts-morph. * Do not make direct changes to the file. */ export interface paths { readonly "/pricing/products": { readonly parameters: { readonly query?: never; readonly path?: never; readonly cookie?: never; }; /** * Get Prices (Batch) * @description Calculate batch pricing for products for a specific channel, currency, and customer group. * * The rounded prices in this endpoint's response will align with the currency's decimal precision as defined in the [currency](https://support.bigcommerce.com/s/article/Managing-Currencies?language=en_US#add) settings page. * * **Limits** * * Limit of 50 concurrent requests. */ readonly post: operations["getPrices"]; }; } export type webhooks = Record; export interface components { schemas: { /** @description You can use the original details of the request to identify the exact product variant and fetch prices. */ readonly ReferenceRequest: { /** @description The (required) product ID of the item. */ readonly product_id?: number; /** @description The (optional) variant ID of the item. */ readonly variant_id?: number; /** @description The optional product option configuration for this generated price. */ readonly options?: readonly { /** @description The ID of the variant option or modifier option configured for this price. */ readonly option_id?: number; /** @description The selected value ID for the configured option. */ readonly value_id?: number; }[]; }; readonly BulkPricingTier: { /** @description The minimum quantity required to trigger this bulk pricing discount. */ readonly minimum?: number; /** @description The maximum quantity (or 0 for unlimited) to trigger this bulk pricing discount. */ readonly maximum?: number; readonly discount_amount?: number; /** @enum {string} */ readonly discount_type?: "price" | "percent" | "fixed"; /** @description Formats the `bulk_pricing.discount_amount` into the tax price amounts. */ readonly tax_discount_amount?: readonly { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description Determines whether the 'as_entered' price is inclusive or exclusive of tax based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; }[]; }; readonly PricingResponse: { readonly data?: readonly { /** @description The (required) product ID of the item. */ readonly product_id?: number; /** @description The (optional) variant ID of the item. */ readonly variant_id?: number; /** @description The optional product option configuration this price was generated for */ readonly options?: readonly { /** @description The ID of the variant option or modifier option configured for this price */ readonly option_id?: number; /** @description The selected value ID for the configured option. */ readonly value_id?: number; }[]; /** @description The (optional) RRP/retail price configured for this product. */ readonly retail_price?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The price for a product, including estimates for tax. */ readonly sale_price?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The price for a product, including estimates for tax. */ readonly minimum_advertised_price?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The price for a product, including estimates for tax. */ readonly price?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The price for a product, including estimates for tax. */ readonly calculated_price?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description For estimated prices, the minimum/maximum price that will typically apply to this product. */ readonly price_range?: { /** @description The price for a product, including estimates for tax. */ readonly minimum?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The price for a product, including estimates for tax. */ readonly maximum?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; }; /** @description For estimated prices, the minimum/maximum price that will typically apply to this product. */ readonly retail_price_range?: { /** @description The price for a product, including estimates for tax. */ readonly minimum?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The price for a product including estimates for tax */ readonly maximum?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; }; readonly bulk_pricing?: readonly { /** @description The minimum quantity required to trigger this bulk pricing discount. */ readonly minimum?: number; /** @description The maximum quantity (or 0 for unlimited) to trigger this bulk pricing discount. */ readonly maximum?: number; /** @description The price reduction set by the merchant for this bulk pricing discount. */ readonly discount_amount?: number; /** * @description The format of the price reduction set by the merchant for this bulk pricing discount. * @enum {string} */ readonly discount_type?: "price" | "percent" | "fixed"; /** @description Formats the `bulk_pricing.discount_amount` into the tax price amounts. */ readonly tax_discount_amount?: readonly { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description Determines whether the 'as_entered' price is inclusive or exclusive of tax based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; }[]; }[]; }[]; /** @description Response metadata. */ readonly meta?: { readonly [key: string]: unknown; }; }; /** @description For estimated prices, the minimum/maximum price that will typically apply to this product. */ readonly PriceRange: { /** @description The price for a product, including estimates for tax. */ readonly minimum?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The price for a product, including estimates for tax. */ readonly maximum?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; }; /** @description The price for a product, including estimates for tax. */ readonly TaxPrice: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; readonly ItemPricing: { /** @description The (required) product ID of the item. */ readonly product_id?: number; /** @description The (optional) variant ID of the item. */ readonly variant_id?: number; /** @description The optional product option configuration for which this price was generated. */ readonly options?: readonly { /** @description The ID of the variant option or modifier option configured for this price. */ readonly option_id?: number; /** @description The selected value ID for the configured option. */ readonly value_id?: number; }[]; /** @description The (optional) RRP/retail price configured for this product. */ readonly retail_price?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The price for a product, including estimates for tax. */ readonly sale_price?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The price for a product, including estimates for tax. */ readonly minimum_advertised_price?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The price for a product, including estimates for tax. */ readonly price?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The price for a product, including estimates for tax. */ readonly calculated_price?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description For estimated prices, the minimum/maximum price that will typically apply to this product. */ readonly price_range?: { /** @description The price for a product, including estimates for tax. */ readonly minimum?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The price for a product, including estimates for tax. */ readonly maximum?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax. jurisdiction */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; }; /** @description For estimated prices, the minimum/maximum price that will typically apply to this product. */ readonly retail_price_range?: { /** @description The price for a product, including estimates for tax. */ readonly minimum?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The price for a product, including estimates for tax. */ readonly maximum?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; }; readonly bulk_pricing?: readonly components["schemas"]["BulkPricingTier"][]; }; /** @description Details/configuration for the product to request a price for. */ readonly Item: { /** @description The (required) product ID of the item. */ readonly product_id?: number; /** @description The (optional) variant ID of the item. */ readonly variant_id?: number; /** @description The (optional) option configuration of the product. May be "partially" configured for estimates. */ readonly options?: readonly { /** @description The ID of the variant option or modifier option being configured for this product. */ readonly option_id?: number; /** @description The ID of the value matching the option being configured. * * **Note:** must be ID, not the value. */ readonly value_id?: number; }[]; }; readonly PricingRequest: { /** * @description The channel ID that pricing evaluates within. The default BigCommerce storefront is channel 1. * @example 1 */ readonly channel_id?: number; /** * @description The currency of prices to be returned for this request. * @example USD */ readonly currency_code?: string; /** @description The customer group relevant for any customer group pricing, tax values, etc. */ readonly customer_group_id?: number; /** @description The items for which to fetch prices. */ readonly items?: readonly { /** @description The (required) product ID of the item. */ readonly product_id?: number; /** @description The (optional) variant ID of the item. */ readonly variant_id?: number; /** @description The (optional) option configuration of the product. May be "partially" configured for estimates. */ readonly options?: readonly { /** @description The ID of the variant option or modifier option being configured for this product. */ readonly option_id?: number; /** @description The ID of the value matching the option being configured. * * **Note:** This must be the ID, not the value. * */ readonly value_id?: number; }[]; }[]; }; }; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export interface operations { readonly getPrices: { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly requestBody: { readonly content: { readonly "application/json": { /** * @description The channel ID that pricing evaluates within. The default BigCommerce storefront is channel 1. * @example 1 */ readonly channel_id: number; /** * @description The currency code of prices this request returns. * @example USD */ readonly currency_code: string; /** * @description An ISO 3166-1 alpha-2 shopper's country code representing a country or special geographic area. * @example US */ readonly country_code?: string; /** @description The customer group ID that's relevant for any customer group pricing, tax values, etc. */ readonly customer_group_id?: number; /** @description The ID of the customer for whom to fetch prices. */ readonly customer_id?: number; /** @description The items for which to fetch prices. */ readonly items: readonly { /** @description The (required) product ID of the item. */ readonly product_id?: number; /** @description The (optional) variant ID of the item. */ readonly variant_id?: number; /** @description The option configuration of the product (optional); might be partially configured for estimates. */ readonly options?: readonly { /** @description The ID of the variant option or modifier option that is being configured for this product. */ readonly option_id?: number; /** @description The ID of the value matching the option that's being configured. * * **Note:*** This must be the ID, not the value. */ readonly value_id?: number; }[]; }[]; }; }; }; readonly responses: { /** @description OK */ readonly 200: { headers: { readonly [name: string]: unknown; }; content: { /** @example { * "data": [ * { * "product_id": 1, * "variant_id": 1, * "options": [ * { * "option_id": 1, * "value_id": 1 * } * ], * "reference_request": { * "product_id": 1, * "variant_id": 1, * "options": [ * { * "option_id": 1, * "value_id": 1 * } * ] * }, * "retail_price": { * "as_entered": 1.5, * "entered_inclusive": true, * "tax_exclusive": 1.1, * "tax_inclusive": 1.5 * }, * "sale_price": { * "as_entered": 1.5, * "entered_inclusive": true, * "tax_exclusive": 1.1, * "tax_inclusive": 1.5 * }, * "minimum_advertised_price": { * "as_entered": 1.5, * "entered_inclusive": true, * "tax_exclusive": 1.1, * "tax_inclusive": 1.5 * }, * "saved": { * "as_entered": 1.5, * "entered_inclusive": true, * "tax_exclusive": 1.1, * "tax_inclusive": 1.5 * }, * "price": { * "as_entered": 1.5, * "entered_inclusive": true, * "tax_exclusive": 1.1, * "tax_inclusive": 1.5 * }, * "calculated_price": { * "as_entered": 1.5, * "entered_inclusive": true, * "tax_exclusive": 1.1, * "tax_inclusive": 1.5 * }, * "price_range": { * "minimum": { * "as_entered": 1.5, * "entered_inclusive": true, * "tax_exclusive": 1.1, * "tax_inclusive": 1.5 * }, * "maximum": { * "as_entered": 1.5, * "entered_inclusive": true, * "tax_exclusive": 1.1, * "tax_inclusive": 1.5 * } * }, * "retail_price_range": { * "minimum": { * "as_entered": 1.5, * "entered_inclusive": true, * "tax_exclusive": 1.1, * "tax_inclusive": 1.5 * }, * "maximum": { * "as_entered": 1.5, * "entered_inclusive": true, * "tax_exclusive": 1.1, * "tax_inclusive": 1.5 * } * }, * "bulk_pricing": [ * { * "minimum": 1, * "maximum": 1, * "discount_amount": 1, * "discount_type": "percent", * "tax_discount_amount": [ * { * "as_entered": 10, * "tax_inclusive": 10, * "tax_exclusive": 10, * "entered_inclusive": false * } * ] * } * ] * } * ], * "meta": {} * } */ readonly "application/json": { readonly data?: readonly (components["schemas"]["ReferenceRequest"] & { readonly reference_request?: components["schemas"]["ReferenceRequest"]; } & { /** @description The (optional) RRP/retail price configured for this product and used for price comparison and storefront display purposes. */ readonly retail_price?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The merchant-entered sale price for a product overwrites the default price. The `sale_price` is optional. */ readonly sale_price?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The minimum advertised price (MAP) you can display on a storefront. A value supplied by the merchant and used for display purposes. */ readonly minimum_advertised_price?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The amount that merchants save, determined by the difference between `retail_price` and `calculated_price`. */ readonly saved?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The merchant-entered price for a product, which could include or exclude tax. When creating a product, you must define the price, which serves as the default price. */ readonly price?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The shopper price for a product, which includes modifier, option, and option set rules. The `calculated_price` may include or exclude estimates for tax. */ readonly calculated_price?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The minimum and maximum price that will typically apply to this product. Only used for complex products (products with variants). */ readonly price_range?: { /** @description The price for a product, including estimates for tax. */ readonly minimum?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The price for a product, including estimates for tax. */ readonly maximum?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; }; /** @description The productʼs variants that will typically apply to this product. */ readonly retail_price_range?: { /** @description The price for a product, including estimates for tax. */ readonly minimum?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; /** @description The price for a product, including estimates for tax. */ readonly maximum?: { /** @description The price provided by the merchant, as entered in their catalog/price list; may include or exclude tax. */ readonly as_entered?: number; /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the store's tax jurisdiction. */ readonly entered_inclusive?: boolean; /** @description The estimated tax-exclusive price for this product based on the provided customer group. */ readonly tax_exclusive?: number; /** @description The estimated tax-inclusive price for this product based on the provided customer group. */ readonly tax_inclusive?: number; }; }; readonly bulk_pricing?: readonly components["schemas"]["BulkPricingTier"][]; })[]; /** @description Response metadata. */ readonly meta?: { readonly [key: string]: unknown; }; }; }; }; }; }; }