{ "openapi": "3.1.0", "info": { "title": "Voyant Operator API", "version": "0.0.0", "description": "Generated from the composed operator app. Do not edit by hand." }, "servers": [ { "url": "/", "description": "This deployment (same origin)" } ], "components": { "schemas": { "CatalogSearchFilter": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": ["eq"] }, "field": { "type": "string", "minLength": 1 }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": ["kind", "field", "value"] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": ["in"] }, "field": { "type": "string", "minLength": 1 }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": ["kind", "field", "values"] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": ["range"] }, "field": { "type": "string", "minLength": 1 }, "gte": { "type": "number" }, "lte": { "type": "number" } }, "required": ["kind", "field"] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": ["and"] }, "clauses": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogSearchFilter" } } }, "required": ["kind", "clauses"] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": ["or"] }, "clauses": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogSearchFilter" } } }, "required": ["kind", "clauses"] } ] } }, "parameters": {} }, "paths": { "/v1/admin/trips/health": { "get": { "responses": { "200": { "description": "Trips module health status", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "module": { "type": "string", "enum": ["trips"] }, "status": { "type": "string", "enum": ["scaffolded"] } }, "required": ["module", "status"] } }, "required": ["data"] } } } } }, "operationId": "getAdminTripsHealth", "summary": "GET /v1/admin/trips/health", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" } }, "/v1/admin/trips": { "get": { "parameters": [ { "schema": { "type": "string", "enum": [ "draft", "priced", "reserve_in_progress", "reserved", "checkout_started", "booked", "failed", "cancelled" ] }, "required": false, "name": "status", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "required": false, "name": "search", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "required": false, "name": "productId", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "required": false, "name": "accommodationId", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "required": false, "name": "cruiseId", "in": "query" }, { "schema": { "type": ["boolean", "null"] }, "required": false, "name": "hasFlight", "in": "query" }, { "schema": { "type": ["integer", "null"], "minimum": 0 }, "required": false, "name": "totalMinCents", "in": "query" }, { "schema": { "type": ["integer", "null"], "minimum": 0 }, "required": false, "name": "totalMaxCents", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 35 }, "required": false, "name": "createdFrom", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 35 }, "required": false, "name": "createdTo", "in": "query" }, { "schema": { "type": "string", "enum": ["updatedAt", "createdAt", "status", "total"], "default": "updatedAt" }, "required": false, "name": "sortBy", "in": "query" }, { "schema": { "type": "string", "enum": ["asc", "desc"], "default": "desc" }, "required": false, "name": "sortDir", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": ["integer", "null"], "minimum": 0, "default": 0 }, "required": false, "name": "offset", "in": "query" } ], "responses": { "200": { "description": "Paginated list of trip envelopes with their components", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "envelope": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "priced", "reserve_in_progress", "reserved", "checkout_started", "booked", "failed", "cancelled" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "travelerParty": { "type": "object", "additionalProperties": {} }, "constraints": { "type": "object", "additionalProperties": {} }, "aggregateCurrency": { "type": ["string", "null"] }, "aggregateSubtotalAmountCents": { "type": ["integer", "null"] }, "aggregateTaxAmountCents": { "type": ["integer", "null"] }, "aggregateTotalAmountCents": { "type": ["integer", "null"] }, "aggregatePricingSnapshot": {}, "currentPriceExpiresAt": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "reserveIdempotencyKey": { "type": ["string", "null"] }, "reserveStartedAt": { "type": ["string", "null"] }, "reservedAt": { "type": ["string", "null"] }, "checkoutIdempotencyKey": { "type": ["string", "null"] }, "checkoutStartedAt": { "type": ["string", "null"] }, "createdBy": { "type": ["string", "null"] }, "updatedBy": { "type": ["string", "null"] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "status", "title", "description", "travelerParty", "constraints", "aggregateCurrency", "aggregateSubtotalAmountCents", "aggregateTaxAmountCents", "aggregateTotalAmountCents", "currentPriceExpiresAt", "bookingGroupId", "orderId", "paymentSessionId", "reserveIdempotencyKey", "reserveStartedAt", "reservedAt", "checkoutIdempotencyKey", "checkoutStartedAt", "createdBy", "updatedBy", "createdAt", "updatedAt" ] }, "components": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "sequence": { "type": "integer" }, "kind": { "type": "string", "enum": [ "catalog_booking", "manual_placeholder", "flight_placeholder", "flight_order", "external_order" ] }, "status": { "type": "string", "enum": [ "draft", "priced", "unavailable", "held", "booked", "checkout_started", "failed", "cancelled", "removed" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "entityModule": { "type": ["string", "null"] }, "entityId": { "type": ["string", "null"] }, "sourceKind": { "type": ["string", "null"] }, "sourceConnectionId": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "bookingDraftId": { "type": ["string", "null"] }, "catalogQuoteId": { "type": ["string", "null"] }, "bookingId": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "providerRef": { "type": ["string", "null"] }, "supplierRef": { "type": ["string", "null"] }, "componentCurrency": { "type": ["string", "null"] }, "componentSubtotalAmountCents": { "type": ["integer", "null"] }, "componentTaxAmountCents": { "type": ["integer", "null"] }, "componentTotalAmountCents": { "type": ["integer", "null"] }, "pricingSnapshot": {}, "taxLines": { "type": ["array", "null"], "items": {} }, "cancellationSnapshot": {}, "holdToken": { "type": ["string", "null"] }, "holdExpiresAt": { "type": ["string", "null"] }, "priceExpiresAt": { "type": ["string", "null"] }, "warningCodes": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "envelopeId", "sequence", "kind", "status", "title", "description", "entityModule", "entityId", "sourceKind", "sourceConnectionId", "sourceRef", "bookingDraftId", "catalogQuoteId", "bookingId", "bookingGroupId", "orderId", "paymentSessionId", "providerRef", "supplierRef", "componentCurrency", "componentSubtotalAmountCents", "componentTaxAmountCents", "componentTotalAmountCents", "taxLines", "holdToken", "holdExpiresAt", "priceExpiresAt", "warningCodes", "metadata", "createdAt", "updatedAt" ] } } }, "required": ["envelope", "components"] } }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "required": ["data", "total", "limit", "offset"] } } } } }, "operationId": "getAdminTrips", "summary": "GET /v1/admin/trips", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string" }, "travelerParty": { "type": "object", "additionalProperties": {}, "default": {} }, "constraints": { "type": "object", "additionalProperties": {}, "default": {} }, "createdBy": { "type": "string", "minLength": 1 } } } } } }, "responses": { "201": { "description": "The created trip envelope with its (initially empty) components", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "envelope": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "priced", "reserve_in_progress", "reserved", "checkout_started", "booked", "failed", "cancelled" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "travelerParty": { "type": "object", "additionalProperties": {} }, "constraints": { "type": "object", "additionalProperties": {} }, "aggregateCurrency": { "type": ["string", "null"] }, "aggregateSubtotalAmountCents": { "type": ["integer", "null"] }, "aggregateTaxAmountCents": { "type": ["integer", "null"] }, "aggregateTotalAmountCents": { "type": ["integer", "null"] }, "aggregatePricingSnapshot": {}, "currentPriceExpiresAt": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "reserveIdempotencyKey": { "type": ["string", "null"] }, "reserveStartedAt": { "type": ["string", "null"] }, "reservedAt": { "type": ["string", "null"] }, "checkoutIdempotencyKey": { "type": ["string", "null"] }, "checkoutStartedAt": { "type": ["string", "null"] }, "createdBy": { "type": ["string", "null"] }, "updatedBy": { "type": ["string", "null"] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "status", "title", "description", "travelerParty", "constraints", "aggregateCurrency", "aggregateSubtotalAmountCents", "aggregateTaxAmountCents", "aggregateTotalAmountCents", "currentPriceExpiresAt", "bookingGroupId", "orderId", "paymentSessionId", "reserveIdempotencyKey", "reserveStartedAt", "reservedAt", "checkoutIdempotencyKey", "checkoutStartedAt", "createdBy", "updatedBy", "createdAt", "updatedAt" ] }, "components": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "sequence": { "type": "integer" }, "kind": { "type": "string", "enum": [ "catalog_booking", "manual_placeholder", "flight_placeholder", "flight_order", "external_order" ] }, "status": { "type": "string", "enum": [ "draft", "priced", "unavailable", "held", "booked", "checkout_started", "failed", "cancelled", "removed" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "entityModule": { "type": ["string", "null"] }, "entityId": { "type": ["string", "null"] }, "sourceKind": { "type": ["string", "null"] }, "sourceConnectionId": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "bookingDraftId": { "type": ["string", "null"] }, "catalogQuoteId": { "type": ["string", "null"] }, "bookingId": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "providerRef": { "type": ["string", "null"] }, "supplierRef": { "type": ["string", "null"] }, "componentCurrency": { "type": ["string", "null"] }, "componentSubtotalAmountCents": { "type": ["integer", "null"] }, "componentTaxAmountCents": { "type": ["integer", "null"] }, "componentTotalAmountCents": { "type": ["integer", "null"] }, "pricingSnapshot": {}, "taxLines": { "type": ["array", "null"], "items": {} }, "cancellationSnapshot": {}, "holdToken": { "type": ["string", "null"] }, "holdExpiresAt": { "type": ["string", "null"] }, "priceExpiresAt": { "type": ["string", "null"] }, "warningCodes": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "envelopeId", "sequence", "kind", "status", "title", "description", "entityModule", "entityId", "sourceKind", "sourceConnectionId", "sourceRef", "bookingDraftId", "catalogQuoteId", "bookingId", "bookingGroupId", "orderId", "paymentSessionId", "providerRef", "supplierRef", "componentCurrency", "componentSubtotalAmountCents", "componentTaxAmountCents", "componentTotalAmountCents", "taxLines", "holdToken", "holdExpiresAt", "priceExpiresAt", "warningCodes", "metadata", "createdAt", "updatedAt" ] } } }, "required": ["envelope", "components"] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request — body failed validation", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "404": { "description": "A referenced entity was not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "409": { "description": "The envelope could not be created in the requested state", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } } }, "operationId": "postAdminTrips", "summary": "POST /v1/admin/trips", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" } }, "/v1/admin/trips/{envelopeId}": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "envelopeId", "in": "path" } ], "responses": { "200": { "description": "A trip envelope with its components", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "envelope": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "priced", "reserve_in_progress", "reserved", "checkout_started", "booked", "failed", "cancelled" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "travelerParty": { "type": "object", "additionalProperties": {} }, "constraints": { "type": "object", "additionalProperties": {} }, "aggregateCurrency": { "type": ["string", "null"] }, "aggregateSubtotalAmountCents": { "type": ["integer", "null"] }, "aggregateTaxAmountCents": { "type": ["integer", "null"] }, "aggregateTotalAmountCents": { "type": ["integer", "null"] }, "aggregatePricingSnapshot": {}, "currentPriceExpiresAt": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "reserveIdempotencyKey": { "type": ["string", "null"] }, "reserveStartedAt": { "type": ["string", "null"] }, "reservedAt": { "type": ["string", "null"] }, "checkoutIdempotencyKey": { "type": ["string", "null"] }, "checkoutStartedAt": { "type": ["string", "null"] }, "createdBy": { "type": ["string", "null"] }, "updatedBy": { "type": ["string", "null"] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "status", "title", "description", "travelerParty", "constraints", "aggregateCurrency", "aggregateSubtotalAmountCents", "aggregateTaxAmountCents", "aggregateTotalAmountCents", "currentPriceExpiresAt", "bookingGroupId", "orderId", "paymentSessionId", "reserveIdempotencyKey", "reserveStartedAt", "reservedAt", "checkoutIdempotencyKey", "checkoutStartedAt", "createdBy", "updatedBy", "createdAt", "updatedAt" ] }, "components": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "sequence": { "type": "integer" }, "kind": { "type": "string", "enum": [ "catalog_booking", "manual_placeholder", "flight_placeholder", "flight_order", "external_order" ] }, "status": { "type": "string", "enum": [ "draft", "priced", "unavailable", "held", "booked", "checkout_started", "failed", "cancelled", "removed" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "entityModule": { "type": ["string", "null"] }, "entityId": { "type": ["string", "null"] }, "sourceKind": { "type": ["string", "null"] }, "sourceConnectionId": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "bookingDraftId": { "type": ["string", "null"] }, "catalogQuoteId": { "type": ["string", "null"] }, "bookingId": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "providerRef": { "type": ["string", "null"] }, "supplierRef": { "type": ["string", "null"] }, "componentCurrency": { "type": ["string", "null"] }, "componentSubtotalAmountCents": { "type": ["integer", "null"] }, "componentTaxAmountCents": { "type": ["integer", "null"] }, "componentTotalAmountCents": { "type": ["integer", "null"] }, "pricingSnapshot": {}, "taxLines": { "type": ["array", "null"], "items": {} }, "cancellationSnapshot": {}, "holdToken": { "type": ["string", "null"] }, "holdExpiresAt": { "type": ["string", "null"] }, "priceExpiresAt": { "type": ["string", "null"] }, "warningCodes": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "envelopeId", "sequence", "kind", "status", "title", "description", "entityModule", "entityId", "sourceKind", "sourceConnectionId", "sourceRef", "bookingDraftId", "catalogQuoteId", "bookingId", "bookingGroupId", "orderId", "paymentSessionId", "providerRef", "supplierRef", "componentCurrency", "componentSubtotalAmountCents", "componentTaxAmountCents", "componentTotalAmountCents", "taxLines", "holdToken", "holdExpiresAt", "priceExpiresAt", "warningCodes", "metadata", "createdAt", "updatedAt" ] } } }, "required": ["envelope", "components"] } }, "required": ["data"] } } } }, "404": { "description": "Trip envelope not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } } }, "operationId": "getAdminTripsByEnvelopeId", "summary": "GET /v1/admin/trips/{envelopeId}", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" }, "patch": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "envelopeId", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": ["string", "null"], "minLength": 1, "maxLength": 255 }, "description": { "type": ["string", "null"] }, "travelerParty": { "type": "object", "additionalProperties": {} }, "constraints": { "type": "object", "additionalProperties": {} }, "status": { "type": "string", "enum": [ "draft", "priced", "reserve_in_progress", "reserved", "checkout_started", "booked", "failed", "cancelled" ] }, "updatedBy": { "type": ["string", "null"], "minLength": 1 } } } } } }, "responses": { "200": { "description": "The updated trip envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "priced", "reserve_in_progress", "reserved", "checkout_started", "booked", "failed", "cancelled" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "travelerParty": { "type": "object", "additionalProperties": {} }, "constraints": { "type": "object", "additionalProperties": {} }, "aggregateCurrency": { "type": ["string", "null"] }, "aggregateSubtotalAmountCents": { "type": ["integer", "null"] }, "aggregateTaxAmountCents": { "type": ["integer", "null"] }, "aggregateTotalAmountCents": { "type": ["integer", "null"] }, "aggregatePricingSnapshot": {}, "currentPriceExpiresAt": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "reserveIdempotencyKey": { "type": ["string", "null"] }, "reserveStartedAt": { "type": ["string", "null"] }, "reservedAt": { "type": ["string", "null"] }, "checkoutIdempotencyKey": { "type": ["string", "null"] }, "checkoutStartedAt": { "type": ["string", "null"] }, "createdBy": { "type": ["string", "null"] }, "updatedBy": { "type": ["string", "null"] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "status", "title", "description", "travelerParty", "constraints", "aggregateCurrency", "aggregateSubtotalAmountCents", "aggregateTaxAmountCents", "aggregateTotalAmountCents", "currentPriceExpiresAt", "bookingGroupId", "orderId", "paymentSessionId", "reserveIdempotencyKey", "reserveStartedAt", "reservedAt", "checkoutIdempotencyKey", "checkoutStartedAt", "createdBy", "updatedBy", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request — body failed validation", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "403": { "description": "Admin-only operation invoked on the public surface", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "404": { "description": "Trip envelope not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "409": { "description": "Invalid trip envelope state transition", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } } }, "operationId": "patchAdminTripsByEnvelopeId", "summary": "PATCH /v1/admin/trips/{envelopeId}", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" } }, "/v1/admin/trips/{envelopeId}/snapshots": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "envelopeId", "in": "path" } ], "responses": { "200": { "description": "Frozen snapshots for a trip envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "sourceEnvelopeUpdatedAt": { "type": "string" }, "titleSnapshot": { "type": ["string", "null"] }, "descriptionSnapshot": { "type": ["string", "null"] }, "travelerPartySnapshot": { "type": "object", "additionalProperties": {} }, "constraintsSnapshot": { "type": "object", "additionalProperties": {} }, "currency": { "type": "string" }, "subtotalAmountCents": { "type": "integer" }, "taxAmountCents": { "type": "integer" }, "totalAmountCents": { "type": "integer" }, "componentCount": { "type": "integer" }, "pricedComponentCount": { "type": "integer" }, "frozenEnvelope": {}, "frozenComponents": { "type": "array", "items": {} }, "proposal": {}, "createdBy": { "type": ["string", "null"] }, "createdAt": { "type": "string" } }, "required": [ "id", "envelopeId", "sourceEnvelopeUpdatedAt", "titleSnapshot", "descriptionSnapshot", "travelerPartySnapshot", "constraintsSnapshot", "currency", "subtotalAmountCents", "taxAmountCents", "totalAmountCents", "componentCount", "pricedComponentCount", "frozenComponents", "createdBy", "createdAt" ] } } }, "required": ["data"] } } } }, "403": { "description": "Admin-only operation invoked on the public surface", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } } }, "operationId": "getAdminTripsByEnvelopeIdSnapshots", "summary": "GET /v1/admin/trips/{envelopeId}/snapshots", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" }, "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "envelopeId", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "createdBy": { "type": ["string", "null"], "minLength": 1 } } } } } }, "responses": { "201": { "description": "The frozen trip snapshot", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "sourceEnvelopeUpdatedAt": { "type": "string" }, "titleSnapshot": { "type": ["string", "null"] }, "descriptionSnapshot": { "type": ["string", "null"] }, "travelerPartySnapshot": { "type": "object", "additionalProperties": {} }, "constraintsSnapshot": { "type": "object", "additionalProperties": {} }, "currency": { "type": "string" }, "subtotalAmountCents": { "type": "integer" }, "taxAmountCents": { "type": "integer" }, "totalAmountCents": { "type": "integer" }, "componentCount": { "type": "integer" }, "pricedComponentCount": { "type": "integer" }, "frozenEnvelope": {}, "frozenComponents": { "type": "array", "items": {} }, "proposal": {}, "createdBy": { "type": ["string", "null"] }, "createdAt": { "type": "string" } }, "required": [ "id", "envelopeId", "sourceEnvelopeUpdatedAt", "titleSnapshot", "descriptionSnapshot", "travelerPartySnapshot", "constraintsSnapshot", "currency", "subtotalAmountCents", "taxAmountCents", "totalAmountCents", "componentCount", "pricedComponentCount", "frozenComponents", "createdBy", "createdAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request — body failed validation", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "403": { "description": "Admin-only operation invoked on the public surface", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "404": { "description": "Trip envelope not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "409": { "description": "Trip envelope cannot be snapshotted in its current state", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } } }, "operationId": "postAdminTripsByEnvelopeIdSnapshots", "summary": "POST /v1/admin/trips/{envelopeId}/snapshots", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" } }, "/v1/admin/trips/snapshots/{snapshotId}": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "snapshotId", "in": "path" } ], "responses": { "200": { "description": "A frozen trip snapshot by id", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "sourceEnvelopeUpdatedAt": { "type": "string" }, "titleSnapshot": { "type": ["string", "null"] }, "descriptionSnapshot": { "type": ["string", "null"] }, "travelerPartySnapshot": { "type": "object", "additionalProperties": {} }, "constraintsSnapshot": { "type": "object", "additionalProperties": {} }, "currency": { "type": "string" }, "subtotalAmountCents": { "type": "integer" }, "taxAmountCents": { "type": "integer" }, "totalAmountCents": { "type": "integer" }, "componentCount": { "type": "integer" }, "pricedComponentCount": { "type": "integer" }, "frozenEnvelope": {}, "frozenComponents": { "type": "array", "items": {} }, "proposal": {}, "createdBy": { "type": ["string", "null"] }, "createdAt": { "type": "string" } }, "required": [ "id", "envelopeId", "sourceEnvelopeUpdatedAt", "titleSnapshot", "descriptionSnapshot", "travelerPartySnapshot", "constraintsSnapshot", "currency", "subtotalAmountCents", "taxAmountCents", "totalAmountCents", "componentCount", "pricedComponentCount", "frozenComponents", "createdBy", "createdAt" ] } }, "required": ["data"] } } } }, "403": { "description": "Admin-only operation invoked on the public surface", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "404": { "description": "Trip snapshot not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } } }, "operationId": "getAdminTripsSnapshotsBySnapshotId", "summary": "GET /v1/admin/trips/snapshots/{snapshotId}", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" } }, "/v1/admin/trips/{envelopeId}/components": { "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "envelopeId", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sequence": { "type": "integer", "minimum": 0, "default": 0 }, "kind": { "type": "string", "enum": [ "catalog_booking", "manual_placeholder", "flight_placeholder", "flight_order", "external_order" ] }, "description": { "type": "string" }, "catalogRef": { "type": "object", "properties": { "entityModule": { "type": "string", "minLength": 1 }, "entityId": { "type": "string", "minLength": 1 }, "sourceKind": { "type": "string", "minLength": 1 }, "sourceConnectionId": { "type": "string", "minLength": 1 }, "sourceRef": { "type": "string", "minLength": 1 } }, "required": ["entityModule", "entityId", "sourceKind"] }, "estimatedPricing": { "type": "object", "properties": { "currency": { "type": "string", "minLength": 3, "maxLength": 3 }, "subtotalAmountCents": { "type": "integer" }, "taxAmountCents": { "type": "integer" }, "totalAmountCents": { "type": "integer" }, "priceExpiresAt": { "type": "string", "format": "date-time" }, "warnings": { "type": "array", "items": { "type": "string" } } }, "required": [ "currency", "subtotalAmountCents", "taxAmountCents", "totalAmountCents" ] }, "metadata": { "type": "object", "additionalProperties": {}, "default": {} } }, "required": ["kind"], "additionalProperties": false } } } }, "responses": { "201": { "description": "The created trip component", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "sequence": { "type": "integer" }, "kind": { "type": "string", "enum": [ "catalog_booking", "manual_placeholder", "flight_placeholder", "flight_order", "external_order" ] }, "status": { "type": "string", "enum": [ "draft", "priced", "unavailable", "held", "booked", "checkout_started", "failed", "cancelled", "removed" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "entityModule": { "type": ["string", "null"] }, "entityId": { "type": ["string", "null"] }, "sourceKind": { "type": ["string", "null"] }, "sourceConnectionId": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "bookingDraftId": { "type": ["string", "null"] }, "catalogQuoteId": { "type": ["string", "null"] }, "bookingId": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "providerRef": { "type": ["string", "null"] }, "supplierRef": { "type": ["string", "null"] }, "componentCurrency": { "type": ["string", "null"] }, "componentSubtotalAmountCents": { "type": ["integer", "null"] }, "componentTaxAmountCents": { "type": ["integer", "null"] }, "componentTotalAmountCents": { "type": ["integer", "null"] }, "pricingSnapshot": {}, "taxLines": { "type": ["array", "null"], "items": {} }, "cancellationSnapshot": {}, "holdToken": { "type": ["string", "null"] }, "holdExpiresAt": { "type": ["string", "null"] }, "priceExpiresAt": { "type": ["string", "null"] }, "warningCodes": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "envelopeId", "sequence", "kind", "status", "title", "description", "entityModule", "entityId", "sourceKind", "sourceConnectionId", "sourceRef", "bookingDraftId", "catalogQuoteId", "bookingId", "bookingGroupId", "orderId", "paymentSessionId", "providerRef", "supplierRef", "componentCurrency", "componentSubtotalAmountCents", "componentTaxAmountCents", "componentTotalAmountCents", "taxLines", "holdToken", "holdExpiresAt", "priceExpiresAt", "warningCodes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request — body failed validation (manual services require metadata.manualService.name)", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "404": { "description": "Trip envelope not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "409": { "description": "Trip component cannot be added in the envelope's current state", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } } }, "operationId": "postAdminTripsByEnvelopeIdComponents", "summary": "POST /v1/admin/trips/{envelopeId}/components", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" } }, "/v1/admin/trips/{envelopeId}/components/reorder": { "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "envelopeId", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "componentIds": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1 } }, "required": ["componentIds"] } } } }, "responses": { "200": { "description": "The reordered trip components", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "sequence": { "type": "integer" }, "kind": { "type": "string", "enum": [ "catalog_booking", "manual_placeholder", "flight_placeholder", "flight_order", "external_order" ] }, "status": { "type": "string", "enum": [ "draft", "priced", "unavailable", "held", "booked", "checkout_started", "failed", "cancelled", "removed" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "entityModule": { "type": ["string", "null"] }, "entityId": { "type": ["string", "null"] }, "sourceKind": { "type": ["string", "null"] }, "sourceConnectionId": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "bookingDraftId": { "type": ["string", "null"] }, "catalogQuoteId": { "type": ["string", "null"] }, "bookingId": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "providerRef": { "type": ["string", "null"] }, "supplierRef": { "type": ["string", "null"] }, "componentCurrency": { "type": ["string", "null"] }, "componentSubtotalAmountCents": { "type": ["integer", "null"] }, "componentTaxAmountCents": { "type": ["integer", "null"] }, "componentTotalAmountCents": { "type": ["integer", "null"] }, "pricingSnapshot": {}, "taxLines": { "type": ["array", "null"], "items": {} }, "cancellationSnapshot": {}, "holdToken": { "type": ["string", "null"] }, "holdExpiresAt": { "type": ["string", "null"] }, "priceExpiresAt": { "type": ["string", "null"] }, "warningCodes": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "envelopeId", "sequence", "kind", "status", "title", "description", "entityModule", "entityId", "sourceKind", "sourceConnectionId", "sourceRef", "bookingDraftId", "catalogQuoteId", "bookingId", "bookingGroupId", "orderId", "paymentSessionId", "providerRef", "supplierRef", "componentCurrency", "componentSubtotalAmountCents", "componentTaxAmountCents", "componentTotalAmountCents", "taxLines", "holdToken", "holdExpiresAt", "priceExpiresAt", "warningCodes", "metadata", "createdAt", "updatedAt" ] } } }, "required": ["data"] } } } }, "400": { "description": "invalid_request — body failed validation", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "403": { "description": "Admin-only operation invoked on the public surface", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "404": { "description": "Trip envelope not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "409": { "description": "Component set mismatch or invalid reorder", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } } }, "operationId": "postAdminTripsByEnvelopeIdComponentsReorder", "summary": "POST /v1/admin/trips/{envelopeId}/components/reorder", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" } }, "/v1/admin/trips/components/{componentId}": { "patch": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "componentId", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sequence": { "type": "integer", "minimum": 0 }, "status": { "type": "string", "enum": [ "draft", "priced", "unavailable", "held", "booked", "checkout_started", "failed", "cancelled", "removed" ] }, "description": { "type": ["string", "null"] }, "catalogRef": { "type": ["object", "null"], "properties": { "entityModule": { "type": "string", "minLength": 1 }, "entityId": { "type": "string", "minLength": 1 }, "sourceKind": { "type": "string", "minLength": 1 }, "sourceConnectionId": { "type": "string", "minLength": 1 }, "sourceRef": { "type": "string", "minLength": 1 } }, "required": ["entityModule", "entityId", "sourceKind"] }, "metadata": { "type": "object", "additionalProperties": {} }, "warningCodes": { "type": "array", "items": { "type": "string", "minLength": 1 } } } } } } }, "responses": { "200": { "description": "The updated trip component", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "sequence": { "type": "integer" }, "kind": { "type": "string", "enum": [ "catalog_booking", "manual_placeholder", "flight_placeholder", "flight_order", "external_order" ] }, "status": { "type": "string", "enum": [ "draft", "priced", "unavailable", "held", "booked", "checkout_started", "failed", "cancelled", "removed" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "entityModule": { "type": ["string", "null"] }, "entityId": { "type": ["string", "null"] }, "sourceKind": { "type": ["string", "null"] }, "sourceConnectionId": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "bookingDraftId": { "type": ["string", "null"] }, "catalogQuoteId": { "type": ["string", "null"] }, "bookingId": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "providerRef": { "type": ["string", "null"] }, "supplierRef": { "type": ["string", "null"] }, "componentCurrency": { "type": ["string", "null"] }, "componentSubtotalAmountCents": { "type": ["integer", "null"] }, "componentTaxAmountCents": { "type": ["integer", "null"] }, "componentTotalAmountCents": { "type": ["integer", "null"] }, "pricingSnapshot": {}, "taxLines": { "type": ["array", "null"], "items": {} }, "cancellationSnapshot": {}, "holdToken": { "type": ["string", "null"] }, "holdExpiresAt": { "type": ["string", "null"] }, "priceExpiresAt": { "type": ["string", "null"] }, "warningCodes": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "envelopeId", "sequence", "kind", "status", "title", "description", "entityModule", "entityId", "sourceKind", "sourceConnectionId", "sourceRef", "bookingDraftId", "catalogQuoteId", "bookingId", "bookingGroupId", "orderId", "paymentSessionId", "providerRef", "supplierRef", "componentCurrency", "componentSubtotalAmountCents", "componentTaxAmountCents", "componentTotalAmountCents", "taxLines", "holdToken", "holdExpiresAt", "priceExpiresAt", "warningCodes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request — body failed validation", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "403": { "description": "Admin-only operation invoked on the public surface", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "404": { "description": "Trip component not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "409": { "description": "Trip component cannot be updated in its current state", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } } }, "operationId": "patchAdminTripsComponentsByComponentId", "summary": "PATCH /v1/admin/trips/components/{componentId}", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" }, "delete": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "componentId", "in": "path" } ], "responses": { "200": { "description": "The removed trip component", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "sequence": { "type": "integer" }, "kind": { "type": "string", "enum": [ "catalog_booking", "manual_placeholder", "flight_placeholder", "flight_order", "external_order" ] }, "status": { "type": "string", "enum": [ "draft", "priced", "unavailable", "held", "booked", "checkout_started", "failed", "cancelled", "removed" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "entityModule": { "type": ["string", "null"] }, "entityId": { "type": ["string", "null"] }, "sourceKind": { "type": ["string", "null"] }, "sourceConnectionId": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "bookingDraftId": { "type": ["string", "null"] }, "catalogQuoteId": { "type": ["string", "null"] }, "bookingId": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "providerRef": { "type": ["string", "null"] }, "supplierRef": { "type": ["string", "null"] }, "componentCurrency": { "type": ["string", "null"] }, "componentSubtotalAmountCents": { "type": ["integer", "null"] }, "componentTaxAmountCents": { "type": ["integer", "null"] }, "componentTotalAmountCents": { "type": ["integer", "null"] }, "pricingSnapshot": {}, "taxLines": { "type": ["array", "null"], "items": {} }, "cancellationSnapshot": {}, "holdToken": { "type": ["string", "null"] }, "holdExpiresAt": { "type": ["string", "null"] }, "priceExpiresAt": { "type": ["string", "null"] }, "warningCodes": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "envelopeId", "sequence", "kind", "status", "title", "description", "entityModule", "entityId", "sourceKind", "sourceConnectionId", "sourceRef", "bookingDraftId", "catalogQuoteId", "bookingId", "bookingGroupId", "orderId", "paymentSessionId", "providerRef", "supplierRef", "componentCurrency", "componentSubtotalAmountCents", "componentTaxAmountCents", "componentTotalAmountCents", "taxLines", "holdToken", "holdExpiresAt", "priceExpiresAt", "warningCodes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request — the removal could not be processed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "403": { "description": "Admin-only operation invoked on the public surface", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "404": { "description": "Trip component not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "409": { "description": "Trip component cannot be removed in its current state", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } } }, "operationId": "deleteAdminTripsComponentsByComponentId", "summary": "DELETE /v1/admin/trips/components/{componentId}", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" } }, "/v1/admin/trips/components/{componentId}/refs": { "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "componentId", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "bookingDraftId": { "type": "string", "minLength": 1 }, "catalogQuoteId": { "type": "string", "minLength": 1 }, "committedRef": { "type": "object", "properties": { "bookingId": { "type": "string", "minLength": 1 }, "bookingGroupId": { "type": "string", "minLength": 1 }, "orderId": { "type": "string", "minLength": 1 }, "paymentSessionId": { "type": "string", "minLength": 1 }, "providerRef": { "type": "string", "minLength": 1 }, "supplierRef": { "type": "string", "minLength": 1 } } } } } } } }, "responses": { "200": { "description": "The trip component with updated commit references", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "sequence": { "type": "integer" }, "kind": { "type": "string", "enum": [ "catalog_booking", "manual_placeholder", "flight_placeholder", "flight_order", "external_order" ] }, "status": { "type": "string", "enum": [ "draft", "priced", "unavailable", "held", "booked", "checkout_started", "failed", "cancelled", "removed" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "entityModule": { "type": ["string", "null"] }, "entityId": { "type": ["string", "null"] }, "sourceKind": { "type": ["string", "null"] }, "sourceConnectionId": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "bookingDraftId": { "type": ["string", "null"] }, "catalogQuoteId": { "type": ["string", "null"] }, "bookingId": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "providerRef": { "type": ["string", "null"] }, "supplierRef": { "type": ["string", "null"] }, "componentCurrency": { "type": ["string", "null"] }, "componentSubtotalAmountCents": { "type": ["integer", "null"] }, "componentTaxAmountCents": { "type": ["integer", "null"] }, "componentTotalAmountCents": { "type": ["integer", "null"] }, "pricingSnapshot": {}, "taxLines": { "type": ["array", "null"], "items": {} }, "cancellationSnapshot": {}, "holdToken": { "type": ["string", "null"] }, "holdExpiresAt": { "type": ["string", "null"] }, "priceExpiresAt": { "type": ["string", "null"] }, "warningCodes": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "envelopeId", "sequence", "kind", "status", "title", "description", "entityModule", "entityId", "sourceKind", "sourceConnectionId", "sourceRef", "bookingDraftId", "catalogQuoteId", "bookingId", "bookingGroupId", "orderId", "paymentSessionId", "providerRef", "supplierRef", "componentCurrency", "componentSubtotalAmountCents", "componentTaxAmountCents", "componentTotalAmountCents", "taxLines", "holdToken", "holdExpiresAt", "priceExpiresAt", "warningCodes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request — body failed validation", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "403": { "description": "Admin-only operation invoked on the public surface", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "404": { "description": "Trip component not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "409": { "description": "Trip component cannot receive references in its current state", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } } }, "operationId": "postAdminTripsComponentsByComponentIdRefs", "summary": "POST /v1/admin/trips/components/{componentId}/refs", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" } }, "/v1/admin/trips/{envelopeId}/requirements": { "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "envelopeId", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "vertical": { "type": "string", "minLength": 1 }, "criteria": { "type": "object", "additionalProperties": {}, "default": {} }, "criteriaVersion": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "minimum": 0 }, "required": { "type": "boolean" }, "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "maxLength": 2000 }, "metadata": { "type": "object", "additionalProperties": {} } }, "required": ["vertical", "criteriaVersion"] } } } }, "responses": { "201": { "description": "The created trip requirement", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "sequence": { "type": "integer" }, "status": { "type": "string" }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "vertical": { "type": "string" }, "criteria": { "type": "object", "additionalProperties": {} }, "criteriaVersion": { "type": "string" }, "required": { "type": "boolean" }, "selectedCandidateId": { "type": ["string", "null"] }, "resolvedComponentId": { "type": ["string", "null"] }, "lastSourcedAt": { "type": ["string", "null"] }, "metadata": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "envelopeId", "sequence", "status", "title", "description", "vertical", "criteria", "criteriaVersion", "required", "selectedCandidateId", "resolvedComponentId", "lastSourcedAt", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request — body failed validation", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "403": { "description": "Admin-only operation invoked on the public surface", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "404": { "description": "Trip envelope not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "409": { "description": "Requirement cannot be added in the envelope's current state", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } } }, "operationId": "postAdminTripsByEnvelopeIdRequirements", "summary": "POST /v1/admin/trips/{envelopeId}/requirements", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" }, "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "envelopeId", "in": "path" } ], "responses": { "200": { "description": "Requirements for a trip envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "sequence": { "type": "integer" }, "status": { "type": "string" }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "vertical": { "type": "string" }, "criteria": { "type": "object", "additionalProperties": {} }, "criteriaVersion": { "type": "string" }, "required": { "type": "boolean" }, "selectedCandidateId": { "type": ["string", "null"] }, "resolvedComponentId": { "type": ["string", "null"] }, "lastSourcedAt": { "type": ["string", "null"] }, "metadata": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "envelopeId", "sequence", "status", "title", "description", "vertical", "criteria", "criteriaVersion", "required", "selectedCandidateId", "resolvedComponentId", "lastSourcedAt", "metadata", "createdAt", "updatedAt" ] } } }, "required": ["data"] } } } }, "400": { "description": "invalid_request — the requirements could not be listed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "403": { "description": "Admin-only operation invoked on the public surface", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "404": { "description": "Trip envelope not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "409": { "description": "Requirements cannot be listed in the envelope's current state", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } } }, "operationId": "getAdminTripsByEnvelopeIdRequirements", "summary": "GET /v1/admin/trips/{envelopeId}/requirements", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" } }, "/v1/admin/trips/requirements/{requirementId}/sourcing-operations/{operationId}": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "requirementId", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "operationId", "in": "path" } ], "responses": { "200": { "description": "Durable sourcing operation status, immutable accepted result, terminal outcome, and error", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "operationId": { "type": "string", "minLength": 1 }, "requirementId": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": ["pending", "processing", "retry", "completed", "dead_letter"] }, "result": { "type": "object", "properties": { "status": { "type": "string", "enum": ["accepted"] }, "operationId": { "type": "string", "minLength": 1 }, "requirementId": { "type": "string", "minLength": 1 }, "statusTool": { "type": "string", "enum": ["get_trip_requirement_sourcing_operation"] } }, "required": ["status", "operationId", "requirementId", "statusTool"] }, "outcome": { "oneOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": ["completed"] }, "candidateCount": { "type": "integer", "minimum": 0 }, "requirementStatus": { "type": "string", "enum": ["candidates_ready", "no_availability"] } }, "required": ["status", "candidateCount", "requirementStatus"] }, { "type": "object", "properties": { "status": { "type": "string", "enum": ["dead_letter"] }, "error": { "type": "string" } }, "required": ["status", "error"] }, { "nullable": true } ] }, "error": { "type": "string", "nullable": true }, "attempts": { "type": "integer", "minimum": 0 }, "maxAttempts": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "nextAttemptAt": { "type": "string" }, "completedAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "operationId", "requirementId", "status", "result", "outcome", "error", "attempts", "maxAttempts", "nextAttemptAt", "completedAt", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "403": { "description": "Admin-only operation invoked on the public surface", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": { "nullable": true } } } } }, "404": { "description": "Sourcing operation not found for this organization and requirement", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": { "nullable": true } } } } } }, "operationId": "getAdminTripsRequirementsByRequirementIdSourcingOperationsByOperationId", "summary": "GET /v1/admin/trips/requirements/{requirementId}/sourcing-operations/{operationId}", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" } }, "/v1/admin/trips/requirements/{requirementId}/select": { "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "requirementId", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "candidateId": { "type": "string", "minLength": 1 } }, "required": ["candidateId"] } } } }, "responses": { "200": { "description": "The resolved requirement, selected candidate, and pinned component", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "requirement": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "sequence": { "type": "integer" }, "status": { "type": "string" }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "vertical": { "type": "string" }, "criteria": { "type": "object", "additionalProperties": {} }, "criteriaVersion": { "type": "string" }, "required": { "type": "boolean" }, "selectedCandidateId": { "type": ["string", "null"] }, "resolvedComponentId": { "type": ["string", "null"] }, "lastSourcedAt": { "type": ["string", "null"] }, "metadata": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "envelopeId", "sequence", "status", "title", "description", "vertical", "criteria", "criteriaVersion", "required", "selectedCandidateId", "resolvedComponentId", "lastSourcedAt", "metadata", "createdAt", "updatedAt" ] }, "candidate": { "type": "object", "properties": { "id": { "type": "string" }, "requirementId": { "type": "string" }, "envelopeId": { "type": "string" }, "rank": { "type": "integer" }, "status": { "type": "string" }, "candidateRef": { "type": "string" }, "entityModule": { "type": "string" }, "entityId": { "type": "string" }, "sourceKind": { "type": "string" }, "sourceConnectionId": { "type": ["string", "null"] }, "sourceModule": { "type": ["string", "null"] }, "selection": { "type": "object", "additionalProperties": {} }, "priceCurrency": { "type": "string" }, "priceAmount": { "type": "string" }, "expiresAt": { "type": ["string", "null"] }, "providerData": {}, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "requirementId", "envelopeId", "rank", "status", "candidateRef", "entityModule", "entityId", "sourceKind", "sourceConnectionId", "sourceModule", "selection", "priceCurrency", "priceAmount", "expiresAt", "createdAt", "updatedAt" ] }, "component": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "sequence": { "type": "integer" }, "kind": { "type": "string", "enum": [ "catalog_booking", "manual_placeholder", "flight_placeholder", "flight_order", "external_order" ] }, "status": { "type": "string", "enum": [ "draft", "priced", "unavailable", "held", "booked", "checkout_started", "failed", "cancelled", "removed" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "entityModule": { "type": ["string", "null"] }, "entityId": { "type": ["string", "null"] }, "sourceKind": { "type": ["string", "null"] }, "sourceConnectionId": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "bookingDraftId": { "type": ["string", "null"] }, "catalogQuoteId": { "type": ["string", "null"] }, "bookingId": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "providerRef": { "type": ["string", "null"] }, "supplierRef": { "type": ["string", "null"] }, "componentCurrency": { "type": ["string", "null"] }, "componentSubtotalAmountCents": { "type": ["integer", "null"] }, "componentTaxAmountCents": { "type": ["integer", "null"] }, "componentTotalAmountCents": { "type": ["integer", "null"] }, "pricingSnapshot": {}, "taxLines": { "type": ["array", "null"], "items": {} }, "cancellationSnapshot": {}, "holdToken": { "type": ["string", "null"] }, "holdExpiresAt": { "type": ["string", "null"] }, "priceExpiresAt": { "type": ["string", "null"] }, "warningCodes": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "envelopeId", "sequence", "kind", "status", "title", "description", "entityModule", "entityId", "sourceKind", "sourceConnectionId", "sourceRef", "bookingDraftId", "catalogQuoteId", "bookingId", "bookingGroupId", "orderId", "paymentSessionId", "providerRef", "supplierRef", "componentCurrency", "componentSubtotalAmountCents", "componentTaxAmountCents", "componentTotalAmountCents", "taxLines", "holdToken", "holdExpiresAt", "priceExpiresAt", "warningCodes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["requirement", "candidate", "component"] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request — body failed validation", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "403": { "description": "Admin-only operation invoked on the public surface", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "404": { "description": "Trip requirement or candidate not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "409": { "description": "Candidate is not selectable (expired / superseded / wrong state)", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } } }, "operationId": "postAdminTripsRequirementsByRequirementIdSelect", "summary": "POST /v1/admin/trips/requirements/{requirementId}/select", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" } }, "/v1/admin/trips/{envelopeId}/checkout": { "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "envelopeId", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 1, "maxLength": 255 }, "intent": { "type": "string", "enum": ["card", "bank_transfer", "hold", "inquiry"], "default": "card" }, "request": { "type": "object", "additionalProperties": {}, "default": {} } } } } } }, "responses": { "200": { "description": "The checkout-started envelope with components and a composed handoff result", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "envelope": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "priced", "reserve_in_progress", "reserved", "checkout_started", "booked", "failed", "cancelled" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "travelerParty": { "type": "object", "additionalProperties": {} }, "constraints": { "type": "object", "additionalProperties": {} }, "aggregateCurrency": { "type": ["string", "null"] }, "aggregateSubtotalAmountCents": { "type": ["integer", "null"] }, "aggregateTaxAmountCents": { "type": ["integer", "null"] }, "aggregateTotalAmountCents": { "type": ["integer", "null"] }, "aggregatePricingSnapshot": {}, "currentPriceExpiresAt": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "reserveIdempotencyKey": { "type": ["string", "null"] }, "reserveStartedAt": { "type": ["string", "null"] }, "reservedAt": { "type": ["string", "null"] }, "checkoutIdempotencyKey": { "type": ["string", "null"] }, "checkoutStartedAt": { "type": ["string", "null"] }, "createdBy": { "type": ["string", "null"] }, "updatedBy": { "type": ["string", "null"] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "status", "title", "description", "travelerParty", "constraints", "aggregateCurrency", "aggregateSubtotalAmountCents", "aggregateTaxAmountCents", "aggregateTotalAmountCents", "currentPriceExpiresAt", "bookingGroupId", "orderId", "paymentSessionId", "reserveIdempotencyKey", "reserveStartedAt", "reservedAt", "checkoutIdempotencyKey", "checkoutStartedAt", "createdBy", "updatedBy", "createdAt", "updatedAt" ] }, "components": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "sequence": { "type": "integer" }, "kind": { "type": "string", "enum": [ "catalog_booking", "manual_placeholder", "flight_placeholder", "flight_order", "external_order" ] }, "status": { "type": "string", "enum": [ "draft", "priced", "unavailable", "held", "booked", "checkout_started", "failed", "cancelled", "removed" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "entityModule": { "type": ["string", "null"] }, "entityId": { "type": ["string", "null"] }, "sourceKind": { "type": ["string", "null"] }, "sourceConnectionId": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "bookingDraftId": { "type": ["string", "null"] }, "catalogQuoteId": { "type": ["string", "null"] }, "bookingId": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "providerRef": { "type": ["string", "null"] }, "supplierRef": { "type": ["string", "null"] }, "componentCurrency": { "type": ["string", "null"] }, "componentSubtotalAmountCents": { "type": ["integer", "null"] }, "componentTaxAmountCents": { "type": ["integer", "null"] }, "componentTotalAmountCents": { "type": ["integer", "null"] }, "pricingSnapshot": {}, "taxLines": { "type": ["array", "null"], "items": {} }, "cancellationSnapshot": {}, "holdToken": { "type": ["string", "null"] }, "holdExpiresAt": { "type": ["string", "null"] }, "priceExpiresAt": { "type": ["string", "null"] }, "warningCodes": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "envelopeId", "sequence", "kind", "status", "title", "description", "entityModule", "entityId", "sourceKind", "sourceConnectionId", "sourceRef", "bookingDraftId", "catalogQuoteId", "bookingId", "bookingGroupId", "orderId", "paymentSessionId", "providerRef", "supplierRef", "componentCurrency", "componentSubtotalAmountCents", "componentTaxAmountCents", "componentTotalAmountCents", "taxLines", "holdToken", "holdExpiresAt", "priceExpiresAt", "warningCodes", "metadata", "createdAt", "updatedAt" ] } } }, "required": ["envelope", "components"], "additionalProperties": {} } }, "required": ["data"] } } } }, "400": { "description": "invalid_request — body failed validation", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "404": { "description": "Trip envelope not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "409": { "description": "Envelope cannot start checkout in its current state", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "501": { "description": "Trips checkout dependencies are not configured", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } } }, "operationId": "postAdminTripsByEnvelopeIdCheckout", "summary": "POST /v1/admin/trips/{envelopeId}/checkout", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" } }, "/v1/admin/trips/{envelopeId}/cancellation-preview": { "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "envelopeId", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "componentIds": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1 }, "reason": { "type": "string", "minLength": 1, "maxLength": 500 }, "requestedAt": { "type": "string", "format": "date-time" }, "request": { "type": "object", "additionalProperties": {}, "default": {} } } } } } }, "responses": { "200": { "description": "A composed cancellation preview for the envelope / selected components", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "envelope": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "priced", "reserve_in_progress", "reserved", "checkout_started", "booked", "failed", "cancelled" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "travelerParty": { "type": "object", "additionalProperties": {} }, "constraints": { "type": "object", "additionalProperties": {} }, "aggregateCurrency": { "type": ["string", "null"] }, "aggregateSubtotalAmountCents": { "type": ["integer", "null"] }, "aggregateTaxAmountCents": { "type": ["integer", "null"] }, "aggregateTotalAmountCents": { "type": ["integer", "null"] }, "aggregatePricingSnapshot": {}, "currentPriceExpiresAt": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "reserveIdempotencyKey": { "type": ["string", "null"] }, "reserveStartedAt": { "type": ["string", "null"] }, "reservedAt": { "type": ["string", "null"] }, "checkoutIdempotencyKey": { "type": ["string", "null"] }, "checkoutStartedAt": { "type": ["string", "null"] }, "createdBy": { "type": ["string", "null"] }, "updatedBy": { "type": ["string", "null"] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "status", "title", "description", "travelerParty", "constraints", "aggregateCurrency", "aggregateSubtotalAmountCents", "aggregateTaxAmountCents", "aggregateTotalAmountCents", "currentPriceExpiresAt", "bookingGroupId", "orderId", "paymentSessionId", "reserveIdempotencyKey", "reserveStartedAt", "reservedAt", "checkoutIdempotencyKey", "checkoutStartedAt", "createdBy", "updatedBy", "createdAt", "updatedAt" ] }, "components": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "sequence": { "type": "integer" }, "kind": { "type": "string", "enum": [ "catalog_booking", "manual_placeholder", "flight_placeholder", "flight_order", "external_order" ] }, "status": { "type": "string", "enum": [ "draft", "priced", "unavailable", "held", "booked", "checkout_started", "failed", "cancelled", "removed" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "entityModule": { "type": ["string", "null"] }, "entityId": { "type": ["string", "null"] }, "sourceKind": { "type": ["string", "null"] }, "sourceConnectionId": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "bookingDraftId": { "type": ["string", "null"] }, "catalogQuoteId": { "type": ["string", "null"] }, "bookingId": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "providerRef": { "type": ["string", "null"] }, "supplierRef": { "type": ["string", "null"] }, "componentCurrency": { "type": ["string", "null"] }, "componentSubtotalAmountCents": { "type": ["integer", "null"] }, "componentTaxAmountCents": { "type": ["integer", "null"] }, "componentTotalAmountCents": { "type": ["integer", "null"] }, "pricingSnapshot": {}, "taxLines": { "type": ["array", "null"], "items": {} }, "cancellationSnapshot": {}, "holdToken": { "type": ["string", "null"] }, "holdExpiresAt": { "type": ["string", "null"] }, "priceExpiresAt": { "type": ["string", "null"] }, "warningCodes": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "envelopeId", "sequence", "kind", "status", "title", "description", "entityModule", "entityId", "sourceKind", "sourceConnectionId", "sourceRef", "bookingDraftId", "catalogQuoteId", "bookingId", "bookingGroupId", "orderId", "paymentSessionId", "providerRef", "supplierRef", "componentCurrency", "componentSubtotalAmountCents", "componentTaxAmountCents", "componentTotalAmountCents", "taxLines", "holdToken", "holdExpiresAt", "priceExpiresAt", "warningCodes", "metadata", "createdAt", "updatedAt" ] } } }, "required": ["envelope", "components"], "additionalProperties": {} } }, "required": ["data"] } } } }, "400": { "description": "invalid_request — body failed validation", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "403": { "description": "Admin-only operation invoked on the public surface", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "404": { "description": "Trip envelope not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "409": { "description": "Cancellation cannot be previewed in the envelope's current state", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } } }, "operationId": "postAdminTripsByEnvelopeIdCancellationPreview", "summary": "POST /v1/admin/trips/{envelopeId}/cancellation-preview", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" } }, "/v1/admin/trips/{envelopeId}/cancel-components": { "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "envelopeId", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "componentIds": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1 }, "reason": { "type": "string", "minLength": 1, "maxLength": 500 }, "requestedAt": { "type": "string", "format": "date-time" }, "request": { "type": "object", "additionalProperties": {}, "default": {} }, "idempotencyKey": { "type": "string", "minLength": 1, "maxLength": 255 } } } } } }, "responses": { "200": { "description": "A composed cancellation result for the envelope / selected components", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "envelope": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "priced", "reserve_in_progress", "reserved", "checkout_started", "booked", "failed", "cancelled" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "travelerParty": { "type": "object", "additionalProperties": {} }, "constraints": { "type": "object", "additionalProperties": {} }, "aggregateCurrency": { "type": ["string", "null"] }, "aggregateSubtotalAmountCents": { "type": ["integer", "null"] }, "aggregateTaxAmountCents": { "type": ["integer", "null"] }, "aggregateTotalAmountCents": { "type": ["integer", "null"] }, "aggregatePricingSnapshot": {}, "currentPriceExpiresAt": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "reserveIdempotencyKey": { "type": ["string", "null"] }, "reserveStartedAt": { "type": ["string", "null"] }, "reservedAt": { "type": ["string", "null"] }, "checkoutIdempotencyKey": { "type": ["string", "null"] }, "checkoutStartedAt": { "type": ["string", "null"] }, "createdBy": { "type": ["string", "null"] }, "updatedBy": { "type": ["string", "null"] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "status", "title", "description", "travelerParty", "constraints", "aggregateCurrency", "aggregateSubtotalAmountCents", "aggregateTaxAmountCents", "aggregateTotalAmountCents", "currentPriceExpiresAt", "bookingGroupId", "orderId", "paymentSessionId", "reserveIdempotencyKey", "reserveStartedAt", "reservedAt", "checkoutIdempotencyKey", "checkoutStartedAt", "createdBy", "updatedBy", "createdAt", "updatedAt" ] }, "components": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "sequence": { "type": "integer" }, "kind": { "type": "string", "enum": [ "catalog_booking", "manual_placeholder", "flight_placeholder", "flight_order", "external_order" ] }, "status": { "type": "string", "enum": [ "draft", "priced", "unavailable", "held", "booked", "checkout_started", "failed", "cancelled", "removed" ] }, "title": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "entityModule": { "type": ["string", "null"] }, "entityId": { "type": ["string", "null"] }, "sourceKind": { "type": ["string", "null"] }, "sourceConnectionId": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "bookingDraftId": { "type": ["string", "null"] }, "catalogQuoteId": { "type": ["string", "null"] }, "bookingId": { "type": ["string", "null"] }, "bookingGroupId": { "type": ["string", "null"] }, "orderId": { "type": ["string", "null"] }, "paymentSessionId": { "type": ["string", "null"] }, "providerRef": { "type": ["string", "null"] }, "supplierRef": { "type": ["string", "null"] }, "componentCurrency": { "type": ["string", "null"] }, "componentSubtotalAmountCents": { "type": ["integer", "null"] }, "componentTaxAmountCents": { "type": ["integer", "null"] }, "componentTotalAmountCents": { "type": ["integer", "null"] }, "pricingSnapshot": {}, "taxLines": { "type": ["array", "null"], "items": {} }, "cancellationSnapshot": {}, "holdToken": { "type": ["string", "null"] }, "holdExpiresAt": { "type": ["string", "null"] }, "priceExpiresAt": { "type": ["string", "null"] }, "warningCodes": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "envelopeId", "sequence", "kind", "status", "title", "description", "entityModule", "entityId", "sourceKind", "sourceConnectionId", "sourceRef", "bookingDraftId", "catalogQuoteId", "bookingId", "bookingGroupId", "orderId", "paymentSessionId", "providerRef", "supplierRef", "componentCurrency", "componentSubtotalAmountCents", "componentTaxAmountCents", "componentTotalAmountCents", "taxLines", "holdToken", "holdExpiresAt", "priceExpiresAt", "warningCodes", "metadata", "createdAt", "updatedAt" ] } } }, "required": ["envelope", "components"], "additionalProperties": {} } }, "required": ["data"] } } } }, "400": { "description": "invalid_request — body failed validation", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "403": { "description": "Admin-only operation invoked on the public surface", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "404": { "description": "Trip envelope not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } }, "409": { "description": "Components cannot be cancelled in their current state", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"], "additionalProperties": {} } } } } }, "operationId": "postAdminTripsByEnvelopeIdCancelComponents", "summary": "POST /v1/admin/trips/{envelopeId}/cancel-components", "tags": ["trips"], "x-voyant-module": "trips", "x-voyant-surface": "admin" } } }, "webhooks": {} }