Skip to content

Commit

Permalink
(no ticket): [update] Catalog Price, fix broken IMG URL (#1969)
Browse files Browse the repository at this point in the history 
Co-authored-by: Sarah Riehl <[email protected]>
  • Loading branch information
@bc-tgomez
bc-tgomez and Sarah Riehl authored Aug 28, 2023
1 parent 12bd4f9 commit 2b93460
Showing 1 changed file with 106 additions and 102 deletions.
208 changes: 106 additions & 102 deletions docs/stencil-docs/developing-further/catalog-price-object.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down Expand Up @@ -61,6 +62,7 @@ A corresponding catalog price object for the product will be structured as shown
}
}
}
}
```

In this example:
Expand All @@ -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:
Expand Down Expand Up @@ -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

Expand All @@ -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"
}
}
}
```
Expand All @@ -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"
}
}
}
```
Expand Down

0 comments on commit 2b93460

Please sign in to comment.