{ "openapi": "3.1.0", "info": { "title": "Atom Tickets Partner API", "version": "1.0.0", "description": "REST API for movie ticketing integrations. Search theaters, browse movies, query showtimes, and manage ticket orders.", "contact": { "name": "Atom Tickets Partner Support", "email": "support@atomtickets.com" } }, "servers": [ { "url": "https://api-beta.atomtickets.com", "description": "Beta (Testing)" }, { "url": "https://api.atomtickets.com", "description": "Production" } ], "security": [ { "ApiKeyAuth": [] } ], "tags": [ { "name": "Ping", "description": "Health check endpoints" }, { "name": "Venues", "description": "Theater and venue lookup" }, { "name": "Productions", "description": "Movie and production information" }, { "name": "Showtimes", "description": "Showtime schedules and ticket availability" }, { "name": "Ordering", "description": "Ticket ordering, checkout, seat selection, and order management" } ], "paths": { "/partner/ping": { "get": { "operationId": "ping", "summary": "Health check", "tags": ["Ping"], "responses": { "200": { "description": "Service is healthy" }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/partner/v1/venue/details/byLocation": { "get": { "operationId": "getVenueDetailsByLocation", "summary": "Get venue details by geographic location", "tags": ["Venues"], "parameters": [ { "name": "lat", "in": "query", "required": true, "schema": { "type": "number" }, "description": "Latitude of the search center" }, { "name": "lon", "in": "query", "required": true, "schema": { "type": "number" }, "description": "Longitude of the search center" }, { "name": "radius", "in": "query", "required": true, "schema": { "type": "number", "maximum": 80 }, "description": "Search radius in kilometers (max 80)" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Page number for pagination" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "default": 25, "maximum": 100 }, "description": "Number of results per page (default 25, max 100)" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VenueDetailsResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/partner/v1/venue/details/byIds": { "post": { "operationId": "getVenueDetailsByIds", "summary": "Get venue details by IDs", "tags": ["Venues"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetVenueDetailsRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VenueDetailsResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/partner/v1/venue/details/search": { "get": { "operationId": "searchVenueDetails", "summary": "Search venue details by term", "tags": ["Venues"], "parameters": [ { "name": "term", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Search term" }, { "name": "lat", "in": "query", "required": true, "schema": { "type": "number" }, "description": "Latitude of the search center" }, { "name": "lon", "in": "query", "required": true, "schema": { "type": "number" }, "description": "Longitude of the search center" }, { "name": "radius", "in": "query", "required": true, "schema": { "type": "number" }, "description": "Search radius in kilometers" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Number of results per page" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Page number for pagination" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VenueDetailsResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/partner/v1/venues/byVendorVenueId/{vendorVenueId}": { "get": { "operationId": "getVenueByVendorVenueId", "summary": "Get venue by vendor venue ID", "tags": ["Venues"], "parameters": [ { "name": "vendorVenueId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The vendor-specific venue identifier" }, { "name": "circuitId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Circuit identifier" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VenueDetailsResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/partner/v1/production/ids/byVenue/{venueId}": { "get": { "operationId": "getProductionIdsByVenue", "summary": "Get production IDs by venue", "tags": ["Productions"], "parameters": [ { "name": "venueId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The venue identifier" }, { "name": "isoStartDate", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ISO 8601 start date filter" }, { "name": "isoEndDate", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ISO 8601 end date filter" }, { "name": "localStartDate", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Local start date filter" }, { "name": "localEndDate", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Local end date filter" }, { "name": "marketplaceId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Marketplace identifier" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductionIdsResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/partner/v1/production/details/byIds": { "post": { "operationId": "getProductionDetailsByIds", "summary": "Get production details by IDs", "tags": ["Productions"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProductionDetailsRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductionDetailsResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/partner/v1/production/search/byName": { "get": { "operationId": "searchProductionsByName", "summary": "Search productions by name", "tags": ["Productions"], "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Production name to search for" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductionDetailsResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/partner/v1/productions/byVendorProductionId/{vendorProductionId}": { "get": { "operationId": "getProductionByVendorProductionId", "summary": "Get production by vendor production ID", "tags": ["Productions"], "parameters": [ { "name": "vendorProductionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The vendor-specific production identifier" }, { "name": "circuitId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Circuit identifier" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductionDetailsResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/partner/v1/showtime/details/byVenue/{venueId}": { "get": { "operationId": "getShowtimeDetailsByVenue", "summary": "Get showtime details by venue", "tags": ["Showtimes"], "parameters": [ { "name": "venueId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The venue identifier" }, { "name": "isoStartDate", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ISO 8601 start date filter" }, { "name": "isoEndDate", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ISO 8601 end date filter" }, { "name": "localStartDate", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Local start date filter" }, { "name": "localEndDate", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Local end date filter" }, { "name": "productionIds", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated list of production IDs to filter by" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShowtimeDetailsResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/partner/v1/showtime/details/byIds": { "post": { "operationId": "getShowtimeDetailsByIds", "summary": "Get showtime details by IDs", "tags": ["Showtimes"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetShowtimeDetailsRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShowtimeDetailsResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/partner/v1/showtime/details/forVenues": { "post": { "operationId": "getShowtimeDetailsForVenues", "summary": "Get showtime details for multiple venues", "tags": ["Showtimes"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetShowtimesForVenuesRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShowtimeDetailsForVenuesResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/partner/v1/venues/{venueId}/showtimes/byVendorShowtimeId/{vendorShowtimeId}": { "get": { "operationId": "getShowtimeByVendorShowtimeIdAndVenueId", "summary": "Get showtime by vendor showtime ID and venue ID", "tags": ["Showtimes"], "parameters": [ { "name": "venueId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The venue identifier" }, { "name": "vendorShowtimeId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The vendor-specific showtime identifier" }, { "name": "circuitId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Circuit identifier" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShowtimeDetailsResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/partner/v1/venues/byVendorVenueId/{vendorVenueId}/showtimes/byVendorShowtimeId/{vendorShowtimeId}": { "get": { "operationId": "getShowtimeByVendorIds", "summary": "Get showtime by vendor venue ID and vendor showtime ID", "tags": ["Showtimes"], "parameters": [ { "name": "vendorVenueId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The vendor-specific venue identifier" }, { "name": "vendorShowtimeId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The vendor-specific showtime identifier" }, { "name": "circuitId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Circuit identifier" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShowtimeDetailsResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/ordering/v2/aggregation/checkout/refresh": { "post": { "operationId": "refreshCheckout", "summary": "Refresh checkout with aggregated pricing, fees, and available offers", "tags": ["Ordering"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutRefreshRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutRefreshResponseV2" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/ordering/v1/discovery/auditoriums": { "get": { "operationId": "discoverAuditoriums", "summary": "Discover auditorium layout and available seats for a showtime", "tags": ["Ordering"], "parameters": [ { "name": "showtimeId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The showtime identifier to get auditorium info for" }, { "name": "tickets", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Ticket selection parameter" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLayoutResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/ordering/v1/customer/account/guest": { "post": { "operationId": "createGuestAccount", "summary": "Create a guest customer account for checkout", "tags": ["Ordering"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGuestAccountRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuestAccountResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/ordering/v1/customer/account/authenticate": { "post": { "operationId": "authenticateCustomer", "summary": "Authenticate an existing customer account", "tags": ["Ordering"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/ordering/v1/inventory/lease": { "post": { "operationId": "leaseInventory", "summary": "Lease (temporarily hold) seats for a showtime", "description": "Requires ordering authentication headers (X-Atom-Timestamp, X-Atom-AuthToken, X-Atom-DeviceSignature, X-Atom-Signature, X-Atom-DeviceId, X-Atom-AdId) in addition to x-api-key.", "tags": ["Ordering"], "security": [ { "ApiKeyAuth": [], "OrderingAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeaseInventoryRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeaseInventoryResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/ordering/v2/customer/orders/preview": { "post": { "operationId": "previewOrder", "summary": "Preview an order with full cost breakdown before placing it", "description": "Requires ordering authentication headers (X-Atom-Timestamp, X-Atom-AuthToken, X-Atom-DeviceSignature, X-Atom-Signature, X-Atom-DeviceId, X-Atom-AdId) in addition to x-api-key.", "tags": ["Ordering"], "security": [ { "ApiKeyAuth": [], "OrderingAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewOrderResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/ordering/v1/customer/orders": { "post": { "operationId": "placeOrder", "summary": "Place a ticket order with payment", "description": "Requires ordering authentication headers (X-Atom-Timestamp, X-Atom-AuthToken, X-Atom-DeviceSignature, X-Atom-Signature, X-Atom-DeviceId, X-Atom-AdId) in addition to x-api-key.", "tags": ["Ordering"], "security": [ { "ApiKeyAuth": [], "OrderingAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/ordering/v1/customer/orders/{id}/status": { "get": { "operationId": "getOrderStatus", "summary": "Get the current status of an order", "description": "Requires ordering authentication headers (X-Atom-Timestamp, X-Atom-AuthToken, X-Atom-DeviceSignature, X-Atom-Signature, X-Atom-DeviceId, X-Atom-AdId) in addition to x-api-key.", "tags": ["Ordering"], "security": [ { "ApiKeyAuth": [], "OrderingAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The order identifier" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderStatusResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/ordering/v2/customer/orders/{id}/summary": { "get": { "operationId": "getOrderSummary", "summary": "Get a detailed summary of a completed order", "description": "Requires ordering authentication headers (X-Atom-Timestamp, X-Atom-AuthToken, X-Atom-DeviceSignature, X-Atom-Signature, X-Atom-DeviceId, X-Atom-AdId) in addition to x-api-key.", "tags": ["Ordering"], "security": [ { "ApiKeyAuth": [], "OrderingAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The order identifier" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderSummaryResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } }, "/v1/customer/orders/{id}": { "delete": { "operationId": "cancelOrder", "summary": "Cancel an existing order", "description": "Requires ordering authentication headers (X-Atom-Timestamp, X-Atom-AuthToken, X-Atom-DeviceSignature, X-Atom-Signature, X-Atom-DeviceId, X-Atom-AdId) in addition to x-api-key.", "tags": ["Ordering"], "security": [ { "ApiKeyAuth": [], "OrderingAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The order identifier" } ], "responses": { "200": { "description": "Order cancelled successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCancellationResponse" } } } }, "429": { "description": "Rate limit exceeded. Reduce request frequency and retry." } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "API key provided by Atom Tickets. Required for all endpoints." }, "OrderingAuth": { "type": "apiKey", "in": "header", "name": "X-Atom-AuthToken", "description": "Ordering endpoints (Lease Inventory through Cancel Order) require additional authentication headers: X-Atom-Timestamp (ISO 8601 UTC), X-Atom-AuthToken (from authentication response), X-Atom-DeviceSignature (from device info), X-Atom-Signature (from request parts + auth info), X-Atom-DeviceId (device identifier), X-Atom-AdId (ad serving identifier). See the Authentication Headers documentation for details." } }, "schemas": { "PageInfo": { "type": "object", "properties": { "page": { "type": "integer", "description": "Current page number" }, "pageSize": { "type": "integer", "description": "Number of results per page" }, "totalPages": { "type": "integer", "description": "Total number of pages available" } } }, "LatLonPair": { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude" }, "lon": { "type": "number", "description": "Longitude" } } }, "ISODateBounds": { "type": "object", "properties": { "isoStartDate": { "type": "string", "description": "ISO 8601 start date" }, "isoEndDate": { "type": "string", "description": "ISO 8601 end date" } } }, "LocalDateBounds": { "type": "object", "properties": { "localStartDate": { "type": "string", "description": "Local start date" }, "localEndDate": { "type": "string", "description": "Local end date" } } }, "Address": { "type": "object", "properties": { "line": { "type": "string", "description": "Street address" }, "city": { "type": "string", "description": "City name" }, "state": { "type": "string", "description": "State or province" }, "postal": { "type": "string", "description": "Postal or ZIP code" }, "lat": { "type": "number", "description": "Latitude of the address" }, "lon": { "type": "number", "description": "Longitude of the address" } } }, "Properties": { "type": "object", "properties": { "supportsConcessions": { "type": "boolean", "description": "Whether the venue supports concession orders" }, "supported": { "type": "boolean", "description": "Whether the venue is currently supported" } } }, "Venue": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique venue identifier" }, "name": { "type": "string", "description": "Venue display name" }, "address": { "$ref": "#/components/schemas/Address" }, "properties": { "$ref": "#/components/schemas/Properties" }, "venueUrl": { "type": "string", "description": "URL to the venue page on Atom Tickets" }, "atomVenueId": { "type": "string", "description": "Atom-specific venue identifier" } } }, "VenueDetail": { "type": "object", "properties": { "venue": { "$ref": "#/components/schemas/Venue" }, "kmDistance": { "type": "number", "description": "Distance from the search location in kilometers" } } }, "GetVenueDetailsRequest": { "type": "object", "required": ["ids"], "properties": { "ids": { "type": "array", "items": { "type": "string" }, "description": "List of venue IDs to retrieve" }, "location": { "$ref": "#/components/schemas/LatLonPair" }, "page": { "type": "integer", "description": "Page number for pagination" }, "pageSize": { "type": "integer", "description": "Number of results per page" } } }, "VenueDetailsResponse": { "type": "object", "properties": { "venueDetails": { "type": "array", "items": { "$ref": "#/components/schemas/VenueDetail" }, "description": "List of venue details" }, "pageInfo": { "$ref": "#/components/schemas/PageInfo" } } }, "ProductionIdsResponse": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "description": "List of production IDs" } } }, "ImageData": { "type": "object", "properties": { "coverImageUrl": { "type": "string", "description": "URL of the cover image" }, "promoImageUrls": { "type": "array", "items": { "type": "string" }, "description": "URLs of promotional images" } } }, "TrailerData": { "type": "object", "properties": { "trailerUrls": { "type": "array", "items": { "type": "string" }, "description": "URLs of trailers" } } }, "ProductionMedia": { "type": "object", "properties": { "imageData": { "$ref": "#/components/schemas/ImageData" }, "trailerData": { "$ref": "#/components/schemas/TrailerData" } } }, "Cast": { "type": "object", "properties": { "name": { "type": "string", "description": "Actor name" }, "characterName": { "type": "string", "description": "Character portrayed" } } }, "Crew": { "type": "object", "properties": { "name": { "type": "string", "description": "Crew member name" }, "role": { "type": "string", "description": "Role (e.g. Director, Producer)" } } }, "Contributors": { "type": "object", "properties": { "cast": { "type": "array", "items": { "$ref": "#/components/schemas/Cast" }, "description": "List of cast members" }, "crew": { "type": "array", "items": { "$ref": "#/components/schemas/Crew" }, "description": "List of crew members" } } }, "ProductionDetail": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique production identifier" }, "name": { "type": "string", "description": "Production title" }, "productionMedia": { "$ref": "#/components/schemas/ProductionMedia" }, "contributors": { "$ref": "#/components/schemas/Contributors" }, "synopsis": { "type": "string", "description": "Plot summary" }, "advisoryRating": { "type": "string", "description": "MPAA rating (e.g. PG-13, R)" }, "genres": { "type": "array", "items": { "type": "string" }, "description": "List of genres" }, "runtimeMinutes": { "type": "integer", "description": "Runtime in minutes" }, "releaseDate": { "type": "string", "description": "Release date" }, "atomUserScore": { "type": "number", "description": "Atom user rating score" }, "productionUrl": { "type": "string", "description": "URL to the production page on Atom Tickets" }, "distributor": { "type": "string", "description": "Film distributor" }, "imdbId": { "type": "string", "description": "IMDB identifier" }, "atomProductionId": { "type": "string", "description": "Atom-specific production identifier" } } }, "GetProductionDetailsRequest": { "type": "object", "required": ["ids"], "properties": { "ids": { "type": "array", "items": { "type": "string" }, "description": "List of production IDs to retrieve" }, "marketplaceId": { "type": "string", "description": "Marketplace identifier" }, "page": { "type": "integer", "description": "Page number for pagination" }, "pageSize": { "type": "integer", "description": "Number of results per page" } } }, "ProductionDetailsResponse": { "type": "object", "properties": { "productionDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ProductionDetail" }, "description": "List of production details" }, "pageInfo": { "$ref": "#/components/schemas/PageInfo" } } }, "Attribute": { "type": "object", "properties": { "id": { "type": "string", "description": "Attribute identifier" }, "type": { "type": "string", "description": "Attribute type" }, "iconUrl": { "type": "string", "description": "URL to the attribute icon" }, "friendlyName": { "type": "string", "description": "Human-readable attribute name" }, "description": { "type": "string", "description": "Attribute description" } } }, "Price": { "type": "object", "properties": { "value": { "type": "number", "description": "Price amount" }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code (e.g. USD)" } } }, "Offer": { "type": "object", "properties": { "label": { "type": "string", "description": "Offer label (e.g. Adult, Child, Senior)" }, "price": { "$ref": "#/components/schemas/Price" } } }, "OfferData": { "type": "object", "properties": { "offers": { "type": "array", "items": { "$ref": "#/components/schemas/Offer" }, "description": "Available ticket offers" } } }, "ShowtimeDetail": { "type": "object", "properties": { "showtimeId": { "type": "string", "description": "Unique showtime identifier" }, "productionId": { "type": "string", "description": "Associated production identifier" }, "venueId": { "type": "string", "description": "Associated venue identifier" }, "offerData": { "$ref": "#/components/schemas/OfferData" }, "utcShowtimeStart": { "type": "string", "description": "Showtime start in UTC" }, "localShowtimeStart": { "type": "string", "description": "Showtime start in local timezone" }, "attributes": { "type": "array", "items": { "type": "string" }, "description": "Attribute IDs for this showtime (reference attributeMap for details)" }, "checkoutUrl": { "type": "string", "description": "URL to purchase tickets for this showtime" }, "availableInventory": { "type": "integer", "description": "Number of available seats" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags associated with this showtime" } } }, "PreOrderDetail": { "type": "object", "properties": { "productionId": { "type": "string", "description": "Associated production identifier" }, "venueId": { "type": "string", "description": "Associated venue identifier" }, "showtimeDays": { "type": "array", "items": { "type": "string" }, "description": "Days when pre-order showtimes are available" } } }, "GetShowtimeDetailsRequest": { "type": "object", "required": ["ids"], "properties": { "ids": { "type": "array", "items": { "type": "string" }, "description": "List of showtime IDs to retrieve" }, "page": { "type": "integer", "description": "Page number for pagination" }, "pageSize": { "type": "integer", "description": "Number of results per page" } } }, "GetShowtimesForVenuesRequest": { "type": "object", "required": ["venueIds"], "properties": { "venueIds": { "type": "array", "items": { "type": "string" }, "description": "List of venue IDs to get showtimes for" }, "productionIds": { "type": "array", "items": { "type": "string" }, "description": "Optional list of production IDs to filter by" }, "isoDateBounds": { "$ref": "#/components/schemas/ISODateBounds" }, "localDateBounds": { "$ref": "#/components/schemas/LocalDateBounds" }, "includeProductionDetails": { "type": "boolean", "description": "Whether to include production details in the response" }, "marketplaceId": { "type": "string", "description": "Marketplace identifier" } } }, "ShowtimeDetailsResponse": { "type": "object", "properties": { "showtimeDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ShowtimeDetail" }, "description": "List of showtime details" }, "preOrderDetails": { "type": "array", "items": { "$ref": "#/components/schemas/PreOrderDetail" }, "description": "List of pre-order details" }, "attributeMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Attribute" }, "description": "Map of attribute IDs to attribute details" } } }, "VenueShowtimeDetails": { "type": "object", "properties": { "showtimeDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ShowtimeDetail" }, "description": "List of showtime details for this venue" }, "preOrderDetails": { "type": "array", "items": { "$ref": "#/components/schemas/PreOrderDetail" }, "description": "List of pre-order details for this venue" } } }, "ShowtimeDetailsForVenuesResponse": { "type": "object", "properties": { "venueShowtimeDetailsMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/VenueShowtimeDetails" }, "description": "Map of venue IDs to their showtime details" }, "attributeMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Attribute" }, "description": "Map of attribute IDs to attribute details" }, "productionDetailsMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ProductionDetail" }, "description": "Map of production IDs to production details (when includeProductionDetails is true)" } } }, "CheckoutRefreshRequest": { "type": "object", "required": ["showtimeId", "promotions"], "properties": { "showtimeId": { "type": "string", "description": "Showtime identifier" }, "promotions": { "type": "array", "items": { "type": "string" }, "description": "List of promotion codes to apply" }, "includeAreaCategory": { "type": "boolean", "description": "Whether to include area category in the response" }, "accessToken": { "type": "string", "description": "Access token for authenticated checkout scenarios" } } }, "CheckoutRefreshResponseV2": { "type": "object", "required": ["surveyDetailResponse", "showtimesResponse"], "properties": { "surveyDetailResponse": { "type": "object", "description": "Survey details associated with the showtime" }, "showtimesResponse": { "type": "object", "description": "Showtime and ticket offer data" }, "offerChangedMessage": { "type": "string", "description": "Message displayed when offers have changed" }, "maxTicketQuantity": { "type": "integer", "description": "Maximum number of tickets allowed per order" }, "agePolicyLink": { "type": "string", "description": "Link to the venue's age policy" }, "shippingDeliveryMessage": { "type": "string", "description": "Shipping or delivery instructions" }, "shippingFAQSupportLink": { "type": "string", "description": "Link to shipping FAQ" } } }, "GetLayoutResponse": { "type": "object", "required": ["layoutArea", "legend", "occupiedSeats", "numAvailable"], "properties": { "layoutArea": { "type": "object", "description": "Seating layout structure" }, "legend": { "type": "array", "items": { "type": "object", "description": "Legend entry describing a seat category" }, "description": "Legend entries describing seat categories" }, "occupiedSeats": { "type": "object", "additionalProperties": true, "description": "Map of seat ID to the customer occupying it" }, "recommendedSeats": { "type": "array", "items": { "type": "string" }, "description": "Suggested seat IDs for the current ticket count" }, "numAvailable": { "type": "integer", "description": "Total number of available seats" } } }, "CreateGuestAccountRequest": { "type": "object", "required": ["email", "firstName", "lastName", "attributionMap"], "properties": { "email": { "type": "string", "description": "Guest email address" }, "firstName": { "type": "string", "description": "Guest first name" }, "lastName": { "type": "string", "description": "Guest last name" }, "attributionMap": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Attribution key-value pairs" } } }, "GuestAccountResponse": { "type": "object", "required": ["authToken", "accountId", "identityId", "identityValue"], "properties": { "authToken": { "type": "string", "description": "Authentication token for the session" }, "accountId": { "type": "string", "description": "Unique account identifier" }, "identityId": { "type": "string", "description": "Identity record identifier" }, "identityValue": { "type": "string", "description": "Identity value (e.g. email)" } } }, "AuthenticateRequest": { "type": "object", "required": ["identityValue", "password"], "properties": { "identityValue": { "type": "string", "description": "User identity (e.g. email or username)" }, "password": { "type": "string", "description": "User password" } } }, "AuthenticateResponse": { "type": "object", "required": [ "token", "accountId", "identities", "customer", "atomToken", "privateKey", "signupPromoId" ], "properties": { "token": { "type": "string", "description": "Session token" }, "accountId": { "type": "string", "description": "Unique account identifier" }, "identities": { "type": "array", "items": { "type": "object" }, "description": "List of identities linked to the account" }, "customer": { "type": "object", "description": "Customer profile data" }, "atomToken": { "type": "string", "description": "Atom-specific authentication token" }, "privateKey": { "type": "string", "description": "Private key for request signing" }, "signupPromoId": { "type": "string", "description": "Promotion ID applied at signup" }, "providerData": { "type": "object", "additionalProperties": true, "description": "Additional provider-specific data" } } }, "LeaseItem": { "type": "object", "required": ["productId", "offerId", "seatIds"], "properties": { "productId": { "type": "string", "description": "Product identifier from checkout refresh" }, "offerId": { "type": "string", "description": "Offer identifier from checkout refresh" }, "seatIds": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "description": "Set of seat IDs to lease" } } }, "LeaseInventoryRequest": { "type": "object", "required": ["clientRequestId", "leaseItems"], "properties": { "clientRequestId": { "type": "string", "description": "Client-generated idempotency key. Use the same value for lease, preview, and create order calls within one checkout flow." }, "leaseItems": { "type": "array", "items": { "$ref": "#/components/schemas/LeaseItem" }, "description": "Items to lease" } } }, "LeaseInventoryResponse": { "type": "object", "required": ["leaseDurationSeconds"], "properties": { "leaseDurationSeconds": { "type": "integer", "description": "Duration in seconds the lease is held" } } }, "OrderParameters": { "type": "object", "required": [ "lineItems", "channel", "clientVersion", "clientRequestId" ], "properties": { "lineItems": { "type": "array", "items": { "type": "object" }, "description": "Line items in the order" }, "channel": { "type": "string", "description": "Channel identifier (e.g. app, web)" }, "clientVersion": { "type": "string", "description": "Client application version" }, "clientRequestId": { "type": "string", "description": "Client-generated idempotency key. Must match the value used in lease inventory." }, "paymentInstrumentId": { "type": "string", "description": "Saved payment instrument identifier" }, "externalPaymentNonce": { "type": "string", "description": "Payment nonce from an external provider" }, "externalPaymentProvider": { "type": "string", "description": "External payment provider name" }, "promotionCode": { "type": "string", "description": "Single promotion code to apply" }, "loyaltyCardNumber": { "type": "string", "description": "Loyalty card number for rewards" }, "isGuestOrder": { "type": "boolean", "description": "Whether this is a guest (non-authenticated) order" }, "paymentDeviceData": { "type": "string", "description": "Device data for fraud detection" }, "shippingAddress": { "type": "object", "description": "Shipping address for physical delivery" }, "vendorData": { "type": "object", "description": "Vendor-specific data" }, "paymentProcessor": { "type": "string", "description": "Payment processor to use (e.g. PartnerPay)" }, "tenantId": { "type": "string", "description": "Tenant identifier for multi-tenant setups" }, "associateTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Associate attribution tags" }, "storedValueCards": { "type": "array", "items": { "type": "object" }, "description": "Stored value cards to apply" }, "paymentData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional payment key-value data" }, "paymentInfo": { "type": "object", "description": "Structured payment information" }, "excludeAtomGiftCard": { "type": "boolean", "description": "Exclude Atom gift card balance from payment" }, "showtimeTags": { "type": "array", "items": { "type": "object" }, "description": "Tags associated with the showtime" }, "excludeAtomCredit": { "type": "boolean", "description": "Exclude Atom credit balance from payment" }, "promotionCodes": { "type": "array", "items": { "type": "string" }, "description": "Multiple promotion codes to apply" }, "vendorBenefits": { "type": "object", "description": "Vendor benefit details" }, "redemptionCodes": { "type": "array", "items": { "type": "string" }, "description": "Redemption codes to apply" } } }, "CreateOrderRequest": { "type": "object", "required": ["orderParameters"], "properties": { "orderParameters": { "$ref": "#/components/schemas/OrderParameters" } } }, "PreviewOrderResponse": { "type": "object", "required": ["receipt"], "properties": { "receipt": { "type": "object", "description": "Itemized receipt for the previewed order" }, "autoAddedItems": { "type": "array", "items": { "type": "object" }, "description": "Items automatically added (e.g. service fees)" } } }, "CreateOrderResponse": { "type": "object", "required": ["orderId", "eventId"], "properties": { "orderId": { "type": "string", "description": "Unique order identifier" }, "eventId": { "type": "string", "description": "Associated event identifier" } } }, "OrderStatusResponse": { "type": "object", "required": ["orderStatus"], "properties": { "orderStatus": { "type": "string", "description": "Current order status" }, "orderStatusReason": { "type": "string", "description": "Human-readable reason for the status" }, "orderStatusReasonCode": { "type": "string", "description": "Machine-readable status reason code" } } }, "OrderSummaryResponse": { "type": "object", "required": [ "orderId", "eventId", "orderStatus", "receipt", "venueInfo", "showtime", "tickets", "concessions" ], "properties": { "orderId": { "type": "string", "description": "Unique order identifier" }, "eventId": { "type": "string", "description": "Associated event identifier" }, "orderStatus": { "type": "string", "description": "Current order status" }, "orderStatusReason": { "type": "string", "description": "Human-readable reason for the status" }, "orderStatusReasonCode": { "type": "string", "description": "Machine-readable status reason code" }, "receipt": { "type": "object", "description": "Itemized receipt" }, "venueInfo": { "type": "object", "description": "Venue information for the order" }, "showtime": { "type": "object", "description": "Showtime details" }, "tickets": { "type": "array", "items": { "type": "object" }, "description": "Tickets included in the order" }, "concessions": { "type": "array", "items": { "type": "object" }, "description": "Concession items in the order" } } }, "OrderCancellationResponse": { "type": "object", "required": ["orderId", "cancellationStatus"], "properties": { "orderId": { "type": "string", "description": "Unique order identifier" }, "cancellationStatus": { "type": "string", "description": "Status of the cancellation" }, "refundAmount": { "type": "number", "description": "Refund amount, if applicable" }, "cancellationReason": { "type": "string", "description": "Reason the cancellation occurred" } } }, "OrderingError": { "type": "object", "description": "Error codes that may be returned in ordering workflow responses.", "properties": { "errorCode": { "type": "string", "enum": [ "INVENTORY_UNAVAILABLE", "SEAT_UNAVAILABLE", "DUPLICATE_CLIENT_REQUEST_ID", "FRAUD_DETECTED", "INVALID_CREDIT_CARD_NUMBER", "PROCESSOR_DECLINED", "GENERIC_ERROR", "ORDER_NOT_FOUND", "ORDER_NOT_CANCELLABLE", "CANCELLATION_WINDOW_EXPIRED", "REFUND_PROCESSING_ERROR" ], "description": "Error code identifying the type of failure" }, "message": { "type": "string", "description": "Human-readable error message" } } } } } }