Skip to main content

Data conventions

Money​

Amounts are integers in minor units of the currency, in fields ending in Minor: amountMinor: 238000 in EUR is €2,380.00. Currencies are ISO 4217 codes (^[A-Z]{3}$). There are no floating-point amounts in the order engine contracts.

Payment and refund amounts are always positive; the kind (payment or refund) gives the direction. Allocation legs of a refund are negative.

One exception: on the quote store, external_price.amount (a supplier price on a quote line) is in major units.

Identifiers​

ResourceFormatExample
TripTenant prefix, a hyphen, 12 hexadecimal charactersTRP-B2BD5A9771E4
Purchase orderPO- and 12 hexadecimal charactersPO-5BEE8AAD2A57
Order lineL- and 12 hexadecimal charactersL-A610167BDD4D
QuotationQT- and 12 hexadecimal charactersQT-E419E9088B0D
IntentINT- and 12 hexadecimal characters, or your own valueINT-E7814BE45E5F
QuoteTenant prefix and 8 characters without ambiguous lettersQ-7KD2M9QX
Payment, refundpay_ and a UUIDpay_c61ba173-…
Groupgrp_ and the agreement reference, or a UUIDgrp_GA-2026-582C6A
Group agreementga_ and a UUID; reference GA- year and 6 charactersGA-2026-582C6A
Disruption, mass changedis_, mc_ and a UUIDmc_f40b7d54-…
Changechg_ and 20 hexadecimal characterschg_1884420249cffc7a9544

Treat identifiers as opaque strings of up to 200 characters. Your own references (customerRef, agencyRef, externalRef, actorRef) are stored as given.

Timestamps and dates​

Timestamps are ISO 8601 with an offset (2026-11-02T09:05:37.000Z); the service writes UTC. Calendar dates without a time (deposit due dates, departure dates on group agreements) are YYYY-MM-DD.

Codes from configuration​

Channels, purchase moments, markets, connected systems, processes and payment scenarios are codes defined in the tenant's orchestration configuration (^[a-z][a-z0-9_-]*$). The examples in this documentation use the channels web, app, contact_centre, agency and onboard and the moments booking, pre_trip and onboard; your tenant's codes may differ. Read them with GET /order-orchestration/config.

Actors​

Writes record who made them:

SurfaceFieldShape
Order orchestrationactorRef, createdByA reference string; createdBy adds kind (customer, agent, agency).
Order operations, groupsactor{ id, name?, role, channel? }
Configurationactor{ id, name?, role?, channel } with channel api, form, change_desk, system or seed.
Quote store, repricing—Taken from the token.