Creates an in progress standard order as a booking

Digital Platform

Getting Started

Orders

Seating

Loyalty

Subscriptions

Payments

Completed Orders

API Reference

Vista Digital Platform

Completed Order Assets

Completed Orders Assets

Completed Orders

Seats

Discounts

Events

Showtimes

Films

Gift Cards

Items

Journeys

Third Party Passes

Loyalty

Authentication

Members

Friends

Password Reset

Payments

Subscriptions

Ticket Redemption Cards

Credentials

Watched Films

Watchlist Films

BookingFees

Completion

Orders

put

Sets the customer for an in progress standard order or in progress gift shop order

get

Gets the customer set on an in progress order base

delete

Removes an order payment base from an in progress order base

post

Creates an in progress standard order as a booking

get

Gets the details of a in progress order base

delete

Cancels an in progress order base

post

Resets the expiry of an in progress order base

Gift shop

Vouchers

Refunds

Seating

Sites

3rd Party Member Schemes

Ticket Prices

Tracking Events

Tips

Creates an in progress standard order as a booking

Licenses Required

Vista.Ocapi

Request

header Parameters

Connect-Region-Code

string

Region Code

Request Body schema:
application/json
required

Details of the order to be created

siteId required	string non-empty Gets the unique identifier of the site
bookingMode required	string (OrderBookingMode) Represents the mode of an order booking base Enum: "Paid" "Unpaid" "UnpaidConfirmed"

Responses

200

Success

400

Site does not exist.

post/ocapi/v1/orders/standard/booking

Request samples

Payload
curl
JavaScript
Node.js

{"siteId": "string",
"bookingMode": "Paid"
}

Response samples

application/json

{"order": {"id": "string",
"type": "Standard",
"status": "InProgress",
"totalPrice": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"booking": {"mode": "Paid",
"totalBookingFee": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
}
},
"showtimes": [{"showtimeId": "string",
"tickets": [{"type": "Normal",
"tickets": [{"ticketTypeId": "string",
"admissionStatus": "NotAdmitted"
}
],
"items": [{"itemId": "string"
}
],
"id": "string",
"collectionStatus": "NotCollected",
"refundStatus": "NotRefunded",
"ticketTypeId": "string",
"price": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"amountSaved": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"bookingFee": {"id": "string",
"amount": {"valueIncludingTax": null,
"valueExcludingTax": null,
"tax": null
},
"collectionStatus": "NotCollected",
"refundStatus": "NotRefunded",
"refundAvailability": {"isAvailable": null,
"unavailableReason": null
}
},
"rewardId": 0,
"ticketRedemptionCardId": "1c953716-206c-4079-9c26-e26d83d3b6c5",
"voucherId": "string",
"discountId": "string",
"dealId": "string",
"refundAvailability": {"isAvailable": true,
"unavailableReason": "NotApplicable"
}
}
],
"seats": [{"seatId": "string",
"seatLabel": "5",
"rowLabel": "string",
"areaName": {"text": "string",
"translations": [null
]
},
"areaCategoryId": "string",
"position": {"areaNumber": 0,
"columnNumber": 0,
"rowNumber": 0
}
}
],
"seatSwapStatus": {"isAvailable": true,
"unavailableReason": "NotApplicable"
}
}
],
"items": [{"id": "string",
"itemId": "string",
"type": "Normal",
"price": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"amountSaved": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"collectionStatus": "NotCollected",
"refundStatus": "NotRefunded",
"rewardId": 0,
"parentSalesItemId": "string",
"modifierGroups": [{"itemModifierGroupId": "string",
"modifiers": [{"itemId": null,
"price": null,
"amountSaved": null
}
]
}
],
"items": [{"itemId": "string",
"type": "Normal",
"price": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"amountSaved": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"parentSalesItemId": "string",
"modifierGroups": [{"itemModifierGroupId": null,
"modifiers": [ ]
}
],
"components": [{"itemId": null,
"type": null,
"price": null,
"amountSaved": null,
"modification": null,
"modifierGroups": [ ],
"parentSalesItemId": null
}
],
"deliveryId": "string",
"comment": "string"
}
],
"components": [{"itemId": "string",
"type": "Normal",
"price": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"amountSaved": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"modification": "None",
"modifierGroups": [{"itemModifierGroupId": null,
"modifiers": [ ]
}
],
"parentSalesItemId": "string"
}
],
"discountId": "string",
"dealId": "string",
"deliveryId": "string",
"comment": "string",
"refundAvailability": {"isAvailable": true,
"unavailableReason": "NotApplicable"
}
}
],
"itemDeliveries": [{"method": "CounterPickup",
"id": "string"
}
],
"payments": [{"id": "string",
"type": "CinemaProcessed",
"value": 0.1,
"status": "NotStarted"
}
],
"vouchers": [{"id": "string",
"type": "Ticket",
"maskedBarcode": "12.......6789",
"voucherTypeCode": "string",
"voucherTypeDescription": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
}
],
"deals": [{"id": "string",
"dealId": "string",
"voucherId": "string"
}
],
"ticketRedemptionCards": [{"type": "MemberSubscriptionCard",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"subscriptionId": 0,
"maskedCardNumber": "12.......6789",
"memberName": {"givenName": "string",
"familyName": "string",
"middleName": "string"
}
}
],
"expiresAt": "2019-08-24T14:15:22Z",
"siteId": "string",
"hasCustomer": true,
"amountSaved": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"tip": {"id": "string",
"amount": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"collectionStatus": "NotCollected",
"refundStatus": "NotRefunded",
"refundAvailability": {"isAvailable": true,
"unavailableReason": "NotApplicable"
}
}
},
"relatedData": {"films": [{"id": "string",
"title": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"externalIds": {"moviexchangeReleaseId": "6ce6697a-16c1-46a9-acef-0a6ce948a353",
"corporateId": "string"
},
"censorRatingId": "string",
"censorRatingNote": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
}
],
"ticketTypes": [{"id": "string",
"description": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
}
],
"items": [{"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"hoCode": "string",
"hopk": "string",
"isSundry": true,
"isPreparationRequired": true
}
],
"showtimes": [{"id": "string",
"schedule": {"businessDate": "2019-08-24T14:15:22Z",
"startsAt": "2019-08-24T14:15:22Z",
"endsAt": "2019-08-24T14:15:22Z",
"filmStartsAt": "2019-08-24T14:15:22Z",
"filmEndsAt": "2019-08-24T14:15:22Z",
"inSeatItemDelivery": {"startsAt": "2019-08-24T14:15:22Z",
"endsAt": "2019-08-24T14:15:22Z"
}
},
"filmId": "string",
"siteId": "string",
"screenId": "string"
}
],
"sites": [{"location": {"latitude": 0.1,
"longitude": 0.1
},
"contactDetails": {"phoneNumbers": [{"type": "Home",
"number": "string"
}
],
"email": "string",
"address": {"line1": "60 Khyber Pass Road",
"line2": "Grafton",
"city": "Auckland 1023"
}
},
"ianaTimeZoneName": "America/New_York",
"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"hasSellableItems": true,
"allowedItemDeliveryMethods": ["CounterPickup"
]
}
],
"screens": [{"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
}
],
"censorRatings": [{"id": "string",
"classification": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"classificationDescription": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"ageRestriction": {"minimumAge": 0
}
}
],
"itemServiceAreas": [{"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"shortName": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
}
],
"itemShowtimeDeliveryWindows": [{"minutes": 0,
"type": "MinutesFromStart",
"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
}
],
"subscriptionBillingOption": {"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"subscriptionId": 0,
"billingPeriodInMonths": 0,
"isRecurring": true
},
"subscription": {"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
},
"balanceType": {"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"isPrimary": true,
"unitName": "Points",
"paymentConversionRate": 0.1,
"unitDecimalPlaces": 0
}
}
}

Creates an in progress standard order as a booking

Licenses Required

header Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json-patch+jsonapplication/jsonrequired

Request Body schema:
application/json
required