Commerce
Regions
Regions, currencies, and tax.
A region is a set of countries that share a currency and checkout setup. Every cart belongs to a region, and the region decides what the buyer pays and how.
What a region sets
| Field | Meaning |
|---|---|
currency_code | The currency of carts and orders in the region. One currency per region. |
countries | ISO 3166-1 alpha-2 codes. A country belongs to at most one region. |
payment_providers | The payment providers buyers can use. |
automatic_taxes | When true, taxes are recalculated on every cart change. When false, call Calculate taxes yourself before checkout. |
is_tax_inclusive | Whether the region's prices already include tax. |
Need two currencies for the same countries? Use two regions. A storefront lets the buyer pick one, or picks it from their country.
Currencies
The store's supported currencies are the ones prices can be set in. Amounts in the API are in the currency's main unit (10.5 is ten and a half dollars), not cents.
Tax
- Tax regions hold tax rates per country, and optionally per province. Rates can be overridden for specific products, product types, or shipping options with tax rate rules.
- Tax-inclusive pricing is set per region or per currency (price preferences). Product responses show it in
calculated_price.is_calculated_price_tax_inclusive. - To show prices with tax on product pages, send
region_idandcountry_code(andprovincewhen rates differ by province). Readcalculated_amount_with_tax. - Tax is calculated by the tax provider set on the tax region. The default provider uses the stored rates.
Routes
- List regions and currencies (store)
- Regions, tax regions, tax rates, and price preferences (admin)