Duty Calculation¶

Api SMC_TAXO V2 allow to estimate duty fees.

Base URL = https://taxo.imxpostal.fr/api

Description of api¶

Méthode : POST

Headers : * x-api-key : Secret code given by IMX

Url : https://taxo.imxpostal.fr/api/v1.1/duty_calculation

JSON Request Body Format¶


{
    "products": [
        {
            "identification": {
                "value": string
            },
            "weight": number,
            "weight_unit": string,
            "quantity": number,
            "unit_price": number,
            "currency_unit_price": string,
            "unit_ship_price": number,
            "unit_packaging_price": number,
            "unit_insurance_price": number,
            "origin_country": string,
            "transport": {
            "type": string,
            "id": number
            },
        }
    ],
    "lang": string,
    "from_country": string,
    "to_country": string,
    "from_district": string,
    "to_district": string,
    "shipment_type": string,
    "global_ship_price": number,
    "currency_global_ship_price": string,
    "global_packaging_price": number,
    "currency_global_packaging_price": string,
    "global_insurance_price": number,
    "currency_global_insurance_price": string,
    "included_tax": boolean,
    "incoterm": string,
    "extra_fees": number,
    "sender": {
    "pro": boolean,
    "revenue_country_annual": number,
    "currency_revenue_country_annual": string
  },
  "transport": {
    "type": string,
    "id": number
  },
  "transit_fees" : {
    "percentage": null,
    "amount" : 10, 
    "currency" : "EUR",  
    "on_products_price": false, 
    "on_shipping_products_price": false, 
    "on_global": true
  },
  "receiver": {
    "pro": boolean,
    "activity_id": string
  }
}

Request fields¶

"products" / "identification" / "value"¶

You need to fill this field with a HTS Code version 2017. Between 8 to 13 digits numbers.

Examples : 9503006100

Type : string

Required : yes

"products" / "weight"¶

You need to fill the "weight" field of the product with a number.

Examples : 12 or 3.5

Type : number

Required : yes if "unit_ship_price" and "currency_unit_ship_price"are not mentionned. Or if you request Switzerland in "from_country".

"products" / "weight_unit"¶

You can fill the "weight_unit" field with one of this two labels :

"kg" : if you use the international metric system
"lbs" : if you use the imperial system

Type : string

Required : yes if "unit_ship_price" and "currency_unit_ship_price"are not mentionned. Or if you request Switzerland in "from_country".

"products" / "quantity"¶

You need to fill the "quantity" field with a entire number representing your product units.

Examples : 1 or 9

Type : number

Required : yes

"products" / "unit_price"¶

You need to fill the "unit_price" field with a number representing the price of one item.

Examples : 39 or 99.90

Type : number

Required : yes.

"products" / "currency_unit_price"¶

You need to fill the "currency_unit_price" field of the product with a currency iso Alpha 3. Download the list of currencies with them name and code.

Examples : "EUR" or "CAD"

Type : string

Required : yes

"products" / "unit_ship_price"¶

You need to fill the "unit_ship_price" field of the product with a number.

Examples : 19 or 34.37

Type : number

Required : yes

"products" / "unit_packaging_price"¶

You need to fill the "unit_packaging_price" field of the product with a number.

Examples : 19 or 34.37

Type : number

Required : yes

"products" / "unit_insurance_price"¶

You need to fill the "unit_insurance_price" field of the product with a number.

Examples : 19 or 34.37

Type : number

Required : yes

"products" / "origin_country"¶

You need to fill the "origin_country" field with the Iso Alpha 2 or 3 code from where the product had build.

Examples : "FRA" or "VEN"

Type : string

Required : yes

"products" / "transport" / "type"¶

You need to fill the "transport" field of the shipping product(s) price.

Type : string

Required : optional (required if you want to know the duty fees by product)

"products" / "transport" / "id"¶

You need to fill the "transport" field of the shipping product(s) price with an id number. Download the list of carriers and freight forwarders.

Type : string

Required : optional (required if you want to know the duty fees by product)

"products" / "unit"¶

You need to fill the "unit" field with a entire number representing an other feature of product.

Examples : 1 or 9

Type : number

Required : optional

"products" / "unit_type"¶

You need to fill the "unit_price" field with a number representing the price of one item.

Examples : 39 or 99.90

Type : number

Required : optional and yes es if "unit" is mentioned.

"lang"¶

You need to fill this field with a web language code of your product name or description.

3 languages are available :

fr = french
en = english
es = spanish

Examples : "fr"

Type : string

Required : yes

"from_country"¶

You need to fill the "from_country" field with the country english label or Iso Alpha 2 or 3 from where the product is sent.

Examples : "Bulgaria" or "ZHN"

Type : string

Required : yes

"from_district"¶

You need to fill the "from_district" field with the Iso codes of the district from where the product is sent. Download the list of district.

Examples : "AL-11" or "FR-GES"

Type : string

Required : yes

"to_country"¶

You need to fill the "to_country" field with the country english label or Iso Alpha 2 or 3 from where the product arrives.

Examples : "Brazil" or "GLP"

Type : string

Required : yes

"to_district"¶

You need to fill the "to_district" field with the Iso codes of the district from where the product arrives. Download the list of district.

Examples : "AL-11" or "FR-GES"

Type : string

Required : yes

"shipment_type"¶

GLOBAL : global shipping

ARTICLE : One ship price per article

Type : enum

Required: yes