Skip to content

Commit 152a3ba

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

File tree

1 file changed

+33
-3
lines changed

1 file changed

+33
-3
lines changed

reference/tax_provider.yml

Lines changed: 33 additions & 3 deletions
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
@@ -1227,16 +1239,21 @@ components:
12271239
response-item:
12281240
type: object
12291241
description: |-
1230-
The tax liabilities calculated for a specific item.
1242+
The tax liabilities, and any duties, calculated for a specific item.
12311243
1232-
Note: Tax liabilities should be calculated with **quantity** accounted for.
1244+
Note: Tax liabilities and duties should be calculated with the item's **quantity** accounted for.
12331245
title: Item
12341246
properties:
12351247
id:
12361248
type: string
12371249
description: A unique identifier for the line item these tax liabilities are calculated for. Must match the corresponding request line item ID.
12381250
price:
12391251
$ref: '#/components/schemas/response-taxprice'
1252+
duties_summary:
1253+
type: array
1254+
description: Breakdown of any duties that applied to this item.
1255+
items:
1256+
$ref: '#/components/schemas/Duties'
12401257
required:
12411258
- id
12421259
- price
@@ -1301,6 +1318,19 @@ 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.
1331+
required:
1332+
- name
1333+
- amount
13041334
item_type:
13051335
type: string
13061336
description: |-

0 commit comments

Comments
 (0)