Skip to main content

Onsale Gateway 0.1.0

Onsale Gateway

Last updated: 18-Nov-2026
Recent changes: refactor: quotation marks

Overview

Technical integration details for the accommodation-sourcing-partners (Onsale Gateway) API.

Base paths

The API is exposed through the Apigee proxy under the partners base path:

Environment Base URL
Prod https://prod.api.tui/partners
Test https://test.api.tui/partners

All resource paths are prefixed with /v1, e.g. https://prod.api.tui/partners/v1/change.

Authentication

All endpoints require an authenticated request. Supply a valid JWT as a bearer token:

Authorization: Bearer <token>

Requests without a valid token are rejected with 401 Unauthorized; authenticated requests that lack the required permission are rejected with 403 Forbidden.

Content type

Requests and responses use application/json. Send Content-Type: application/json on requests with a body (POST), and Accept: application/json to request a JSON response.

Correlation

Send an x-correlation-id header with a unique value per request. It is echoed back on the response and should be included when reporting issues so requests can be traced end to end.

Operations

Method Path Purpose
POST /v1/change Create an allotment or release change request.
GET /v1/change/{id} Retrieve the status of a change request.
POST /v1/allocation/_query Query current allocation data.

See the API Details document for full request and response payloads, the supported markets and their routing rules, and error responses.

Markets and routing

The markets array on each request identifies the contract. Supported values and the combinations that may be sent together:

Markets Notes
NL and/or BE May be combined.
DE Must be sent on its own.
UK or SE Exactly one; cannot be combined with each other or with other markets.

Any other combination is rejected with a 400 validation error.

Error handling

Status Meaning
400 Validation failed (e.g. invalid market combination, ambiguous accommodation, missing required fields).
401 Missing or invalid token.
403 Authenticated but not permitted.
404 Unknown change id on GET /v1/change/{id}.

Validation errors return a descriptive message, for example:

  • The combination of markets is not allowed.
  • The accommodation cannot be uniquely resolved in DOD.

About us

TUI is one of the world’s leading tourism groups. The broad portfolio gathered under the Group umbrella consists of strong tour operators, 1,600 travel agencies and leading online portals, five airlines with around 150 aircraft, over 400 hotels, 16 cruise liners and many incoming agencies in all major holiday destinations around the globe.

 

TUI Group logo

Contact

Login to your account