Gets a journey details by its reference

Gets a journey which represents, from start to finish, a customer's interactions with Vista software in relation to one or multiple visits to the cinema initiated by a single sale.

A journey reference is generated when the asynchronous journey service is started so that it's possible to distinguish between a valid journey that hasn't been prepared by the service and one that doesn't exist.

Licenses Required

Vista.Ocapi

Request

path Parameters

journeyReference

required

string

A reference for the journey to be retrieved

header Parameters

Connect-Region-Code

string

Region Code

Responses

200

Success

202

Journey reference exists, but journey is not yet ready for retrieval.

404

Journey does not exist.

get/ocapi/v1/journeys/by-reference/{journeyReference}

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"journey": {"id": "string",
"siteId": "string",
"orders": [{"id": "string",
"type": "Standard",
"status": "InProgress",
"totalPrice": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"originalPrice": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"booking": {"id": "string",
"totalBookingFee": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"originalBookingFee": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"mode": "Paid"
},
"transaction": {"number": 0,
"barcode": "T00210738425",
"createdAt": "2019-08-24T14:15:22Z"
},
"vouchers": [{"id": "string",
"type": "Ticket",
"maskedBarcode": "12.......6789",
"voucherTypeCode": "string",
"voucherTypeDescription": {"text": "string",
"translations": [null
]
}
}
],
"deals": [{"id": "string",
"dealId": "string",
"voucherId": "string"
}
],
"payments": [{"id": "string",
"type": "CinemaProcessed",
"value": 0.1,
"status": "NotStarted"
}
],
"showtimes": [{"showtimeId": "string",
"tickets": [{"type": null,
"tickets": [{"ticketTypeId": "string",
"admissionStatus": "NotAdmitted"
}
],
"items": [{"itemId": "string"
}
],
"id": null,
"collectionStatus": null,
"refundStatus": null,
"ticketTypeId": null,
"price": null,
"amountSaved": null,
"bookingFee": null,
"rewardId": null,
"ticketRedemptionCardId": null,
"voucherId": null,
"discountId": null,
"dealId": null,
"refundAvailability": null
}
],
"seats": [{"seatId": null,
"seatLabel": null,
"rowLabel": null,
"areaName": null,
"areaCategoryId": null,
"position": null
}
],
"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": null,
"modifiers": [ ]
}
],
"items": [{"itemId": null,
"type": null,
"price": null,
"amountSaved": null,
"parentSalesItemId": null,
"modifierGroups": [ ],
"components": [ ],
"deliveryId": null,
"comment": null
}
],
"components": [{"itemId": null,
"type": null,
"price": null,
"amountSaved": null,
"modification": null,
"modifierGroups": [ ],
"parentSalesItemId": null
}
],
"discountId": "string",
"dealId": "string",
"deliveryId": "string",
"comment": "string",
"refundAvailability": {"isAvailable": true,
"unavailableReason": "NotApplicable"
}
}
],
"itemDeliveries": [{"id": "string",
"method": "CounterPickup"
}
],
"ticketRedemptionCards": [{"type": "MemberSubscriptionCard",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"subscriptionId": 0,
"maskedCardNumber": "12.......6789",
"memberName": {"givenName": "string",
"familyName": "string",
"middleName": "string"
}
}
],
"siteId": "string",
"preparation": {"collectionNumber": 0,
"status": "NotStarted"
},
"amountSaved": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"journeyReference": "string",
"tip": {"id": "string",
"amount": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"collectionStatus": "NotCollected",
"refundStatus": "NotRefunded",
"refundAvailability": {"isAvailable": true,
"unavailableReason": "NotApplicable"
}
},
"refundAvailability": {"isAvailable": true,
"unavailableReason": "NotApplicable",
"availableMethods": ["Full"
],
"isBookingFeeRefundable": true
},
"totalRefunded": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"expiresAt": "2019-08-24T14:15:22Z",
"parentOrderId": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z"
},
"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
}
}
}