# Orders (OMS)

## Add an order

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

This endpoint allows you to create an order

#### Headers

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

### Request body

```
{
  "order_id": string,
  "invoice_id": string,
  "url": url,
  "order_date_hour": number,
  "customer_firstname": string,
  "customer_lastname": string,
  "customer_address": string,
  "customer_zipcode": string,
  "customer_city": string,
  "customer_country": string,
  "customer_email": string,
  "buyer_firstname": string,
  "buyer_lastname": string,
  "buyer_address": string",
  "buyer_zipcode": string,
  "buyer_city": string,
  "buyer_country": string,
  "agent_firstname": string,
  "agent_lastname": string,
  "agent_address": string,
  "agent_zipcode": string,
  "agent_city": string,
  "agent_country": string,
  "order_payment_type": string,
  "order_payment_date": number,
  "exporting_carrier": string,
  "departure_country": string,
  "arrival_country": string,
  "products": [
    {"sku": string, "quantity": number, "unit_price": number, "unit_price_currency": string, seller_id : string}
  ],
  "shipping_carrier": string,
  "category_of_item": string,
  "payment_type": string,
  "amount_products": number,
  "amount_shipping": number,
  "amount_duty": number,
  "amount_vat": number,
  "amount_specialtaxes": number,
  "incoterm": string,
  "currency": string,
  "order_statut": string,
  "duty_calculation_timestamp": number
}

```

### Json Request Format

#### "order\_id"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "invoice\_id"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "url"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "order\_date\_hour"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "customer\_firstname"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "customer\_lastname"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "customer\_address"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "customer\_zipcode"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "customer\_city"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "customer\_country"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "buyer\_firstname"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "buyer\_lastname"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "buyer\_address"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "buyer\_zipcode"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "buyer\_city"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "buyer\_country"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "agent\_firstname"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "agent\_lastname"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "agent\_adress"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "agent\_zipcode"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "agent\_city"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "agent\_country"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "order\_payment\_type"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "order\_payment\_date"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "exporting\_carrier"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "departure\_country"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "arrival\_country"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "products" */* "sku"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "products" */* "quantity"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "products" */* "unit\_price"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "products" */* "unit\_price\_currency"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "shipping\_carrier"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "category\_of\_item"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "payment\_type"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "amount\_products"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "amount\_shipping"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "amount\_duty"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "amount\_vat"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "amount\_specialtaxes"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "incoterm"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "currency"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

#### "order\_statut"

You need to fill the field with ...\
\&#xNAN;***Examples :*** \
\&#xNAN;***Type :** string*\
\&#xNAN;***Required :** yes*

### 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...

## Update an order

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

This endpoint allows you to update an order

#### Headers

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

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

```
```

{% endtab %}
{% endtabs %}

## Get order informations

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

This endpoint allows you to get informations of a specific order

#### Headers

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

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

```
{
    "mail": "com-ave@yopmail.com",
    "order_id": "001",
    "invoice_id": "001-I",
    "url": "https://www.comave.com",
    "order_date_hour": 1753175951270,
    "customer_firstname": "Gauthier",
    "customer_lastname": "Legrix",
    "customer_address": "4 Rue des Moulins",
    "customer_zipcode": "67000",
    "customer_city": "Strasbourg",
    "customer_country": "FRA",
    "customer_email": "gauthier@transiteo.com",
    "buyer_firstname": "Gauthier",
    "buyer_lastname": "Legrix",
    "buyer_address": "4 Rue des Moulins",
    "buyer_zipcode": "67000",
    "buyer_city": "Strasbourg",
    "buyer_country": "FRA",
    "agent_firstname": "Comave",
    "agent_lastname": "France",
    "agent_address": "12 rue principal",
    "agent_zipcode": "L-56789",
    "agent_city": "Luxembourg",
    "agent_country": "LUX",
    "order_payment_type": "Stripe",
    "order_payment_date": 1753175951270,
    "exporting_carrier": "DHL",
    "departure_country": "FRA",
    "arrival_country": "FRA",
    "products": [
        {
            "amount_duty": 0,
            "quantity": 1,
            "amount_specialtaxes": 0,
            "amount_vat": 0,
            "unit_price_currency": "EUR",
            "sku": "SKU01",
            "unit_price": 100,
            "seller_id": 001
        }
    ],
    "shipping_carrier": "DHL",
    "category_of_item": "Commercial Goods",
    "payment_type": "Card",
    "amount_products": 100,
    "amount_shipping": 10,
    "amount_shipping_duty": 0,
    "amount_shipping_vat": 0,
    "amount_shipping_specialtaxes": 0,
    "amount_duty": 0,
    "amount_vat": 0,
    "amount_specialtaxes": 0,
    "amount_discount": 0,
    "global_products_discount": null,
    "global_shipping_discount": null,
    "currency": "EUR",
    "order_statut": "Expédié",
    "order_update_statut": 1753176084489,
    "incoterm": "CIF",
    "incoterm_delivery": "DDP",
    "customer_documents": null,
    "landed_cost_timestamp": 1753176347840,
    "canceled": null,
    "export_invoice_url": [
        "https://services.transiteo.io/templates/exportInvoice/sub_HFIAFDGHBDFHBKRoxU2sbh6B8M2Fmc.pdf"
    ],
    "sellers_export_invoice_url": {
      "00001" : https://services.transiteo.io/templates/exportInvoice/sub_HFIAFDGHBDFHBKRoxU2sbh6B8M2Fmc.pdf
      "00002" : https://services.transiteo.io/templates/exportInvoice/sub_HFIAFDGHBDFHBKRoxU2sbh6B8M2Fmc.pdf
    }
}    
```

{% endtab %}
{% endtabs %}

## Get orders list

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

This endpoint allows you to get informations of all orders created.

#### Headers

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

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

```
```

{% endtab %}
{% endtabs %}

## Delete an order

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

This endpoint allows you to delete a specific order

#### 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/order.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.