Skip to main content
Version: 2.0.5

easy to travel product API

This is a easy to travel Server based on the OpenAPI 3 specification.

API presents data endpoints for providing clients with all necessary data to build the UI and create order.

To create an order, a customer needs to use the endpoints from the products section, and then use the createOrder endpoint to create the order.

For cancelling and refunding order items from a specific order client needs to use refundOrderItem endpoint.

Localization (X-Locale)​

Operations that return localizable content expose plain English fields (title, description, howToUse, address) alongside *Localized maps (see the I18N schema). The optional X-Locale request header selects which locale the *Localized maps carry:

  • Accepted values: any well-formed BCP 47 language tag (de, de-LU, pt-BR, zh-Hans-MY). Matching is case-insensitive and _ is normalized to - (pt_br -> pt-BR).
  • Resolution: specific to general, ending at en: zh-Hans-MY -> zh-Hans -> zh -> en, de-LU -> de -> en.
  • Response: *Localized maps contain the en key plus the key of the locale actually served -- not the one requested -- in canonical BCP 47 form. Asking for de-LU and being served de yields {"en": "...", "de": "..."}.
  • Header absent, empty or unrecognized: *Localized maps contain only {"en": "..."}.
  • Plain fields: title, description, howToUse and address are always English and unaffected by the header.
  • Errors: the header never causes 400 -- any value is accepted.
  • Response headers: no Content-Language header is returned.

Request example: curl -H 'X-Locale: de-LU' https://api.easyto.travel/api/v2/agent/features returns every titleLocalized as {"en": "Shower", "de": "Dusche"}.

Translatable locales -- the tags that carry translations today, alongside the en source: id, es, es-MX, es-AR, kk, fr, pt, pt-BR, pt-PT, ru, vi, uk, ar, ja, zh-Hans-MY, zh-Hant, cs, da, de, el, it, lt, hu, nl, no, pl, ro, fi, sv. Any other well-formed BCP 47 tag is still accepted and resolved down the chain above, ending at en.

Authentication​

Security Scheme Type:

apiKey

Header parameter name:

x-api-key