Skip to content

Commit 25b91e0

Browse files
committed
Expand Tax Provider API to include customs information, duties
1 parent 1f49508 commit 25b91e0

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

reference/tax_provider.yml

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -939,9 +939,21 @@ components:
939939
default: false
940940
tax_properties:
941941
type: array
942-
description: Merchants may opt to include additional properties that a tax provider can choose to support, factoring these values into tax calculation.
942+
description: Merchants may opt to include additional properties that a tax provider can choose to support, factoring these values into tax calculation. See [Tax Properties API](/docs/rest-management/tax-properties) for more information on configuring tax properties.
943943
items:
944944
$ref: '#/components/schemas/request-item-tax-property'
945+
customs_information:
946+
type: object
947+
description: Merchants may opt to include customs information data in the quote request allowing tax providers to supply calculated duties in addition to taxes. See [Customs Information API](/docs/rest-management/shipping/customs-information) for more information on configuring customs information.
948+
properties:
949+
country_of_origin:
950+
type: string
951+
description: The country of manufacture, production, or growth represented in ISO 3166-1 alpha-2 format, when available.
952+
example: 'AU'
953+
hs_code:
954+
type: string
955+
description: The item's harmonized tariff code for the document's destination country, when available.
956+
example: '817355'
945957
required:
946958
- id
947959
- price
@@ -1262,6 +1274,11 @@ components:
12621274
description: Breakdown of the sales taxes that applied to this item.
12631275
items:
12641276
$ref: '#/components/schemas/SalesTax'
1277+
duties_summary:
1278+
type: array
1279+
description: Breakdown of any duties that applied to this item.
1280+
items:
1281+
$ref: '#/components/schemas/Duties'
12651282
required:
12661283
- amount_inclusive
12671284
- amount_exclusive
@@ -1301,6 +1318,16 @@ components:
13011318
- rate
13021319
- amount
13031320
x-internal: false
1321+
Duties:
1322+
type: object
1323+
properties:
1324+
name:
1325+
type: string
1326+
description: The human-readable name of this custom duty. May not be empty.
1327+
amount:
1328+
type: number
1329+
format: double
1330+
description: The absolute amount that the shopper will be charged for this custom duty.
13041331
item_type:
13051332
type: string
13061333
description: |-

0 commit comments

Comments
 (0)