Skip to content

Commit

Permalink
(no ticket): [update] Tax Rates & Zones, file cleanup (#22)
Browse files Browse the repository at this point in the history
<!-- Ticket number or summary of work -->
# (no ticket): [update] Tax Rates & Zones, file cleanup


## What changed?
<!-- Provide a bulleted list in the present tense -->
* attempt linting fix to ghost theme: info tag

## Release notes draft
<!-- Provide an entry for the release notes using simple, conversational
language. Don't be too technical. Explain how the change will benefit
the merchant and link to the feature.

Examples:
* The newly-released [X feature] is now available to use. Now, you’ll be
able to [perform Y action].
* We're happy to announce [X feature], which can help you [perform Y
action].
* [X feature] helps you to create [Y response] using the [Z query
parameter]. Now, you can deliver [ex, localized shopping experiences for
your customers].
* Fixed a bug in the [X endpoint]. Now the [Y field] will appear when
you click [Z option]. -->
* Cleaned up syntax in the Tax Rates and Zones file. Artifacts from
previous syntax should no longer appear in the site build.

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->

ping {names}
  • Loading branch information
Sarah Riehl authored Jan 9, 2024
1 parent 60191e7 commit dd1fb68
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions reference/tax_rates_zones.v3.yml
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

0 comments on commit dd1fb68

Please sign in to comment.