Data Standards

Common data structures and their format

Standards

Dates

All dates in the API are represented in ISO 8601 format.

JSON

// Dates need to be provided in ISO 8601 format 
{
   "dates": [
      {
         "start": "2023-09-23T13:50:00+01:00",
         "end": "2023-09-23T16:50:00+01:00"
      }
   ]
}

Countries

All countries in this API are represented using two-letter country codes as defined by the ISO 3166-1 alpha-2 standard. These codes provide a concise and internationally recognized way to identify countries. For example, DE represents Germany, FR represents France, and US represents the United States.

For a complete list of country codes and more information about the standard, please refer to the ISO 3166-1 alpha-2 Wikipedia article.

When using the API, ensure that you provide the correct two-letter code for the country in question to avoid any errors or misinterpretations in your requests or responses.

JSON

// Countries need to be provided in ISO 3166-1 alpha-2 standard 
{
  "country": "DE"
}

Dimensions

In this API, all dimensions (length, width, height) are expressed in centimeters (cm), and weights are expressed in kilograms (kg). These units are part of the metric system, which is widely used internationally for scientific and everyday measurements.

When specifying item dimensions and weights, use integer values without decimal places.

JSON

{
    "items": [
        {
            "quantity": 2,
            "length": 120,
            "width": 100,
            "height": 80,
            "weight": 320
        }
    ]
}

Phone Numbers

All phone numbers in the API must be provided in the E.164 format. This is an international standard for phone number formatting that includes the country code and removes any special characters or spaces. For example:

In this format:

The number always starts with a + sign
Followed by the country code (e.g., 49 for Germany)
Then the rest of the phone number without any spaces or special characters

This standardized format ensures consistent and unambiguous representation of phone numbers across different countries and regions.

JSON

// Dates need to be provided in E.164 format format 
{
  "phone": "+49123456789"
}