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
+33-3Lines changed: 33 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -939,9 +939,21 @@ components:
939
939
default: false
940
940
tax_properties:
941
941
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.
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'
945
957
required:
946
958
- id
947
959
- price
@@ -1227,16 +1239,21 @@ components:
1227
1239
response-item:
1228
1240
type: object
1229
1241
description: |-
1230
-
The tax liabilities calculated for a specific item.
1242
+
The tax liabilities, and any duties, calculated for a specific item.
1231
1243
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.
1233
1245
title: Item
1234
1246
properties:
1235
1247
id:
1236
1248
type: string
1237
1249
description: A unique identifier for the line item these tax liabilities are calculated for. Must match the corresponding request line item ID.
1238
1250
price:
1239
1251
$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'
1240
1257
required:
1241
1258
- id
1242
1259
- price
@@ -1301,6 +1318,19 @@ components:
1301
1318
- rate
1302
1319
- amount
1303
1320
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.
0 commit comments