/omio/companies

POST /api/omio/companies

Price: 20 credits

Get details for an Omio travel company (carrier) by its company page path. Returns the provider code and name, a full description, luggage and cancellation/refund policies, whether unaccompanied minors are allowed and the onboard amenities (wifi, food, seat reservation, accessibility, pets and more) with descriptions. The company path is the page_link returned by the routes overview provider breakdown, e.g. trains/iryo-qgixa.

How to use it

Get an Omio travel company (carrier) by its company page path (the provider page_link from the routes endpoint, e.g. trains/iryo-qgixa). Returns code, name, description, luggage and cancellation/refund policies, unaccompanied_minors_allowed and amenities (name, exists, description).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Company page path as returned in a route's provider page_link, e.g. trains/iryo-qgixa (examples: "trains/iryo-qgixa"; minLength: 1)

Response

• @type string (default: "OmioCompany")
• code string nullable
• name string nullable
• legacy_id integer nullable
• description string nullable
• luggage_included boolean nullable
• luggage_included_desc string nullable
• luggage_storage boolean nullable
• luggage_storage_desc string nullable
• cancellation_policy string nullable
• refundable_when_cancelled boolean nullable
• refundable_when_cancelled_desc string nullable
• unaccompanied_minors_allowed boolean nullable
• amenities array (default: [])
  • @type string (default: "OmioAmenity")
  • name string nullable
  • exists boolean nullable
  • description string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No company found for the given company page path Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.