Revision History

Reference Data API#

RevisionDateNotes
                                                                                                     
1 – 2.3Dec 2016 - Apr 2017Initial versions in line with development
2.417 May 2017Updating error codes & ticket types endpoint description
2.529 May 2017Updated to new subdomain and introduced path in URL. Added note re. using credentials for multiple API services
2.68 Jun 2017Added new MX-Api-Client-Secret header details
2.71 Aug 2017New MX branding applied
2.811 Aug 2017Added updated error codes for GetTicketTypes
2.92 Nov 2017Added Correlation Id header details
2.1013 Nov 2017Clarified ‘startTime’ property is in the site’s local timezone
2.1115 Dec 2017Updated ‘Get CinemaChain’ response to include configuration information
2.1212 Jan 2018Added explanation of 404 response code for Get Ticket Types
2.1331 Jan 2018Added concession support. Separated showtimes and concessions reference data endpoints.
3.021 Feb 2018Renamed to MX Reference Data API Guide
3.127 Feb 2018Added Connect version requirement for concessions, and added productionYear to Get Films
3.219 Mar 2018Added description for error code 40030
3.328 Mar 2018Added countryCode (Cinema Chains), seatsAvailable and lastUpdatedUtc (Showtimes) and mxfReleaseId (Films)
3.410 Apr 2018Improved the description of the lastUpdatedUtc property on Showtimes
3.58 May 2018Added ‘isAllocatedSeating’ property to Get Ticket Types, and described ‘isAllocatedSeating’ on Get Showtimes
3.623 May 2018Added MX Tickets licence requirement for Get Ticket Types endpoint
3.725 Jun 2018Added 30004 to error code list
3.89 Jul 2018Aligned error codes with Transactional API document
3.92 Aug 18Added modifiers for item models
3.1017 Aug 2018Added some missing error codes
3.112 Oct 2018Added screenId to ‘Get Showtimes’
3.1230 Oct 2018Replaced HTTP with HTTPS on all examples
3.135 Dec 2018General review and refinement of terminology throughout
3.1419 Dec 2018Added Get Showtimes including Ticket Types endpoint
3.1523 Jan 2019Added note about visibility of seatsAvailable on Get Showtimes endpoints
3.1625 Jan 2019Exposed original cinema chain film data for Get Films and Showtimes endpoints
3.175 Feb 2019Added Postman collection details
3.1818 Feb 2019Added error code 40034 : Cinema Chain Does Not Support Feature
3.1927 Mar 2019Added the IANA timezone name to Get Sites for Cinema Chain
3.202 Apr 2019Added requiresClientPaymentToken to Get Cinema Chains
3.212 Apr 2019Added phoneNumber to Get Sites for Cinema Chain
3.222 Apr 2019Added itemsOnlyOrdersEnabled to Get Cinema Chains
3.237 Oct 2019Added curatedData to Get Sites for Cinema Chain
3.248 Nov 2019Added websiteUrl, currencyCode, country and zipCode to Curated Site Data for Get Sites for Cinema Chain

Transactional API#

RevisionDateNotes
                                                                                                     
1 – 1.5Dec 2016 - Mar 2017Initial versions in line with development
1.631 Mar 2017RC Documentation
1.710 Apr 2017Added intended usage note, Client ID clarification, Vista Showtime ID methods, and note about creating application-specific credentials.
1.811 Apr 2017Corrected HTTP verb for booking cancellation request.
1.913 Apr 2017Added Limitations and “Remove Tickets” sections.
2.013 Apr 2017Added descriptions and examples to the API endpoints. Added error codes.
2.121 Apr 2017Added note about setting customer details before completing order.
2.228 Apr 2017Added note about the issuing of refresh tokens being made optional. Clarified usage of refresh tokens
2.32 May 2017Separated MX Tickets functionality out from single movieXchange API document
2.44 May 2017Added separate examples for credit card and non-credit card payments
2.517 May 2017Updating error codes section
2.629 May 2017Updated to new subdomain and introduced path in URL. Added note re. using credentials for multiple API services
2.78 Jun 2017Added new MX-Api-Client-Secret header details
2.86 Jul 2017Added seatsRequireSelection flag details
2.913 Jul 2017Added further seatsRequireSelection details
3.01 Aug 2017Booking refund API added
3.110 Aug 2017Loyalty support – earn points for completed orders
3.224 Aug 2017Added more seating details
3.325 Sept 2017Corrected swagger link for Bookings
3.426 Oct 2017Added information on bookingId and barcodes
3.527 Oct 2017Added seat layout detail
3.62 Nov 2017Added Correlation Id header details
3.717 Nov 2017Fixed inconsistent quantities in the order JSON examples
3.820 Dec 2017Added note to refund booking about supporting refunds after showtime start
3.909 Jan 2018Added note in Create Order section about optional expirationTimeUtc field in ticketing responses
3.1011 Jan 2018Added Get Booking
3.1117 Jan 2018Added partial refunds
3.1230 Jan 2018Added concession support. Separated showtimes and concessions reference data endpoints.
4.021 Feb 2018Renamed to MX Transactional API Guide, and added credit card number format requirement to ‘Complete Order’
4.15 Apr 2018Added Membership Card Validation (Loyalty Service)
4.210 Apr 2018Updated endpoint address for Loyalty (to include v1)
4.321 May 2018Updated example response for Get Booking to remove duplicate line items
4.425 Jun 2018Updated collectedStatus description in Get Booking, added 30004 to error code list, added coverage of handling 504 responses and automated ‘checking and reversal’ process to ‘Complete Order’, added ‘Get Screen Layout for Showtime’
4.59 Jul 2018Added Seat Swap
4.620 Jul 2018Added ‘Unavailable’ state for seats
4.72 Aug 2018Added modifiers for order and booking endpoints
4.817 Aug 2018Added some missing error codes
4.915 Oct 2018Added email and phone elements to loyalty on Set Customer Details
4.1030 Oct 2018Replaced HTTP with HTTPS in all examples
4.115 Dec 2018General review and refinement of terminology throughout
4.126 Dec 2018Support for validating loyalty membership by email and phone number (v2 endpoint). Support for earning loyalty points using email or phone number
4.1317 Jan 2019Corrected sample request for v2 Validate Membership
4.1425 Jan 2019Added areaCategoryDescription to Get Screen Layout endpoints
4.1530 Jan 2019Added hasAssociatedLoyaltyMembership to Get Booking
4.165 Feb 2019Added Postman collection details
4.1718 Feb 2019Added error code 40034 : Cinema Chain Does Not Support Feature
4.1825 Feb 2019Added 'Create Payment Token' endpoint
4.192 Apr 2019Added support for creating orders with only tickets, only items or both to Create Order
4.2010 Apr 2019Added 'Extend Order Expiration' endpoint, and added canResetOrderExpiry to Get Cinema Chains
4.2115 May 2019Updated documentation of the automated cleanup of timed-out order completions in Complete Order
4.227 Jun 2019Added support for ticket packages
4.2319 Aug 2019Added transactionId support to Complete Order and Get Booking
4.2429 Aug 2019Added support for ticket sales after the beginning of a showtime
4.2518 Mar 2020Added support for the customer's tax details to be added to an order
4.2626 May 2020Added 'Begin Item Preparation' endpoint
4.2703 Jun 2020Added support for 'Booking Notes'

Matching API#

RevisionDateNotes
                                                                                                     
1.017 Feb 2019Added Get Films by External Identifiers
1.0229 Jul 2019Added Get Sites by External Identifiers