BATCH API
Consolidated event extracts
Submit up to 50 independent canonical booking events in one partial JSON extract.
The supported format
POST /api/ocean/v1/messages with format FORYN_EXTRACT_EVENTS_V1 and snapshotKind PARTIAL.
records is an array of 1–50 items, each independently validated against foryn.ocean.booking.v1.
Records may be valid or invalid within the same HTTP 200 batch response. Inspect each results[index].status and nested result.
CODE / EXAMPLE
GET /developers/v1/examples/partial-batch.json
Partial is not complete
- Omitted records never cancel earlier bookings.
- No authoritative complete snapshot or omission-based cancellation is implemented.
- Use explicit CANCELLED events with source identity and a newer revision.
- A batch must not be used to manufacture per-row carrier confirmations or monotonically increasing revisions.
Per-record outcomes
| status | Meaning |
|---|---|
| PROCESSED | Record reached canonical handler. Inspect nested data.status; it could still be INSUFFICIENT_EVIDENCE. |
| FAILED | Record reached canonical handler and returned a non-200 response; inspect httpStatus and result.error. |
| INVALID_RECORD | Input item did not satisfy the canonical booking schema; no booking write for that item. |
API v1 · Fictional examples · Production access requires coordinated onboarding · OpenAPI contract ↗