Region

A region holds settings specific to a geographical location, including the currency, tax rates, and fulfillment and payment providers. A Region can consist of multiple countries to accomodate common shopping settings across countries.

Properties

idstringRequired

The region's ID

created_atDateRequired

The date with timezone at which the resource was created.

updated_atDateRequired

The date with timezone at which the resource was updated.

deleted_atnull | DateRequired

The date with timezone at which the resource was deleted.

namestringRequired

The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.

currency_codestringRequired

The three character currency code used in the region.

currencyCurrencyRequired

The details of the currency used in the region.

tax_ratenumberRequired

The tax rate that should be charged on purchases in the Region.

tax_ratesnull | TaxRate[]Required

The details of the tax rates used in the region, aside from the default rate.

tax_codestringRequired

The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.

gift_cards_taxablebooleanRequired

Whether the gift cards are taxable or not in this region.

Default: true

automatic_taxesbooleanRequired

Whether taxes should be automated in this region.

Default: true

countriesCountry[]Required

The details of the countries included in this region.

tax_provider_idnull | stringRequired

The ID of the tax provider used in this region

tax_providerTaxProviderRequired

The details of the tax provider used in the region.

payment_providersPaymentProvider[]Required

The details of the payment providers that can be used to process payments in the region.

fulfillment_providersFulfillmentProvider[]Required

The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.

metadataRecord<string, unknown>Required

An optional key-value map with additional details

includes_taxbooleanRequired

Whether the prices for the region include tax

Default: false