Classify commodities

curl --request POST \
  --url https://api.teleship.com/api/trade-engine/classifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "originCountry": "GB",
  "products": [
    {
      "quantity": 1,
      "title": "Flix Earrings",
      "hsCode": "7117190090",
      "kgWeight": 0.18,
      "sku": "stock-1",
      "countryOfOrigin": "GR"
    }
  ]
}
'

{
  "classifications": [
    {
      "itemNumber": 123,
      "title": "<string>",
      "productId": "<string>",
      "classification": {
        "sixDigitHSCode": "<string>",
        "originHSCode": "<string>",
        "destinationHSCode": "<string>",
        "originCode": {
          "hsCode": "<string>",
          "region": {}
        },
        "destinationCode": {
          "hsCode": "<string>",
          "region": {}
        },
        "regionalCodes": [
          {
            "hsCode": "<string>",
            "region": {}
          }
        ]
      },
      "restrictions": [
        {
          "importRegion": "<string>",
          "flag": "<string>",
          "importRisk": "<string>",
          "id": "<string>",
          "hts": "<string>",
          "chapter": "<string>",
          "message": "<string>",
          "info": "<string>",
          "capture": "<string>",
          "metadata": {},
          "serviceCode": "TELESHIP-EXPEDITED-PICKUP",
          "shippingMethod": "RM-RETURN-T24",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ]
}

{
  "messages": [
    {
      "code": 123,
      "level": "error",
      "timestamp": "2024-01-01T00:00:00.00Z",
      "message": "An error occurred",
      "details": [
        "Missing required field"
      ]
    }
  ]
}

{
  "messages": [
    {
      "code": 123,
      "level": "error",
      "timestamp": "2024-01-01T00:00:00.00Z",
      "message": "An error occurred",
      "details": [
        "Missing required field"
      ]
    }
  ]
}

{
  "messages": [
    {
      "code": 123,
      "level": "error",
      "timestamp": "2024-01-01T00:00:00.00Z",
      "message": "An error occurred",
      "details": [
        "Missing required field"
      ]
    }
  ]
}

POST

api

trade-engine

classifications

curl --request POST \
  --url https://api.teleship.com/api/trade-engine/classifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "originCountry": "GB",
  "products": [
    {
      "quantity": 1,
      "title": "Flix Earrings",
      "hsCode": "7117190090",
      "kgWeight": 0.18,
      "sku": "stock-1",
      "countryOfOrigin": "GR"
    }
  ]
}
'

{
  "classifications": [
    {
      "itemNumber": 123,
      "title": "<string>",
      "productId": "<string>",
      "classification": {
        "sixDigitHSCode": "<string>",
        "originHSCode": "<string>",
        "destinationHSCode": "<string>",
        "originCode": {
          "hsCode": "<string>",
          "region": {}
        },
        "destinationCode": {
          "hsCode": "<string>",
          "region": {}
        },
        "regionalCodes": [
          {
            "hsCode": "<string>",
            "region": {}
          }
        ]
      },
      "restrictions": [
        {
          "importRegion": "<string>",
          "flag": "<string>",
          "importRisk": "<string>",
          "id": "<string>",
          "hts": "<string>",
          "chapter": "<string>",
          "message": "<string>",
          "info": "<string>",
          "capture": "<string>",
          "metadata": {},
          "serviceCode": "TELESHIP-EXPEDITED-PICKUP",
          "shippingMethod": "RM-RETURN-T24",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ]
}

{
  "messages": [
    {
      "code": 123,
      "level": "error",
      "timestamp": "2024-01-01T00:00:00.00Z",
      "message": "An error occurred",
      "details": [
        "Missing required field"
      ]
    }
  ]
}

{
  "messages": [
    {
      "code": 123,
      "level": "error",
      "timestamp": "2024-01-01T00:00:00.00Z",
      "message": "An error occurred",
      "details": [
        "Missing required field"
      ]
    }
  ]
}

{
  "messages": [
    {
      "code": 123,
      "level": "error",
      "timestamp": "2024-01-01T00:00:00.00Z",
      "message": "An error occurred",
      "details": [
        "Missing required field"
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

originCountry

enum<string>

required

Origin country of the commodities

Available options:

AF,

AL,

DZ,

AS,

AC,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

CI,

HR,

CU,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

EL,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

AN,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

SH,

KN,

LC,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SK,

SI,

SB,

SO,

ZA,

GS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW

products

object[]

required

Array of products to classify (max 20)

Maximum array length: 20

Show child attributes

destinationCountry

enum<string>

Destination country of the commodities

Available options:

All,

US,

GB,

EU,

AU,

CA,

AT,

BE,

BG,

HR,

CY,

CH,

CZ,

DK,

EE,

FI,

FR,

DE,

GR,

HU,

IE,

IT,

LV,

LT,

LU,

MT,

NL,

PL,

PT,

RO,

SK,

SI,

ES,

SE,

IS,

LI,

NO,

NZ,

SG,

HK,

AE,

SA

additionalRegions

enum<string>

Additional countries to classify the commodities

Available options:

All,

US,

GB,

EU,

AU,

CA,

AT,

BE,

BG,

HR,

CY,

CH,

CZ,

DK,

EE,

FI,

FR,

DE,

GR,

HU,

IE,

IT,

LV,

LT,

LU,

MT,

NL,

PL,

PT,

RO,

SK,

SI,

ES,

SE,

IS,

LI,

NO,

NZ,

SG,

HK,

AE,

SA

Response

classifications

object[]

required

List of classified products

Show child attributes

Delete webhook Get HTS restrictions for products

Overview

Authentication

Shipping services

Trade engine

Taxes collections

Authorizations

Body

Response