Skip to main content

Availability

What the order engine API provides today, and what it does not. Integration designs should rely only on capabilities marked available.

Available in production code and documented on this site. Partial available with the limits stated. Not available not provided by the API today.

Platform​

CapabilityStatusNotes
Tenant token authentication, tenant isolationAvailableAuthentication
Read-only roleAvailablesupply_readonly
Per-resource scopes (for example orders:write)Not availableTwo roles only: read-write and read-only.
OAuth 2.0 client-credentials token endpointNot availableTokens are issued to the integration at onboarding.
Agency-scoped tokens on trips and ordersNot availableRefused with 403 scope_forbidden; the agency is recorded on each record instead. The quote store accepts agency-scoped tokens.
Idempotency keys on every writeAvailableIdempotency keys
Optimistic concurrencyAvailableIf-Match on purchase order writes; expectedVersion on configuration, groups, agreements and lines. Concurrency
One error envelope with request idsAvailableOn the order orchestration, order operations, group, group sales and quote store surfaces. Repricing errors carry code, with the message in error, and no requestId. Errors
URI versioning and contract snapshotAvailableVersioning
Deprecation and Sunset headers, public changelogNot available
OpenAPI documentAvailableOpenAPI 3.0, generated from the contract snapshot.
One pagination style on every listPartialFour bounded patterns; the trip list returns the newest 200 at most. Pagination
One field casingPartialQuote store and repricing use snake_case; the other surfaces camelCase.
Published rate limitsNot availableNo per-client quota is enforced today. Rate limits

Events​

CapabilityStatusNotes
Transactional outbox, polled by sequenceAvailableEvents overview
Inbound status events with deduplication, mapping and replayAvailable
Missing-feedback alerts and integration monitoringAvailableMonitoring views when enabled for the tenant.
Webhooks (push, signed, per event type, retries, dead-letter)Not availableWebhooks
Cursor on the integration logPartialGET /order-orchestration/events is newest-first with a limit; the monitoring message list has a cursor. Use the outbox for change feeds.

Resources​

CapabilityStatusNotes
Quotes: price, save, retrieve across channels, revalidate, acceptAvailableQuotes and quotations
Server-side frozen conditions, verified on conversionAvailableVerification is switched on per tenant (verify_frozen_conditions).
Quotations: create, alternatives, resume by creator, convert, reportAvailable
Automatic quotation expiryNot availableThe expired status is reserved; quotes in the quote store expire by validUntil.
Trips with one anchor and many purchase ordersAvailableTrips
Purchase orders from any channel and moment; ownership routingAvailablePurchase orders
Order changes from repricing proposalsAvailable
Passenger manifest on the tripNot availablePassengers are referenced on order lines.
Remove passengers, cancel a cabin, cancel an order, with fees and refundsAvailableChanges and refunds
Name change or passenger substitution on an individual tripNot availableAvailable between trips of a group agreement.
Payments and refunds with line allocationAvailablePayments and allocation
Passenger-level balances and payment splitsAvailableDerived from line allocation.
Allocating a payment directly to a passengerNot availableUse the purchase order anchor or manual legs on the passenger's lines.
Groups with inherited constraintsAvailableGroups, agreements and block requests
Group agreements: approval, contracting, berth holds, releases, receipts, settlement, ledger, as-of readsAvailable
Block requests with pricing, four-eyes decision and acceptanceAvailableCabin counts per category, with optional cabin numbers.
Travel parties and party quotesAvailable
ChannelsPartialRegistered in the orchestration configuration; no channel resource with its own credentials. Channels
Orchestration configuration: versioned, validated, audited, rollbackAvailableOrchestration configuration
Disruption and mass change: plan, commit token, retry, rollback, guest choice, work itemsAvailableMass change and operations
Service recovery with eligibility and approvalAvailableService recovery
Care read modelsAvailableCare views