Refresh checkout details for a showtime, including ticket offers and promotions.
| |
|---|
| Method | POST |
| Route | /ordering/v2/aggregation/checkout/refresh |
| Header | Required | Description |
|---|
x-api-key | Yes | API key |
| Field | Type | Required | Description |
|---|
showtimeId | String | Yes | Showtime identifier |
promotions | List[String] | Yes | List of promotion codes |
includeAreaCategory | Boolean | No | Include area category details |
accessToken | String | No | Access token |
Returns CheckoutRefreshResponseV2 with:
| Field | Type | Required | Description |
|---|
surveyDetailResponse | Object | Yes | Survey details |
showtimesResponse | Object | Yes | Showtime information |
offerChangedMessage | String | No | Offer change notification |
maxTicketQuantity | Int | No | Maximum ticket quantity |
agePolicyLink | String | No | Link to age policy |
shippingDeliveryMessage | String | No | Shipping delivery message |
shippingFAQSupportLink | String | No | Link to shipping FAQ |
Retrieve auditorium seat layout for a showtime.
| |
|---|
| Method | GET |
| Route | /ordering/v1/discovery/auditoriums |
| Header | Required | Description |
|---|
x-api-key | Yes | API key |
| Parameter | Type | Required | Description |
|---|
showtimeId | String | Yes | Showtime identifier |
tickets | String | Yes | Ticket selection parameter |
Returns GetLayoutResponse with:
| Field | Type | Required | Description |
|---|
layoutArea | LayoutArea | Yes | Seat layout area |
legend | List[LegendEntry] | Yes | Legend entries for seat types |
occupiedSeats | Map | Yes | Map of occupied seats |
recommendedSeats | Object | No | Recommended seat selections |
numAvailable | Int | Yes | Number of available seats |
Create a guest account for checkout without full registration.
| |
|---|
| Method | POST |
| Route | /ordering/v1/customer/account/guest |
| Header | Required | Description |
|---|
x-api-key | Yes | API key |
| Field | Type | Required | Description |
|---|
email | String | Yes | Guest email address |
firstName | String | Yes | Guest first name |
lastName | String | Yes | Guest last name |
attributionMap | Map[String, String] | Yes | Attribution key-value pairs |
Returns GuestAccountResponse with:
| Field | Type | Description |
|---|
authToken | String | Authentication token |
accountId | String | Account identifier |
identityId | String | Identity identifier |
identityValue | String | Identity value |
Authenticate an existing user account.
| |
|---|
| Method | POST |
| Route | /ordering/v1/customer/account/authenticate |
| Header | Required | Description |
|---|
x-api-key | Yes | API key |
| Field | Type | Required | Description |
|---|
identityValue | String | Yes | User identity value |
password | String | Yes | User password |
Returns AuthenticateResponse with:
| Field | Type | Required | Description |
|---|
token | String | Yes | Authentication token |
accountId | String | Yes | Account identifier |
identities | Object | Yes | User identities |
customer | Object | Yes | Customer details |
atomToken | String | Yes | Atom authentication token |
privateKey | String | Yes | Private key for signing |
signupPromoId | String | Yes | Signup promotion identifier |
providerData | Object | No | Additional provider data |
Reserve seats or tickets temporarily before placing an order.
| |
|---|
| Method | POST |
| Route | /ordering/v1/inventory/lease |
Requires all authentication headers. See Authentication Headers.
| Field | Type | Required | Description |
|---|
clientRequestId | String | Yes | Client request identifier |
leaseItems | List[LeaseItem] | Yes | Items to lease |
LeaseItem:
| Field | Type | Required | Description |
|---|
productId | String | Yes | Product identifier |
offerId | String | Yes | Offer identifier |
seatIds | List[String] | Yes | List of seat IDs |
Returns LeaseInventoryResponse with:
| Field | Type | Description |
|---|
leaseDurationSeconds | Int | Duration of the lease in seconds |
Preview an order before final submission to see the receipt breakdown.
| |
|---|
| Method | POST |
| Route | /ordering/v2/customer/orders/preview |
Requires all authentication headers. See Authentication Headers.
CreateOrderRequest with orderParameters (OrderParameters) including:
| Field | Type | Description |
|---|
lineItems | List | Order line items |
channel | String | Order channel |
clientVersion | String | Client version |
clientRequestId | String | Client request identifier |
paymentInstrumentId | String | Payment instrument identifier |
isGuestOrder | Boolean | Whether this is a guest order |
associateTags | Map[String, String] | Associated tags |
Returns PreviewOrderResponse with:
| Field | Type | Required | Description |
|---|
receipt | Receipt | Yes | Order receipt breakdown |
autoAddedItems | List | No | Automatically added items |
Submit a finalized order for processing.
| |
|---|
| Method | POST |
| Route | /ordering/v1/customer/orders |
Requires all authentication headers. See Authentication Headers.
Same CreateOrderRequest as Preview Order.
Returns CreateOrderResponse with:
| Field | Type | Description |
|---|
orderId | String | Order identifier |
eventId | String | Event identifier |
Check the current status of an order.
| |
|---|
| Method | GET |
| Route | /ordering/v1/customer/orders/:id/status |
Requires all authentication headers. See Authentication Headers.
| Parameter | Type | Required | Description |
|---|
id | String | Yes | Order identifier |
Returns OrderStatusResponse with:
| Field | Type | Required | Description |
|---|
orderStatus | String | Yes | Current order status |
orderStatusReason | String | No | Reason for order status |
orderStatusReasonCode | String | No | Status reason code |
Retrieve the full summary of a completed order.
| |
|---|
| Method | GET |
| Route | /ordering/v2/customer/orders/:id/summary |
Requires all authentication headers. See Authentication Headers.
| Parameter | Type | Required | Description |
|---|
id | String | Yes | Order identifier |
Returns OrderSummaryResponse with:
| Field | Type | Required | Description |
|---|
orderId | String | Yes | Order identifier |
eventId | String | Yes | Event identifier |
orderStatus | String | Yes | Current order status |
orderStatusReason | String | No | Reason for order status |
orderStatusReasonCode | String | No | Status reason code |
receipt | Object | Yes | Order receipt |
venueInfo | Object | Yes | Venue information |
showtime | Object | Yes | Showtime details |
tickets | Object | Yes | Ticket details |
concessions | Object | Yes | Concession details |
Cancel an existing order.
| |
|---|
| Method | DELETE |
| Route | /v1/customer/orders/:id |
Requires all authentication headers. See Authentication Headers.
| Parameter | Type | Required | Description |
|---|
id | String | Yes | Order identifier |
Returns OrderCancellationResponse with:
| Field | Type | Required | Description |
|---|
orderId | String | Yes | Order identifier |
cancellationStatus | String | Yes | Status of cancellation |
refundAmount | BigDecimal | No | Refund amount |
cancellationReason | String | No | Reason for cancellation |
Endpoints 5 through 10 (Lease Inventory, Preview Order, Create Order, Poll Order Status, Get Order Summary, and Cancel Order) require the following authentication headers in addition to x-api-key:
| Header | Description |
|---|
X-Atom-Timestamp | Current time as ISO 8601 date with UTC timezone |
X-Atom-AuthToken | Auth token from the authentication call |
X-Atom-DeviceSignature | Generated using device information |
X-Atom-Signature | Generated using request parts and authentication info |
X-Atom-DeviceId | Device identifier |
X-Atom-AdId | Ad serving identifier |