Skip to content

Commit f519e90

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

File tree

1 file changed

+38
-2
lines changed

1 file changed

+38
-2
lines changed

reference/tax_provider.yml

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,9 @@ paths:
149149
class_id: '0'
150150
name: Default Tax Class
151151
tax_exempt: false
152+
customs_information:
153+
country_of_origin: 'AU'
154+
hs_code: '817355'
152155
type: item
153156
wrapping:
154157
id: d2675662-6326-4a23-9107-ab71fa6a21a1
@@ -254,6 +257,9 @@ paths:
254257
name: Brutal Tax
255258
code: US
256259
id: Brutal Tax
260+
duties:
261+
- name: Brutal Duty
262+
amount: 50
257263
type: item
258264
wrapping:
259265
id: d2675662-6326-4a23-9107-ab71fa6a21a1
@@ -942,6 +948,18 @@ components:
942948
description: Merchants may opt to include additional properties that a tax provider can choose to support, factoring these values into tax calculation.
943949
items:
944950
$ref: '#/components/schemas/request-item-tax-property'
951+
customs_information:
952+
type: object
953+
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.
954+
properties:
955+
country_of_origin:
956+
type: string
957+
description: The country of manufacture, production, or growth represented in ISO 3166-1 alpha-2 format, when available.
958+
example: 'AU'
959+
hs_code:
960+
type: string
961+
description: The item's harmonized tariff code for the document's destination country, when available.
962+
example: '817355'
945963
required:
946964
- id
947965
- price
@@ -1227,16 +1245,21 @@ components:
12271245
response-item:
12281246
type: object
12291247
description: |-
1230-
The tax liabilities calculated for a specific item.
1248+
The tax liabilities, and any duties, calculated for a specific item.
12311249
1232-
Note: Tax liabilities should be calculated with **quantity** accounted for.
1250+
Note: Tax liabilities and duties should be calculated with the item's **quantity** accounted for.
12331251
title: Item
12341252
properties:
12351253
id:
12361254
type: string
12371255
description: A unique identifier for the line item these tax liabilities are calculated for. Must match the corresponding request line item ID.
12381256
price:
12391257
$ref: '#/components/schemas/response-taxprice'
1258+
duties:
1259+
type: array
1260+
description: Any duties that applied to this item.
1261+
items:
1262+
$ref: '#/components/schemas/CustomDuty'
12401263
required:
12411264
- id
12421265
- price
@@ -1301,6 +1324,19 @@ components:
13011324
- rate
13021325
- amount
13031326
x-internal: false
1327+
CustomDuty:
1328+
type: object
1329+
properties:
1330+
name:
1331+
type: string
1332+
description: The human-readable name of this custom duty. May not be empty.
1333+
amount:
1334+
type: number
1335+
format: double
1336+
description: The absolute amount that the shopper will be charged for this custom duty.
1337+
required:
1338+
- name
1339+
- amount
13041340
item_type:
13051341
type: string
13061342
description: |-

0 commit comments

Comments
 (0)