You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: reference/tax_provider.yml
+38-2Lines changed: 38 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -149,6 +149,9 @@ paths:
149
149
class_id: '0'
150
150
name: Default Tax Class
151
151
tax_exempt: false
152
+
customs_information:
153
+
country_of_origin: 'AU'
154
+
hs_code: '817355'
152
155
type: item
153
156
wrapping:
154
157
id: d2675662-6326-4a23-9107-ab71fa6a21a1
@@ -254,6 +257,9 @@ paths:
254
257
name: Brutal Tax
255
258
code: US
256
259
id: Brutal Tax
260
+
duties:
261
+
- name: Brutal Duty
262
+
amount: 50
257
263
type: item
258
264
wrapping:
259
265
id: d2675662-6326-4a23-9107-ab71fa6a21a1
@@ -942,6 +948,18 @@ components:
942
948
description: Merchants may opt to include additional properties that a tax provider can choose to support, factoring these values into tax calculation.
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'
945
963
required:
946
964
- id
947
965
- price
@@ -1227,16 +1245,21 @@ components:
1227
1245
response-item:
1228
1246
type: object
1229
1247
description: |-
1230
-
The tax liabilities calculated for a specific item.
1248
+
The tax liabilities, and any duties, calculated for a specific item.
1231
1249
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.
1233
1251
title: Item
1234
1252
properties:
1235
1253
id:
1236
1254
type: string
1237
1255
description: A unique identifier for the line item these tax liabilities are calculated for. Must match the corresponding request line item ID.
1238
1256
price:
1239
1257
$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'
1240
1263
required:
1241
1264
- id
1242
1265
- price
@@ -1301,6 +1324,19 @@ components:
1301
1324
- rate
1302
1325
- amount
1303
1326
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.
0 commit comments