Calculate duties on a consignment

curl --request POST \
  --url https://{tenant}.mytraddal.com/admin/api/v1/consignments/{id}/calculate \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenant}.mytraddal.com/admin/api/v1/consignments/{id}/calculate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{tenant}.mytraddal.com/admin/api/v1/consignments/{id}/calculate"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "assessment_id": "asmt_01J9ZK...",
  "destination_country": "US",
  "total_duty": 12.42,
  "total_tax": 0,
  "currency": "USD",
  "items": [
    {
      "hs_code": "4202.92",
      "duty": 12.42,
      "rates_applied": ["general", "sec301"]
    }
  ]
}

POST

consignments

{id}

calculate

Calculate duties on a consignment

curl --request POST \
  --url https://{tenant}.mytraddal.com/admin/api/v1/consignments/{id}/calculate \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenant}.mytraddal.com/admin/api/v1/consignments/{id}/calculate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{tenant}.mytraddal.com/admin/api/v1/consignments/{id}/calculate"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "assessment_id": "asmt_01J9ZK...",
  "destination_country": "US",
  "total_duty": 12.42,
  "total_tax": 0,
  "currency": "USD",
  "items": [
    {
      "hs_code": "4202.92",
      "duty": 12.42,
      "rates_applied": ["general", "sec301"]
    }
  ]
}

Requires the consignments:write scope. Runs a landed-cost assessment over every item on the consignment using its declared (or classified) HS codes, origins, and values. The result is stored as an assessment and emits a duties.calculated webhook.

string

required

The consignment ID.

{
  "assessment_id": "asmt_01J9ZK...",
  "destination_country": "US",
  "total_duty": 12.42,
  "total_tax": 0,
  "currency": "USD",
  "items": [
    {
      "hs_code": "4202.92",
      "duty": 12.42,
      "rates_applied": ["general", "sec301"]
    }
  ]
}

Retrieve past assessments with GET /consignments/{id}/assessments and GET /consignments/{id}/assessments/{assessment_id}.

Delete a consignment

Classify a product

⌘I

Overview

Consignments

Classify

Calculate

Restrict

Screen

Request archive

Calculate duties on a consignment