# Products (PIM)

## Add a product in its transiteo catalog

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

This endpoint allows you to add a product in your catalog. And thanks to product SKU you could calculate duties and taxes from & to every countries in the world.

#### Headers

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

### Json Request Format

```
{
    "type": string,
    "sku": string,
    "value": string,
    "weight": number,
    "weight_unit": string,
    "unit_price": number,
    "currency_unit_price": string,
    "ecoTax_code_pro": string,
    "ecoTax_subCode_pro": string,
    "ecoTax_code_personal": string,
    "ecoTax_price_pro": number,
    "ecoTax_price_personal": number,
    "ecoTax_price_default_pro": number,
    "ecoTax_price_default_personal": number,
    "ecoTax_default": string,
    "co2_product_kg": number,
    "un_code": [string],
    "origin_country": string,
    "to_district": string,
    "to_country": string,
    "hscodefinder_hs_code": string,
    "quantity": number,
    "sale_unit_price": number,
    "sale_currency_unit_price": string,
    "purchase_unit_price": number,
    "purchase_currency_unit_price": string
}
```

### Request fields & values

#### "type"

You need to fill with "SKU"\
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "sku"

You need to fill this field with the sku (Stock Keeping Unit) of your product.\
\&#xNAN;***Examples : "**&#x39;754628", "dress" **or** "ARZ2-987H"* \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "*value*"

You need to fill this field with the title of your product.\
\&#xNAN;***Examples : "**&#x50;laystation 5", "*&#x54;hon blanc germon au naturel 200&#x67;*" **or** "Louis Vitton bagpack"* \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "weight"

You need to fill the "weight" field of the product with a number.\
\&#xNAN;***Examples :** 12 **or** 3.5*\
\&#xNAN;***Type :** number*\
\&#xNAN;***Required :** yes.*

#### "products" / "weight\_unit"

You can fill the "weight\_unit" field with one of this two labels : \
\&#xNAN;**- "kg"** :  if you use the international metric system\
\&#xNAN;**- "lbs"** : if you use the imperial system\
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes.*

#### "unit\_price"

You need to fill the "unit\_price" field with a number representing the price of one item.\
\&#xNAN;***Examples :** 39 **or** 99.90*\
\&#xNAN;***Type :** number*\
\&#xNAN;***Required :** yes.*

#### "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](https://f.hubspotusercontent20.net/hubfs/3856821/Dico%20-%20currency.csv) with them name and code.\
\&#xNAN;***Examples : "**&#x45;UR" **or "**&#x43;AD"*\
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "origin\_country"

You need to fill this field with the iso Alpha 2 or 3 of the product origin country. Download the [list of countries](https://f.hubspotusercontent20.net/hubfs/3856821/Dico%20-%20countries.csv).\
\&#xNAN;***Examples :*** CHN\
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** No*

#### "to\_district"

You need to fill thsi field with the iso code of the district of the product's arrival district. Download the [list of districts](https://f.hubspotusercontent20.net/hubfs/3856821/Dico%20-%20districts.csv).\
\&#xNAN;***Examples :*** FR-IDF\
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** No*

#### "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).\
\&#xNAN;***Examples : "**&#x42;razil" **or "**&#x47;LP"* \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes if hscodefinder\_hs\_code is filled.*

#### "hscodefinder\_hs\_code"

You need to fill this field with a HS Code. Between 8 to 13 digits numbers.\
\&#xNAN;***Examples :**  9503006100*\
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** No*

#### "quantity"

You need to fill this field with the quantity of this product in your stock.\
\&#xNAN;***Examples :*** 10 or 28\
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** No*

#### "sale\_unit\_price"

You need to fill this field with your sale price\
\&#xNAN;***Examples :*** 23.76 or 11\
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** No*

#### "sale\_currency\_unit\_price"

You need to fill this field with the currency of your sale price.\
\&#xNAN;***Examples :*** USD\
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** No*

#### "purchase\_unit\_price"

You need to fill this field with your purchase price.\
\&#xNAN;***Examples :*** 23.76 or 11\
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** No*

#### "purchase\_currency\_unit\_price"

You need to fill this field with the currency of your purchase price.\
\&#xNAN;***Examples :*** USD\
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** No*

### JSON Examples - Request & Response

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

### Video explainer

in progress...

## Update a product in its catalog

<mark style="color:orange;">`PUT`</mark> `https://api.transiteo.io/v1/customer/products/{sku}`

This endpoint allows you tu update a product in its catalog

#### Headers

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

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

```
```

{% endtab %}
{% endtabs %}

## Get product informations

<mark style="color:blue;">`GET`</mark> `https://api.transiteo.io/v1/customer/products/{sku}`

This endpoint allows you to get informations of specific product

#### Headers

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

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

```
```

{% endtab %}
{% endtabs %}

## Get all products in its catalog

<mark style="color:blue;">`GET`</mark> `https://api.transiteo.io/v1/customer/products`

This endpoint allows you to get a list of all product in its catalog

#### Headers

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

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

```
```

{% endtab %}
{% endtabs %}

## Delete a product in its catalog

<mark style="color:red;">`DELETE`</mark> `https://api.transiteo.io/v1/customer/products/{sku}`

This endpoint allows to delete a specific product inn its catalog

#### Headers

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

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

```
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://transiteo.gitbook.io/transiteo/management-system/products-pim.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.