Orders (OMS)

Order Management System

Add an order

POST 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,
  "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}
  ],
  "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
}

Json Request Format

"order_id"

You need to fill the field with ... Examples : Type : string Required : yes

"invoice_id"

You need to fill the field with ... Examples : Type : string Required : yes

"url"

You need to fill the field with ... Examples : Type : string Required : yes

"order_date_hour"

You need to fill the field with ... Examples : Type : string Required : yes

"customer_firstname"

You need to fill the field with ... Examples : Type : string Required : yes

"customer_lastname"

You need to fill the field with ... Examples : Type : string Required : yes

"customer_address"

You need to fill the field with ... Examples : Type : string Required : yes

"customer_zipcode"

You need to fill the field with ... Examples : Type : string Required : yes

"customer_city"

You need to fill the field with ... Examples : Type : string Required : yes

"customer_country"

You need to fill the field with ... Examples : Type : string Required : yes

"buyer_firstname"

You need to fill the field with ... Examples : Type : string Required : yes

"buyer_lastname"

You need to fill the field with ... Examples : Type : string Required : yes

"buyer_address"

You need to fill the field with ... Examples : Type : string Required : yes

"buyer_zipcode"

You need to fill the field with ... Examples : Type : string Required : yes

"buyer_city"

You need to fill the field with ... Examples : Type : string Required : yes

"buyer_country"

You need to fill the field with ... Examples : Type : string Required : yes

"agent_firstname"

You need to fill the field with ... Examples : Type : string Required : yes

"agent_lastname"

You need to fill the field with ... Examples : Type : string Required : yes

"agent_adress"

You need to fill the field with ... Examples : Type : string Required : yes

"agent_zipcode"

You need to fill the field with ... Examples : Type : string Required : yes

"agent_city"

You need to fill the field with ... Examples : Type : string Required : yes

"agent_country"

You need to fill the field with ... Examples : Type : string Required : yes

"order_payment_type"

You need to fill the field with ... Examples : Type : string Required : yes

"order_payment_date"

You need to fill the field with ... Examples : Type : string Required : yes

"exporting_carrier"

You need to fill the field with ... Examples : Type : string Required : yes

"departure_country"

You need to fill the field with ... Examples : Type : string Required : yes

"arrival_country"

You need to fill the field with ... Examples : Type : string Required : yes

"products" / "sku"

You need to fill the field with ... Examples : Type : string Required : yes

"products" / "quantity"

You need to fill the field with ... Examples : Type : string Required : yes

"products" / "unit_price"

You need to fill the field with ... Examples : Type : string Required : yes

"products" / "unit_price_currency"

You need to fill the field with ... Examples : Type : string Required : yes

"shipping_carrier"

You need to fill the field with ... Examples : Type : string Required : yes

"category_of_item"

You need to fill the field with ... Examples : Type : string Required : yes

"payment_type"

You need to fill the field with ... Examples : Type : string Required : yes

"amount_products"

You need to fill the field with ... Examples : Type : string Required : yes

"amount_shipping"

You need to fill the field with ... Examples : Type : string Required : yes

"amount_duty"

You need to fill the field with ... Examples : Type : string Required : yes

"amount_vat"

You need to fill the field with ... Examples : Type : string Required : yes

"amount_specialtaxes"

You need to fill the field with ... Examples : Type : string Required : yes

"incoterm"

You need to fill the field with ... Examples : Type : string Required : yes

"currency"

You need to fill the field with ... Examples : Type : string Required : yes

"order_statut"

You need to fill the field with ... Examples : Type : string Required : yes

JSON Examples - Request & Response

It exist many possibilities. Please book a call with our support team.

Video explainer

in progress...

Update an order

PUT 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"

200

Get order informations

GET https://api.transiteo.io/v1/customer/orders/{Base64}

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"

200

Get orders list

GET 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"

200

Delete an order

DELETE https://api.transiteo.io/v1/customer/orders/{Base64}

This endpoint allows you to delete a specific order

Headers

Name	Type	Description
Content-type	string	application/json
Authorization	string	"your id_token"

200