> For the complete documentation index, see [llms.txt](https://transiteo.gitbook.io/transiteo/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://transiteo.gitbook.io/transiteo/duties-and-taxes-services/trade-tariff-rates-data/specials-taxes-om-omr-....md).

# Specials Taxes (OM, OMR, ...)

Using Product's HSCode

## Infos to get the Special Taxes

<mark style="color:green;">`POST`</mark> `https://api.transiteo.io/v1/data/specialTaxes`

#### Headers

| Name          | Type   | Description      |
| ------------- | ------ | ---------------- |
| Authorization | string | "your id\_token" |
| Content-Type  | string | application/json |

{% tabs %}
{% tab title="200 " %}

```
{
    "hscode_description": "Hats and other headgear, knitted or crocheted, or made up from lace, felt or other textile fabric, in the piece (but not in strips), whether or not lined or trimmed; hairnets of any material, whether or not lined or trimmed",
    "import_statut": "Authorized for importation into this country",
    "threshold_tax": "22",
    "threshold_tax_currency": "EUR",
    "annual_revenue_union_locals_taxes_minimis": 0,
    "other_taxes": []
}
```

{% endtab %}

{% tab title="400 " %}

```
1. Incorrect Json (json body request incorrect
a)
    @ValidateIf(o => o.sku === undefined && o.product_text === undefined)
    @IsNotEmpty()
    hs_code: string;
    @ValidateIf(o => o.hs_code === undefined && o.product_text === undefined)
    @IsNotEmpty()
    sku: string;
    @ValidateIf(o => o.sku === undefined && o.hs_code === undefined)
    @IsNotEmpty()
    product_text: string;

    @IsNotEmpty()
    @Length(3, 3, {message: "from_country should be ISO3"})
    from_country: string;

    @IsNotEmpty()
    @Length(3, 3, {message: "to_country should be ISO3"})
    to_country: string;
    to_district: string;

b) Error Response Example: 
{
    "code": "INCORRECT_JSON",
    "name": "ClientError",
    "message": "Incorrect Json Request",
    "details": [
        {
            "parameter": {
                "name": "hs_code / product_text / sku"
            },
            "causes": [
                "hs_code or product_text or sku must be filled"
            ]
        }
    ]
}



```

{% endtab %}

{% tab title="403 " %}

```
wrong token id or token has expired
```

{% endtab %}

{% tab title="404 " %}

```
1. Country not match

{
    "code": "COUNTRY_NOT_MATCH",
    "httpCode": 404,
    "name": "BusinessError",
    "message": "Sorry, we did not match any country. Please make sure it's spelled correctly",
    "details": []
}

2. HScode not found. Happened when eu hscode is given but no correspondance was found in DUTY_DYNAMO

{
    "code": "HSCODE_NOT_FOUND",
    "httpCode": 404,
    "name": "BusinessError",
    "message": "No duty data found",
    "details": []
}

3. Machine Learning did not recognize text (maybee text with special 
characters or text is a barcode){
    "code": "TEXT_NOT_FOUND",
    "httpCode": 404,
    "name": "ClientError",
    "message": "Did not find your text in our database",
    "details": []
}
```

{% endtab %}

{% tab title="500 Unexpected error (Mostly cause with wrong data type in database. exemple : string instead of number)" %}

```
{
    "code": "UNEXPECTED_ERROR",
    "httpCode": 500,
    "reason": "Please try again or contact our service",
}
```

{% endtab %}
{% endtabs %}

### Json Request Format

```
{
    “sku”: string,
    “hs_code”: string,
    “from_country”: string,
    “to_country”: string
}
```

### Request fields & values

#### "sku"

You need to fill this field with the product's SKU of your catalog\
***Examples :**&#x20;*&#x20;HUYYUU37Y\
***Type :** string*\
***Required :** yes if you don't fill hs\_code & product\_text fields*

#### "hs\_code"

You need to fill this field with the product's HSCode (8 to 13 digits) of the arrival country.\
***Examples :**&#x20;*&#x20;4202310000\
***Type :** string*\
***Required :**  yes if you don't fill sku & product\_text fields*

#### "from\_country"

You need to fill the "from\_country" field with the Iso Alpha 2 or 3 from where the product leaves.\
Download the [list of countries](https://f.hubspotusercontent20.net/hubfs/3856821/Dico%20-%20countries.csv).\
***Examples : "**&#x46;RA*"\
***Type :** string*\
***Required :** yes*

#### "to\_country"

You need to fill the "to\_country" field with the Iso Alpha 2 or 3 from where the product arrives.\
Download the [list of countries](https://f.hubspotusercontent20.net/hubfs/3856821/Dico%20-%20countries.csv).\
***Examples : "**&#x56;EN"* \
***Type :** string*\
***Required :** yes*

### Json Response Format

```
{
    "hscode_description": string,
    "import_statut": string,
    "threshold_tax": number,
    "threshold_tax_currency": string,
    "other_taxes": [
        {
            "label": string,
            "percentage": number
        },
    ]
}
```

### Result fields & value

#### "hscode\_description"

It's the entire HSCode (customs code) description/designation\
***Examples :**&#x20;*&#x20;chapter\_designation : Articles of leather; saddlery and harness; travel goods, handbags and similar containers; articles of animal gut (other than silk- worm gut) -- heading\_designation : Trunks, suit-cases, vanity-cases, executive-cases, brief-cases, school satchels, spectacle cases, binocular cases, camera cases, musical instrument cases, gun cases, holsters and similar containers; travelling-bags, insulated food or beverages bags, toilet bags, rucksacks, handbags, shopping-bags, wallets, purses, map-cases, cigarette-cases, tobacco-pouches, tool bags, sports bags, bottle-cases, jewellery boxes, powder-boxes, cutlery cases and similar containers, of leather or of composition leather, of sheeting of plastics, of textile materials, of vulcanised fibre or of paperboard, or wholly or mainly covered with such materials or with paper. -- subheading\_designation : Wallets, purses, key-pouches, cigarette-cases, tobacco-pouches and similar articles carried in the pocket or handbag, with outer surface of leather, composition leather or patent leather -- national\_designation : Baúles maletas (valijas) maletines incluidos los de aseo y los portadocumentos portafolios (carteras de mano) cartapacios fundas y estuches para gafas (anteojos) binoculares cámaras fotográficas o cinematográficas instrumentos musicales o armas y continentes similares; sacos de viaje sacos (bolsas) aislantes para alimentos y bebidas bolsas de aseo mochilas bolsos de mano (carteras) bolsas para la compra billeteras portamonedas portamapas petacas pitilleras y bolsas para tabaco bolsas para herramientas y para artículos de deporte estuches para frascos y botellas estuches para joyas polveras estuches para orfebrería y continentes similares de cuero natural o regenerado hojas de plástico materia textil fibra vulcanizada o cartón o recubiertos totalmente o en su mayor parte con esas materias o papel: artículos de bolsillo o de bolsos de mano (cartera): con la superficie exterior de cuero natural o cuero regenerado\
***Type :** string*<br>

#### "import\_statut"

*There are 3 differents values :* Authorized for importation into this country */* Restricted for importation into this country */* Prohibited for importation into this country. It's the product statut for importation in the to\_country.\
***Examples :**&#x20;*&#x20;Authorized for importation into this country\
***Type :** string*<br>

#### "threshold\_tax"

*Each country have an order threshold. This one is for the locals taxes taxes. If your order is less than the threshold you don't need to pay locals tax. If your order is more than the threshold you have to pay locals tax.*\
***Examples :**&#x20;*&#x20;0\
***Type :** string*

#### "threshold\_tax\_currency"

*It's the currency iso 3 code of threshold tax.* Download the [list of currencies](https://f.hubspotusercontent20.net/hubfs/3856821/Dico%20-%20currency.csv) with them name and code.\
***Examples :**&#x20;*&#x20;EUR\
***Type :** string*

#### "locals\_taxes" / "label"

*It's the local tax name.*\
***Examples :**  OM*\
***Type :** string*

#### "locals\_taxes" / "percentage"

*It's the special tax percentage to apply.*\
***Examples :**  7*\
***Type :** string*

### JSON Examples - Request & Response

It exist many possibilities. Please [book a call ](https://meetings.hubspot.com/gauthier11/gauthier)with our support team.<br>

### Video explainer

in progress...
