{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/TaxZone", "title": "TaxZone", "type": "object", "x-examples": {}, "properties": { "id": { "type": "integer", "description": "Tax Zone ID. Internal identifier used to get, update, or delete a specific tax zone.", "example": 1 }, "name": { "type": "string", "description": "The human-readable name for this tax zone. The name displays on the merchant's control panel.", "example": "Australia" }, "enabled": { "type": "boolean", "description": "Indicates whether a tax zone is enabled. Tax operations are only for enabled zones.", "default": true }, "price_display_settings": { "type": "object", "description": "Settings that describe how a store displays prices to shoppers matched with this tax zone.", "properties": { "show_inclusive": { "type": "boolean", "description": "Indicates whether to show prices as tax inclusive or tax exclusive to shoppers matched with this tax zone." }, "show_both_on_detail_view": { "type": "boolean", "description": "Indicates whether to show both tax inclusive and tax exclusive prices when viewing product detail; for example, on product pages. This view applies to shoppers matched with this tax zone." }, "show_both_on_list_view": { "type": "boolean", "description": "Indicates whether to show both tax inclusive and tax exclusive prices when viewing a list of products; for example, on category and brand pages. This view applies to shoppers matched with this tax zone." } } }, "shopper_target_settings": { "type": "object", "description": "Settings that describe which shoppers match this tax zone and help determine the most appropriate target for a shopper. You cannot define shopper target settings for the default tax zone because it must accommodate all shoppers who don\u02bct qualify for any other zone.", "properties": { "locations": { "type": "array", "description": "A tax zone may target shoppers in one or more locations.", "items": { "type": "object", "properties": { "country_code": { "type": "string", "example": "AU", "description": "Two-letter ISO 3166-1 country code" }, "subdivision_codes": { "type": "array", "example": [ "NSW", "QLD" ], "description": "Three-letter ISO 3166-2 subdivision code", "items": { "type": "string" } }, "postal_codes": { "type": "array", "example": [ "2234", "2170" ], "items": { "type": "string" } } } } }, "customer_groups": { "type": "array", "description": "One or more customer groups that a tax zone targets. Empty array if zone applies to all customers.", "items": { "type": "integer" } } } } } }