diff --git a/docs/stencil-docs/developing-further/catalog-price-object.mdx b/docs/stencil-docs/developing-further/catalog-price-object.mdx index ec60b8860..b94b74d22 100644 --- a/docs/stencil-docs/developing-further/catalog-price-object.mdx +++ b/docs/stencil-docs/developing-further/catalog-price-object.mdx @@ -29,7 +29,8 @@ Assume that a merchant has defined the following for a product in the control pa A corresponding catalog price object for the product will be structured as shown below: ```json filename="Catalog price object, no sale price defined" showLineNumbers copy -"product": { +{ + "product": { // ... }, "price": { @@ -61,6 +62,7 @@ A corresponding catalog price object for the product will be structured as shown } } } +} ``` In this example: @@ -84,45 +86,48 @@ A corresponding catalog price object for the product will be structured as shown ```json filename="Catalog price object, sale price defined" showLineNumbers copy -"product": { - // ... - "price": { - "without_tax": { - "formatted": "$15.00", - "value": 15 - }, - "tax_label": "Sales Tax", - "sale_price_without_tax": { - "formatted": "$15.00", - "value": 15 - }, - "non_sale_price_without_tax": { - "formatted": "$20.00", - "value": 20 - }, - "rrp_without_tax": { - "formatted": "$25.00", - "value": 25 - }, - "saved": { - "formatted": "$10.00", - "value": 10 - }, - "retail_price_range": { - "min": { - "without_tax": { - "formatted": "$25.00", - "value": 25 - } +{ + "product": { + // ... + "price": { + "without_tax": { + "formatted": "$15.00", + "value": 15 }, - "max": { - "without_tax": { - "formatted": "$25.00", - "value": 25 + "tax_label": "Sales Tax", + "sale_price_without_tax": { + "formatted": "$15.00", + "value": 15 + }, + "non_sale_price_without_tax": { + "formatted": "$20.00", + "value": 20 + }, + "rrp_without_tax": { + "formatted": "$25.00", + "value": 25 + }, + "saved": { + "formatted": "$10.00", + "value": 10 + }, + "retail_price_range": { + "min": { + "without_tax": { + "formatted": "$25.00", + "value": 25 + } + }, + "max": { + "without_tax": { + "formatted": "$25.00", + "value": 25 + } } } } } +} ``` In this example: @@ -159,12 +164,7 @@ Depending on the store’s [**Tax Display Settings**](https://login.bigcommerce. This display setting affects how values are returned in the catalog price object and how the values appear on storefront pages. - -![Configure tax display settings -](https://storage.cloud.google.com/bigcommerce-production-dev-center/images/tax-settings.png " Configure tax display settings -") - - ![Configure tax display settings](https://raw.githubusercontent.com/bigcommerce/dev-docs/master/assets/images/catalog-price-object-examples.png "Configure tax display settings.") +![Configure tax display settings](https://storage.googleapis.com/bigcommerce-production-dev-center/images/Tax-Settings.png "Configure tax display settings.") ### No sale price defined in control panel @@ -178,29 +178,31 @@ There is no defined sale price for the product. A corresponding catalog price object will be structured as shown below: ```json filename="Product including and excluding tax, no sale price defined" showLineNumbers copy -"product": { - "price": { - "with_tax": { - "formatted": "$165.00", - "value": 165 - }, - "without_tax": { - "formatted": "$150.00", - "value": 150 - }, - "rrp_with_tax": { - "formatted": "$275.00", - "value": 275 - }, - "rrp_without_tax": { - "formatted": "$250.00", - "value": 250 - }, - "saved": { - "formatted": "$110.00", - "value": 110 +{ + "product": { + "price": { + "with_tax": { + "formatted": "$165.00", + "value": 165 + }, + "without_tax": { + "formatted": "$150.00", + "value": 150 + }, + "rrp_with_tax": { + "formatted": "$275.00", + "value": 275 }, - "tax_label": "Tax" + "rrp_without_tax": { + "formatted": "$250.00", + "value": 250 + }, + "saved": { + "formatted": "$110.00", + "value": 110 + }, + "tax_label": "Tax" + } } } ``` @@ -226,45 +228,47 @@ Assume that a merchant has defined the following tax configurations for a produc * Use a flat rate of 10% tax ```json filename="Product including and excluding tax, sale price defined" showLineNumbers copy -"product": { - "price": { - "with_tax": { - "formatted": "$135.30", - "value": 135.3 - }, - "without_tax": { - "formatted": "$123.00", - "value": 123 - }, - "sale_price_without_tax": { - "formatted": "123.00", - "value": 123 - }, - "sale_price_with_tax": { - "formatted": "135.30", - "value": 135.3 - }, - "rrp_with_tax": { - "formatted": "$275.00", - "value": 275 - }, - "rrp_without_tax": { - "formatted": "$250.00", - "value": 250 - }, - "saved": { - "formatted": "$139.70", - "value": 139.7 - }, - "non_sale_price_without_tax": { - "formatted": "$150.00", - "value": 150 - }, - "non_sale_price_with_tax": { - "formatted": "$165.00", - "value": 165 - }, - "tax_label": "Tax" +{ + "product": { + "price": { + "with_tax": { + "formatted": "$135.30", + "value": 135.3 + }, + "without_tax": { + "formatted": "$123.00", + "value": 123 + }, + "sale_price_without_tax": { + "formatted": "123.00", + "value": 123 + }, + "sale_price_with_tax": { + "formatted": "135.30", + "value": 135.3 + }, + "rrp_with_tax": { + "formatted": "$275.00", + "value": 275 + }, + "rrp_without_tax": { + "formatted": "$250.00", + "value": 250 + }, + "saved": { + "formatted": "$139.70", + "value": 139.7 + }, + "non_sale_price_without_tax": { + "formatted": "$150.00", + "value": 150 + }, + "non_sale_price_with_tax": { + "formatted": "$165.00", + "value": 165 + }, + "tax_label": "Tax" + } } } ```