diff --git a/reference/tax_rates_zones.v3.yml b/reference/tax_rates_zones.v3.yml index ffbb892a5..a6771f311 100644 --- a/reference/tax_rates_zones.v3.yml +++ b/reference/tax_rates_zones.v3.yml @@ -29,7 +29,7 @@ paths: tags: - Tax Zones summary: Get Tax Zones - description: 'Retrieve a selection of tax zones when you provide a list of tax zone IDs. Otherwise, retrieve all tax zones defined on the store.' + description: Retrieve a selection of tax zones when you provide a list of tax zone IDs. Otherwise, retrieve all tax zones defined on the store. operationId: get-tax-zones responses: '200': @@ -127,7 +127,7 @@ paths: > #### Note > You cannot create a default tax zone. - + operationId: create-tax-zones requestBody: $ref: '#/components/requestBodies/Tax_ZoneArrayPOST' @@ -432,10 +432,10 @@ components: properties: id: type: integer - description: 'Tax Zone ID. Internal identifier used to get, update, or delete a specific tax zone.' + description: Tax Zone ID. Internal identifier used to get, update, or delete a specific tax zone. name: type: string - description: The human-readable name for this tax zone. The name displays on the merchant's control panel. + description: The human-readable name for this tax zone. The name appears in the store control panel. example: Australia enabled: type: boolean @@ -450,10 +450,10 @@ components: 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.' + 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.' + 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ʼt qualify for any other zone. @@ -493,10 +493,10 @@ components: properties: id: type: integer - description: 'Tax Zone ID. Internal identifier used to get, update, or delete a specific tax zone.' + description: Tax Zone ID. Internal identifier used to get, update, or delete a specific tax zone. name: type: string - description: The human-readable name for this tax zone. The name displays on the merchant's control panel. + description: The human-readable name for this tax zone. The name appears in the store control panel. example: Australia enabled: type: boolean @@ -511,10 +511,10 @@ components: 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.' + 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.' + 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ʼt qualify for any other zone. @@ -556,7 +556,7 @@ components: properties: name: type: string - description: The human-readable name for this tax zone. The name displays on the merchant's control panel. + description: The human-readable name for this tax zone. The name appears in the store control panel. example: Australia enabled: type: boolean @@ -571,11 +571,11 @@ components: 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.' + 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. default: false 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.' + 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. default: false required: - show_inclusive @@ -644,11 +644,11 @@ components: example: 3 name: type: string - description: 'The human-readable name for this tax zone. The name displays on the merchant control panel and to shoppers, depending on store tax settings.' + description: The human-readable name for this tax zone. The name appears in the store control panel and may be visible to shoppers, depending on store tax settings. example: Sales Tax priority: type: integer - description: 'Allows for compounding tax rates, common in certain jurisdictions.' + description: Allows for compounding tax rates, common in certain jurisdictions. default: 1 tax_zone_id: type: integer @@ -682,11 +682,11 @@ components: example: 3 name: type: string - description: 'The human-readable name for this tax zone. The name displays on the merchant control panel and to shoppers, depending on store tax settings.' + description: The human-readable name for this tax zone. The name appears in the store control panel and may be visible to shoppers, depending on store tax settings. example: Sales Tax priority: type: integer - description: 'Allows for compounding tax rates, common in certain jurisdictions.' + description: Allows for compounding tax rates, common in certain jurisdictions. default: 1 tax_zone_id: type: integer @@ -720,11 +720,11 @@ components: default: true name: type: string - description: 'The human-readable name for this tax zone. The name displays on the merchant control panel and to shoppers, depending on store tax settings.' + description: The human-readable name for this tax zone. The name appears in the store control panel and may be visible to shoppers, depending on store tax settings. example: Sales Tax priority: type: integer - description: 'Allows for compounding tax rates, common in certain jurisdictions.' + description: Allows for compounding tax rates, common in certain jurisdictions. default: 1 tax_zone_id: type: integer