Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(no ticket): [update] Tax Rates & Zones, file cleanup #22

Merged
merged 1 commit into from
Jan 9, 2024
Merged

(no ticket): [update] Tax Rates & Zones, file cleanup #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions reference/tax_rates_zones.v3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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':
Expand Down Expand Up @@ -127,7 +127,7 @@ paths:

> #### Note
> You cannot create a default tax zone.

operationId: create-tax-zones
requestBody:
$ref: '#/components/requestBodies/Tax_ZoneArrayPOST'
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading