Skip to main content

API reference

Every operation of the order engine API: 164 operations in 21 groups. Request schemas are generated from the service's contract snapshot, and the examples are requests and responses captured from the service itself.

Download the machine-readable contract: OpenAPI 3.0 (YAML). It imports into Anypoint Exchange, Postman and other OpenAPI 3.0 tooling.

Generated from edge-platform ad3c54b6, committed 2026-10-28.

GroupOperationsWhat it covers
Quotes7The durable quote store. A quote is priced and saved, can be retrieved by any channel allowed to see it, revalidated, and accepted, which freezes its commercial conditions for the order engine.
Quotations4Quotation tracking on the order engine. A quotation links a saved quote to a trip, groups alternatives under one intent and converts into the booking purchase order.
Trips5The trip is the container for one customer journey. It holds one anchor product (the cruise), the quotations that led to it and every purchase order sold into it.
Purchase orders6A purchase order is one commercial transaction on a trip, placed on one channel at one purchase moment. Each holds order lines with four status dimensions.
Order lines2The order line projection used by payments, allocation, changes and operations. Lines are projected from purchase orders automatically.
Payments and allocation7Payments, refunds and their allocation to order lines, with balances at group, trip, purchase order and passenger level.
Changes and cancellations2Passenger-level change impact. Preview or apply the removal of passengers, the cancellation of a cabin or of a whole purchase order, with fees, refunds and re-allocation computed per passenger.
Repricing6Post-booking repricing proposals and bulk moves, applied to purchase orders as order changes.
Events5The outbox the order engine publishes (polled by sequence), the inbound status events specialist systems send, and the integration log.
Orchestration configuration17The versioned, audited configuration of the order engine. It holds channels, purchase moments, markets, connected systems, execution-ownership rules, status models, the event catalogue and payment rules.
Monitoring15Integration monitoring. Message trace, exceptions, missing-feedback alerts and connected-system health. Available when monitoring is enabled for the tenant.
Groups7The order engine group umbrella that links individual trips, carries the negotiated conditions and enforces inherited constraints.
Group agreements27Group agreements (blocks and rate-only agreements) with approval, contracting, berth holds, releases, receipts, settlement and a ledger. Every read can be taken as of a date.
Travel parties6Families and friends travelling together on separate trips, without group commercial terms.
Block requests12Group requests from tour operators, agencies and MICE organisers. A request is drafted, priced, submitted, decided and accepted, which creates the group agreement.
Party quotes5Quotes for a travel party that books several units together, with a preview of converting to group terms.
Disruption and mass change15Record a disruption, plan a mass change (line update or re-accommodation with price protection), commit it with its commit token, retry failures and roll back.
Operations6Operational work queues, exception work items and trip marks raised by mass changes.
Service recovery5Goodwill and service-recovery cases with eligibility, approval thresholds and issue of vouchers or onboard credit.
Care views2Read models for a customer-care console (for example a Service Cloud component).
Cabin inventory3Cabin-level inventory reads and holds used by block requests and deck plans.