Skip to content
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.

DEVDOCS-5425 [new]: Tax Settings API, add tax zone based price display for storefront #1456

Merged
merged 8 commits into from
Oct 25, 2023
28 changes: 26 additions & 2 deletions reference/tax_settings.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,19 @@ components:
should_subtract_store_tax:
default: true
type: boolean
description: This setting applies only if a merchant enters tax-inclusive prices. When enabled, the store subtracts the itemʼs store tax rate before calculating tax using the shopperʼs tax zone. The tax-exclusive amount will be the same across all tax zones. When disabled, the tax-inclusive price remains the same across all tax zones; only the tax amount will vary based on the shopperʼs location. The tax-exclusive amount may vary among tax zones. These calculations are relevant for tax pricing and tax quotations that use basic tax.
description: This setting applies only if a merchant enters tax-inclusive prices. When enabled, the store subtracts the itemʼs store tax rate before calculating tax using the shopperʼs tax zone. The tax-exclusive amount will be the same across all tax zones. When disabled, the tax-inclusive price remains the same across all tax zones; only the tax amount will vary based on the shopperʼs location. The tax-exclusive amount may vary among tax zones. These calculations are relevant for tax pricing and tax quotations that use basic tax.
should_use_geolocation_to_determine_guest_shopper_tax_zone:
bc-msung marked this conversation as resolved.
Show resolved Hide resolved
default: false
type: boolean
description: When enabled, the guest shopper's geolocation will be used to determine the relevant country-level tax zone for storefront tax estimation. The geolocation data will be used to determine the corresponding tax zone provided in basic tax - once the corresponding tax zone is found, the tax estimation will be applied to the store.
bc-andreadao marked this conversation as resolved.
Show resolved Hide resolved
guest_shopper_tax_zone_id:
default: 1
type: integer
description: Describes which tax zone is used for guest shoppers when requiring storefront tax estimation. When applicable, the guest shopper's geolocation will be used in favour of the guest shopper tax zone.
store_tax_zone_id:
default: 1
type: integer
description: This setting applies only if a merchant enters tax-inclusive prices and store tax subtraction is enabled. Describes which tax zone to use for store tax subtraction.
Tax_Settings_Req:
type: object
properties:
Expand All @@ -169,7 +181,7 @@ components:
- EXCLUSIVE
fallback_strategy:
type: string
description: 'Decribes the fallback behaviour that applies when a tax provider produces an error. A merchant may decide to use a flat 10% fallback tax rate, their basic tax settings, or to block the transaction until a successful result can be achieved.'
description: 'Describes the fallback behaviour that applies when a tax provider produces an error. A merchant may decide to use a flat 10% fallback tax rate, their basic tax settings, or to block the transaction until a successful result can be achieved.'
bc-msung marked this conversation as resolved.
Show resolved Hide resolved
enum:
- FIXED
- BASIC
Expand All @@ -178,6 +190,18 @@ components:
default: true
type: boolean
description: This setting applies only if a merchant enters tax-inclusive prices. When enabled, the store subtracts the itemʼs store tax rate before calculating tax using the shopperʼs tax zone. The tax-exclusive amount will be the same across all tax zones. When disabled, the tax-inclusive price remains the same across all tax zones; only the tax amount will vary based on the shopperʼs location. The tax-exclusive amount may vary among tax zones. These calculations are relevant for tax pricing and tax quotations that use basic tax.
should_use_geolocation_to_determine_guest_shopper_tax_zone:
bc-andreadao marked this conversation as resolved.
Show resolved Hide resolved
default: false
type: boolean
description: When enabled, the guest shopper's geolocation will be used to determine the relevant country-level tax zone for storefront tax estimation. The geolocation data will be used to determine the corresponding tax zone provided in basic tax - once the corresponding tax zone is found, the tax estimation will be applied to the store.
guest_shopper_tax_zone_id:
default: 1
type: integer
description: Describes which tax zone is used for guest shoppers when requiring storefront tax estimation. When applicable, the guest shopper's geolocation will be used in favour of the guest shopper tax zone.
bc-andreadao marked this conversation as resolved.
Show resolved Hide resolved
store_tax_zone_id:
default: 1
type: integer
description: This setting applies only if a merchant enters tax-inclusive prices and store tax subtraction is enabled. Describes which tax zone to use for store tax subtraction.
bc-andreadao marked this conversation as resolved.
Show resolved Hide resolved
MetaOpen:
title: Response meta
type: object
Expand Down