Data Types
Learn how to use and are used data types
The Unify API aims to have consistency across all endpoints.
This page defines common data type formats. Two kinds of data are explained below : Built-in data type & Custom data type
Built-in data type
Date and Date-time
The ISO 8601 format is used for date and time:
- Date format - yyyy-MM-d e.g. 2023-09-12
- Date-time format - yyyy-MM-ddTHH:mm:ssZ e.g. 2023-09-12T12:30:00Z+01:00
InfoNote: that Z may be used to represent UTC time +00:00
Currency
The alphabetic ISO 4217 format is used for currency code:
-
Currency code format - USD for US dollar
All currency values are expressed in the smallest units of the currency (e.g. cents for EUR and USD, but yen for JPY). -
Currency amount format - 130.99 would be stored as 13099
Country
The ISO-3166 specification is used for country code.
InfoFor France, use "FR"
Phone Number
The UIT-T E.164 specification is used for phone number.
Here are the main characteristics of this standard:
Number structure:
- The number begins with the + symbol (indicating an international number).
- It is followed by the country code (for example, 1 for the United States, 33 for France).
- Then comes the area code (if applicable) and the local number.
Maximum length:
A telephone number in E.164 format must not exceed 15 digits (excluding the + symbol).
Example of a number:
InfoFor a French number: +33123456789 (where 33 is the country code, 1 the area code).
Custom data type
Carrier
Supported carriers
| Code | Name | Type |
|---|---|---|
| BPOST | BPost | Home |
| BPOST_RELAY | BPost Relay | Relay |
| CHP | Chronopost | Home |
| CHP_EX | Chronopost Express | Home |
| CHP_RELAY | Chronopost Relay | Relay |
| CHP_18 | Chronopost 18 | Home |
| CHP_FRESH | Chronopost Fresh | Home |
| CHP_2SHOP | Chronopost 2shop | Relay |
| COL | Colissimo | Home |
| COL_RELAY | Colissimo Relay | Relay |
| COL_SIGN | Colissimo with signature | Home |
| CPR | Colis Privé | Home |
| DHL | DHL | Home |
| DHL_EX | DHL Express | Home |
| DPD_PICKUP | DPD PickUp | Relay |
| DPD_PRDICT | DPD Predict | Home |
| EVEREST | Everest | Home |
| FEDEX_2DAY | FEDEX 2nd Day | Home |
| FEDEX_GROUND | Fedex Ground | Home |
| FEDEX_INTER | Fedex International | Home |
| GEODIS | GEODIS | Home |
| GLS | GLS | Home |
| GLS_RELAY | GLS Relais | Relay |
| HG | Hors Gabarit | Home |
| HG_FLOOR | Hors Gabarit Floor | Home |
| KIALA | Kiala | Relay |
| MR | Mondial Relay | Relay |
| NO_CARRIER | No Carrier | N/A |
| RC | Relais Colis | Relay |
| STORE_PICKUP | Store Pickup | Store |
| TNT | TNT | Home |
| UPS | UPS | Home |
| UPS_RELAY | UPS Access Point | Relay |
| UPS_EX | UPS Express Saver | Home |
| SCHENKER | Schenker | Home |
Payment Method
Supported payment methods
| Code | Name |
|---|---|
| KLARNA | Klarna |
| COFINOGA | Cofinoga |
| ACOMPTE | Deposit |
| ALMA | Alma |
| VIREMENT | Bank Transfer |
| CHEQUE | Cheque |
| GIFT_CARD | Gift Card |
| ONEY | Oney |
| APPLE_PAY | Apple Pay |
| CETELEM | Cetelem |
| AMEX | American Express |
| IDEAL | iDEAL |
| MYBANK | MyBank |
| BANCONTACT | Bancontact |
| NULL | None |
| MULTIBANCO | Multibanco |
| CREDIT_CARD | Credit Card (Visa, Mastercard, Maestro) |
| MOONEY | Mooney |
| PAYPAL | PayPal |
| MBWAY | MB Way |
| COFIDIS_3X | Cofidis 3x |
| GOOGLE_PAY | Google Pay |
| BRIDGE | Bridge |
| GIROPAY | Giropay |
| SOFORT | Sofort |
| SOFTPOS | SoftPOS |
| CASH | Cash |
Predefined tags
Some keys are fixed and expected by the system, and their values must follow specific formats:
| Key | Object | Description | Format / Example |
|---|---|---|---|
virtual | Item | Indicates whether the item is virtual or physical. | "true" or "false" |
hs_code | Item | Harmonized System code used for customs declaration. | "852349" |
origin_country | Item | The country where the item was produced. Must be an ISO-3166 country code. | "FR" |
packaging | Item | Indicates whether the item is a package or not. | "1" |
mp | Order | The name of the marketplace. | "Amazon" |
Order status
The following statuses represent the different stages of an order lifecycle.
Since an order may generate multiple preparation requests, statuses can apply either at the global order level or reflect the state of its related preparation requests.
| Status | Description |
|---|---|
| pending | The order has been created but not yet orchestrated (no preparation requests assigned). |
| waiting | The order is waiting to be accepted by a store or warehouse. |
| initiated | The order has been initiated but not yet fully placed. |
| processing | At least one preparation request has been accepted (the store or warehouse started preparing items). |
| partial_processing | Some preparation requests have been accepted, but others are still pending or waiting. |
| processed | All preparation requests have been fully processed. |
| incompletely_processed | The order was processed but some items are missing across one or more preparation requests. |
| partially_processed | Only some preparation requests have been processed, while others are still pending or waiting. |
| shipped | All preparation requests have been shipped in full. |
| incompletely_shipped | The order was shipped but some items from one or more preparation requests are missing. |
| partially_shipped | Only some preparation requests have been shipped, while others are still processing or waiting. |
| available_in_store | The order is ready and available in-store for pickup. |
| delivered_to_customer | The order has been fully delivered to the customer. |
| incompletely_delivered | The customer received only part of the order (some preparation requests missing). |
| partially_delivered | Some preparation requests were delivered, while others are still in progress or failed. |
| pickup_refused | The customer refused the pickup of the order. |
| canceled | The order and all its preparation requests have been fully canceled. |
| partially_canceled | Some preparation requests or items have been canceled, but the rest remain valid. |
| expired | The order has expired and will no longer be processed. |
| service_sent | Used for digital or service-type orders (e.g., gift cards) that have been sent electronically. |
Preparation request status
Each preparation request follows its own lifecycle, from orchestration to processing, shipping, or pickup.
These statuses describe the state of a single preparation request, independently of the global order.
| Status | Description |
|---|---|
| pending | The preparation request has been created but not yet assigned or accepted. |
| waiting | The preparation request is waiting for a store or warehouse to accept it. |
| processing | The preparation request has been accepted and items are being prepared. |
| processed | The preparation request has been fully processed. |
| incompletely_processed | The preparation request was processed but some items are missing. |
| refused | The preparation request was refused by the store or warehouse. |
| shipped | The preparation request has been shipped in full. |
| incompletely_shipped | The preparation request was shipped, but some items are missing. |
| available_in_store | The preparation request is ready and available for in-store pickup. |
| delivered_to_customer | The preparation request has been delivered to the customer in full. |
| incompletely_delivered | The preparation request was delivered, but some items were missing. |
| pickup_refused | The customer refused to pick up the preparation request. |
| canceled | The preparation request was canceled and will not be processed. |
| closed | The preparation request has been closed and finalized. |
| service_sent | Used for service or digital items (e.g., gift cards) that were sent electronically. |
Updated about 2 months ago