Ordering Models

Request Models

CheckoutRefreshRequest

Refreshes checkout data for a given showtime, including available promotions and ticket policies.

CheckoutRefreshRequest {
  showtimeId: String,
  promotions: List[String],
  includeAreaCategory: Option[Boolean],
  accessToken: Option[String]
}

Field	Type	Required	Description
showtimeId	String	Yes	Showtime to refresh checkout data for
promotions	List[String]	Yes	List of promotion codes to apply
includeAreaCategory	Boolean	No	Whether to include area category in the response
accessToken	String	No	Access token for authenticated checkout scenarios

CreateGuestAccountRequest

Creates a guest account for unauthenticated ordering.

CreateGuestAccountRequest {
  email: String,
  firstName: String,
  lastName: String,
  attributionMap: Map[String, String]
}

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

AuthenticateRequest

Authenticates a user by identity and password.

AuthenticateRequest {
  identityValue: String,
  password: String
}

Field	Type	Required	Description
identityValue	String	Yes	User identity (e.g. email or username)
password	String	Yes	User password

LeaseInventoryRequest

Requests a temporary hold on inventory items (seats/tickets).

LeaseInventoryRequest {
  clientRequestId: String,
  leaseItems: List[LeaseItem]
}

Field	Type	Required	Description
clientRequestId	String	Yes	Client-generated idempotency key
leaseItems	List[LeaseItem]	Yes	Items to lease

CreateOrderRequest

Wraps order parameters to submit a new order.

CreateOrderRequest {
  orderParameters: OrderParameters
}

Field	Type	Required	Description
orderParameters	OrderParameters	Yes	Full order specification

Response Models

CheckoutRefreshResponseV2

Returned after refreshing checkout data for a showtime.

CheckoutRefreshResponseV2 {
  surveyDetailResponse: SurveyDetailResponse,
  showtimesResponse: ShowtimesResponseV2,
  offerChangedMessage: Option[String],
  maxTicketQuantity: Option[Int],
  agePolicyLink: Option[SupportLink],
  shippingDeliveryMessage: Option[String],
  shippingFAQSupportLink: Option[SupportLink]
}

Field	Type	Required	Description
surveyDetailResponse	SurveyDetailResponse	Yes	Survey details associated with the showtime
showtimesResponse	ShowtimesResponseV2	Yes	Showtime and ticket offer data
offerChangedMessage	String	No	Message displayed when offers have changed
maxTicketQuantity	Int	No	Maximum number of tickets allowed per order
agePolicyLink	SupportLink	No	Link to the venue’s age policy
shippingDeliveryMessage	String	No	Shipping or delivery instructions
shippingFAQSupportLink	SupportLink	No	Link to shipping FAQ

GetLayoutResponse

Returns seating layout information for a venue screen.

GetLayoutResponse {
  layoutArea: LayoutArea,
  legend: List[LegendEntry],
  occupiedSeats: Map[String, SimpleCustomer],
  recommendedSeats: Option[List[String]],
  numAvailable: Int
}

Field	Type	Required	Description
layoutArea	LayoutArea	Yes	Seating layout structure
legend	List[LegendEntry]	Yes	Legend entries describing seat categories
occupiedSeats	Map[String, SimpleCustomer]	Yes	Map of seat ID to the customer occupying it
recommendedSeats	List[String]	No	Suggested seat IDs for the current ticket count
numAvailable	Int	Yes	Total number of available seats

GuestAccountResponse

Returned after creating a guest account.

GuestAccountResponse {
  authToken: String,
  accountId: String,
  identityId: String,
  identityValue: String
}

Field	Type	Required	Description
authToken	String	Yes	Authentication token for the session
accountId	String	Yes	Unique account identifier
identityId	String	Yes	Identity record identifier
identityValue	String	Yes	Identity value (e.g. email)

AuthenticateResponse

Returned after successful authentication.

AuthenticateResponse {
  token: String,
  accountId: String,
  identities: List[Identity],
  customer: SimpleCustomer,
  atomToken: String,
  privateKey: String,
  signupPromoId: String,
  providerData: Option[Map[String, JsValue]]
}

Field	Type	Required	Description
token	String	Yes	Session token
accountId	String	Yes	Unique account identifier
identities	List[Identity]	Yes	List of identities linked to the account
customer	SimpleCustomer	Yes	Customer profile data
atomToken	String	Yes	Atom-specific authentication token
privateKey	String	Yes	Private key for request signing
signupPromoId	String	Yes	Promotion ID applied at signup
providerData	Map[String, JsValue]	No	Additional provider-specific data

LeaseInventoryResponse

Returned after successfully leasing inventory.

LeaseInventoryResponse {
  leaseDurationSeconds: Int
}

Field	Type	Required	Description
leaseDurationSeconds	Int	Yes	Duration in seconds the lease is held

PreviewOrderResponse

Returned when previewing an order before final submission.

PreviewOrderResponse {
  receipt: Receipt,
  autoAddedItems: Option[List[OrderItem]]
}

Field	Type	Required	Description
receipt	Receipt	Yes	Itemized receipt for the previewed order
autoAddedItems	List[OrderItem]	No	Items automatically added (e.g. service fees)

CreateOrderResponse

Returned after successfully creating an order.

CreateOrderResponse {
  orderId: String,
  eventId: String
}

Field	Type	Required	Description
orderId	String	Yes	Unique order identifier
eventId	String	Yes	Associated event identifier

OrderStatusResponse

Returns the current status of an order.

OrderStatusResponse {
  orderStatus: String,
  orderStatusReason: Option[String],
  orderStatusReasonCode: Option[String]
}

Field	Type	Required	Description
orderStatus	String	Yes	Current order status
orderStatusReason	String	No	Human-readable reason for the status
orderStatusReasonCode	String	No	Machine-readable status reason code

OrderSummaryResponse

Full order summary including receipt, venue, showtime, and line items.

OrderSummaryResponse {
  orderId: String,
  eventId: String,
  orderStatus: String,
  orderStatusReason: Option[String],
  orderStatusReasonCode: Option[String],
  receipt: Receipt,
  venueInfo: VenueInfo,
  showtime: Showtime,
  tickets: List[Ticket],
  concessions: List[Concession]
}

Field	Type	Required	Description
orderId	String	Yes	Unique order identifier
eventId	String	Yes	Associated event identifier
orderStatus	String	Yes	Current order status
orderStatusReason	String	No	Human-readable reason for the status
orderStatusReasonCode	String	No	Machine-readable status reason code
receipt	Receipt	Yes	Itemized receipt
venueInfo	VenueInfo	Yes	Venue information for the order
showtime	Showtime	Yes	Showtime details
tickets	List[Ticket]	Yes	Tickets included in the order
concessions	List[Concession]	Yes	Concession items in the order

OrderCancellationResponse

Returned after requesting an order cancellation.

OrderCancellationResponse {
  orderId: String,
  cancellationStatus: String,
  refundAmount: Option[BigDecimal],
  cancellationReason: Option[String]
}

Field	Type	Required	Description
orderId	String	Yes	Unique order identifier
cancellationStatus	String	Yes	Status of the cancellation
refundAmount	BigDecimal	No	Refund amount, if applicable
cancellationReason	String	No	Reason the cancellation occurred

Shared Types

LeaseItem

Represents a single item to lease (a product/offer with specific seats).

LeaseItem {
  productId: String,
  offerId: String,
  seatIds: Set[String]
}

Field	Type	Required	Description
productId	String	Yes	Product identifier
offerId	String	Yes	Offer identifier for this product
seatIds	Set[String]	Yes	Set of seat IDs to lease

OrderParameters

Complete set of parameters for creating or previewing an order.

OrderParameters {
  lineItems: List[LineItemParameters],
  channel: String,
  clientVersion: String,
  clientRequestId: String,
  paymentInstrumentId: Option[String],
  externalPaymentNonce: Option[String],
  externalPaymentProvider: Option[String],
  promotionCode: Option[String],
  loyaltyCardNumber: Option[String],
  isGuestOrder: Option[Boolean],
  paymentDeviceData: Option[String],
  shippingAddress: Option[Address],
  vendorData: Option[VendorData],
  paymentProcessor: Option[String],
  tenantId: Option[String],
  associateTags: Option[Map[String, String]],
  storedValueCards: Option[List[StoredValueCard]],
  paymentData: Option[Map[String, String]],
  paymentInfo: Option[PaymentInfo],
  excludeAtomGiftCard: Option[Boolean],
  showtimeTags: Option[List[Tag]],
  excludeAtomCredit: Option[Boolean],
  promotionCodes: Option[List[String]],
  vendorBenefits: Option[VendorBenefits],
  redemptionCodes: Option[List[String]]
}

Field	Type	Required	Description
lineItems	List[LineItemParameters]	Yes	Line items in the order
channel	String	Yes	Channel identifier (e.g. app, web)
clientVersion	String	Yes	Client application version
clientRequestId	String	Yes	Client-generated idempotency key
paymentInstrumentId	String	No	Saved payment instrument identifier
externalPaymentNonce	String	No	Payment nonce from an external provider
externalPaymentProvider	String	No	External payment provider name
promotionCode	String	No	Single promotion code to apply
loyaltyCardNumber	String	No	Loyalty card number for rewards
isGuestOrder	Boolean	No	Whether this is a guest (non-authenticated) order
paymentDeviceData	String	No	Device data for fraud detection
shippingAddress	Address	No	Shipping address for physical delivery
vendorData	VendorData	No	Vendor-specific data
paymentProcessor	String	No	Payment processor to use
tenantId	String	No	Tenant identifier for multi-tenant setups
associateTags	Map[String, String]	No	Associate attribution tags
storedValueCards	List[StoredValueCard]	No	Stored value cards to apply
paymentData	Map[String, String]	No	Additional payment key-value data
paymentInfo	PaymentInfo	No	Structured payment information
excludeAtomGiftCard	Boolean	No	Exclude Atom gift card balance from payment
showtimeTags	List[Tag]	No	Tags associated with the showtime
excludeAtomCredit	Boolean	No	Exclude Atom credit balance from payment
promotionCodes	List[String]	No	Multiple promotion codes to apply
vendorBenefits	VendorBenefits	No	Vendor benefit details
redemptionCodes	List[String]	No	Redemption codes to apply