{"items":[{"type":"link","label":"Vista Digital Platform","link":"/openapi/digital-platform/openapi","routeSlug":"/openapi/digital-platform/openapi","content":{"contentType":"overview","meta":{"name":"Vista Digital Platform"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi/digital-platform/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi/digital-platform/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"cURL","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Vista Digital Platform (V1)","showPageActions":true}],"sectionId":"/openapi/digital-platform/openapi"}]}]}},{"type":"group","label":"Completed Order Assets","link":"/openapi/digital-platform/openapi/completed-order-assets","routeSlug":"/openapi/digital-platform/openapi/completed-order-assets","items":[{"label":"Gets a google wallet pass containing an 'event ticket' pass for each order showtime within a completed standard order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-order-assets/ocapicompletedorderassets_getgooglewalletpassfororder","routeSlug":"/openapi/digital-platform/openapi/completed-order-assets/ocapicompletedorderassets_getgooglewalletpassfororder","metadata":{"seo":{"title":"Gets a google wallet pass containing an 'event ticket' pass for each order showtime within a completed standard order","description":"Can be used to create an 'Add to Google Wallet' button for a completed standard order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrderAssets_GetGoogleWalletPassForOrder","name":"Gets a google wallet pass containing an 'event ticket' pass for each order showtime within a completed standard order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1assets~1google-wallet-pass/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a google wallet pass containing an 'event ticket' pass for each order showtime within a completed standard order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be used to create an 'Add to Google Wallet' button for a completed standard order"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opening the Google Wallet Pass on a supported device will prompt the patron to add the passes to their Google Wallet."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completed-order-assets/ocapicompletedorderassets_getgooglewalletpassfororder/request/licenses-required","deepLinkHash":"/completed-order-assets/ocapicompletedorderassets_getgooglewalletpassfororder#completed-order-assets/ocapicompletedorderassets_getgooglewalletpassfororder/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed standard order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1assets~1google-wallet-pass/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1assets~1google-wallet-pass/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/completed/{orderId}/assets/google-wallet-pass","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/assets/google-wallet-pass","href":"completed-order-assets/ocapicompletedorderassets_getgooglewalletpassfororder","openApiOperationId":"OcapiCompletedOrderAssets_GetGoogleWalletPassForOrder","summary":"Gets a google wallet pass containing an 'event ticket' pass for each order showtime within a completed standard order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.GoogleWalletPass"}},"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.GoogleWalletPass"},{"code":"400","description":"Invalid order type, or order does not contain any tickets."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1assets~1google-wallet-pass/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.GoogleWalletPass","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.GoogleWalletPass"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/assets/google-wallet-pass"},{"label":"Gets an iCalendar (iCal) file containing a calendar event for each order showtime within a completed standard order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-order-assets/ocapicompletedorderassets_getcalendareventfororder","routeSlug":"/openapi/digital-platform/openapi/completed-order-assets/ocapicompletedorderassets_getcalendareventfororder","metadata":{"seo":{"title":"Gets an iCalendar (iCal) file containing a calendar event for each order showtime within a completed standard order","description":"Can be used to create an 'Add to Calendar' button for a completed standard order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrderAssets_GetCalendarEventForOrder","name":"Gets an iCalendar (iCal) file containing a calendar event for each order showtime within a completed standard order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1assets~1calendar-event/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets an iCalendar (iCal) file containing a calendar event for each order showtime within a completed standard order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be used to create an 'Add to Calendar' button for a completed standard order"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opening the iCalendar file on a supported device will prompt the patron to add the calendar events to their calendar application."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completed-order-assets/ocapicompletedorderassets_getcalendareventfororder/request/licenses-required","deepLinkHash":"/completed-order-assets/ocapicompletedorderassets_getcalendareventfororder#completed-order-assets/ocapicompletedorderassets_getcalendareventfororder/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed standard order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1assets~1calendar-event/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1assets~1calendar-event/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/completed/{orderId}/assets/calendar-event","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/assets/calendar-event","href":"completed-order-assets/ocapicompletedorderassets_getcalendareventfororder","openApiOperationId":"OcapiCompletedOrderAssets_GetCalendarEventForOrder","summary":"Gets an iCalendar (iCal) file containing a calendar event for each order showtime within a completed standard order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34"},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1assets~1calendar-event/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/assets/calendar-event"},{"label":"Gets an Apple Wallet Pass bundle containing an 'event ticket' pass for each order showtime within a completed standard order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-order-assets/ocapicompletedorderassets_getapplewalletpassfororder","routeSlug":"/openapi/digital-platform/openapi/completed-order-assets/ocapicompletedorderassets_getapplewalletpassfororder","metadata":{"seo":{"title":"Gets an Apple Wallet Pass bundle containing an 'event ticket' pass for each order showtime within a completed standard order","description":"Can be used to create an 'Add to Apple Wallet' button for a completed standard order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrderAssets_GetAppleWalletPassForOrder","name":"Gets an Apple Wallet Pass bundle containing an 'event ticket' pass for each order showtime within a completed standard order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1assets~1apple-wallet-pass/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets an Apple Wallet Pass bundle containing an 'event ticket' pass for each order showtime within a completed standard order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be used to create an 'Add to Apple Wallet' button for a completed standard order"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opening the Apple Wallet Pass bundle on a supported Apple device will prompt the patron to add the passes to their Apple Wallet."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completed-order-assets/ocapicompletedorderassets_getapplewalletpassfororder/request/licenses-required","deepLinkHash":"/completed-order-assets/ocapicompletedorderassets_getapplewalletpassfororder#completed-order-assets/ocapicompletedorderassets_getapplewalletpassfororder/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed standard order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1assets~1apple-wallet-pass/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1assets~1apple-wallet-pass/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/completed/{orderId}/assets/apple-wallet-pass","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/assets/apple-wallet-pass","href":"completed-order-assets/ocapicompletedorderassets_getapplewalletpassfororder","openApiOperationId":"OcapiCompletedOrderAssets_GetAppleWalletPassForOrder","summary":"Gets an Apple Wallet Pass bundle containing an 'event ticket' pass for each order showtime within a completed standard order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34"},{"code":"400","description":"Invalid order type, or order does not contain any tickets."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1assets~1apple-wallet-pass/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/assets/apple-wallet-pass"},{"label":"Gets the list of completed order redeemable item base entities for a completed gift shop order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-order-assets/ocapienterprisecompletedorders_getcompletedorderredeemableitems","routeSlug":"/openapi/digital-platform/openapi/completed-order-assets/ocapienterprisecompletedorders_getcompletedorderredeemableitems","metadata":{"seo":{"title":"Gets the list of completed order redeemable item base entities for a completed gift shop order","description":"This endpoint will only return redeemable items for completed gift shop order entities. For other types of completed orders,such as completed standard order, this endpoint will return an empty array."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiEnterpriseCompletedOrders_GetCompletedOrderRedeemableItems","name":"Gets the list of completed order redeemable item base entities for a completed gift shop order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1enterprise~1orders~1completed~1{orderId}~1redeemable-items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the list of completed order redeemable item base entities for a completed gift shop order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint will only return redeemable items for completed gift shop order entities. For other types of completed orders,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"such as completed standard order, this endpoint will return an empty array."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Redeemable item details are intentionally separated from completed gift shop order to avoid exposing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sensitive voucher and gift card information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returning these details via a dedicated endpoint reduces the attack surface and helps prevent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unauthorized access to redeemable items that could have direct financial value."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completed-order-assets/ocapienterprisecompletedorders_getcompletedorderredeemableitems/request/licenses-required","deepLinkHash":"/completed-order-assets/ocapienterprisecompletedorders_getcompletedorderredeemableitems#completed-order-assets/ocapienterprisecompletedorders_getcompletedorderredeemableitems/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed gift shop order","required":true}],"pointer":"/paths/~1ocapi~1v1~1enterprise~1orders~1completed~1{orderId}~1redeemable-items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1enterprise~1orders~1completed~1{orderId}~1redeemable-items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/enterprise/orders/completed/{orderId}/redeemable-items","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/enterprise/orders/completed/{orderId}/redeemable-items","href":"completed-order-assets/ocapienterprisecompletedorders_getcompletedorderredeemableitems","openApiOperationId":"OcapiEnterpriseCompletedOrders_GetCompletedOrderRedeemableItems","summary":"Gets the list of completed order redeemable item base entities for a completed gift shop order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderRedeemableItemListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderRedeemableItemListDetails"},{"code":"404","description":"Order does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"schemaId":"components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}],"pointer":"/paths/~1ocapi~1v1~1enterprise~1orders~1completed~1{orderId}~1redeemable-items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderRedeemableItemListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderRedeemableItemListDetails"}}},{"code":"404","schemaId":"components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}}}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/enterprise/orders/completed/{orderId}/redeemable-items"}],"content":{"contentType":"group","meta":{"name":"Completed Order Assets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Completed Order Assets","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/orders/completed/{orderId}/assets/google-wallet-pass","summary":"Gets a google wallet pass containing an 'event ticket' pass for each order showtime within a completed standard order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/completed-order-assets/ocapicompletedorderassets_getgooglewalletpassfororder","deprecated":false},{"title":"/ocapi/v1/orders/completed/{orderId}/assets/calendar-event","summary":"Gets an iCalendar (iCal) file containing a calendar event for each order showtime within a completed standard order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/completed-order-assets/ocapicompletedorderassets_getcalendareventfororder","deprecated":false},{"title":"/ocapi/v1/orders/completed/{orderId}/assets/apple-wallet-pass","summary":"Gets an Apple Wallet Pass bundle containing an 'event ticket' pass for each order showtime within a completed standard order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/completed-order-assets/ocapicompletedorderassets_getapplewalletpassfororder","deprecated":false},{"title":"/ocapi/v1/enterprise/orders/completed/{orderId}/redeemable-items","summary":"Gets the list of completed order redeemable item base entities for a completed gift shop order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/completed-order-assets/ocapienterprisecompletedorders_getcompletedorderredeemableitems","deprecated":false}]}]}]}]}},{"type":"group","label":"Completed Orders","link":"/openapi/digital-platform/openapi/completed-orders","routeSlug":"/openapi/digital-platform/openapi/completed-orders","items":[{"label":"Gets the customer set on a completed standard order or completed gift shop order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedordercustomer_getcustomer","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedordercustomer_getcustomer","metadata":{"seo":{"title":"Gets the customer set on a completed standard order or completed gift shop order","description":"As order customer contains Personally Identifiable Information (PII),the client is responsible for storing this data securely and for as little time as possible."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrderCustomer_GetCustomer","name":"Gets the customer set on a completed standard order or completed gift shop order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1customer/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the customer set on a completed standard order or completed gift shop order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As order customer contains Personally Identifiable Information (PII),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the client is responsible for storing this data securely and for as little time as possible."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completed-orders/ocapicompletedordercustomer_getcustomer/request/licenses-required","deepLinkHash":"/completed-orders/ocapicompletedordercustomer_getcustomer#completed-orders/ocapicompletedordercustomer_getcustomer/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed order base","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1customer/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1customer/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/completed/{orderId}/customer","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/customer","href":"completed-orders/ocapicompletedordercustomer_getcustomer","openApiOperationId":"OcapiCompletedOrderCustomer_GetCustomer","summary":"Gets the customer set on a completed standard order or completed gift shop order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerDetails"},{"code":"400","description":"Invalid order type."},{"code":"404","description":"Order does not exist"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1customer/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerDetails"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/customer"},{"label":"Gets the details of a completed order base","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getcompletedorder","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getcompletedorder","metadata":{"seo":{"title":"Gets the details of a completed order base","description":"This endpoint does not currently support tab order entities."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrders_GetCompletedOrder","name":"Gets the details of a completed order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the details of a completed order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint does not currently support tab order entities."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completed-orders/ocapicompletedorders_getcompletedorder/request/licenses-required","deepLinkHash":"/completed-orders/ocapicompletedorders_getcompletedorder#completed-orders/ocapicompletedorders_getcompletedorder/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed order base being retrieved","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/completed/{orderId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}","href":"completed-orders/ocapicompletedorders_getcompletedorder","openApiOperationId":"OcapiCompletedOrders_GetCompletedOrder","summary":"Gets the details of a completed order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase"}},"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase"},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}"},{"label":"Gets the details of a completed standard order by its completed standard order JourneyReference","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getcompletedorderbyjourneyreference","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getcompletedorderbyjourneyreference","metadata":{"seo":{"title":"Gets the details of a completed standard order by its completed standard order JourneyReference","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrders_GetCompletedOrderByJourneyReference","name":"Gets the details of a completed standard order by its completed standard order JourneyReference","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1by-journey-reference~1{journeyReference}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the details of a completed standard order by its completed standard order JourneyReference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completed-orders/ocapicompletedorders_getcompletedorderbyjourneyreference/request/licenses-required","deepLinkHash":"/completed-orders/ocapicompletedorders_getcompletedorderbyjourneyreference#completed-orders/ocapicompletedorders_getcompletedorderbyjourneyreference/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"journeyReference","in":"path","schemaId":"schema_33","description":"The journey reference of the completed standard order being retrieved","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1by-journey-reference~1{journeyReference}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1by-journey-reference~1{journeyReference}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/completed/by-journey-reference/{journeyReference}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"journeyReference","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/orders/completed/by-journey-reference/{journeyReference}","href":"completed-orders/ocapicompletedorders_getcompletedorderbyjourneyreference","openApiOperationId":"OcapiCompletedOrders_GetCompletedOrderByJourneyReference","summary":"Gets the details of a completed standard order by its completed standard order JourneyReference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderDetails"},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1by-journey-reference~1{journeyReference}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/by-journey-reference/{journeyReference}"},{"label":"Gets the details of a completed standard order by its completed order booking Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getcompletedorderbybookingid","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getcompletedorderbybookingid","metadata":{"seo":{"title":"Gets the details of a completed standard order by its completed order booking Id","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrders_GetCompletedOrderByBookingId","name":"Gets the details of a completed standard order by its completed order booking Id","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1sites~1{siteId}~1by-booking-id~1{bookingId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the details of a completed standard order by its completed order booking Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completed-orders/ocapicompletedorders_getcompletedorderbybookingid/request/licenses-required","deepLinkHash":"/completed-orders/ocapicompletedorders_getcompletedorderbybookingid#completed-orders/ocapicompletedorders_getcompletedorderbybookingid/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site","required":true},{"name":"bookingId","in":"path","schemaId":"schema_33","description":"The booking identifier of the completed standard order being retrieved","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1sites~1{siteId}~1by-booking-id~1{bookingId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1sites~1{siteId}~1by-booking-id~1{bookingId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/completed/sites/{siteId}/by-booking-id/{bookingId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"},{"name":"bookingId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/orders/completed/sites/{siteId}/by-booking-id/{bookingId}","href":"completed-orders/ocapicompletedorders_getcompletedorderbybookingid","openApiOperationId":"OcapiCompletedOrders_GetCompletedOrderByBookingId","summary":"Gets the details of a completed standard order by its completed order booking Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderDetails"},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1sites~1{siteId}~1by-booking-id~1{bookingId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/sites/{siteId}/by-booking-id/{bookingId}"},{"label":"Swaps the seats for an order showtime within a completed standard order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_swapseats","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_swapseats","metadata":{"seo":{"title":"Swaps the seats for an order showtime within a completed standard order","description":"This endpoint can only be used for completed orders. To change the seats in a in progress standard order, use SetShowtime instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrders_SwapSeats","name":"Swaps the seats for an order showtime within a completed standard order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1showtimes~1{showtimeId}~1seats/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Swaps the seats for an order showtime within a completed standard order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint can only be used for completed orders. To change the seats in a in progress standard order, use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/showtimes/ocapiordershowtimes_setshowtime"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SetShowtime"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seats can only be swapped when order showtime seat swap status IsAvailable equals true."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completed-orders/ocapicompletedorders_swapseats/request/licenses-required","deepLinkHash":"/completed-orders/ocapicompletedorders_swapseats#completed-orders/ocapicompletedorders_swapseats/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed standard order being modified","required":true},{"name":"showtimeId","in":"path","schemaId":"schema_33","description":"The unique identifier of the order showtime being modified","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1showtimes~1{showtimeId}~1seats/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1showtimes~1{showtimeId}~1seats/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeSeatSwapRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeSeatSwapRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeSeatSwapRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeSeatSwapRequest"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeSeatSwapRequest","pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1showtimes~1{showtimeId}~1seats/put/requestBody","description":"The requested replacement seats"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/orders/completed/{orderId}/showtimes/{showtimeId}/seats","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"},{"name":"showtimeId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeSeatSwapRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeSeatSwapRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeSeatSwapRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeSeatSwapRequest"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/showtimes/{showtimeId}/seats","href":"completed-orders/ocapicompletedorders_swapseats","openApiOperationId":"OcapiCompletedOrders_SwapSeats","summary":"Swaps the seats for an order showtime within a completed standard order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeSeatSwapRequest","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeSeatSwapRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeSeatSwapRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeSeatSwapRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeSeatSwapRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderDetails"},{"code":"400","description":"Request property is invalid or missing, or seats cannot be swapped."},{"code":"404","description":"Order or showtime does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1showtimes~1{showtimeId}~1seats/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderDetails"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/showtimes/{showtimeId}/seats"},{"label":"Requests the preparation of all completed order item delivery base entities in a completed standard order\r\nwith an completed order item delivery preparation status OnHold status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_setitemdeliveriesasrequested","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_setitemdeliveriesasrequested","metadata":{"seo":{"title":"Requests the preparation of all completed order item delivery base entities in a completed standard order\r\nwith an completed order item delivery preparation status OnHold status","description":"Calling this endpoint will update the preparation status of all completed order item delivery base entities with an completed order item delivery preparation status OnHoldstatus that are available for preparation to completed order item delivery preparation status Requested"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrders_SetItemDeliveriesAsRequested","name":"Requests the preparation of all completed order item delivery base entities in a completed standard order\r\nwith an completed order item delivery preparation status OnHold status","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1item-deliveries~1preparation-status~1requested/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Requests the preparation of all completed order item delivery base entities in a completed standard order\r\nwith an completed order item delivery preparation status OnHold status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calling this endpoint will update the preparation status of all completed order item delivery base entities with an completed order item delivery preparation status OnHold"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status that are available for preparation to completed order item delivery preparation status Requested"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calling this endpoint will also set the collectable order line CollectionStatus of all items in all completed order item delivery base"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"entities that have been requested for preparation to order line collection status Collected"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completed-orders/ocapicompletedorders_setitemdeliveriesasrequested/request/licenses-required","deepLinkHash":"/completed-orders/ocapicompletedorders_setitemdeliveriesasrequested#completed-orders/ocapicompletedorders_setitemdeliveriesasrequested/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed order base","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1item-deliveries~1preparation-status~1requested/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1item-deliveries~1preparation-status~1requested/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderItemDeliveriesPreparationStatusUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderItemDeliveriesPreparationStatusUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderItemDeliveriesPreparationStatusUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderItemDeliveriesPreparationStatusUpdate"}},"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderItemDeliveriesPreparationStatusUpdate","pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1item-deliveries~1preparation-status~1requested/put/requestBody","description":"The additional request options"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/preparation-status/requested","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderItemDeliveriesPreparationStatusUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderItemDeliveriesPreparationStatusUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderItemDeliveriesPreparationStatusUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderItemDeliveriesPreparationStatusUpdate"}},"responseCodes":["200","202","400","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/preparation-status/requested","href":"completed-orders/ocapicompletedorders_setitemdeliveriesasrequested","openApiOperationId":"OcapiCompletedOrders_SetItemDeliveriesAsRequested","summary":"Requests the preparation of all completed order item delivery base entities in a completed standard order\r\nwith an completed order item delivery preparation status OnHold status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderItemDeliveriesPreparationStatusUpdate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderItemDeliveriesPreparationStatusUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderItemDeliveriesPreparationStatusUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderItemDeliveriesPreparationStatusUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderItemDeliveriesPreparationStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase"}},"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase"},{"code":"202","description":"No changes made to the order.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase"}},"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase"},{"code":"400","description":"Order item delivery preparation cannot be started."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1item-deliveries~1preparation-status~1requested/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase"}}},{"code":"202","schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/preparation-status/requested"},{"label":"Requests the preparation of a completed order item delivery base with an completed order item delivery preparation status OnHold status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_setitemdeliveryasrequested","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_setitemdeliveryasrequested","metadata":{"seo":{"title":"Requests the preparation of a completed order item delivery base with an completed order item delivery preparation status OnHold status","description":"This endpoint can only be used for completed order item delivery base entities with an order item delivery schedule type OnRequest schedule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrders_SetItemDeliveryAsRequested","name":"Requests the preparation of a completed order item delivery base with an completed order item delivery preparation status OnHold status","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1item-deliveries~1{itemDeliveryId}~1preparation-status~1requested/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Requests the preparation of a completed order item delivery base with an completed order item delivery preparation status OnHold status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint can only be used for completed order item delivery base entities with an order item delivery schedule type OnRequest schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calling this endpoint will update the preparation status of all completed order item delivery base entities"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with an completed order item delivery preparation status OnHold status to completed order item delivery preparation status Requested"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calling this endpoint will also set the collectable order line CollectionStatus of all items in the completed order item delivery base"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to order line collection status Collected"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completed-orders/ocapicompletedorders_setitemdeliveryasrequested/request/licenses-required","deepLinkHash":"/completed-orders/ocapicompletedorders_setitemdeliveryasrequested#completed-orders/ocapicompletedorders_setitemdeliveryasrequested/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed order base","required":true},{"name":"itemDeliveryId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed order item delivery base that is to be prepared","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1item-deliveries~1{itemDeliveryId}~1preparation-status~1requested/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1item-deliveries~1{itemDeliveryId}~1preparation-status~1requested/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/{itemDeliveryId}/preparation-status/requested","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"},{"name":"itemDeliveryId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","202","400","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/{itemDeliveryId}/preparation-status/requested","href":"completed-orders/ocapicompletedorders_setitemdeliveryasrequested","openApiOperationId":"OcapiCompletedOrders_SetItemDeliveryAsRequested","summary":"Requests the preparation of a completed order item delivery base with an completed order item delivery preparation status OnHold status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase"}},"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase"},{"code":"202","description":"No changes made to the order.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase"}},"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase"},{"code":"400","description":"Order item delivery preparation cannot be started."},{"code":"404","description":"Order or item delivery does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1item-deliveries~1{itemDeliveryId}~1preparation-status~1requested/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase"}}},{"code":"202","schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/{itemDeliveryId}/preparation-status/requested"},{"label":"Gets the completed standard order identifiers for a completed standard order\r\nby its completed standard order JourneyReference","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getorderidentifiersbyjourneyreference","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getorderidentifiersbyjourneyreference","metadata":{"seo":{"title":"Gets the completed standard order identifiers for a completed standard order\r\nby its completed standard order JourneyReference","description":"Gets a set of identifiers that can be used to call other OCAPI endpoints in a consistent manner."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrders_GetOrderIdentifiersByJourneyReference","name":"Gets the completed standard order identifiers for a completed standard order\r\nby its completed standard order JourneyReference","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1by-journey-reference~1{journeyReference}~1identifiers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the completed standard order identifiers for a completed standard order\r\nby its completed standard order JourneyReference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets a set of identifiers that can be used to call other OCAPI endpoints in a consistent manner."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completed-orders/ocapicompletedorders_getorderidentifiersbyjourneyreference/request/licenses-required","deepLinkHash":"/completed-orders/ocapicompletedorders_getorderidentifiersbyjourneyreference#completed-orders/ocapicompletedorders_getorderidentifiersbyjourneyreference/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"journeyReference","in":"path","schemaId":"schema_33","description":"The journey reference of the completed standard order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1by-journey-reference~1{journeyReference}~1identifiers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1by-journey-reference~1{journeyReference}~1identifiers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/completed/by-journey-reference/{journeyReference}/identifiers","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"journeyReference","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/orders/completed/by-journey-reference/{journeyReference}/identifiers","href":"completed-orders/ocapicompletedorders_getorderidentifiersbyjourneyreference","openApiOperationId":"OcapiCompletedOrders_GetOrderIdentifiersByJourneyReference","summary":"Gets the completed standard order identifiers for a completed standard order\r\nby its completed standard order JourneyReference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderIdentifiers"}},"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderIdentifiers"},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1by-journey-reference~1{journeyReference}~1identifiers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderIdentifiers","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderIdentifiers"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/by-journey-reference/{journeyReference}/identifiers"},{"label":"Gets the print streams of an uncollected completed order base that are compatible with the requested printer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getprintstreams","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getprintstreams","metadata":{"seo":{"title":"Gets the print streams of an uncollected completed order base that are compatible with the requested printer","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrders_GetPrintStreams","name":"Gets the print streams of an uncollected completed order base that are compatible with the requested printer","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1print-streams/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the print streams of an uncollected completed order base that are compatible with the requested printer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completed-orders/ocapicompletedorders_getprintstreams/request/licenses-required","deepLinkHash":"/completed-orders/ocapicompletedorders_getprintstreams#completed-orders/ocapicompletedorders_getprintstreams/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed order base being retrieved","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1print-streams/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"printTemplateName","in":"query","schemaId":"schema_33","description":"The name of the print templates to generate the print streams with","required":true},{"name":"languageTag","in":"query","schemaId":"schema_33","description":"The IETF (RFC 4646) language tag representing the desired language that the print streams will be generated in.\r\nIf not supplied, the default language configured at cinema will be used"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1print-streams/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1print-streams/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/completed/{orderId}/print-streams","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[{"name":"printTemplateName","in":"query","required":true,"schemaId":"schema_33"},{"name":"languageTag","in":"query","schemaId":"schema_33"}],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/print-streams","href":"completed-orders/ocapicompletedorders_getprintstreams","openApiOperationId":"OcapiCompletedOrders_GetPrintStreams","summary":"Gets the print streams of an uncollected completed order base that are compatible with the requested printer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderPrintStreams"}},"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderPrintStreams"},{"code":"400","description":"Invalid query parameter, or the order is in an invalid state."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1print-streams/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderPrintStreams","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderPrintStreams"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/print-streams"},{"label":"Sets the order line collection status of all lines in a completed standard order to order line collection status Collected","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_setorderascollected","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_setorderascollected","metadata":{"seo":{"title":"Sets the order line collection status of all lines in a completed standard order to order line collection status Collected","description":"Calling this endpoint confirms that all completed order print streams have been printed and will prevent any further calls to GetPrintStreams."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrders_SetOrderAsCollected","name":"Sets the order line collection status of all lines in a completed standard order to order line collection status Collected","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1collection-status~1collected/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sets the order line collection status of all lines in a completed standard order to order line collection status Collected","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calling this endpoint confirms that all completed order print streams have been printed and will prevent any further calls to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getprintstreams"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GetPrintStreams"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint will also start the preparation of any items in a completed standard order, so a further call to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_startorderpreparation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"StartOrderPreparation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not necessary."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The completed order print streams ItemCollectionVouchers will contain relevant collection details."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completed-orders/ocapicompletedorders_setorderascollected/request/licenses-required","deepLinkHash":"/completed-orders/ocapicompletedorders_setorderascollected#completed-orders/ocapicompletedorders_setorderascollected/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed standard order being retrieved","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1collection-status~1collected/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1collection-status~1collected/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderCollectionStatusUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderCollectionStatusUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderCollectionStatusUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderCollectionStatusUpdate"}},"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderCollectionStatusUpdate","pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1collection-status~1collected/put/requestBody","description":"The additional request options"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/orders/completed/{orderId}/collection-status/collected","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderCollectionStatusUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderCollectionStatusUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderCollectionStatusUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderCollectionStatusUpdate"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/collection-status/collected","href":"completed-orders/ocapicompletedorders_setorderascollected","openApiOperationId":"OcapiCompletedOrders_SetOrderAsCollected","summary":"Sets the order line collection status of all lines in a completed standard order to order line collection status Collected"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderCollectionStatusUpdate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderCollectionStatusUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderCollectionStatusUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderCollectionStatusUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderCollectionStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderDetails"},{"code":"400","description":"Order has already been collected."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1collection-status~1collected/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderDetails"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/collection-status/collected"},{"label":"Creates an in progress standard order that is a child of a completed standard order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_createchildorder","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_createchildorder","metadata":{"seo":{"title":"Creates an in progress standard order that is a child of a completed standard order","description":"This endpoint can only be used for completed standard order entities that are not children themselves."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrders_CreateChildOrder","name":"Creates an in progress standard order that is a child of a completed standard order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1child-orders/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates an in progress standard order that is a child of a completed standard order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint can only be used for completed standard order entities that are not children themselves."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"orders/ocapicompletedorders_createchildorder/request/completed-orders/ocapicompletedorders_createchildorder/request/licenses-required","deepLinkHash":"/orders/ocapicompletedorders_createchildorder#orders/ocapicompletedorders_createchildorder/request/completed-orders/ocapicompletedorders_createchildorder/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed standard order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1child-orders/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1child-orders/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/completed/{orderId}/child-orders","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/child-orders","href":"completed-orders/ocapicompletedorders_createchildorder","openApiOperationId":"OcapiCompletedOrders_CreateChildOrder","summary":"Creates an in progress standard order that is a child of a completed standard order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1child-orders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/child-orders"},{"label":"Gets the order showtime seats details for the provided barcode","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorderseats_getorderseatsbybarcode","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorderseats_getorderseatsbybarcode","metadata":{"seo":{"title":"Gets the order showtime seats details for the provided barcode","description":"Can return seats for orders that were not made by Connect, e.g. POS."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrderSeats_GetOrderSeatsByBarcode","name":"Gets the order showtime seats details for the provided barcode","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1by-barcode~1{barcode}~1seats/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the order showtime seats details for the provided barcode","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can return seats for orders that were not made by Connect, e.g. POS."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only seats for showtimes that are currently available for purchase will be returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"seats/ocapicompletedorderseats_getorderseatsbybarcode/request/completed-orders/ocapicompletedorderseats_getorderseatsbybarcode/request/licenses-required","deepLinkHash":"/seats/ocapicompletedorderseats_getorderseatsbybarcode#seats/ocapicompletedorderseats_getorderseatsbybarcode/request/completed-orders/ocapicompletedorderseats_getorderseatsbybarcode/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site","required":true},{"name":"barcode","in":"path","schemaId":"schema_33","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ambiguous reference that can be used to identify a booking or a ticket in a completed order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"example","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WQ9LJTK (booking ID)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"example","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"B10000044294 (booking barcode)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"example","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S100044294 (short booking barcode)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"example","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"B100000442940001 (booking ticket barcode)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"example","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S1000442940001 (short booking ticket barcode)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"example","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"T10000041793 (transaction barcode)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"example","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"T100000417930001 (transaction ticket barcode)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"example","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"U100041793 (short transaction barcode)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"example","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"U1000417930001 (short transaction ticket barcode)"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1by-barcode~1{barcode}~1seats/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1by-barcode~1{barcode}~1seats/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}/orders/by-barcode/{barcode}/seats","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"},{"name":"barcode","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}/orders/by-barcode/{barcode}/seats","href":"completed-orders/ocapicompletedorderseats_getorderseatsbybarcode","openApiOperationId":"OcapiCompletedOrderSeats_GetOrderSeatsByBarcode","summary":"Gets the order showtime seats details for the provided barcode"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatsDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatsDetails"},{"code":"404","description":"Order not found."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1by-barcode~1{barcode}~1seats/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatsDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatsDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}/orders/by-barcode/{barcode}/seats"},{"label":"Gets a journey details for a completed standard order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapijourneys_getjourneyforcompletedorder","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapijourneys_getjourneyforcompletedorder","metadata":{"seo":{"title":"Gets a journey details for a completed standard order","description":"Gets a journey which represents, from start to finish, a customer's interactions withVista software in relation to one or multiple visits to the cinema initiated by asingle sale."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiJourneys_GetJourneyForCompletedOrder","name":"Gets a journey details for a completed standard order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1journeys~1by-order-id~1{orderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a journey details for a completed standard order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets a journey which represents, from start to finish, a customer's interactions with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista software in relation to one or multiple visits to the cinema initiated by a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single sale."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completed-orders/ocapijourneys_getjourneyforcompletedorder/request/licenses-required","deepLinkHash":"/completed-orders/ocapijourneys_getjourneyforcompletedorder#completed-orders/ocapijourneys_getjourneyforcompletedorder/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed standard order","required":true}],"pointer":"/paths/~1ocapi~1v1~1journeys~1by-order-id~1{orderId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1journeys~1by-order-id~1{orderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/journeys/by-order-id/{orderId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","202","404"],"pointer":"/ocapi/v1/journeys/by-order-id/{orderId}","href":"completed-orders/ocapijourneys_getjourneyforcompletedorder","openApiOperationId":"OcapiJourneys_GetJourneyForCompletedOrder","summary":"Gets a journey details for a completed standard order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Journey.JourneyDetails"}},"schemaId":"components/schemas/Ocapi.V1.Journey.JourneyDetails"},{"code":"202","description":"Order exists, but journey is not yet ready for retrieval."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1journeys~1by-order-id~1{orderId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Journey.JourneyDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Journey.JourneyDetails"}}},{"code":"202"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/journeys/by-order-id/{orderId}"},{"label":"Gets a list of active member completed order base entities for the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapimembercompletedorders_getmemberactivecompletedorders","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapimembercompletedorders_getmemberactivecompletedorders","metadata":{"seo":{"title":"Gets a list of active member completed order base entities for the currently authenticated member","description":"Active orders are defined as member completed order base entities that have not expired (see member completed order base ExpiresAt)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberCompletedOrders_GetMemberActiveCompletedOrders","name":"Gets a list of active member completed order base entities for the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1completed-orders~1active/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of active member completed order base entities for the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active orders are defined as member completed order base entities that have not expired (see member completed order base ExpiresAt)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active orders are returned in descending order based on the member completed order base CreatedAt date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint does not currently support tab order entities."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimembercompletedorders_getmemberactivecompletedorders/request/completed-orders/ocapimembercompletedorders_getmemberactivecompletedorders/request/licenses-required","deepLinkHash":"/members/ocapimembercompletedorders_getmemberactivecompletedorders#members/ocapimembercompletedorders_getmemberactivecompletedorders/request/completed-orders/ocapimembercompletedorders_getmemberactivecompletedorders/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1completed-orders~1active/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/completed-orders/active","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","401"],"pointer":"/ocapi/v1/members/current/completed-orders/active","href":"completed-orders/ocapimembercompletedorders_getmemberactivecompletedorders","openApiOperationId":"OcapiMemberCompletedOrders_GetMemberActiveCompletedOrders","summary":"Gets a list of active member completed order base entities for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderListDetails"},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1completed-orders~1active/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderListDetails"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/completed-orders/active"},{"label":"Gets a list of expired member completed order base entities for the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapimembercompletedorders_getmemberexpiredcompletedorders","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapimembercompletedorders_getmemberexpiredcompletedorders","metadata":{"seo":{"title":"Gets a list of expired member completed order base entities for the currently authenticated member","description":"Expired completed orders are member completed order base entities that have expired (see member completed order base ExpiresAt)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberCompletedOrders_GetMemberExpiredCompletedOrders","name":"Gets a list of expired member completed order base entities for the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1completed-orders~1expired/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of expired member completed order base entities for the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expired completed orders are member completed order base entities that have expired (see member completed order base ExpiresAt)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination is supported as potentially large amounts of historical data is in scope of query."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expired orders are returned in descending order based on the member completed order base CreatedAt date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint does not currently support tab order entities."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimembercompletedorders_getmemberexpiredcompletedorders/request/completed-orders/ocapimembercompletedorders_getmemberexpiredcompletedorders/request/licenses-required","deepLinkHash":"/members/ocapimembercompletedorders_getmemberexpiredcompletedorders#members/ocapimembercompletedorders_getmemberexpiredcompletedorders/request/completed-orders/ocapimembercompletedorders_getmemberexpiredcompletedorders/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_35","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of orders to return in the result set. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_36","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index of the first order to return in the result set. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]}]}]}]}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1completed-orders~1expired/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1completed-orders~1expired/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/completed-orders/expired","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_35"},{"name":"offset","in":"query","schemaId":"schema_36"}],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/ocapi/v1/members/current/completed-orders/expired","href":"completed-orders/ocapimembercompletedorders_getmemberexpiredcompletedorders","openApiOperationId":"OcapiMemberCompletedOrders_GetMemberExpiredCompletedOrders","summary":"Gets a list of expired member completed order base entities for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderPaginatedResultSet"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderPaginatedResultSet"},{"code":"400","description":"The provided limit or offset is invalid."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1completed-orders~1expired/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderPaginatedResultSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderPaginatedResultSet"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/completed-orders/expired"},{"label":"Gets the survey for a completed standard order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapisurveys_getordersurvey","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapisurveys_getordersurvey","metadata":{"seo":{"title":"Gets the survey for a completed standard order","description":"Only standard orders with a single showtime are applicable for a survey."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiSurveys_GetOrderSurvey","name":"Gets the survey for a completed standard order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1survey/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the survey for a completed standard order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only standard orders with a single showtime are applicable for a survey."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A survey that has been completed will return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response, where survey IsCompleted equals true."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"surveys/ocapisurveys_getordersurvey/request/completed-orders/ocapisurveys_getordersurvey/request/licenses-required","deepLinkHash":"/surveys/ocapisurveys_getordersurvey#surveys/ocapisurveys_getordersurvey/request/completed-orders/ocapisurveys_getordersurvey/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Surveys"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed standard order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1survey/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1survey/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/completed/{orderId}/survey","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/survey","href":"completed-orders/ocapisurveys_getordersurvey","openApiOperationId":"OcapiSurveys_GetOrderSurvey","summary":"Gets the survey for a completed standard order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.SurveyDetails"}},"schemaId":"components/schemas/Ocapi.V1.Surveys.SurveyDetails"},{"code":"400","description":"Surveys are not enabled or not applicable for this order."},{"code":"404","description":"Order does not exist, or the survey is not yet available or has expired."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1survey/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Surveys.SurveyDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.SurveyDetails"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/survey"},{"label":"Updates the survey responses for completed standard order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapisurveys_setordersurveyresponses","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapisurveys_setordersurveyresponses","metadata":{"seo":{"title":"Updates the survey responses for completed standard order","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiSurveys_SetOrderSurveyResponses","name":"Updates the survey responses for completed standard order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1survey~1responses/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates the survey responses for completed standard order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"surveys/ocapisurveys_setordersurveyresponses/request/completed-orders/ocapisurveys_setordersurveyresponses/request/licenses-required","deepLinkHash":"/surveys/ocapisurveys_setordersurveyresponses#surveys/ocapisurveys_setordersurveyresponses/request/completed-orders/ocapisurveys_setordersurveyresponses/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Surveys"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed standard order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1survey~1responses/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1survey~1responses/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"}},"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate","pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1survey~1responses/put/requestBody","description":"The survey responses to be updated"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/orders/completed/{orderId}/survey/responses","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"}},"responseCodes":["204","400","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/survey/responses","href":"completed-orders/ocapisurveys_setordersurveyresponses","openApiOperationId":"OcapiSurveys_SetOrderSurveyResponses","summary":"Updates the survey responses for completed standard order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Survey responses updated."},{"code":"400","description":"Survey is expired or already completed, or one or more question responses are missing or invalid."},{"code":"404","description":"Order or survey does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1survey~1responses/put/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/survey/responses"},{"label":"Starts preparation of items in a completed standard order","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_startorderpreparation","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_startorderpreparation","metadata":{"seo":{"title":"Starts preparation of items in a completed standard order","description":"Calling this endpoint will also set the CollectionStatus of the items to Collected."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrders_StartOrderPreparation","name":"Starts preparation of items in a completed standard order","deprecated":true,"isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1preparation/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Starts preparation of items in a completed standard order","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calling this endpoint will also set the CollectionStatus of the items to Collected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is not necessary to call this endpoint if "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_setorderascollected"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SetOrderAsCollected"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" had been called prior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as the concession items that require preparing will have already been sent to the kitchen."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completed-orders/ocapicompletedorders_startorderpreparation/request/licenses-required","deepLinkHash":"/completed-orders/ocapicompletedorders_startorderpreparation#completed-orders/ocapicompletedorders_startorderpreparation/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed standard order that is to be prepared for collection","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1preparation/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1preparation/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/completed/{orderId}/preparation","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/preparation","href":"completed-orders/ocapicompletedorders_startorderpreparation","openApiOperationId":"OcapiCompletedOrders_StartOrderPreparation","summary":"Starts preparation of items in a completed standard order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Preparations.OrderPreparation"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Preparations.OrderPreparation"},{"code":"400","description":"Order preparation cannot be started."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1preparation/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Preparations.OrderPreparation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Preparations.OrderPreparation"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/preparation"},{"label":"Requests the preparation of all completed order item delivery base entities in a completed standard order\r\nwith an completed order item delivery preparation status OnHold status that are available for preparation to\r\ncompleted order item delivery preparation status Requested","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_prepareallitemdeliveries","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_prepareallitemdeliveries","metadata":{"seo":{"title":"Requests the preparation of all completed order item delivery base entities in a completed standard order\r\nwith an completed order item delivery preparation status OnHold status that are available for preparation to\r\ncompleted order item delivery preparation status Requested","description":"Calling this endpoint will also set the collectable order line CollectionStatus of all items in thecompleted standard order to order line collection status Collected"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrders_PrepareAllItemDeliveries","name":"Requests the preparation of all completed order item delivery base entities in a completed standard order\r\nwith an completed order item delivery preparation status OnHold status that are available for preparation to\r\ncompleted order item delivery preparation status Requested","deprecated":true,"isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1item-deliveries~1preparation/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Requests the preparation of all completed order item delivery base entities in a completed standard order\r\nwith an completed order item delivery preparation status OnHold status that are available for preparation to\r\ncompleted order item delivery preparation status Requested","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calling this endpoint will also set the collectable order line CollectionStatus of all items in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completed standard order to order line collection status Collected"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completed-orders/ocapicompletedorders_prepareallitemdeliveries/request/licenses-required","deepLinkHash":"/completed-orders/ocapicompletedorders_prepareallitemdeliveries#completed-orders/ocapicompletedorders_prepareallitemdeliveries/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed standard order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1item-deliveries~1preparation/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1item-deliveries~1preparation/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/preparation","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/preparation","href":"completed-orders/ocapicompletedorders_prepareallitemdeliveries","openApiOperationId":"OcapiCompletedOrders_PrepareAllItemDeliveries","summary":"Requests the preparation of all completed order item delivery base entities in a completed standard order\r\nwith an completed order item delivery preparation status OnHold status that are available for preparation to\r\ncompleted order item delivery preparation status Requested"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrder"}},"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrder"},{"code":"400","description":"Order item delivery preparation cannot be started."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1item-deliveries~1preparation/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrder"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/preparation"},{"label":"Requests the preparation of a completed order item delivery base with an completed order item delivery preparation status OnHold status","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_prepareitemdelivery","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_prepareitemdelivery","metadata":{"seo":{"title":"Requests the preparation of a completed order item delivery base with an completed order item delivery preparation status OnHold status","description":"This endpoint can only be used for completed order item delivery base entities with an order item delivery schedule type OnRequest schedule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrders_PrepareItemDelivery","name":"Requests the preparation of a completed order item delivery base with an completed order item delivery preparation status OnHold status","deprecated":true,"isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1item-deliveries~1{itemDeliveryId}~1preparation/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Requests the preparation of a completed order item delivery base with an completed order item delivery preparation status OnHold status","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint can only be used for completed order item delivery base entities with an order item delivery schedule type OnRequest schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calling this endpoint will also set the collectable order line CollectionStatus of all items in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completed standard order to order line collection status Collected"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completed-orders/ocapicompletedorders_prepareitemdelivery/request/licenses-required","deepLinkHash":"/completed-orders/ocapicompletedorders_prepareitemdelivery#completed-orders/ocapicompletedorders_prepareitemdelivery/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed standard order","required":true},{"name":"itemDeliveryId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed order item delivery base that is to be prepared","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1item-deliveries~1{itemDeliveryId}~1preparation/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1item-deliveries~1{itemDeliveryId}~1preparation/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/{itemDeliveryId}/preparation","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"},{"name":"itemDeliveryId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/{itemDeliveryId}/preparation","href":"completed-orders/ocapicompletedorders_prepareitemdelivery","openApiOperationId":"OcapiCompletedOrders_PrepareItemDelivery","summary":"Requests the preparation of a completed order item delivery base with an completed order item delivery preparation status OnHold status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37"}},"schemaId":"schema_37"},{"code":"400","description":"Order item delivery preparation cannot be started."},{"code":"404","description":"Order or item delivery does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1item-deliveries~1{itemDeliveryId}~1preparation/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_37","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/{itemDeliveryId}/preparation"}],"content":{"contentType":"group","meta":{"name":"Completed Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Completed Orders","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/orders/completed/{orderId}/customer","summary":"Gets the customer set on a completed standard order or completed gift shop order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/completed-orders/ocapicompletedordercustomer_getcustomer","deprecated":false},{"title":"/ocapi/v1/orders/completed/{orderId}","summary":"Gets the details of a completed order base","prefix":{"name":"get","color":"get"},"badges":[],"link":"/completed-orders/ocapicompletedorders_getcompletedorder","deprecated":false},{"title":"/ocapi/v1/orders/completed/by-journey-reference/{journeyReference}","summary":"Gets the details of a completed standard order by its completed standard order JourneyReference","prefix":{"name":"get","color":"get"},"badges":[],"link":"/completed-orders/ocapicompletedorders_getcompletedorderbyjourneyreference","deprecated":false},{"title":"/ocapi/v1/orders/completed/sites/{siteId}/by-booking-id/{bookingId}","summary":"Gets the details of a completed standard order by its completed order booking Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/completed-orders/ocapicompletedorders_getcompletedorderbybookingid","deprecated":false},{"title":"/ocapi/v1/orders/completed/{orderId}/showtimes/{showtimeId}/seats","summary":"Swaps the seats for an order showtime within a completed standard order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/completed-orders/ocapicompletedorders_swapseats","deprecated":false},{"title":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/preparation-status/requested","summary":"Requests the preparation of all completed order item delivery base entities in a completed standard order\r\nwith an completed order item delivery preparation status OnHold status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/completed-orders/ocapicompletedorders_setitemdeliveriesasrequested","deprecated":false},{"title":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/{itemDeliveryId}/preparation-status/requested","summary":"Requests the preparation of a completed order item delivery base with an completed order item delivery preparation status OnHold status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/completed-orders/ocapicompletedorders_setitemdeliveryasrequested","deprecated":false},{"title":"/ocapi/v1/orders/completed/by-journey-reference/{journeyReference}/identifiers","summary":"Gets the completed standard order identifiers for a completed standard order\r\nby its completed standard order JourneyReference","prefix":{"name":"get","color":"get"},"badges":[],"link":"/completed-orders/ocapicompletedorders_getorderidentifiersbyjourneyreference","deprecated":false},{"title":"/ocapi/v1/orders/completed/{orderId}/print-streams","summary":"Gets the print streams of an uncollected completed order base that are compatible with the requested printer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/completed-orders/ocapicompletedorders_getprintstreams","deprecated":false},{"title":"/ocapi/v1/orders/completed/{orderId}/collection-status/collected","summary":"Sets the order line collection status of all lines in a completed standard order to order line collection status Collected","prefix":{"name":"put","color":"put"},"badges":[],"link":"/completed-orders/ocapicompletedorders_setorderascollected","deprecated":false},{"title":"/ocapi/v1/orders/completed/{orderId}/child-orders","summary":"Creates an in progress standard order that is a child of a completed standard order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/completed-orders/ocapicompletedorders_createchildorder","deprecated":false},{"title":"/ocapi/v1/sites/{siteId}/orders/by-barcode/{barcode}/seats","summary":"Gets the order showtime seats details for the provided barcode","prefix":{"name":"get","color":"get"},"badges":[],"link":"/completed-orders/ocapicompletedorderseats_getorderseatsbybarcode","deprecated":false},{"title":"/ocapi/v1/journeys/by-order-id/{orderId}","summary":"Gets a journey details for a completed standard order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/completed-orders/ocapijourneys_getjourneyforcompletedorder","deprecated":false},{"title":"/ocapi/v1/members/current/completed-orders/active","summary":"Gets a list of active member completed order base entities for the currently authenticated member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/completed-orders/ocapimembercompletedorders_getmemberactivecompletedorders","deprecated":false},{"title":"/ocapi/v1/members/current/completed-orders/expired","summary":"Gets a list of expired member completed order base entities for the currently authenticated member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/completed-orders/ocapimembercompletedorders_getmemberexpiredcompletedorders","deprecated":false},{"title":"/ocapi/v1/orders/completed/{orderId}/survey","summary":"Gets the survey for a completed standard order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/completed-orders/ocapisurveys_getordersurvey","deprecated":false},{"title":"/ocapi/v1/orders/completed/{orderId}/survey/responses","summary":"Updates the survey responses for completed standard order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/completed-orders/ocapisurveys_setordersurveyresponses","deprecated":false},{"title":"/ocapi/v1/orders/completed/{orderId}/preparation","summary":"Starts preparation of items in a completed standard order","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/completed-orders/ocapicompletedorders_startorderpreparation","deprecated":true},{"title":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/preparation","summary":"Requests the preparation of all completed order item delivery base entities in a completed standard order\r\nwith an completed order item delivery preparation status OnHold status that are available for preparation to\r\ncompleted order item delivery preparation status Requested","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/completed-orders/ocapicompletedorders_prepareallitemdeliveries","deprecated":true},{"title":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/{itemDeliveryId}/preparation","summary":"Requests the preparation of a completed order item delivery base with an completed order item delivery preparation status OnHold status","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/completed-orders/ocapicompletedorders_prepareitemdelivery","deprecated":true}]}]}]}]}},{"type":"group","label":"Orders","link":"/openapi/digital-platform/openapi/orders","routeSlug":"/openapi/digital-platform/openapi/orders","items":[{"label":"Creates an in progress standard order that is a child of a completed standard order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapicompletedorders_createchildorder","routeSlug":"/openapi/digital-platform/openapi/orders/ocapicompletedorders_createchildorder","metadata":{"seo":{"title":"Creates an in progress standard order that is a child of a completed standard order","description":"This endpoint can only be used for completed standard order entities that are not children themselves."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrders_CreateChildOrder","name":"Creates an in progress standard order that is a child of a completed standard order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1child-orders/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates an in progress standard order that is a child of a completed standard order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint can only be used for completed standard order entities that are not children themselves."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"orders/ocapicompletedorders_createchildorder/request/completed-orders/ocapicompletedorders_createchildorder/request/licenses-required","deepLinkHash":"/orders/ocapicompletedorders_createchildorder#orders/ocapicompletedorders_createchildorder/request/completed-orders/ocapicompletedorders_createchildorder/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed standard order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1child-orders/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1child-orders/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/completed/{orderId}/child-orders","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/child-orders","href":"orders/ocapicompletedorders_createchildorder","openApiOperationId":"OcapiCompletedOrders_CreateChildOrder","summary":"Creates an in progress standard order that is a child of a completed standard order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1child-orders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/child-orders"},{"label":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapimemberorders_getmembertabordersforsite","routeSlug":"/openapi/digital-platform/openapi/orders/ocapimemberorders_getmembertabordersforsite","metadata":{"seo":{"title":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberOrders_GetMemberTabOrdersForSite","name":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1orders~1tab~1by-site~1{siteId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tabs/ocapimemberorders_getmembertabordersforsite/request/members/ocapimemberorders_getmembertabordersforsite/request/orders/ocapimemberorders_getmembertabordersforsite/request/licenses-required","deepLinkHash":"/tabs/ocapimemberorders_getmembertabordersforsite#tabs/ocapimemberorders_getmembertabordersforsite/request/members/ocapimemberorders_getmembertabordersforsite/request/orders/ocapimemberorders_getmembertabordersforsite/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.ChecksAPI"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","required":true}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1orders~1tab~1by-site~1{siteId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1orders~1tab~1by-site~1{siteId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/orders/tab/by-site/{siteId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","401","404"],"pointer":"/ocapi/v1/members/current/orders/tab/by-site/{siteId}","href":"orders/ocapimemberorders_getmembertabordersforsite","openApiOperationId":"OcapiMemberOrders_GetMemberTabOrdersForSite","summary":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderListDetailsGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressTabOrder"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderListDetailsGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressTabOrder"},{"code":"401","description":"No member authenticated."},{"code":"404","description":"Site does not exist."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1orders~1tab~1by-site~1{siteId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderListDetailsGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressTabOrder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderListDetailsGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressTabOrder"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/orders/tab/by-site/{siteId}"},{"label":"Sets the customer for an in progress standard order, in progress gift shop order,\r\nor in progress tab order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiordercustomer_setcustomer","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiordercustomer_setcustomer","metadata":{"seo":{"title":"Sets the customer for an in progress standard order, in progress gift shop order,\r\nor in progress tab order","description":"This endpoint is not available for in progress subscription order entities, as the order customer isautomatically set based on the details of the authenticated member"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderCustomer_SetCustomer","name":"Sets the customer for an in progress standard order, in progress gift shop order,\r\nor in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1customer/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sets the customer for an in progress standard order, in progress gift shop order,\r\nor in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is not available for in progress subscription order entities, as the order customer is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automatically set based on the details of the authenticated member"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only a subset of order customer are currently supported for in progress tab order entities."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"orders/ocapiordercustomer_setcustomer/request/licenses-required","deepLinkHash":"/orders/ocapiordercustomer_setcustomer#orders/ocapiordercustomer_setcustomer/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base being modified","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1customer/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1customer/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.Requests.OrderCustomerUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.Requests.OrderCustomerUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.Requests.OrderCustomerUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.Requests.OrderCustomerUpdate"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.Requests.OrderCustomerUpdate","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1customer/put/requestBody","description":"The customer's details"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/orders/{orderId}/customer","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.Requests.OrderCustomerUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.Requests.OrderCustomerUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.Requests.OrderCustomerUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.Requests.OrderCustomerUpdate"}},"responseCodes":["204","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/customer","href":"orders/ocapiordercustomer_setcustomer","openApiOperationId":"OcapiOrderCustomer_SetCustomer","summary":"Sets the customer for an in progress standard order, in progress gift shop order,\r\nor in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.Requests.OrderCustomerUpdate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.Requests.OrderCustomerUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.Requests.OrderCustomerUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.Requests.OrderCustomerUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.Requests.OrderCustomerUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Order customer updated."},{"code":"400","description":"Request property is invalid for order type or missing."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1customer/put/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/orders/{orderId}/customer"},{"label":"Gets the customer set on an in progress order base","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiordercustomer_getcustomer","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiordercustomer_getcustomer","metadata":{"seo":{"title":"Gets the customer set on an in progress order base","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderCustomer_GetCustomer","name":"Gets the customer set on an in progress order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1customer/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the customer set on an in progress order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"orders/ocapiordercustomer_getcustomer/request/licenses-required","deepLinkHash":"/orders/ocapiordercustomer_getcustomer#orders/ocapiordercustomer_getcustomer/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1customer/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1customer/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/{orderId}/customer","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/orders/{orderId}/customer","href":"orders/ocapiordercustomer_getcustomer","openApiOperationId":"OcapiOrderCustomer_GetCustomer","summary":"Gets the customer set on an in progress order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.OrderCustomer"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.OrderCustomer"},{"code":"404","description":"Order does not exist, or customer has not been set."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1customer/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Customers.OrderCustomer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Customers.OrderCustomer"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/customer"},{"label":"Adds items to an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiorderitems_additems","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiorderitems_additems","metadata":{"seo":{"title":"Adds items to an in progress tab order","description":"Items cannot be added to an in progress tab order when in progress tab order IsOpen equals false."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderItems_AddItems","name":"Adds items to an in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adds items to an in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items cannot be added to an in progress tab order when in progress tab order IsOpen equals false."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For in progress standard order or in progress gift shop order entities, use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/items/ocapiorderitems_setitems"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SetItems"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items that require preparation are immediately sent to the kitchen."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items cannot be removed or modified once added to an in progress tab order"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tabs/ocapiorderitems_additems/request/items/ocapiorderitems_additems/request/orders/ocapiorderitems_additems/request/licenses-required","deepLinkHash":"/tabs/ocapiorderitems_additems#tabs/ocapiorderitems_additems/request/items/ocapiorderitems_additems/request/orders/ocapiorderitems_additems/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress tab order being modified","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/post/requestBody","description":"The requested items"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/items","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/items","href":"orders/ocapiorderitems_additems","openApiOperationId":"OcapiOrderItems_AddItems","summary":"Adds items to an in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order items","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase"},{"code":"400","description":"Request property is invalid or missing, or invalid order type."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/items"},{"label":"Assigns an in progress tab order to the currently authenticated member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiordermember_setordermember","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiordermember_setordermember","metadata":{"seo":{"title":"Assigns an in progress tab order to the currently authenticated member","description":"This endpoint is not available for in progress standard order,in progress gift shop order or in progress subscription order entities, as theauthenticated member is automatically set when the order is created or modified."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderMember_SetOrderMember","name":"Assigns an in progress tab order to the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1member~1current/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assigns an in progress tab order to the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is not available for in progress standard order,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in progress gift shop order or in progress subscription order entities, as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authenticated member is automatically set when the order is created or modified."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapiordermember_setordermember/request/orders/ocapiordermember_setordermember/request/licenses-required","deepLinkHash":"/members/ocapiordermember_setordermember#members/ocapiordermember_setordermember/request/orders/ocapiordermember_setordermember/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress tab order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1member~1current/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1member~1current/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/orders/{orderId}/member/current","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["204","400","401","404","409"],"pointer":"/ocapi/v1/orders/{orderId}/member/current","href":"orders/ocapiordermember_setordermember","openApiOperationId":"OcapiOrderMember_SetOrderMember","summary":"Assigns an in progress tab order to the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Order member updated."},{"code":"400","description":"Invalid order type."},{"code":"401","description":"No member authenticated."},{"code":"404","description":"Order does not exist."},{"code":"409","description":"Order has already been assigned to another member."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1member~1current/put/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/orders/{orderId}/member/current"},{"label":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiorderpaymentcard_createorderembeddedpaymentcard","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiorderpaymentcard_createorderembeddedpaymentcard","metadata":{"seo":{"title":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderPaymentCard_CreateOrderEmbeddedPaymentCard","name":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1embedded/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapiorderpaymentcard_createorderembeddedpaymentcard/request/tabs/ocapiorderpaymentcard_createorderembeddedpaymentcard/request/orders/ocapiorderpaymentcard_createorderembeddedpaymentcard/request/licenses-required","deepLinkHash":"/payments/ocapiorderpaymentcard_createorderembeddedpaymentcard#payments/ocapiorderpaymentcard_createorderembeddedpaymentcard/request/tabs/ocapiorderpaymentcard_createorderembeddedpaymentcard/request/orders/ocapiorderpaymentcard_createorderembeddedpaymentcard/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress tab order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1embedded/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1embedded/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1embedded/post/requestBody","description":"The values needed to create an embedded order payment card"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/payment-card/embedded","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/payment-card/embedded","href":"orders/ocapiorderpaymentcard_createorderembeddedpaymentcard","openApiOperationId":"OcapiOrderPaymentCard_CreateOrderEmbeddedPaymentCard","summary":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardClientData"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardClientData"},{"code":"400","description":"Request property is invalid/missing or Customer Details have not been set."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1embedded/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardClientData","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardClientData"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/payment-card/embedded"},{"label":"Gets the current order payment card for an in progress tab order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiorderpaymentcard_getcurrentorderpaymentcard","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiorderpaymentcard_getcurrentorderpaymentcard","metadata":{"seo":{"title":"Gets the current order payment card for an in progress tab order","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderPaymentCard_GetCurrentOrderPaymentCard","name":"Gets the current order payment card for an in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1current/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current order payment card for an in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapiorderpaymentcard_getcurrentorderpaymentcard/request/tabs/ocapiorderpaymentcard_getcurrentorderpaymentcard/request/orders/ocapiorderpaymentcard_getcurrentorderpaymentcard/request/licenses-required","deepLinkHash":"/payments/ocapiorderpaymentcard_getcurrentorderpaymentcard#payments/ocapiorderpaymentcard_getcurrentorderpaymentcard/request/tabs/ocapiorderpaymentcard_getcurrentorderpaymentcard/request/orders/ocapiorderpaymentcard_getcurrentorderpaymentcard/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress tab order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1current/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1current/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/{orderId}/payment-card/current","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/payment-card/current","href":"orders/ocapiorderpaymentcard_getcurrentorderpaymentcard","openApiOperationId":"OcapiOrderPaymentCard_GetCurrentOrderPaymentCard","summary":"Gets the current order payment card for an in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderPaymentCard"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderPaymentCard"},{"code":"400","description":"Order is not a tab order."},{"code":"404","description":"Order does not exist, or payment card has not been created."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1current/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderPaymentCard","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderPaymentCard"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/payment-card/current"},{"label":"Removes an order payment base from an in progress order base","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiorderpayments_removepayment","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiorderpayments_removepayment","metadata":{"seo":{"title":"Removes an order payment base from an in progress order base","description":"Only order gift card payment and order member balance payment entities can be removed at this time."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderPayments_RemovePayment","name":"Removes an order payment base from an in progress order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1{paymentId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removes an order payment base from an in progress order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only order gift card payment and order member balance payment entities can be removed at this time."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapiorderpayments_removepayment/request/orders/ocapiorderpayments_removepayment/request/licenses-required","deepLinkHash":"/payments/ocapiorderpayments_removepayment#payments/ocapiorderpayments_removepayment/request/orders/ocapiorderpayments_removepayment/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base that the payment will be removed from","required":true},{"name":"paymentId","in":"path","schemaId":"schema_33","description":"The unique identifier of the order payment base to be removed","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1{paymentId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1{paymentId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ocapi/v1/orders/{orderId}/payments/{paymentId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"},{"name":"paymentId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["204","400"],"pointer":"/ocapi/v1/orders/{orderId}/payments/{paymentId}","href":"orders/ocapiorderpayments_removepayment","openApiOperationId":"OcapiOrderPayments_RemovePayment","summary":"Removes an order payment base from an in progress order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Payment removed."},{"code":"400","description":"Payment cannot be removed."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1{paymentId}/delete/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/orders/{orderId}/payments/{paymentId}"},{"label":"Creates an order payment card payment and completes the in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiorderpayments_createpaymentcardpayment","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiorderpayments_createpaymentcardpayment","metadata":{"seo":{"title":"Creates an order payment card payment and completes the in progress tab order","description":"The order must have an assigned in progress tab order PaymentCard and an unpaid balancein order to create an order payment card payment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderPayments_CreatePaymentCardPayment","name":"Creates an order payment card payment and completes the in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1payment-card/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates an order payment card payment and completes the in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order must have an assigned in progress tab order PaymentCard and an unpaid balance"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in order to create an order payment card payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment card will be charged for the unpaid balance of the in progress tab order"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapiorderpayments_createpaymentcardpayment/request/tabs/ocapiorderpayments_createpaymentcardpayment/request/orders/ocapiorderpayments_createpaymentcardpayment/request/licenses-required","deepLinkHash":"/payments/ocapiorderpayments_createpaymentcardpayment#payments/ocapiorderpayments_createpaymentcardpayment/request/tabs/ocapiorderpayments_createpaymentcardpayment/request/orders/ocapiorderpayments_createpaymentcardpayment/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress tab order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1payment-card/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1payment-card/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/payments/payment-card","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/payments/payment-card","href":"orders/ocapiorderpayments_createpaymentcardpayment","openApiOperationId":"OcapiOrderPayments_CreatePaymentCardPayment","summary":"Creates an order payment card payment and completes the in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}},"schemaId":"schema_38"},{"code":"400","description":"Order does not contain any concessions or Payment card declined."},{"code":"404","description":"Order or payment card does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1payment-card/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_38","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/payments/payment-card"},{"label":"Creates an in progress standard order as a booking","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiorders_createstandardorderasbooking","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiorders_createstandardorderasbooking","metadata":{"seo":{"title":"Creates an in progress standard order as a booking","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrders_CreateStandardOrderAsBooking","name":"Creates an in progress standard order as a booking","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1standard~1booking/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates an in progress standard order as a booking","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"orders/ocapiorders_createstandardorderasbooking/request/licenses-required","deepLinkHash":"/orders/ocapiorders_createstandardorderasbooking#orders/ocapiorders_createstandardorderasbooking/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1standard~1booking/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.StandardOrderAsBookingCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.StandardOrderAsBookingCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.StandardOrderAsBookingCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.StandardOrderAsBookingCreate"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.StandardOrderAsBookingCreate","pointer":"/paths/~1ocapi~1v1~1orders~1standard~1booking/post/requestBody","description":"Details of the order to be created"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/standard/booking","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.StandardOrderAsBookingCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.StandardOrderAsBookingCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.StandardOrderAsBookingCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.StandardOrderAsBookingCreate"}},"responseCodes":["200","400"],"pointer":"/ocapi/v1/orders/standard/booking","href":"orders/ocapiorders_createstandardorderasbooking","openApiOperationId":"OcapiOrders_CreateStandardOrderAsBooking","summary":"Creates an in progress standard order as a booking"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.StandardOrderAsBookingCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.StandardOrderAsBookingCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.StandardOrderAsBookingCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.StandardOrderAsBookingCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.StandardOrderAsBookingCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},{"code":"400","description":"Site does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1standard~1booking/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"}}},{"code":"400"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/standard/booking"},{"label":"Gets the details of a in progress order base","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiorders_getorder","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiorders_getorder","metadata":{"seo":{"title":"Gets the details of a in progress order base","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrders_GetOrder","name":"Gets the details of a in progress order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the details of a in progress order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"orders/ocapiorders_getorder/request/licenses-required","deepLinkHash":"/orders/ocapiorders_getorder#orders/ocapiorders_getorder/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base being retrieved","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/{orderId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/orders/{orderId}","href":"orders/ocapiorders_getorder","openApiOperationId":"OcapiOrders_GetOrder","summary":"Gets the details of a in progress order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase"},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}"},{"label":"Cancels an in progress order base","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiorders_cancelorder","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiorders_cancelorder","metadata":{"seo":{"title":"Cancels an in progress order base","description":"This endpoint is not available for in progress tab order entities, as any items in the orderhave already been processed and confirmed for the patron."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrders_CancelOrder","name":"Cancels an in progress order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancels an in progress order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is not available for in progress tab order entities, as any items in the order"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"have already been processed and confirmed for the patron."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"orders/ocapiorders_cancelorder/request/licenses-required","deepLinkHash":"/orders/ocapiorders_cancelorder#orders/ocapiorders_cancelorder/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base being cancelled","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ocapi/v1/orders/{orderId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["204","400"],"pointer":"/ocapi/v1/orders/{orderId}","href":"orders/ocapiorders_cancelorder","openApiOperationId":"OcapiOrders_CancelOrder","summary":"Cancels an in progress order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Order cancelled."},{"code":"400","description":"Invalid order type or order is already being completed."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}/delete/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/orders/{orderId}"},{"label":"Resets the expiry of an in progress order base","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiorders_resetorderexpiry","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiorders_resetorderexpiry","metadata":{"seo":{"title":"Resets the expiry of an in progress order base","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrders_ResetOrderExpiry","name":"Resets the expiry of an in progress order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1expiry~1reset/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resets the expiry of an in progress order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"orders/ocapiorders_resetorderexpiry/request/licenses-required","deepLinkHash":"/orders/ocapiorders_resetorderexpiry#orders/ocapiorders_resetorderexpiry/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base being reset","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1expiry~1reset/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1expiry~1reset/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/expiry/reset","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/orders/{orderId}/expiry/reset","href":"orders/ocapiorders_resetorderexpiry","openApiOperationId":"OcapiOrders_ResetOrderExpiry","summary":"Resets the expiry of an in progress order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase"},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1expiry~1reset/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/expiry/reset"},{"label":"Removes a voucher from an in progress order base","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiordervouchers_removevoucher","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiordervouchers_removevoucher","metadata":{"seo":{"title":"Removes a voucher from an in progress order base","description":"This endpoint is not available for in progress tab order entities."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderVouchers_RemoveVoucher","name":"Removes a voucher from an in progress order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1vouchers~1{voucherId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removes a voucher from an in progress order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is not available for in progress tab order entities."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the voucher is not a deal voucher, all usages of the voucher on the order must be cancelled before the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"voucher can be removed."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"vouchers/ocapiordervouchers_removevoucher/request/orders/ocapiordervouchers_removevoucher/request/licenses-required","deepLinkHash":"/vouchers/ocapiordervouchers_removevoucher#vouchers/ocapiordervouchers_removevoucher/request/orders/ocapiordervouchers_removevoucher/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base being modified","required":true},{"name":"voucherId","in":"path","schemaId":"schema_33","description":"The unique identifier of the order voucher being removed","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1vouchers~1{voucherId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1vouchers~1{voucherId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ocapi/v1/orders/{orderId}/vouchers/{voucherId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"},{"name":"voucherId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["204","400"],"pointer":"/ocapi/v1/orders/{orderId}/vouchers/{voucherId}","href":"orders/ocapiordervouchers_removevoucher","openApiOperationId":"OcapiOrderVouchers_RemoveVoucher","summary":"Removes a voucher from an in progress order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Voucher removed."},{"code":"400","description":"Voucher cannot be removed."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1vouchers~1{voucherId}/delete/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/orders/{orderId}/vouchers/{voucherId}"},{"label":"Adds a voucher to an in progress order base","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiordervouchers_addvoucher","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiordervouchers_addvoucher","metadata":{"seo":{"title":"Adds a voucher to an in progress order base","description":"This endpoint is not available for in progress tab order entities."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderVouchers_AddVoucher","name":"Adds a voucher to an in progress order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1vouchers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adds a voucher to an in progress order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is not available for in progress tab order entities."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint validates the provided voucher credentials and stores a successfully validated voucher against the order for later use."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"vouchers/ocapiordervouchers_addvoucher/request/orders/ocapiordervouchers_addvoucher/request/licenses-required","deepLinkHash":"/vouchers/ocapiordervouchers_addvoucher#vouchers/ocapiordervouchers_addvoucher/request/orders/ocapiordervouchers_addvoucher/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base being modified","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1vouchers/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1vouchers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_39"},"text/json":{"schemaId":"schema_39"},"application/*+json":{"schemaId":"schema_39"},"application/json-patch+json":{"schemaId":"schema_39"}},"schemaId":"schema_39","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1vouchers/post/requestBody","description":"The details of the voucher to be added to the in progress order base"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/vouchers","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_39"},"text/json":{"schemaId":"schema_39"},"application/*+json":{"schemaId":"schema_39"},"application/json-patch+json":{"schemaId":"schema_39"}},"responseCodes":["200","400","404","429"],"pointer":"/ocapi/v1/orders/{orderId}/vouchers","href":"orders/ocapiordervouchers_addvoucher","openApiOperationId":"OcapiOrderVouchers_AddVoucher","summary":"Adds a voucher to an in progress order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_39","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_39"},"text/json":{"schemaId":"schema_39"},"application/*+json":{"schemaId":"schema_39"},"application/json-patch+json":{"schemaId":"schema_39"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucherDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucherDetails"},{"code":"400","description":"Request property is invalid or missing, or invalid order type/voucher."},{"code":"404","description":"Order does not exist."},{"code":"429","description":"Too many requests. Try again later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}},"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1vouchers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucherDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucherDetails"}}},{"code":"400"},{"code":"404"},{"code":"429","schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}}}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/vouchers"},{"label":"Creates an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapitaborders_createtaborder","routeSlug":"/openapi/digital-platform/openapi/orders/ocapitaborders_createtaborder","metadata":{"seo":{"title":"Creates an in progress tab order","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiTabOrders_CreateTabOrder","name":"Creates an in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1tab/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates an in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tabs/ocapitaborders_createtaborder/request/sites/ocapitaborders_createtaborder/request/orders/ocapitaborders_createtaborder/request/licenses-required","deepLinkHash":"/tabs/ocapitaborders_createtaborder#tabs/ocapitaborders_createtaborder/request/sites/ocapitaborders_createtaborder/request/orders/ocapitaborders_createtaborder/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.ChecksAPI"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1tab/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate","pointer":"/paths/~1ocapi~1v1~1orders~1tab/post/requestBody","description":"Details of the order to be created"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/tab","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/tab","href":"orders/ocapitaborders_createtaborder","openApiOperationId":"OcapiTabOrders_CreateTabOrder","summary":"Creates an in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},{"code":"400","description":"Site does not exist."},{"code":"404","description":"Showtime or seat(s) do not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1tab/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/tab"},{"label":"Gets an in progress tab order by its in progress tab order AccessCode","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapitaborders_gettaborderbyaccesscode","routeSlug":"/openapi/digital-platform/openapi/orders/ocapitaborders_gettaborderbyaccesscode","metadata":{"seo":{"title":"Gets an in progress tab order by its in progress tab order AccessCode","description":"The access code is a case-insensitive, human-readable, 5-character alphanumeric string,generated from a restricted character set designed to avoid visually ambiguous characters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiTabOrders_GetTabOrderByAccessCode","name":"Gets an in progress tab order by its in progress tab order AccessCode","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1tab~1by-access-code~1{accessCode}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets an in progress tab order by its in progress tab order AccessCode","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The access code is a case-insensitive, human-readable, 5-character alphanumeric string,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generated from a restricted character set designed to avoid visually ambiguous characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tabs/ocapitaborders_gettaborderbyaccesscode/request/sites/ocapitaborders_gettaborderbyaccesscode/request/orders/ocapitaborders_gettaborderbyaccesscode/request/licenses-required","deepLinkHash":"/tabs/ocapitaborders_gettaborderbyaccesscode#tabs/ocapitaborders_gettaborderbyaccesscode/request/sites/ocapitaborders_gettaborderbyaccesscode/request/orders/ocapitaborders_gettaborderbyaccesscode/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.ChecksAPI"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","required":true},{"name":"accessCode","in":"path","schemaId":"schema_33","description":"The access code for the in progress tab order being retrieved","required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1tab~1by-access-code~1{accessCode}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1tab~1by-access-code~1{accessCode}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}/orders/tab/by-access-code/{accessCode}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"},{"name":"accessCode","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}/orders/tab/by-access-code/{accessCode}","href":"orders/ocapitaborders_gettaborderbyaccesscode","openApiOperationId":"OcapiTabOrders_GetTabOrderByAccessCode","summary":"Gets an in progress tab order by its in progress tab order AccessCode"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},{"code":"404","description":"Tab order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1tab~1by-access-code~1{accessCode}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}/orders/tab/by-access-code/{accessCode}"},{"label":"Adds a tip to an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ordertips_addordertip","routeSlug":"/openapi/digital-platform/openapi/orders/ordertips_addordertip","metadata":{"seo":{"title":"Adds a tip to an in progress tab order","description":"For in progress standard order entities, use SetOrderTip instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OrderTips_AddOrderTip","name":"Adds a tip to an in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tips/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adds a tip to an in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For in progress standard order entities, use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/tips/ordertips_setordertip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SetOrderTip"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tips/ordertips_addordertip/request/tabs/ordertips_addordertip/request/orders/ordertips_addordertip/request/licenses-required","deepLinkHash":"/tips/ordertips_addordertip#tips/ordertips_addordertip/request/tabs/ordertips_addordertip/request/orders/ordertips_addordertip/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress tab order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tips/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tips/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tips/post/requestBody","description":"The tip to add"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/tips","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/tips","href":"orders/ordertips_addordertip","openApiOperationId":"OrderTips_AddOrderTip","summary":"Adds a tip to an in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/atomsvc+xml","mediaTypes":["application/atomsvc+xml","application/atom+xml; type=feed","application/atom+xml","application/xml","application/atom+xml; type=entry","application/json; odata=minimalmetadata; streaming=true","application/json; odata=minimalmetadata; streaming=false","application/json; odata=minimalmetadata","application/json; odata=fullmetadata; streaming=true","application/json; odata=fullmetadata; streaming=false","application/json; odata=fullmetadata","application/json; odata=nometadata; streaming=true","application/json; odata=nometadata; streaming=false","application/json; odata=nometadata","application/json; odata=verbose","application/json; streaming=true","application/json; streaming=false","application/json","text/xml","text/json","text/plain"],"mediaTypeContent":{"application/atomsvc+xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/atom+xml; type=feed":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/atom+xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/atom+xml; type=entry":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=minimalmetadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=minimalmetadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=minimalmetadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=fullmetadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=fullmetadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=fullmetadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=nometadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=nometadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=nometadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=verbose":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"text/xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"text/plain":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},{"code":"400","description":"Request property is invalid or missing."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tips/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails","mediaTypes":["application/atomsvc+xml","application/atom+xml; type=feed","application/atom+xml","application/xml","application/atom+xml; type=entry","application/json; odata=minimalmetadata; streaming=true","application/json; odata=minimalmetadata; streaming=false","application/json; odata=minimalmetadata","application/json; odata=fullmetadata; streaming=true","application/json; odata=fullmetadata; streaming=false","application/json; odata=fullmetadata","application/json; odata=nometadata; streaming=true","application/json; odata=nometadata; streaming=false","application/json; odata=nometadata","application/json; odata=verbose","application/json; streaming=true","application/json; streaming=false","application/json","text/xml","text/json","text/plain"],"mediaTypeContent":{"application/atomsvc+xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/atom+xml; type=feed":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/atom+xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/atom+xml; type=entry":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=minimalmetadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=minimalmetadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=minimalmetadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=fullmetadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=fullmetadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=fullmetadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=nometadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=nometadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=nometadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=verbose":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"text/xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"text/plain":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/tips"}],"content":{"contentType":"group","meta":{"name":"Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/orders/completed/{orderId}/child-orders","summary":"Creates an in progress standard order that is a child of a completed standard order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/ocapicompletedorders_createchildorder","deprecated":false},{"title":"/ocapi/v1/members/current/orders/tab/by-site/{siteId}","summary":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/ocapimemberorders_getmembertabordersforsite","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/customer","summary":"Sets the customer for an in progress standard order, in progress gift shop order,\r\nor in progress tab order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/ocapiordercustomer_setcustomer","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/customer","summary":"Gets the customer set on an in progress order base","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/ocapiordercustomer_getcustomer","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/items","summary":"Adds items to an in progress tab order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/ocapiorderitems_additems","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/member/current","summary":"Assigns an in progress tab order to the currently authenticated member","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/ocapiordermember_setordermember","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/payment-card/embedded","summary":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/ocapiorderpaymentcard_createorderembeddedpaymentcard","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/payment-card/current","summary":"Gets the current order payment card for an in progress tab order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/ocapiorderpaymentcard_getcurrentorderpaymentcard","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/payments/{paymentId}","summary":"Removes an order payment base from an in progress order base","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/orders/ocapiorderpayments_removepayment","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/payments/payment-card","summary":"Creates an order payment card payment and completes the in progress tab order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/ocapiorderpayments_createpaymentcardpayment","deprecated":false},{"title":"/ocapi/v1/orders/standard/booking","summary":"Creates an in progress standard order as a booking","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/ocapiorders_createstandardorderasbooking","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}","summary":"Gets the details of a in progress order base","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/ocapiorders_getorder","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}","summary":"Cancels an in progress order base","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/orders/ocapiorders_cancelorder","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/expiry/reset","summary":"Resets the expiry of an in progress order base","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/ocapiorders_resetorderexpiry","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/vouchers/{voucherId}","summary":"Removes a voucher from an in progress order base","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/orders/ocapiordervouchers_removevoucher","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/vouchers","summary":"Adds a voucher to an in progress order base","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/ocapiordervouchers_addvoucher","deprecated":false},{"title":"/ocapi/v1/orders/tab","summary":"Creates an in progress tab order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/ocapitaborders_createtaborder","deprecated":false},{"title":"/ocapi/v1/sites/{siteId}/orders/tab/by-access-code/{accessCode}","summary":"Gets an in progress tab order by its in progress tab order AccessCode","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/ocapitaborders_gettaborderbyaccesscode","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/tips","summary":"Adds a tip to an in progress tab order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/ordertips_addordertip","deprecated":false}]}]}]}]}},{"type":"group","label":"Seats","link":"/openapi/digital-platform/openapi/seats","routeSlug":"/openapi/digital-platform/openapi/seats","items":[{"label":"Gets the order showtime seats details for the provided barcode","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/seats/ocapicompletedorderseats_getorderseatsbybarcode","routeSlug":"/openapi/digital-platform/openapi/seats/ocapicompletedorderseats_getorderseatsbybarcode","metadata":{"seo":{"title":"Gets the order showtime seats details for the provided barcode","description":"Can return seats for orders that were not made by Connect, e.g. POS."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiCompletedOrderSeats_GetOrderSeatsByBarcode","name":"Gets the order showtime seats details for the provided barcode","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1by-barcode~1{barcode}~1seats/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the order showtime seats details for the provided barcode","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can return seats for orders that were not made by Connect, e.g. POS."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only seats for showtimes that are currently available for purchase will be returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"seats/ocapicompletedorderseats_getorderseatsbybarcode/request/completed-orders/ocapicompletedorderseats_getorderseatsbybarcode/request/licenses-required","deepLinkHash":"/seats/ocapicompletedorderseats_getorderseatsbybarcode#seats/ocapicompletedorderseats_getorderseatsbybarcode/request/completed-orders/ocapicompletedorderseats_getorderseatsbybarcode/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site","required":true},{"name":"barcode","in":"path","schemaId":"schema_33","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ambiguous reference that can be used to identify a booking or a ticket in a completed order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"example","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WQ9LJTK (booking ID)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"example","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"B10000044294 (booking barcode)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"example","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S100044294 (short booking barcode)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"example","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"B100000442940001 (booking ticket barcode)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"example","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S1000442940001 (short booking ticket barcode)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"example","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"T10000041793 (transaction barcode)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"example","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"T100000417930001 (transaction ticket barcode)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"example","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"U100041793 (short transaction barcode)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"example","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"U1000417930001 (short transaction ticket barcode)"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1by-barcode~1{barcode}~1seats/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1by-barcode~1{barcode}~1seats/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}/orders/by-barcode/{barcode}/seats","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"},{"name":"barcode","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}/orders/by-barcode/{barcode}/seats","href":"seats/ocapicompletedorderseats_getorderseatsbybarcode","openApiOperationId":"OcapiCompletedOrderSeats_GetOrderSeatsByBarcode","summary":"Gets the order showtime seats details for the provided barcode"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatsDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatsDetails"},{"code":"404","description":"Order not found."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1by-barcode~1{barcode}~1seats/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatsDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatsDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}/orders/by-barcode/{barcode}/seats"}],"content":{"contentType":"group","meta":{"name":"Seats"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Seats","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/sites/{siteId}/orders/by-barcode/{barcode}/seats","summary":"Gets the order showtime seats details for the provided barcode","prefix":{"name":"get","color":"get"},"badges":[],"link":"/seats/ocapicompletedorderseats_getorderseatsbybarcode","deprecated":false}]}]}]}]}},{"type":"group","label":"Dining","link":"/openapi/digital-platform/openapi/dining","routeSlug":"/openapi/digital-platform/openapi/dining","items":[{"label":"Gets the dining layout for a site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/dining/ocapidininglayouts_getdininglayoutforsite","routeSlug":"/openapi/digital-platform/openapi/dining/ocapidininglayouts_getdininglayoutforsite","metadata":{"seo":{"title":"Gets the dining layout for a site","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiDiningLayouts_GetDiningLayoutForSite","name":"Gets the dining layout for a site","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1dining-layout/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the dining layout for a site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"sites/ocapidininglayouts_getdininglayoutforsite/request/dining/ocapidininglayouts_getdininglayoutforsite/request/licenses-required","deepLinkHash":"/sites/ocapidininglayouts_getdininglayoutforsite#sites/ocapidininglayouts_getdininglayoutforsite/request/dining/ocapidininglayouts_getdininglayoutforsite/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site","required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1dining-layout/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1dining-layout/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}/dining-layout","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}/dining-layout","href":"dining/ocapidininglayouts_getdininglayoutforsite","openApiOperationId":"OcapiDiningLayouts_GetDiningLayoutForSite","summary":"Gets the dining layout for a site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Dining.DiningLayoutDetails"}},"schemaId":"components/schemas/Ocapi.V1.Dining.DiningLayoutDetails"},{"code":"404","description":"Site does not exist or does not have a dining layout."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1dining-layout/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Dining.DiningLayoutDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Dining.DiningLayoutDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}/dining-layout"},{"label":"Gets the dining location tab availability for a dining location base","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/dining/ocapitablocationavailability_getdininglocationtabavailability","routeSlug":"/openapi/digital-platform/openapi/dining/ocapitablocationavailability_getdininglocationtabavailability","metadata":{"seo":{"title":"Gets the dining location tab availability for a dining location base","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiTabLocationAvailability_GetDiningLocationTabAvailability","name":"Gets the dining location tab availability for a dining location base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1dining-locations~1{diningLocationId}~1tab-availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the dining location tab availability for a dining location base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tabs/ocapitablocationavailability_getdininglocationtabavailability/request/dining/ocapitablocationavailability_getdininglocationtabavailability/request/licenses-required","deepLinkHash":"/tabs/ocapitablocationavailability_getdininglocationtabavailability#tabs/ocapitablocationavailability_getdininglocationtabavailability/request/dining/ocapitablocationavailability_getdininglocationtabavailability/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.ChecksAPI"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"diningLocationId","in":"path","schemaId":"schema_33","description":"The unique identifier of the dining location base","required":true}],"pointer":"/paths/~1ocapi~1v1~1dining-locations~1{diningLocationId}~1tab-availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1dining-locations~1{diningLocationId}~1tab-availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/dining-locations/{diningLocationId}/tab-availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"diningLocationId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/dining-locations/{diningLocationId}/tab-availability","href":"dining/ocapitablocationavailability_getdininglocationtabavailability","openApiOperationId":"OcapiTabLocationAvailability_GetDiningLocationTabAvailability","summary":"Gets the dining location tab availability for a dining location base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.DiningLocationTabAvailability"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.DiningLocationTabAvailability"},{"code":"404","description":"Dining location does not exist."}],"pointer":"/paths/~1ocapi~1v1~1dining-locations~1{diningLocationId}~1tab-availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.DiningLocationTabAvailability","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.DiningLocationTabAvailability"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/dining-locations/{diningLocationId}/tab-availability"}],"content":{"contentType":"group","meta":{"name":"Dining"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dining","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/sites/{siteId}/dining-layout","summary":"Gets the dining layout for a site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dining/ocapidininglayouts_getdininglayoutforsite","deprecated":false},{"title":"/ocapi/v1/dining-locations/{diningLocationId}/tab-availability","summary":"Gets the dining location tab availability for a dining location base","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dining/ocapitablocationavailability_getdininglocationtabavailability","deprecated":false}]}]}]}]}},{"type":"group","label":"Sites","link":"/openapi/digital-platform/openapi/sites","routeSlug":"/openapi/digital-platform/openapi/sites","items":[{"label":"Gets the dining layout for a site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/sites/ocapidininglayouts_getdininglayoutforsite","routeSlug":"/openapi/digital-platform/openapi/sites/ocapidininglayouts_getdininglayoutforsite","metadata":{"seo":{"title":"Gets the dining layout for a site","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiDiningLayouts_GetDiningLayoutForSite","name":"Gets the dining layout for a site","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1dining-layout/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the dining layout for a site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"sites/ocapidininglayouts_getdininglayoutforsite/request/dining/ocapidininglayouts_getdininglayoutforsite/request/licenses-required","deepLinkHash":"/sites/ocapidininglayouts_getdininglayoutforsite#sites/ocapidininglayouts_getdininglayoutforsite/request/dining/ocapidininglayouts_getdininglayoutforsite/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site","required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1dining-layout/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1dining-layout/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}/dining-layout","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}/dining-layout","href":"sites/ocapidininglayouts_getdininglayoutforsite","openApiOperationId":"OcapiDiningLayouts_GetDiningLayoutForSite","summary":"Gets the dining layout for a site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Dining.DiningLayoutDetails"}},"schemaId":"components/schemas/Ocapi.V1.Dining.DiningLayoutDetails"},{"code":"404","description":"Site does not exist or does not have a dining layout."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1dining-layout/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Dining.DiningLayoutDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Dining.DiningLayoutDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}/dining-layout"},{"label":"Gets a detailed site list details including related data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/sites/ocapisites_getsites","routeSlug":"/openapi/digital-platform/openapi/sites/ocapisites_getsites","metadata":{"seo":{"title":"Gets a detailed site list details including related data","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiSites_GetSites","name":"Gets a detailed site list details including related data","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a detailed site list details including related data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"sites/ocapisites_getsites/request/licenses-required","deepLinkHash":"/sites/ocapisites_getsites#sites/ocapisites_getsites/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/ocapi/v1/sites","href":"sites/ocapisites_getsites","openApiOperationId":"OcapiSites_GetSites","summary":"Gets a detailed site list details including related data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteListDetails"}],"pointer":"/paths/~1ocapi~1v1~1sites/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteListDetails"}}}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites"},{"label":"Gets a Site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/sites/ocapisites_getsite","routeSlug":"/openapi/digital-platform/openapi/sites/ocapisites_getsite","metadata":{"seo":{"title":"Gets a Site","description":"Returns a detailed site and its related data based on the provided siteId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiSites_GetSite","name":"Gets a Site","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a Site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a detailed site and its related data based on the provided siteId."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"sites/ocapisites_getsite/request/licenses-required","deepLinkHash":"/sites/ocapisites_getsite#sites/ocapisites_getsite/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","description":"The unique identifier of site","required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}","href":"sites/ocapisites_getsite","openApiOperationId":"OcapiSites_GetSite","summary":"Gets a Site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteDetails"}},"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteDetails"},{"code":"404","description":"Site does not exist."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}"},{"label":"Gets a detailed site list details for a film","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/sites/ocapisites_getsitesforfilm","routeSlug":"/openapi/digital-platform/openapi/sites/ocapisites_getsitesforfilm","metadata":{"seo":{"title":"Gets a detailed site list details for a film","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiSites_GetSitesForFilm","name":"Gets a detailed site list details for a film","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1for-film~1{filmId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a detailed site list details for a film","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"sites/ocapisites_getsitesforfilm/request/licenses-required","deepLinkHash":"/sites/ocapisites_getsitesforfilm#sites/ocapisites_getsitesforfilm/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"filmId","in":"path","schemaId":"schema_33","description":"The unique identifier of the film","required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1for-film~1{filmId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1for-film~1{filmId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/for-film/{filmId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"filmId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/for-film/{filmId}","href":"sites/ocapisites_getsitesforfilm","openApiOperationId":"OcapiSites_GetSitesForFilm","summary":"Gets a detailed site list details for a film"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteListDetails"},{"code":"404","description":"Film does not exist."}],"pointer":"/paths/~1ocapi~1v1~1sites~1for-film~1{filmId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteListDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/for-film/{filmId}"},{"label":"Creates an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/sites/ocapitaborders_createtaborder","routeSlug":"/openapi/digital-platform/openapi/sites/ocapitaborders_createtaborder","metadata":{"seo":{"title":"Creates an in progress tab order","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiTabOrders_CreateTabOrder","name":"Creates an in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1tab/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates an in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tabs/ocapitaborders_createtaborder/request/sites/ocapitaborders_createtaborder/request/orders/ocapitaborders_createtaborder/request/licenses-required","deepLinkHash":"/tabs/ocapitaborders_createtaborder#tabs/ocapitaborders_createtaborder/request/sites/ocapitaborders_createtaborder/request/orders/ocapitaborders_createtaborder/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.ChecksAPI"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1tab/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate","pointer":"/paths/~1ocapi~1v1~1orders~1tab/post/requestBody","description":"Details of the order to be created"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/tab","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/tab","href":"sites/ocapitaborders_createtaborder","openApiOperationId":"OcapiTabOrders_CreateTabOrder","summary":"Creates an in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},{"code":"400","description":"Site does not exist."},{"code":"404","description":"Showtime or seat(s) do not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1tab/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/tab"},{"label":"Gets an in progress tab order by its in progress tab order AccessCode","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/sites/ocapitaborders_gettaborderbyaccesscode","routeSlug":"/openapi/digital-platform/openapi/sites/ocapitaborders_gettaborderbyaccesscode","metadata":{"seo":{"title":"Gets an in progress tab order by its in progress tab order AccessCode","description":"The access code is a case-insensitive, human-readable, 5-character alphanumeric string,generated from a restricted character set designed to avoid visually ambiguous characters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiTabOrders_GetTabOrderByAccessCode","name":"Gets an in progress tab order by its in progress tab order AccessCode","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1tab~1by-access-code~1{accessCode}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets an in progress tab order by its in progress tab order AccessCode","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The access code is a case-insensitive, human-readable, 5-character alphanumeric string,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generated from a restricted character set designed to avoid visually ambiguous characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tabs/ocapitaborders_gettaborderbyaccesscode/request/sites/ocapitaborders_gettaborderbyaccesscode/request/orders/ocapitaborders_gettaborderbyaccesscode/request/licenses-required","deepLinkHash":"/tabs/ocapitaborders_gettaborderbyaccesscode#tabs/ocapitaborders_gettaborderbyaccesscode/request/sites/ocapitaborders_gettaborderbyaccesscode/request/orders/ocapitaborders_gettaborderbyaccesscode/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.ChecksAPI"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","required":true},{"name":"accessCode","in":"path","schemaId":"schema_33","description":"The access code for the in progress tab order being retrieved","required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1tab~1by-access-code~1{accessCode}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1tab~1by-access-code~1{accessCode}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}/orders/tab/by-access-code/{accessCode}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"},{"name":"accessCode","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}/orders/tab/by-access-code/{accessCode}","href":"sites/ocapitaborders_gettaborderbyaccesscode","openApiOperationId":"OcapiTabOrders_GetTabOrderByAccessCode","summary":"Gets an in progress tab order by its in progress tab order AccessCode"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},{"code":"404","description":"Tab order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1tab~1by-access-code~1{accessCode}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}/orders/tab/by-access-code/{accessCode}"},{"label":"Gets the list of third party member scheme entities for a specified site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/sites/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite","routeSlug":"/openapi/digital-platform/openapi/sites/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite","metadata":{"seo":{"title":"Gets the list of third party member scheme entities for a specified site","description":"This endpoint excludes any third-party member schemes that are validated against Vista Loyalty."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiThirdPartyMemberSchemes_GetThirdPartyMemberSchemesForSite","name":"Gets the list of third party member scheme entities for a specified site","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1third-party-member-schemes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the list of third party member scheme entities for a specified site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint excludes any third-party member schemes that are validated against Vista Loyalty."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loyalty schemes are handled as \"member reward tickets with an availability restriction\" via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/members/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GetMemberRewardAvailabilitiesForShowtime"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"third-party-member-schemes/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite/request/sites/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite/request/licenses-required","deepLinkHash":"/third-party-member-schemes/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite#third-party-member-schemes/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite/request/sites/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site","required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1third-party-member-schemes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1third-party-member-schemes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}/third-party-member-schemes","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}/third-party-member-schemes","href":"sites/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite","openApiOperationId":"OcapiThirdPartyMemberSchemes_GetThirdPartyMemberSchemesForSite","summary":"Gets the list of third party member scheme entities for a specified site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.ThirdPartyMemberTicketSchemes.ThirdPartyMemberSchemeListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.ThirdPartyMemberTicketSchemes.ThirdPartyMemberSchemeListDetails"},{"code":"404","description":"Site does not exist."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1third-party-member-schemes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.ThirdPartyMemberTicketSchemes.ThirdPartyMemberSchemeListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.ThirdPartyMemberTicketSchemes.ThirdPartyMemberSchemeListDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}/third-party-member-schemes"}],"content":{"contentType":"group","meta":{"name":"Sites"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sites","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/sites/{siteId}/dining-layout","summary":"Gets the dining layout for a site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/ocapidininglayouts_getdininglayoutforsite","deprecated":false},{"title":"/ocapi/v1/sites","summary":"Gets a detailed site list details including related data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/ocapisites_getsites","deprecated":false},{"title":"/ocapi/v1/sites/{siteId}","summary":"Gets a Site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/ocapisites_getsite","deprecated":false},{"title":"/ocapi/v1/sites/for-film/{filmId}","summary":"Gets a detailed site list details for a film","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/ocapisites_getsitesforfilm","deprecated":false},{"title":"/ocapi/v1/orders/tab","summary":"Creates an in progress tab order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sites/ocapitaborders_createtaborder","deprecated":false},{"title":"/ocapi/v1/sites/{siteId}/orders/tab/by-access-code/{accessCode}","summary":"Gets an in progress tab order by its in progress tab order AccessCode","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/ocapitaborders_gettaborderbyaccesscode","deprecated":false},{"title":"/ocapi/v1/sites/{siteId}/third-party-member-schemes","summary":"Gets the list of third party member scheme entities for a specified site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite","deprecated":false}]}]}]}]}},{"type":"group","label":"Discounts","link":"/openapi/digital-platform/openapi/discounts","routeSlug":"/openapi/digital-platform/openapi/discounts","items":[{"label":"Gets the current list of discount availability entities for a particular site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/discounts/ocapidiscountavailability_getdiscountavailabilitiesforsite","routeSlug":"/openapi/digital-platform/openapi/discounts/ocapidiscountavailability_getdiscountavailabilitiesforsite","metadata":{"seo":{"title":"Gets the current list of discount availability entities for a particular site","description":"This endpoint returns availabilities for discount entities configured for the site with respect to thesite's current local time."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiDiscountAvailability_GetDiscountAvailabilitiesForSite","name":"Gets the current list of discount availability entities for a particular site","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1discount-availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current list of discount availability entities for a particular site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns availabilities for discount entities configured for the site with respect to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"site's current local time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/discounts/ocapidiscountavailability_getdiscountavailabilitiesforsiteorderlocation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GetDiscountAvailabilitiesForSiteOrderLocation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the site discount availability list details for a particular site order location"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"discounts/ocapidiscountavailability_getdiscountavailabilitiesforsite/request/licenses-required","deepLinkHash":"/discounts/ocapidiscountavailability_getdiscountavailabilitiesforsite#discounts/ocapidiscountavailability_getdiscountavailabilitiesforsite/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site","required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1discount-availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1discount-availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}/discount-availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}/discount-availability","href":"discounts/ocapidiscountavailability_getdiscountavailabilitiesforsite","openApiOperationId":"OcapiDiscountAvailability_GetDiscountAvailabilitiesForSite","summary":"Gets the current list of discount availability entities for a particular site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"404","description":"Site does not exist."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1discount-availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}/discount-availability"},{"label":"Gets the current list of discount availability entities for a particular site and site order location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/discounts/ocapidiscountavailability_getdiscountavailabilitiesforsiteorderlocation","routeSlug":"/openapi/digital-platform/openapi/discounts/ocapidiscountavailability_getdiscountavailabilitiesforsiteorderlocation","metadata":{"seo":{"title":"Gets the current list of discount availability entities for a particular site and site order location","description":"This endpoint returns availabilities for discount entities configured for the site and site order location with respect to thesite's current local time."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiDiscountAvailability_GetDiscountAvailabilitiesForSiteOrderLocation","name":"Gets the current list of discount availability entities for a particular site and site order location","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1order-locations~1{siteOrderLocationId}~1discount-availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current list of discount availability entities for a particular site and site order location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns availabilities for discount entities configured for the site and site order location with respect to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"site's current local time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/discounts/ocapidiscountavailability_getdiscountavailabilitiesforsite"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GetDiscountAvailabilitiesForSite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the default site discount availability list details for the site"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"discounts/ocapidiscountavailability_getdiscountavailabilitiesforsiteorderlocation/request/licenses-required","deepLinkHash":"/discounts/ocapidiscountavailability_getdiscountavailabilitiesforsiteorderlocation#discounts/ocapidiscountavailability_getdiscountavailabilitiesforsiteorderlocation/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site","required":true},{"name":"siteOrderLocationId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site order location","required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1order-locations~1{siteOrderLocationId}~1discount-availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1order-locations~1{siteOrderLocationId}~1discount-availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}/order-locations/{siteOrderLocationId}/discount-availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"},{"name":"siteOrderLocationId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}/order-locations/{siteOrderLocationId}/discount-availability","href":"discounts/ocapidiscountavailability_getdiscountavailabilitiesforsiteorderlocation","openApiOperationId":"OcapiDiscountAvailability_GetDiscountAvailabilitiesForSiteOrderLocation","summary":"Gets the current list of discount availability entities for a particular site and site order location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.Availability.SiteDiscountAvailabilityListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Sales.Availability.SiteDiscountAvailabilityListDetails"},{"code":"404","description":"Site or order location does not exist."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1order-locations~1{siteOrderLocationId}~1discount-availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Sales.Availability.SiteDiscountAvailabilityListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.Availability.SiteDiscountAvailabilityListDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}/order-locations/{siteOrderLocationId}/discount-availability"},{"label":"Gets the current list of discount availability entities for a particular showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/discounts/ocapidiscountavailability_getdiscountavailabilitiesforshowtime","routeSlug":"/openapi/digital-platform/openapi/discounts/ocapidiscountavailability_getdiscountavailabilitiesforshowtime","metadata":{"seo":{"title":"Gets the current list of discount availability entities for a particular showtime","description":"This endpoint returns availabilities for discount entities with respect to the time of the showtime"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiDiscountAvailability_GetDiscountAvailabilitiesForShowtime","name":"Gets the current list of discount availability entities for a particular showtime","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1discount-availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current list of discount availability entities for a particular showtime","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns availabilities for discount entities with respect to the time of the showtime"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"discounts/ocapidiscountavailability_getdiscountavailabilitiesforshowtime/request/licenses-required","deepLinkHash":"/discounts/ocapidiscountavailability_getdiscountavailabilitiesforshowtime#discounts/ocapidiscountavailability_getdiscountavailabilitiesforshowtime/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"showtimeId","in":"path","schemaId":"schema_33","description":"The unique identifier of the showtime","required":true}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1discount-availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1discount-availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/showtimes/{showtimeId}/discount-availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"showtimeId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/showtimes/{showtimeId}/discount-availability","href":"discounts/ocapidiscountavailability_getdiscountavailabilitiesforshowtime","openApiOperationId":"OcapiDiscountAvailability_GetDiscountAvailabilitiesForShowtime","summary":"Gets the current list of discount availability entities for a particular showtime"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"404","description":"Showtime does not exist."}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1discount-availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/showtimes/{showtimeId}/discount-availability"}],"content":{"contentType":"group","meta":{"name":"Discounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discounts","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/sites/{siteId}/discount-availability","summary":"Gets the current list of discount availability entities for a particular site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/discounts/ocapidiscountavailability_getdiscountavailabilitiesforsite","deprecated":false},{"title":"/ocapi/v1/sites/{siteId}/order-locations/{siteOrderLocationId}/discount-availability","summary":"Gets the current list of discount availability entities for a particular site and site order location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/discounts/ocapidiscountavailability_getdiscountavailabilitiesforsiteorderlocation","deprecated":false},{"title":"/ocapi/v1/showtimes/{showtimeId}/discount-availability","summary":"Gets the current list of discount availability entities for a particular showtime","prefix":{"name":"get","color":"get"},"badges":[],"link":"/discounts/ocapidiscountavailability_getdiscountavailabilitiesforshowtime","deprecated":false}]}]}]}]}},{"type":"group","label":"Events","link":"/openapi/digital-platform/openapi/events","routeSlug":"/openapi/digital-platform/openapi/events","items":[{"label":"Gets a list of event entities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/events/ocapievents_getevents","routeSlug":"/openapi/digital-platform/openapi/events/ocapievents_getevents","metadata":{"seo":{"title":"Gets a list of event entities","description":"Only Head Office defined events are returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiEvents_GetEvents","name":"Gets a list of event entities","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of event entities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only Head Office defined events are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"events/ocapievents_getevents/request/licenses-required","deepLinkHash":"/events/ocapievents_getevents#events/ocapievents_getevents/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/events","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/ocapi/v1/events","href":"events/ocapievents_getevents","openApiOperationId":"OcapiEvents_GetEvents","summary":"Gets a list of event entities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventListDetails"}],"pointer":"/paths/~1ocapi~1v1~1events/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventListDetails"}}}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/events"},{"label":"Gets an event entity by its unique identifier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/events/ocapievents_getevent","routeSlug":"/openapi/digital-platform/openapi/events/ocapievents_getevent","metadata":{"seo":{"title":"Gets an event entity by its unique identifier","description":"Only Head Office defined events can be returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiEvents_GetEvent","name":"Gets an event entity by its unique identifier","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1events~1{eventId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets an event entity by its unique identifier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only Head Office defined events can be returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"events/ocapievents_getevent/request/licenses-required","deepLinkHash":"/events/ocapievents_getevent#events/ocapievents_getevent/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"eventId","in":"path","schemaId":"schema_33","description":"The unique identifier of the event","required":true}],"pointer":"/paths/~1ocapi~1v1~1events~1{eventId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1events~1{eventId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/events/{eventId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"eventId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/events/{eventId}","href":"events/ocapievents_getevent","openApiOperationId":"OcapiEvents_GetEvent","summary":"Gets an event entity by its unique identifier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventDetails"}},"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventDetails"},{"code":"404","description":"Event does not exist."}],"pointer":"/paths/~1ocapi~1v1~1events~1{eventId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/events/{eventId}"}],"content":{"contentType":"group","meta":{"name":"Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/events","summary":"Gets a list of event entities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/ocapievents_getevents","deprecated":false},{"title":"/ocapi/v1/events/{eventId}","summary":"Gets an event entity by its unique identifier","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/ocapievents_getevent","deprecated":false}]}]}]}]}},{"type":"group","label":"Showtimes","link":"/openapi/digital-platform/openapi/showtimes","routeSlug":"/openapi/digital-platform/openapi/showtimes","items":[{"label":"Gets a list of showtime entities for an event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapievents_getshowtimesforevent","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapievents_getshowtimesforevent","metadata":{"seo":{"title":"Gets a list of showtime entities for an event","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiEvents_GetShowtimesForEvent","name":"Gets a list of showtime entities for an event","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1events~1{eventId}~1showtimes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of showtime entities for an event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"showtimes/ocapievents_getshowtimesforevent/request/licenses-required","deepLinkHash":"/showtimes/ocapievents_getshowtimesforevent#showtimes/ocapievents_getshowtimesforevent/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"eventId","in":"path","schemaId":"schema_33","description":"The unique identifier of the event","required":true}],"pointer":"/paths/~1ocapi~1v1~1events~1{eventId}~1showtimes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"siteIds","in":"query","schemaId":"schema_41","description":"Site filter"}],"pointer":"/paths/~1ocapi~1v1~1events~1{eventId}~1showtimes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1events~1{eventId}~1showtimes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/events/{eventId}/showtimes","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"eventId","in":"path","required":true,"schemaId":"schema_33"}],"query":[{"name":"siteIds","in":"query","schemaId":"schema_41"}],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/events/{eventId}/showtimes","href":"showtimes/ocapievents_getshowtimesforevent","openApiOperationId":"OcapiEvents_GetShowtimesForEvent","summary":"Gets a list of showtime entities for an event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.EventShowtimeListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.EventShowtimeListDetails"},{"code":"400","description":"One or more of the provided sites do not exist."},{"code":"404","description":"Event does not exist."}],"pointer":"/paths/~1ocapi~1v1~1events~1{eventId}~1showtimes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.EventShowtimeListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.EventShowtimeListDetails"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/events/{eventId}/showtimes"},{"label":"Gets a list of showtime entities for a film","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapifilms_getshowtimesforfilm","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapifilms_getshowtimesforfilm","metadata":{"seo":{"title":"Gets a list of showtime entities for a film","description":"Returns an empty list of showtime entities if no showtimes are scheduled for that film"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiFilms_GetShowtimesForFilm","name":"Gets a list of showtime entities for a film","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1films~1{filmId}~1showtimes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of showtime entities for a film","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns an empty list of showtime entities if no showtimes are scheduled for that film"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is a maximum of 5 site identifiers to be passed into the siteIds parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"showtimes/ocapifilms_getshowtimesforfilm/request/licenses-required","deepLinkHash":"/showtimes/ocapifilms_getshowtimesforfilm#showtimes/ocapifilms_getshowtimesforfilm/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"filmId","in":"path","schemaId":"schema_33","description":"The film identifier of the requested showtimes","required":true}],"pointer":"/paths/~1ocapi~1v1~1films~1{filmId}~1showtimes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"siteIds","in":"query","schemaId":"schema_41","description":"The site filter"}],"pointer":"/paths/~1ocapi~1v1~1films~1{filmId}~1showtimes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1films~1{filmId}~1showtimes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/films/{filmId}/showtimes","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"filmId","in":"path","required":true,"schemaId":"schema_33"}],"query":[{"name":"siteIds","in":"query","schemaId":"schema_41"}],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/films/{filmId}/showtimes","href":"showtimes/ocapifilms_getshowtimesforfilm","openApiOperationId":"OcapiFilms_GetShowtimesForFilm","summary":"Gets a list of showtime entities for a film"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.FilmShowtimeListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.FilmShowtimeListDetails"},{"code":"400","description":"One or more of the provided sites do not exist."},{"code":"404","description":"Film was not found."}],"pointer":"/paths/~1ocapi~1v1~1films~1{filmId}~1showtimes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.FilmShowtimeListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.FilmShowtimeListDetails"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/films/{filmId}/showtimes"},{"label":"Sets the requested tickets and/or seats for an order showtime within an in progress standard order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapiordershowtimes_setshowtime","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapiordershowtimes_setshowtime","metadata":{"seo":{"title":"Sets the requested tickets and/or seats for an order showtime within an in progress standard order","description":"This endpoint cannot be used for orders that have a parent order (see standard order ParentOrderId)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderShowtimes_SetShowtime","name":"Sets the requested tickets and/or seats for an order showtime within an in progress standard order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1showtimes~1{showtimeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sets the requested tickets and/or seats for an order showtime within an in progress standard order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint cannot be used for orders that have a parent order (see standard order ParentOrderId)"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"showtimes/ocapiordershowtimes_setshowtime/request/specifying-tickets-without-seats-(ticket-first-ordering)","deepLinkHash":"/showtimes/ocapiordershowtimes_setshowtime#showtimes/ocapiordershowtimes_setshowtime/request/specifying-tickets-without-seats-(ticket-first-ordering)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifying Tickets without Seats (Ticket-first Ordering)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If session seat allocation is marked as "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"None"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Tickets will be booked without specific seats"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If session seat allocation is marked as "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Tickets will be booked. Seats will be auto-allocated if possible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If session seat allocation is marked as "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Tickets will be booked. Seats will be auto-allocated if possible."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"showtimes/ocapiordershowtimes_setshowtime/request/specifying-seats-(ticket-first-and-seat-first-ordering)","deepLinkHash":"/showtimes/ocapiordershowtimes_setshowtime#showtimes/ocapiordershowtimes_setshowtime/request/specifying-seats-(ticket-first-and-seat-first-ordering)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifying Seats (Ticket-first and seat-first Ordering)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If session seat allocation is marked as "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"None"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Specifying seats is invalid - a 400 will be returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If session seat allocation is marked as "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Specified seats will be reserved if possible - otherwise a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SeatsUnavailable"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error will be returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If session seat allocation is marked as "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Specified seats will be reserved if possible - otherwise a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SeatsUnavailable"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error will be returned."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"showtimes/ocapiordershowtimes_setshowtime/request/auto-allocation","deepLinkHash":"/showtimes/ocapiordershowtimes_setshowtime#showtimes/ocapiordershowtimes_setshowtime/request/auto-allocation"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-Allocation"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system may attempt to auto-allocate seats if specific seats are not supplied, depending on system configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The auto-allocation system is not guaranteed to allocate seats. Auto-allocation may fail if seats cannot be allocated contiguously."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When allocation fails the client must render a seat plan and the seats must be manually specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is recommended the client render the seat plan regardless to provide the opportunity for the customer to modify the auto-allocated selections."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"showtimes/ocapiordershowtimes_setshowtime/request/licenses-required","deepLinkHash":"/showtimes/ocapiordershowtimes_setshowtime#showtimes/ocapiordershowtimes_setshowtime/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress standard order being modified","required":true},{"name":"showtimeId","in":"path","schemaId":"schema_33","description":"The unique identifier of the order showtime being modified","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1showtimes~1{showtimeId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1showtimes~1{showtimeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeRequest"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeRequest","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1showtimes~1{showtimeId}/put/requestBody","description":"The requested tickets and/or seats"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/orders/{orderId}/showtimes/{showtimeId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"},{"name":"showtimeId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeRequest"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/showtimes/{showtimeId}","href":"showtimes/ocapiordershowtimes_setshowtime","openApiOperationId":"OcapiOrderShowtimes_SetShowtime","summary":"Sets the requested tickets and/or seats for an order showtime within an in progress standard order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeRequest","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},{"code":"400","description":"Request property is invalid or missing, or invalid order type."},{"code":"404","description":"Order or showtime does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1showtimes~1{showtimeId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/showtimes/{showtimeId}"},{"label":"Gets the current list of showtime availability entities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapishowtimeavailability_getshowtimeavailabilities","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapishowtimeavailability_getshowtimeavailabilities","metadata":{"seo":{"title":"Gets the current list of showtime availability entities","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiShowtimeAvailability_GetShowtimeAvailabilities","name":"Gets the current list of showtime availability entities","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1showtimes~1availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current list of showtime availability entities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"browsing/ocapishowtimeavailability_getshowtimeavailabilities/request/showtimes/ocapishowtimeavailability_getshowtimeavailabilities/request/licenses-required","deepLinkHash":"/browsing/ocapishowtimeavailability_getshowtimeavailabilities#browsing/ocapishowtimeavailability_getshowtimeavailabilities/request/showtimes/ocapishowtimeavailability_getshowtimeavailabilities/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"siteIds","in":"query","schemaId":"schema_41","description":"Site filter"},{"name":"filmIds","in":"query","schemaId":"schema_42","description":"Film filter"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/showtimes/availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"siteIds","in":"query","schemaId":"schema_41"},{"name":"filmIds","in":"query","schemaId":"schema_42"}],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/ocapi/v1/showtimes/availability","href":"showtimes/ocapishowtimeavailability_getshowtimeavailabilities","openApiOperationId":"OcapiShowtimeAvailability_GetShowtimeAvailabilities","summary":"Gets the current list of showtime availability entities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityListDetails"},{"code":"400","description":"One or more of the provided sites or films do not exist."}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityListDetails"}}},{"code":"400"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/showtimes/availability"},{"label":"Gets the current showtime availability of a particular showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapishowtimeavailability_getshowtimeavailability","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapishowtimeavailability_getshowtimeavailability","metadata":{"seo":{"title":"Gets the current showtime availability of a particular showtime","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiShowtimeAvailability_GetShowtimeAvailability","name":"Gets the current showtime availability of a particular showtime","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current showtime availability of a particular showtime","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"browsing/ocapishowtimeavailability_getshowtimeavailability/request/showtimes/ocapishowtimeavailability_getshowtimeavailability/request/licenses-required","deepLinkHash":"/browsing/ocapishowtimeavailability_getshowtimeavailability#browsing/ocapishowtimeavailability_getshowtimeavailability/request/showtimes/ocapishowtimeavailability_getshowtimeavailability/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"showtimeId","in":"path","schemaId":"schema_33","description":"The unique identifier of the showtime","required":true}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/showtimes/{showtimeId}/availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"showtimeId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/showtimes/{showtimeId}/availability","href":"showtimes/ocapishowtimeavailability_getshowtimeavailability","openApiOperationId":"OcapiShowtimeAvailability_GetShowtimeAvailability","summary":"Gets the current showtime availability of a particular showtime"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityDetails"}},"schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityDetails"},{"code":"404","description":"Showtime does not exist."}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/showtimes/{showtimeId}/availability"},{"label":"Gets a list of showtime entities for the first business date with showtimes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapishowtimes_getshowtimesforfirstbusinessdate","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapishowtimes_getshowtimesforfirstbusinessdate","metadata":{"seo":{"title":"Gets a list of showtime entities for the first business date with showtimes","description":"Useful when filtering by site or film where showtimes may only be in the future."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiShowtimes_GetShowtimesForFirstBusinessDate","name":"Gets a list of showtime entities for the first business date with showtimes","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1showtimes~1by-business-date~1first/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of showtime entities for the first business date with showtimes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Useful when filtering by site or film where showtimes may only be in the future."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"showtimes/ocapishowtimes_getshowtimesforfirstbusinessdate/request/licenses-required","deepLinkHash":"/showtimes/ocapishowtimes_getshowtimesforfirstbusinessdate#showtimes/ocapishowtimes_getshowtimesforfirstbusinessdate/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"siteIds","in":"query","schemaId":"schema_41","description":"Site filter"},{"name":"filmIds","in":"query","schemaId":"schema_42","description":"Film filter"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1by-business-date~1first/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1by-business-date~1first/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/showtimes/by-business-date/first","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"siteIds","in":"query","schemaId":"schema_41"},{"name":"filmIds","in":"query","schemaId":"schema_42"}],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","204"],"pointer":"/ocapi/v1/showtimes/by-business-date/first","href":"showtimes/ocapishowtimes_getshowtimesforfirstbusinessdate","openApiOperationId":"OcapiShowtimes_GetShowtimesForFirstBusinessDate","summary":"Gets a list of showtime entities for the first business date with showtimes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeBusinessDayListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeBusinessDayListDetails"},{"code":"204","description":"No showtimes scheduled."}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1by-business-date~1first/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeBusinessDayListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeBusinessDayListDetails"}}},{"code":"204"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/showtimes/by-business-date/first"},{"label":"Gets a list of showtime entities for a business date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapishowtimes_getshowtimesforbusinessdate","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapishowtimes_getshowtimesforbusinessdate","metadata":{"seo":{"title":"Gets a list of showtime entities for a business date","description":"Returns an empty list of showtime entities if no showtimes are scheduled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiShowtimes_GetShowtimesForBusinessDate","name":"Gets a list of showtime entities for a business date","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1showtimes~1by-business-date~1{businessDate}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of showtime entities for a business date","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns an empty list of showtime entities if no showtimes are scheduled."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"showtimes/ocapishowtimes_getshowtimesforbusinessdate/request/licenses-required","deepLinkHash":"/showtimes/ocapishowtimes_getshowtimesforbusinessdate#showtimes/ocapishowtimes_getshowtimesforbusinessdate/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"businessDate","in":"path","schemaId":"schema_43","description":"Date of requested showtimes in 'yyyy-MM-dd' format","required":true}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1by-business-date~1{businessDate}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"siteIds","in":"query","schemaId":"schema_41","description":"Site filter"},{"name":"filmIds","in":"query","schemaId":"schema_42","description":"Film filter"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1by-business-date~1{businessDate}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1by-business-date~1{businessDate}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/showtimes/by-business-date/{businessDate}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"businessDate","in":"path","required":true,"schemaId":"schema_43"}],"query":[{"name":"siteIds","in":"query","schemaId":"schema_41"},{"name":"filmIds","in":"query","schemaId":"schema_42"}],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/ocapi/v1/showtimes/by-business-date/{businessDate}","href":"showtimes/ocapishowtimes_getshowtimesforbusinessdate","openApiOperationId":"OcapiShowtimes_GetShowtimesForBusinessDate","summary":"Gets a list of showtime entities for a business date"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeBusinessDayListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeBusinessDayListDetails"},{"code":"400","description":"One or more of the provided sites or films do not exist."}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1by-business-date~1{businessDate}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeBusinessDayListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeBusinessDayListDetails"}}},{"code":"400"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/showtimes/by-business-date/{businessDate}"},{"label":"Gets a list of showtime entities for today and tomorrow for a screen","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapishowtimes_getshowtimesforscreen","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapishowtimes_getshowtimesforscreen","metadata":{"seo":{"title":"Gets a list of showtime entities for today and tomorrow for a screen","description":"This endpoint is currently used to find an in-progress or imminent showtime given a screen ID, which canthen be used as the showtime context for an in-seat delivery order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiShowtimes_GetShowtimesForScreen","name":"Gets a list of showtime entities for today and tomorrow for a screen","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1showtimes~1by-screen~1{screenId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of showtime entities for today and tomorrow for a screen","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is currently used to find an in-progress or imminent showtime given a screen ID, which can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then be used as the showtime context for an in-seat delivery order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"showtime entities for the 48 hours from the beginning (i.e. 00:00) of today's calendar date"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"up to the end of the next calendar day are returned. This is to cater for the scenario where this endpoint"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is called close to the end of the day, such that the next day's showtimes are needed as well."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"showtime entities that started on the previous calendar date, but finish on today's calendar date are included."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"showtime entities that do not support or are not yet available for in-seat delivery are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"still included so that this can be communicated to patrons."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlike endpoints based on business date, the cutoff for each calendar day is always midnight."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"showtimes/ocapishowtimes_getshowtimesforscreen/request/licenses-required","deepLinkHash":"/showtimes/ocapishowtimes_getshowtimesforscreen#showtimes/ocapishowtimes_getshowtimesforscreen/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"screenId","in":"path","schemaId":"schema_33","description":"The unique identifier of the screen","required":true}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1by-screen~1{screenId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1by-screen~1{screenId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/showtimes/by-screen/{screenId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"screenId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/showtimes/by-screen/{screenId}","href":"showtimes/ocapishowtimes_getshowtimesforscreen","openApiOperationId":"OcapiShowtimes_GetShowtimesForScreen","summary":"Gets a list of showtime entities for today and tomorrow for a screen"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44"}},"schemaId":"schema_44"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1by-screen~1{screenId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_44","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/showtimes/by-screen/{screenId}"},{"label":"Gets a showtime by its unique identifier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapishowtimes_getshowtime","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapishowtimes_getshowtime","metadata":{"seo":{"title":"Gets a showtime by its unique identifier","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiShowtimes_GetShowtime","name":"Gets a showtime by its unique identifier","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a showtime by its unique identifier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"showtimes/ocapishowtimes_getshowtime/request/licenses-required","deepLinkHash":"/showtimes/ocapishowtimes_getshowtime#showtimes/ocapishowtimes_getshowtime/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"showtimeId","in":"path","schemaId":"schema_33","description":"The unique identifier of the showtime","required":true}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/showtimes/{showtimeId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"showtimeId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/showtimes/{showtimeId}","href":"showtimes/ocapishowtimes_getshowtime","openApiOperationId":"OcapiShowtimes_GetShowtime","summary":"Gets a showtime by its unique identifier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeDetails"}},"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeDetails"},{"code":"404","description":"Showtime does not exist."}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/showtimes/{showtimeId}"},{"label":"Gets the in seat location tab availability for a seat within a showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapitablocationavailability_getinseatlocationtabavailability","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapitablocationavailability_getinseatlocationtabavailability","metadata":{"seo":{"title":"Gets the in seat location tab availability for a seat within a showtime","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiTabLocationAvailability_GetInSeatLocationTabAvailability","name":"Gets the in seat location tab availability for a seat within a showtime","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seats~1{seatId}~1tab-availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the in seat location tab availability for a seat within a showtime","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"seating/ocapitablocationavailability_getinseatlocationtabavailability/request/tabs/ocapitablocationavailability_getinseatlocationtabavailability/request/showtimes/ocapitablocationavailability_getinseatlocationtabavailability/request/licenses-required","deepLinkHash":"/seating/ocapitablocationavailability_getinseatlocationtabavailability#seating/ocapitablocationavailability_getinseatlocationtabavailability/request/tabs/ocapitablocationavailability_getinseatlocationtabavailability/request/showtimes/ocapitablocationavailability_getinseatlocationtabavailability/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.ChecksAPI"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"showtimeId","in":"path","schemaId":"schema_33","description":"The unique identifier of the showtime","required":true},{"name":"seatId","in":"path","schemaId":"schema_33","description":"The unique identifier of the seat","required":true}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seats~1{seatId}~1tab-availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seats~1{seatId}~1tab-availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/showtimes/{showtimeId}/seats/{seatId}/tab-availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"showtimeId","in":"path","required":true,"schemaId":"schema_33"},{"name":"seatId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/showtimes/{showtimeId}/seats/{seatId}/tab-availability","href":"showtimes/ocapitablocationavailability_getinseatlocationtabavailability","openApiOperationId":"OcapiTabLocationAvailability_GetInSeatLocationTabAvailability","summary":"Gets the in seat location tab availability for a seat within a showtime"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.InSeatLocationTabAvailability"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.InSeatLocationTabAvailability"},{"code":"404","description":"Showtime or seat does not exist."}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seats~1{seatId}~1tab-availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.InSeatLocationTabAvailability","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.InSeatLocationTabAvailability"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/showtimes/{showtimeId}/seats/{seatId}/tab-availability"}],"content":{"contentType":"group","meta":{"name":"Showtimes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Showtimes","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/events/{eventId}/showtimes","summary":"Gets a list of showtime entities for an event","prefix":{"name":"get","color":"get"},"badges":[],"link":"/showtimes/ocapievents_getshowtimesforevent","deprecated":false},{"title":"/ocapi/v1/films/{filmId}/showtimes","summary":"Gets a list of showtime entities for a film","prefix":{"name":"get","color":"get"},"badges":[],"link":"/showtimes/ocapifilms_getshowtimesforfilm","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/showtimes/{showtimeId}","summary":"Sets the requested tickets and/or seats for an order showtime within an in progress standard order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/showtimes/ocapiordershowtimes_setshowtime","deprecated":false},{"title":"/ocapi/v1/showtimes/availability","summary":"Gets the current list of showtime availability entities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/showtimes/ocapishowtimeavailability_getshowtimeavailabilities","deprecated":false},{"title":"/ocapi/v1/showtimes/{showtimeId}/availability","summary":"Gets the current showtime availability of a particular showtime","prefix":{"name":"get","color":"get"},"badges":[],"link":"/showtimes/ocapishowtimeavailability_getshowtimeavailability","deprecated":false},{"title":"/ocapi/v1/showtimes/by-business-date/first","summary":"Gets a list of showtime entities for the first business date with showtimes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/showtimes/ocapishowtimes_getshowtimesforfirstbusinessdate","deprecated":false},{"title":"/ocapi/v1/showtimes/by-business-date/{businessDate}","summary":"Gets a list of showtime entities for a business date","prefix":{"name":"get","color":"get"},"badges":[],"link":"/showtimes/ocapishowtimes_getshowtimesforbusinessdate","deprecated":false},{"title":"/ocapi/v1/showtimes/by-screen/{screenId}","summary":"Gets a list of showtime entities for today and tomorrow for a screen","prefix":{"name":"get","color":"get"},"badges":[],"link":"/showtimes/ocapishowtimes_getshowtimesforscreen","deprecated":false},{"title":"/ocapi/v1/showtimes/{showtimeId}","summary":"Gets a showtime by its unique identifier","prefix":{"name":"get","color":"get"},"badges":[],"link":"/showtimes/ocapishowtimes_getshowtime","deprecated":false},{"title":"/ocapi/v1/showtimes/{showtimeId}/seats/{seatId}/tab-availability","summary":"Gets the in seat location tab availability for a seat within a showtime","prefix":{"name":"get","color":"get"},"badges":[],"link":"/showtimes/ocapitablocationavailability_getinseatlocationtabavailability","deprecated":false}]}]}]}]}},{"type":"group","label":"Films","link":"/openapi/digital-platform/openapi/films","routeSlug":"/openapi/digital-platform/openapi/films","items":[{"label":"Gets a list of film entities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/films/ocapifilms_getfilms","routeSlug":"/openapi/digital-platform/openapi/films/ocapifilms_getfilms","metadata":{"seo":{"title":"Gets a list of film entities","description":"Returns a list of film entities along with their related data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiFilms_GetFilms","name":"Gets a list of film entities","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1films/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of film entities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of film entities along with their related data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Historical film entities that are no longer playing are not returned by this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"films/ocapifilms_getfilms/request/licenses-required","deepLinkHash":"/films/ocapifilms_getfilms#films/ocapifilms_getfilms/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1films/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/films","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/ocapi/v1/films","href":"films/ocapifilms_getfilms","openApiOperationId":"OcapiFilms_GetFilms","summary":"Gets a list of film entities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmListDetails"}],"pointer":"/paths/~1ocapi~1v1~1films/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmListDetails"}}}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/films"},{"label":"Gets a film entity by its unique identifier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/films/ocapifilms_getfilm","routeSlug":"/openapi/digital-platform/openapi/films/ocapifilms_getfilm","metadata":{"seo":{"title":"Gets a film entity by its unique identifier","description":"Returns a detailed film and its related data based on the provided filmId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiFilms_GetFilm","name":"Gets a film entity by its unique identifier","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1films~1{filmId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a film entity by its unique identifier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a detailed film and its related data based on the provided filmId."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"films/ocapifilms_getfilm/request/licenses-required","deepLinkHash":"/films/ocapifilms_getfilm#films/ocapifilms_getfilm/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"filmId","in":"path","schemaId":"schema_33","description":"The unique identifier of the film","required":true}],"pointer":"/paths/~1ocapi~1v1~1films~1{filmId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1films~1{filmId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/films/{filmId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"filmId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/films/{filmId}","href":"films/ocapifilms_getfilm","openApiOperationId":"OcapiFilms_GetFilm","summary":"Gets a film entity by its unique identifier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmDetails"}},"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmDetails"},{"code":"404","description":"Film does not exist."}],"pointer":"/paths/~1ocapi~1v1~1films~1{filmId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/films/{filmId}"},{"label":"Gets the current list of film availability entities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/films/ocapifilms_getfilmavailabilities","routeSlug":"/openapi/digital-platform/openapi/films/ocapifilms_getfilmavailabilities","metadata":{"seo":{"title":"Gets the current list of film availability entities","description":"The details of each film availability is based on the collated data of every site that is screening the film."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiFilms_GetFilmAvailabilities","name":"Gets the current list of film availability entities","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1films~1availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current list of film availability entities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of each film availability is based on the collated data of every site that is screening the film."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"films/ocapifilms_getfilmavailabilities/request/licenses-required","deepLinkHash":"/films/ocapifilms_getfilmavailabilities#films/ocapifilms_getfilmavailabilities/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1films~1availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/films/availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/ocapi/v1/films/availability","href":"films/ocapifilms_getfilmavailabilities","openApiOperationId":"OcapiFilms_GetFilmAvailabilities","summary":"Gets the current list of film availability entities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityListDetails"}],"pointer":"/paths/~1ocapi~1v1~1films~1availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityListDetails"}}}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/films/availability"},{"label":"Gets the current film availability of a particular film","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/films/ocapifilms_getfilmavailability","routeSlug":"/openapi/digital-platform/openapi/films/ocapifilms_getfilmavailability","metadata":{"seo":{"title":"Gets the current film availability of a particular film","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiFilms_GetFilmAvailability","name":"Gets the current film availability of a particular film","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1films~1{filmId}~1availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current film availability of a particular film","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"films/ocapifilms_getfilmavailability/request/licenses-required","deepLinkHash":"/films/ocapifilms_getfilmavailability#films/ocapifilms_getfilmavailability/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"filmId","in":"path","schemaId":"schema_33","description":"The unique identifier of the film","required":true}],"pointer":"/paths/~1ocapi~1v1~1films~1{filmId}~1availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1films~1{filmId}~1availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/films/{filmId}/availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"filmId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/films/{filmId}/availability","href":"films/ocapifilms_getfilmavailability","openApiOperationId":"OcapiFilms_GetFilmAvailability","summary":"Gets the current film availability of a particular film"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityDetails"}},"schemaId":"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityDetails"},{"code":"404","description":"Film does not exist."}],"pointer":"/paths/~1ocapi~1v1~1films~1{filmId}~1availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/films/{filmId}/availability"},{"label":"Gets Screening Dates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/films/ocapifilmscreeningdates_getfilmscreeningdates","routeSlug":"/openapi/digital-platform/openapi/films/ocapifilmscreeningdates_getfilmscreeningdates","metadata":{"seo":{"title":"Gets Screening Dates","description":"Returns a list of dates that have upcoming showtimes, along with details about which films are playing at each site on each day."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiFilmScreeningDates_GetFilmScreeningDates","name":"Gets Screening Dates","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1film-screening-dates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets Screening Dates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of dates that have upcoming showtimes, along with details about which films are playing at each site on each day."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"films/ocapifilmscreeningdates_getfilmscreeningdates/request/licenses-required","deepLinkHash":"/films/ocapifilmscreeningdates_getfilmscreeningdates#films/ocapifilmscreeningdates_getfilmscreeningdates/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"siteIds","in":"query","schemaId":"schema_41","description":"Site filter"},{"name":"filmIds","in":"query","schemaId":"schema_42","description":"Film filter"}],"pointer":"/paths/~1ocapi~1v1~1film-screening-dates/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1film-screening-dates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/film-screening-dates","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"siteIds","in":"query","schemaId":"schema_41"},{"name":"filmIds","in":"query","schemaId":"schema_42"}],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/ocapi/v1/film-screening-dates","href":"films/ocapifilmscreeningdates_getfilmscreeningdates","openApiOperationId":"OcapiFilmScreeningDates_GetFilmScreeningDates","summary":"Gets Screening Dates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.FilmScreenings.FilmScreeningDateListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.FilmScreenings.FilmScreeningDateListDetails"},{"code":"400","description":"One or more of the provided sites or films do not exist."}],"pointer":"/paths/~1ocapi~1v1~1film-screening-dates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.FilmScreenings.FilmScreeningDateListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.FilmScreenings.FilmScreeningDateListDetails"}}},{"code":"400"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/film-screening-dates"},{"label":"Gets the list of film entities for a particular site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/films/ocapifilmsforsite_getfilmsforsite","routeSlug":"/openapi/digital-platform/openapi/films/ocapifilmsforsite_getfilmsforsite","metadata":{"seo":{"title":"Gets the list of film entities for a particular site","description":"Returns a list of film entities along with their related data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiFilmsForSite_GetFilmsForSite","name":"Gets the list of film entities for a particular site","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1films/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the list of film entities for a particular site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of film entities along with their related data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any film entities that are not playing at the requested site are not returned by this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"films/ocapifilmsforsite_getfilmsforsite/request/licenses-required","deepLinkHash":"/films/ocapifilmsforsite_getfilmsforsite#films/ocapifilmsforsite_getfilmsforsite/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site","required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1films/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1films/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}/films","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}/films","href":"films/ocapifilmsforsite_getfilmsforsite","openApiOperationId":"OcapiFilmsForSite_GetFilmsForSite","summary":"Gets the list of film entities for a particular site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmListDetails"},{"code":"404","description":"Site does not exist."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1films/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmListDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}/films"},{"label":"Gets the current list of film availability entities for a particular site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/films/ocapifilmsforsite_getfilmavailabilitiesforsite","routeSlug":"/openapi/digital-platform/openapi/films/ocapifilmsforsite_getfilmavailabilitiesforsite","metadata":{"seo":{"title":"Gets the current list of film availability entities for a particular site","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiFilmsForSite_GetFilmAvailabilitiesForSite","name":"Gets the current list of film availability entities for a particular site","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1films~1availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current list of film availability entities for a particular site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"films/ocapifilmsforsite_getfilmavailabilitiesforsite/request/licenses-required","deepLinkHash":"/films/ocapifilmsforsite_getfilmavailabilitiesforsite#films/ocapifilmsforsite_getfilmavailabilitiesforsite/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site","required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1films~1availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1films~1availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}/films/availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}/films/availability","href":"films/ocapifilmsforsite_getfilmavailabilitiesforsite","openApiOperationId":"OcapiFilmsForSite_GetFilmAvailabilitiesForSite","summary":"Gets the current list of film availability entities for a particular site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityListDetails"},{"code":"404","description":"Site does not exist."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1films~1availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityListDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}/films/availability"}],"content":{"contentType":"group","meta":{"name":"Films"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Films","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/films","summary":"Gets a list of film entities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/films/ocapifilms_getfilms","deprecated":false},{"title":"/ocapi/v1/films/{filmId}","summary":"Gets a film entity by its unique identifier","prefix":{"name":"get","color":"get"},"badges":[],"link":"/films/ocapifilms_getfilm","deprecated":false},{"title":"/ocapi/v1/films/availability","summary":"Gets the current list of film availability entities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/films/ocapifilms_getfilmavailabilities","deprecated":false},{"title":"/ocapi/v1/films/{filmId}/availability","summary":"Gets the current film availability of a particular film","prefix":{"name":"get","color":"get"},"badges":[],"link":"/films/ocapifilms_getfilmavailability","deprecated":false},{"title":"/ocapi/v1/film-screening-dates","summary":"Gets Screening Dates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/films/ocapifilmscreeningdates_getfilmscreeningdates","deprecated":false},{"title":"/ocapi/v1/sites/{siteId}/films","summary":"Gets the list of film entities for a particular site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/films/ocapifilmsforsite_getfilmsforsite","deprecated":false},{"title":"/ocapi/v1/sites/{siteId}/films/availability","summary":"Gets the current list of film availability entities for a particular site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/films/ocapifilmsforsite_getfilmavailabilitiesforsite","deprecated":false}]}]}]}]}},{"type":"group","label":"Gift Cards","link":"/openapi/digital-platform/openapi/gift-cards","routeSlug":"/openapi/digital-platform/openapi/gift-cards","items":[{"label":"Gets the details of a gift card (available balance and expiry date)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/gift-cards/ocapigiftcard_getgiftcarddetails","routeSlug":"/openapi/digital-platform/openapi/gift-cards/ocapigiftcard_getgiftcarddetails","metadata":{"seo":{"title":"Gets the details of a gift card (available balance and expiry date)","description":"Introduced"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiGiftCard_GetGiftCardDetails","name":"Gets the details of a gift card (available balance and expiry date)","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1gift-cards~1details/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the details of a gift card (available balance and expiry date)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"gift-cards/ocapigiftcard_getgiftcarddetails/request/introduced","deepLinkHash":"/gift-cards/ocapigiftcard_getgiftcarddetails#gift-cards/ocapigiftcard_getgiftcarddetails/request/introduced"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Introduced"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5.0.5.1"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"gift-cards/ocapigiftcard_getgiftcarddetails/request/licenses-required","deepLinkHash":"/gift-cards/ocapigiftcard_getgiftcarddetails#gift-cards/ocapigiftcard_getgiftcarddetails/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1gift-cards~1details/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.GiftCards.GiftCardCredentials"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.GiftCards.GiftCardCredentials"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.GiftCards.GiftCardCredentials"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.GiftCards.GiftCardCredentials"}},"schemaId":"components/schemas/Ocapi.V1.GiftCards.GiftCardCredentials","pointer":"/paths/~1ocapi~1v1~1gift-cards~1details/post/requestBody","description":"Credentials of the requested gift card"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/gift-cards/details","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.GiftCards.GiftCardCredentials"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.GiftCards.GiftCardCredentials"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.GiftCards.GiftCardCredentials"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.GiftCards.GiftCardCredentials"}},"responseCodes":["200","400","429"],"pointer":"/ocapi/v1/gift-cards/details","href":"gift-cards/ocapigiftcard_getgiftcarddetails","openApiOperationId":"OcapiGiftCard_GetGiftCardDetails","summary":"Gets the details of a gift card (available balance and expiry date)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.GiftCards.GiftCardCredentials","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.GiftCards.GiftCardCredentials"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.GiftCards.GiftCardCredentials"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.GiftCards.GiftCardCredentials"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.GiftCards.GiftCardCredentials"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Validation succeeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.GiftCards.GiftCardDetails"}},"schemaId":"components/schemas/Ocapi.V1.GiftCards.GiftCardDetails"},{"code":"400","description":"The provided gift card credentials are invalid."},{"code":"429","description":"Too many requests. Try again later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}},"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}],"pointer":"/paths/~1ocapi~1v1~1gift-cards~1details/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.GiftCards.GiftCardDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.GiftCards.GiftCardDetails"}}},{"code":"400"},{"code":"429","schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}}}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/gift-cards/details"},{"label":"Adds an order gift card payment to an in progress order base","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/gift-cards/ocapiorderpayments_addgiftcardpayment","routeSlug":"/openapi/digital-platform/openapi/gift-cards/ocapiorderpayments_addgiftcardpayment","metadata":{"seo":{"title":"Adds an order gift card payment to an in progress order base","description":"Payment details are stored against order and processed when order is complete."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderPayments_AddGiftCardPayment","name":"Adds an order gift card payment to an in progress order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1gift-cards/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adds an order gift card payment to an in progress order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment details are stored against order and processed when order is complete."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"gift-cards/ocapiorderpayments_addgiftcardpayment/request/licenses-required","deepLinkHash":"/gift-cards/ocapiorderpayments_addgiftcardpayment#gift-cards/ocapiorderpayments_addgiftcardpayment/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base that the payment will be added to","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1gift-cards/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1gift-cards/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPaymentCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPaymentCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPaymentCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPaymentCreate"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPaymentCreate","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1gift-cards/post/requestBody","description":"The gift card payment request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/payments/gift-cards","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPaymentCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPaymentCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPaymentCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPaymentCreate"}},"responseCodes":["200","400","404","429"],"pointer":"/ocapi/v1/orders/{orderId}/payments/gift-cards","href":"gift-cards/ocapiorderpayments_addgiftcardpayment","openApiOperationId":"OcapiOrderPayments_AddGiftCardPayment","summary":"Adds an order gift card payment to an in progress order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPaymentCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPaymentCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPaymentCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPaymentCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPaymentCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPayment"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPayment"},{"code":"400","description":"Request property is invalid or missing, or gift card cannot be added."},{"code":"404","description":"Order does not exist."},{"code":"429","description":"Too many requests. Try again later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}},"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1gift-cards/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPayment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPayment"}}},{"code":"400"},{"code":"404"},{"code":"429","schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}}}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/payments/gift-cards"}],"content":{"contentType":"group","meta":{"name":"Gift Cards"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gift Cards","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/gift-cards/details","summary":"Gets the details of a gift card (available balance and expiry date)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gift-cards/ocapigiftcard_getgiftcarddetails","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/payments/gift-cards","summary":"Adds an order gift card payment to an in progress order base","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gift-cards/ocapiorderpayments_addgiftcardpayment","deprecated":false}]}]}]}]}},{"type":"group","label":"Items","link":"/openapi/digital-platform/openapi/items","routeSlug":"/openapi/digital-platform/openapi/items","items":[{"label":"Gets the current list of item availability entities for a particular site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/items/ocapiitemavailability_getitemavailabilitiesforsite","routeSlug":"/openapi/digital-platform/openapi/items/ocapiitemavailability_getitemavailabilitiesforsite","metadata":{"seo":{"title":"Gets the current list of item availability entities for a particular site","description":"Use GetItemAvailabilitiesForSiteOrderLocation to get the site item availability list details for a particular site order location"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiItemAvailability_GetItemAvailabilitiesForSite","name":"Gets the current list of item availability entities for a particular site","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1item-availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current list of item availability entities for a particular site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/items/ocapiitemavailability_getitemavailabilitiesforsiteorderlocation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GetItemAvailabilitiesForSiteOrderLocation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the site item availability list details for a particular site order location"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"items/ocapiitemavailability_getitemavailabilitiesforsite/request/licenses-required","deepLinkHash":"/items/ocapiitemavailability_getitemavailabilitiesforsite#items/ocapiitemavailability_getitemavailabilitiesforsite/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site","required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1item-availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1item-availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}/item-availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}/item-availability","href":"items/ocapiitemavailability_getitemavailabilitiesforsite","openApiOperationId":"OcapiItemAvailability_GetItemAvailabilitiesForSite","summary":"Gets the current list of item availability entities for a particular site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.Availability.SiteItemAvailabilityListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Sales.Availability.SiteItemAvailabilityListDetails"},{"code":"404","description":"Site does not exist."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1item-availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Sales.Availability.SiteItemAvailabilityListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.Availability.SiteItemAvailabilityListDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}/item-availability"},{"label":"Gets the current list of item availability entities for a particular site and site order location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/items/ocapiitemavailability_getitemavailabilitiesforsiteorderlocation","routeSlug":"/openapi/digital-platform/openapi/items/ocapiitemavailability_getitemavailabilitiesforsiteorderlocation","metadata":{"seo":{"title":"Gets the current list of item availability entities for a particular site and site order location","description":"Use GetItemAvailabilitiesForSite to get the default site item availability list details for the site"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiItemAvailability_GetItemAvailabilitiesForSiteOrderLocation","name":"Gets the current list of item availability entities for a particular site and site order location","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1order-locations~1{siteOrderLocationId}~1item-availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current list of item availability entities for a particular site and site order location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/items/ocapiitemavailability_getitemavailabilitiesforsite"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GetItemAvailabilitiesForSite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the default site item availability list details for the site"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"items/ocapiitemavailability_getitemavailabilitiesforsiteorderlocation/request/licenses-required","deepLinkHash":"/items/ocapiitemavailability_getitemavailabilitiesforsiteorderlocation#items/ocapiitemavailability_getitemavailabilitiesforsiteorderlocation/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site","required":true},{"name":"siteOrderLocationId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site order location","required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1order-locations~1{siteOrderLocationId}~1item-availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1order-locations~1{siteOrderLocationId}~1item-availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}/order-locations/{siteOrderLocationId}/item-availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"},{"name":"siteOrderLocationId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}/order-locations/{siteOrderLocationId}/item-availability","href":"items/ocapiitemavailability_getitemavailabilitiesforsiteorderlocation","openApiOperationId":"OcapiItemAvailability_GetItemAvailabilitiesForSiteOrderLocation","summary":"Gets the current list of item availability entities for a particular site and site order location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.Availability.SiteItemAvailabilityListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Sales.Availability.SiteItemAvailabilityListDetails"},{"code":"404","description":"Site or order location does not exist."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1order-locations~1{siteOrderLocationId}~1item-availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Sales.Availability.SiteItemAvailabilityListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.Availability.SiteItemAvailabilityListDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}/order-locations/{siteOrderLocationId}/item-availability"},{"label":"Gets the current list of item availability entities for the Gift Shop","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/items/ocapiitemavailability_getitemavailabilitiesforgiftshop","routeSlug":"/openapi/digital-platform/openapi/items/ocapiitemavailability_getitemavailabilitiesforgiftshop","metadata":{"seo":{"title":"Gets the current list of item availability entities for the Gift Shop","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiItemAvailability_GetItemAvailabilitiesForGiftShop","name":"Gets the current list of item availability entities for the Gift Shop","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1gift-shop~1item-availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current list of item availability entities for the Gift Shop","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"items/ocapiitemavailability_getitemavailabilitiesforgiftshop/request/licenses-required","deepLinkHash":"/items/ocapiitemavailability_getitemavailabilitiesforgiftshop#items/ocapiitemavailability_getitemavailabilitiesforgiftshop/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1gift-shop~1item-availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/gift-shop/item-availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/gift-shop/item-availability","href":"items/ocapiitemavailability_getitemavailabilitiesforgiftshop","openApiOperationId":"OcapiItemAvailability_GetItemAvailabilitiesForGiftShop","summary":"Gets the current list of item availability entities for the Gift Shop"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}},"schemaId":"schema_45"},{"code":"404","description":"Gift shop does not exist."}],"pointer":"/paths/~1ocapi~1v1~1gift-shop~1item-availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_45","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/gift-shop/item-availability"},{"label":"Gets the site item profile and its related data for a specified site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/items/ocapiitemprofiles_getitemprofileforsite","routeSlug":"/openapi/digital-platform/openapi/items/ocapiitemprofiles_getitemprofileforsite","metadata":{"seo":{"title":"Gets the site item profile and its related data for a specified site","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiItemProfiles_GetItemProfileForSite","name":"Gets the site item profile and its related data for a specified site","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1item-profile/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the site item profile and its related data for a specified site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"items/ocapiitemprofiles_getitemprofileforsite/request/licenses-required","deepLinkHash":"/items/ocapiitemprofiles_getitemprofileforsite#items/ocapiitemprofiles_getitemprofileforsite/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site","required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1item-profile/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1item-profile/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}/item-profile","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}/item-profile","href":"items/ocapiitemprofiles_getitemprofileforsite","openApiOperationId":"OcapiItemProfiles_GetItemProfileForSite","summary":"Gets the site item profile and its related data for a specified site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.SiteItemProfileDetails"}},"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.SiteItemProfileDetails"},{"code":"404","description":"Site does not exist."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1item-profile/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.SiteItemProfileDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.SiteItemProfileDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}/item-profile"},{"label":"Gets the site item profile and its related data for a specified site and site order location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/items/ocapiitemprofiles_getitemprofileforsiteorderlocation","routeSlug":"/openapi/digital-platform/openapi/items/ocapiitemprofiles_getitemprofileforsiteorderlocation","metadata":{"seo":{"title":"Gets the site item profile and its related data for a specified site and site order location","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiItemProfiles_GetItemProfileForSiteOrderLocation","name":"Gets the site item profile and its related data for a specified site and site order location","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1order-locations~1{siteOrderLocationId}~1item-profile/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the site item profile and its related data for a specified site and site order location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"items/ocapiitemprofiles_getitemprofileforsiteorderlocation/request/licenses-required","deepLinkHash":"/items/ocapiitemprofiles_getitemprofileforsiteorderlocation#items/ocapiitemprofiles_getitemprofileforsiteorderlocation/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site","required":true},{"name":"siteOrderLocationId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site order location","required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1order-locations~1{siteOrderLocationId}~1item-profile/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1order-locations~1{siteOrderLocationId}~1item-profile/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}/order-locations/{siteOrderLocationId}/item-profile","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"},{"name":"siteOrderLocationId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}/order-locations/{siteOrderLocationId}/item-profile","href":"items/ocapiitemprofiles_getitemprofileforsiteorderlocation","openApiOperationId":"OcapiItemProfiles_GetItemProfileForSiteOrderLocation","summary":"Gets the site item profile and its related data for a specified site and site order location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.SiteItemProfileDetails"}},"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.SiteItemProfileDetails"},{"code":"404","description":"Site or order location does not exist."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1order-locations~1{siteOrderLocationId}~1item-profile/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.SiteItemProfileDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.SiteItemProfileDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}/order-locations/{siteOrderLocationId}/item-profile"},{"label":"Gets a sellable item for an item base with a specified head office entity Hopk for a specified site, and its related data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/items/ocapiitemprofiles_getsellableitembyhopkforsite","routeSlug":"/openapi/digital-platform/openapi/items/ocapiitemprofiles_getsellableitembyhopkforsite","metadata":{"seo":{"title":"Gets a sellable item for an item base with a specified head office entity Hopk for a specified site, and its related data","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiItemProfiles_GetSellableItemByHopkForSite","name":"Gets a sellable item for an item base with a specified head office entity Hopk for a specified site, and its related data","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1sellable-items~1by-hopk~1{itemHopk}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a sellable item for an item base with a specified head office entity Hopk for a specified site, and its related data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"items/ocapiitemprofiles_getsellableitembyhopkforsite/request/licenses-required","deepLinkHash":"/items/ocapiitemprofiles_getsellableitembyhopkforsite#items/ocapiitemprofiles_getsellableitembyhopkforsite/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site","required":true},{"name":"itemHopk","in":"path","schemaId":"schema_33","description":"The head office entity Hopk of the item base","required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1sellable-items~1by-hopk~1{itemHopk}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1sellable-items~1by-hopk~1{itemHopk}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}/sellable-items/by-hopk/{itemHopk}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"},{"name":"itemHopk","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}/sellable-items/by-hopk/{itemHopk}","href":"items/ocapiitemprofiles_getsellableitembyhopkforsite","openApiOperationId":"OcapiItemProfiles_GetSellableItemByHopkForSite","summary":"Gets a sellable item for an item base with a specified head office entity Hopk for a specified site, and its related data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Sellable.SellableItemDetails"}},"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Sellable.SellableItemDetails"},{"code":"404","description":"Site or item does not exist."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1sellable-items~1by-hopk~1{itemHopk}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Sellable.SellableItemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Sellable.SellableItemDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}/sellable-items/by-hopk/{itemHopk}"},{"label":"Gets the item profile and it's related data for the Gift Shop","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/items/ocapiitemprofiles_getitemprofileforgiftshop","routeSlug":"/openapi/digital-platform/openapi/items/ocapiitemprofiles_getitemprofileforgiftshop","metadata":{"seo":{"title":"Gets the item profile and it's related data for the Gift Shop","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiItemProfiles_GetItemProfileForGiftShop","name":"Gets the item profile and it's related data for the Gift Shop","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1gift-shop~1item-profile/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the item profile and it's related data for the Gift Shop","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"items/ocapiitemprofiles_getitemprofileforgiftshop/request/licenses-required","deepLinkHash":"/items/ocapiitemprofiles_getitemprofileforgiftshop#items/ocapiitemprofiles_getitemprofileforgiftshop/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1gift-shop~1item-profile/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/gift-shop/item-profile","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/ocapi/v1/gift-shop/item-profile","href":"items/ocapiitemprofiles_getitemprofileforgiftshop","openApiOperationId":"OcapiItemProfiles_GetItemProfileForGiftShop","summary":"Gets the item profile and it's related data for the Gift Shop"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.GiftShopItemProfileDetails"}},"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.GiftShopItemProfileDetails"},{"code":"400","description":"Gift shop does not exist."}],"pointer":"/paths/~1ocapi~1v1~1gift-shop~1item-profile/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.GiftShopItemProfileDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.GiftShopItemProfileDetails"}}},{"code":"400"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/gift-shop/item-profile"},{"label":"Sets the items for an in progress standard order or in progress gift shop order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/items/ocapiorderitems_setitems","routeSlug":"/openapi/digital-platform/openapi/items/ocapiorderitems_setitems","metadata":{"seo":{"title":"Sets the items for an in progress standard order or in progress gift shop order","description":"Existing items on the order will be replaced with the specified selections."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderItems_SetItems","name":"Sets the items for an in progress standard order or in progress gift shop order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sets the items for an in progress standard order or in progress gift shop order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Existing items on the order will be replaced with the specified selections."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Items with attached scarcity such as items with "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"selling limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currently may fail on repeated PUT as this API is currently not fully atomic."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the order contains showtimes (see standard order Showtimes), item availability will be based on the earliest showtime."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the order has a parent order (see standard order ParentOrderId), item availability will be based on the start time of the earliest showtime of the parent order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For in progress tab order entities, use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/orders/ocapiorderitems_additems"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AddItems"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"items/ocapiorderitems_setitems/request/licenses-required","deepLinkHash":"/items/ocapiorderitems_setitems#items/ocapiorderitems_setitems/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base being modified","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/put/requestBody","description":"The requested items"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/orders/{orderId}/items","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/items","href":"items/ocapiorderitems_setitems","openApiOperationId":"OcapiOrderItems_SetItems","summary":"Sets the items for an in progress standard order or in progress gift shop order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order items","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase"},{"code":"400","description":"Request property is invalid or missing, or invalid order type."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/items"},{"label":"Adds items to an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/items/ocapiorderitems_additems","routeSlug":"/openapi/digital-platform/openapi/items/ocapiorderitems_additems","metadata":{"seo":{"title":"Adds items to an in progress tab order","description":"Items cannot be added to an in progress tab order when in progress tab order IsOpen equals false."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderItems_AddItems","name":"Adds items to an in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adds items to an in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items cannot be added to an in progress tab order when in progress tab order IsOpen equals false."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For in progress standard order or in progress gift shop order entities, use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/items/ocapiorderitems_setitems"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SetItems"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items that require preparation are immediately sent to the kitchen."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items cannot be removed or modified once added to an in progress tab order"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tabs/ocapiorderitems_additems/request/items/ocapiorderitems_additems/request/orders/ocapiorderitems_additems/request/licenses-required","deepLinkHash":"/tabs/ocapiorderitems_additems#tabs/ocapiorderitems_additems/request/items/ocapiorderitems_additems/request/orders/ocapiorderitems_additems/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress tab order being modified","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/post/requestBody","description":"The requested items"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/items","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/items","href":"items/ocapiorderitems_additems","openApiOperationId":"OcapiOrderItems_AddItems","summary":"Adds items to an in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order items","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase"},{"code":"400","description":"Request property is invalid or missing, or invalid order type."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/items"}],"content":{"contentType":"group","meta":{"name":"Items"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Items","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/sites/{siteId}/item-availability","summary":"Gets the current list of item availability entities for a particular site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/items/ocapiitemavailability_getitemavailabilitiesforsite","deprecated":false},{"title":"/ocapi/v1/sites/{siteId}/order-locations/{siteOrderLocationId}/item-availability","summary":"Gets the current list of item availability entities for a particular site and site order location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/items/ocapiitemavailability_getitemavailabilitiesforsiteorderlocation","deprecated":false},{"title":"/ocapi/v1/gift-shop/item-availability","summary":"Gets the current list of item availability entities for the Gift Shop","prefix":{"name":"get","color":"get"},"badges":[],"link":"/items/ocapiitemavailability_getitemavailabilitiesforgiftshop","deprecated":false},{"title":"/ocapi/v1/sites/{siteId}/item-profile","summary":"Gets the site item profile and its related data for a specified site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/items/ocapiitemprofiles_getitemprofileforsite","deprecated":false},{"title":"/ocapi/v1/sites/{siteId}/order-locations/{siteOrderLocationId}/item-profile","summary":"Gets the site item profile and its related data for a specified site and site order location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/items/ocapiitemprofiles_getitemprofileforsiteorderlocation","deprecated":false},{"title":"/ocapi/v1/sites/{siteId}/sellable-items/by-hopk/{itemHopk}","summary":"Gets a sellable item for an item base with a specified head office entity Hopk for a specified site, and its related data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/items/ocapiitemprofiles_getsellableitembyhopkforsite","deprecated":false},{"title":"/ocapi/v1/gift-shop/item-profile","summary":"Gets the item profile and it's related data for the Gift Shop","prefix":{"name":"get","color":"get"},"badges":[],"link":"/items/ocapiitemprofiles_getitemprofileforgiftshop","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/items","summary":"Sets the items for an in progress standard order or in progress gift shop order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/items/ocapiorderitems_setitems","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/items","summary":"Adds items to an in progress tab order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/items/ocapiorderitems_additems","deprecated":false}]}]}]}]}},{"type":"group","label":"Journeys","link":"/openapi/digital-platform/openapi/journeys","routeSlug":"/openapi/digital-platform/openapi/journeys","items":[{"label":"Gets a journey details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/journeys/ocapijourneys_getjourney","routeSlug":"/openapi/digital-platform/openapi/journeys/ocapijourneys_getjourney","metadata":{"seo":{"title":"Gets a journey details","description":"Gets a journey which represents, from start to finish, a customer's interactions withVista software in relation to one or multiple visits to the cinema initiated by asingle sale."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiJourneys_GetJourney","name":"Gets a journey details","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1journeys~1{journeyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a journey details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets a journey which represents, from start to finish, a customer's interactions with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista software in relation to one or multiple visits to the cinema initiated by a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single sale."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"journeys/ocapijourneys_getjourney/request/licenses-required","deepLinkHash":"/journeys/ocapijourneys_getjourney#journeys/ocapijourneys_getjourney/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"journeyId","in":"path","schemaId":"schema_33","description":"The unique identifier of the journey to be retrieved","required":true}],"pointer":"/paths/~1ocapi~1v1~1journeys~1{journeyId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1journeys~1{journeyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/journeys/{journeyId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"journeyId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","202","404"],"pointer":"/ocapi/v1/journeys/{journeyId}","href":"journeys/ocapijourneys_getjourney","openApiOperationId":"OcapiJourneys_GetJourney","summary":"Gets a journey details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Journey.JourneyDetails"}},"schemaId":"components/schemas/Ocapi.V1.Journey.JourneyDetails"},{"code":"202","description":"Journey is not ready."},{"code":"404","description":"Journey does not exist."}],"pointer":"/paths/~1ocapi~1v1~1journeys~1{journeyId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Journey.JourneyDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Journey.JourneyDetails"}}},{"code":"202"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/journeys/{journeyId}"},{"label":"Gets a journey details by its reference","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/journeys/ocapijourneys_getjourneybyreference","routeSlug":"/openapi/digital-platform/openapi/journeys/ocapijourneys_getjourneybyreference","metadata":{"seo":{"title":"Gets a journey details by its reference","description":"Gets a journey which represents, from start to finish, a customer's interactions withVista software in relation to one or multiple visits to the cinema initiated by asingle sale."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiJourneys_GetJourneyByReference","name":"Gets a journey details by its reference","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1journeys~1by-reference~1{journeyReference}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a journey details by its reference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets a journey which represents, from start to finish, a customer's interactions with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista software in relation to one or multiple visits to the cinema initiated by a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single sale."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A journey reference is generated when the asynchronous journey service is started so"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that it's possible to distinguish between a valid journey that hasn't been prepared by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the service and one that doesn't exist."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"journeys/ocapijourneys_getjourneybyreference/request/licenses-required","deepLinkHash":"/journeys/ocapijourneys_getjourneybyreference#journeys/ocapijourneys_getjourneybyreference/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"journeyReference","in":"path","schemaId":"schema_33","description":"A reference for the journey to be retrieved","required":true}],"pointer":"/paths/~1ocapi~1v1~1journeys~1by-reference~1{journeyReference}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1journeys~1by-reference~1{journeyReference}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/journeys/by-reference/{journeyReference}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"journeyReference","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","202","404"],"pointer":"/ocapi/v1/journeys/by-reference/{journeyReference}","href":"journeys/ocapijourneys_getjourneybyreference","openApiOperationId":"OcapiJourneys_GetJourneyByReference","summary":"Gets a journey details by its reference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Journey.JourneyDetails"}},"schemaId":"components/schemas/Ocapi.V1.Journey.JourneyDetails"},{"code":"202","description":"Journey reference exists, but journey is not yet ready for retrieval."},{"code":"404","description":"Journey does not exist."}],"pointer":"/paths/~1ocapi~1v1~1journeys~1by-reference~1{journeyReference}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Journey.JourneyDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Journey.JourneyDetails"}}},{"code":"202"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/journeys/by-reference/{journeyReference}"}],"content":{"contentType":"group","meta":{"name":"Journeys"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Journeys","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/journeys/{journeyId}","summary":"Gets a journey details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/journeys/ocapijourneys_getjourney","deprecated":false},{"title":"/ocapi/v1/journeys/by-reference/{journeyReference}","summary":"Gets a journey details by its reference","prefix":{"name":"get","color":"get"},"badges":[],"link":"/journeys/ocapijourneys_getjourneybyreference","deprecated":false}]}]}]}]}},{"type":"group","label":"Third Party Passes","link":"/openapi/digital-platform/openapi/third-party-passes","routeSlug":"/openapi/digital-platform/openapi/third-party-passes","items":[{"label":"Gets an Apple Wallet pass for a journey","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/third-party-passes/ocapijourneythirdpartypasses_getapplewalletpassforjourney","routeSlug":"/openapi/digital-platform/openapi/third-party-passes/ocapijourneythirdpartypasses_getapplewalletpassforjourney","metadata":{"seo":{"title":"Gets an Apple Wallet pass for a journey","description":"Previously known as 'Apple Passbook' and renamed to 'Apple Wallet' by Apple Inc. in 2015."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiJourneyThirdPartyPasses_GetAppleWalletPassForJourney","name":"Gets an Apple Wallet pass for a journey","deprecated":true,"isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1journeys~1{journeyId}~1third-party-passes~1apple-wallet/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets an Apple Wallet pass for a journey","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously known as 'Apple Passbook' and renamed to 'Apple Wallet' by Apple Inc. in 2015."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be used to create an 'Add to Apple Wallet' button."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"third-party-passes/ocapijourneythirdpartypasses_getapplewalletpassforjourney/request/licenses-required","deepLinkHash":"/third-party-passes/ocapijourneythirdpartypasses_getapplewalletpassforjourney#third-party-passes/ocapijourneythirdpartypasses_getapplewalletpassforjourney/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"journeyId","in":"path","schemaId":"schema_33","description":"The unique identifier of the journey","required":true}],"pointer":"/paths/~1ocapi~1v1~1journeys~1{journeyId}~1third-party-passes~1apple-wallet/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1journeys~1{journeyId}~1third-party-passes~1apple-wallet/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/journeys/{journeyId}/third-party-passes/apple-wallet","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"journeyId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","202","404"],"pointer":"/ocapi/v1/journeys/{journeyId}/third-party-passes/apple-wallet","href":"third-party-passes/ocapijourneythirdpartypasses_getapplewalletpassforjourney","openApiOperationId":"OcapiJourneyThirdPartyPasses_GetAppleWalletPassForJourney","summary":"Gets an Apple Wallet pass for a journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Byte array representing Apple PassKit Pass. Content-Type is application/vnd.apple.pkpass","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34"},{"code":"202","description":"Journey is not ready."},{"code":"404","description":"Journey does not exist."}],"pointer":"/paths/~1ocapi~1v1~1journeys~1{journeyId}~1third-party-passes~1apple-wallet/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}}},{"code":"202"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/journeys/{journeyId}/third-party-passes/apple-wallet"}],"content":{"contentType":"group","meta":{"name":"Third Party Passes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Third Party Passes","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/journeys/{journeyId}/third-party-passes/apple-wallet","summary":"Gets an Apple Wallet pass for a journey","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/third-party-passes/ocapijourneythirdpartypasses_getapplewalletpassforjourney","deprecated":true}]}]}]}]}},{"type":"group","label":"Loyalty","link":"/openapi/digital-platform/openapi/loyalty","routeSlug":"/openapi/digital-platform/openapi/loyalty","items":[{"label":"Returns reference master data required to build member management UIs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/loyalty/ocapiloyaltymasterdata_getmasterdata","routeSlug":"/openapi/digital-platform/openapi/loyalty/ocapiloyaltymasterdata_getmasterdata","metadata":{"seo":{"title":"Returns reference master data required to build member management UIs","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiLoyaltyMasterData_GetMasterData","name":"Returns reference master data required to build member management UIs","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1loyalty-master-data/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns reference master data required to build member management UIs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"loyalty/ocapiloyaltymasterdata_getmasterdata/request/licenses-required","deepLinkHash":"/loyalty/ocapiloyaltymasterdata_getmasterdata#loyalty/ocapiloyaltymasterdata_getmasterdata/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1loyalty-master-data/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/loyalty-master-data","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/ocapi/v1/loyalty-master-data","href":"loyalty/ocapiloyaltymasterdata_getmasterdata","openApiOperationId":"OcapiLoyaltyMasterData_GetMasterData","summary":"Returns reference master data required to build member management UIs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.MasterData.LoyaltyMasterData"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.MasterData.LoyaltyMasterData"}],"pointer":"/paths/~1ocapi~1v1~1loyalty-master-data/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.MasterData.LoyaltyMasterData","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.MasterData.LoyaltyMasterData"}}}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/loyalty-master-data"},{"label":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/loyalty/ocapimemberauthentication_createworkstationauthenticationcookie","routeSlug":"/openapi/digital-platform/openapi/loyalty/ocapimemberauthentication_createworkstationauthenticationcookie","metadata":{"seo":{"title":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","description":"The HTTP Authorization header must include a Central Identity Management device token (also known as a DIM token)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberAuthentication_CreateWorkstationAuthenticationCookie","name":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1workstation-authentication-cookie/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The HTTP Authorization header must include a Central Identity Management device token (also known as a DIM token)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Providing this cookie with subsequent requests works as an alternative to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LoyaltySessionToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sign out is handled by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_expireauthenticationcookie"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ExpireAuthenticationCookie"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using cookie-based authentication, the API will automatically refresh the cookie when the access token has expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In addition to the authentication cookie, a second "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vista-loyalty-member-is-authenticated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cookie is returned that can be used by the client to detect whether the patron is authenticated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data is to be provided as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/x-www-form-urlencoded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" form parameters in the format of member workstation authentication request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlike the standard member authentication endpoints, the cookie from this endpoint does not have permission to update member details."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimemberauthentication_createworkstationauthenticationcookie/request/authentication/ocapimemberauthentication_createworkstationauthenticationcookie/request/loyalty/ocapimemberauthentication_createworkstationauthenticationcookie/request/error-response","deepLinkHash":"/members/ocapimemberauthentication_createworkstationauthenticationcookie#members/ocapimemberauthentication_createworkstationauthenticationcookie/request/authentication/ocapimemberauthentication_createworkstationauthenticationcookie/request/loyalty/ocapimemberauthentication_createworkstationauthenticationcookie/request/error-response"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Response"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LockOutPeriodInSeconds property will only be present on the response object if the response has the error code 32000."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimemberauthentication_createworkstationauthenticationcookie/request/authentication/ocapimemberauthentication_createworkstationauthenticationcookie/request/loyalty/ocapimemberauthentication_createworkstationauthenticationcookie/request/licenses-required","deepLinkHash":"/members/ocapimemberauthentication_createworkstationauthenticationcookie#members/ocapimemberauthentication_createworkstationauthenticationcookie/request/authentication/ocapimemberauthentication_createworkstationauthenticationcookie/request/loyalty/ocapimemberauthentication_createworkstationauthenticationcookie/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1workstation-authentication-cookie/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_46"}},"schemaId":"schema_46","pointer":"/paths/~1ocapi~1v1~1members~1workstation-authentication-cookie/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/workstation-authentication-cookie","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"multipart/form-data":{"schemaId":"schema_46"}},"responseCodes":["204","400","401","403","429"],"pointer":"/ocapi/v1/members/workstation-authentication-cookie","href":"loyalty/ocapimemberauthentication_createworkstationauthenticationcookie","openApiOperationId":"OcapiMemberAuthentication_CreateWorkstationAuthenticationCookie","summary":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_46","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_46"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member authenticated cookies created."},{"code":"400","description":"The provided grant type, credentials, or refresh token are invalid."},{"code":"401","description":"Authentication JWT is missing."},{"code":"403","description":"This endpoint can only be used using a CIM Device Authentication token."},{"code":"429","description":"Member or device locked. Try again later."}],"pointer":"/paths/~1ocapi~1v1~1members~1workstation-authentication-cookie/post/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/workstation-authentication-cookie"},{"label":"Updates the push notification token of the currently authenticated member allowing\r\ntheir mobile device to receive push notifications","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/loyalty/ocapimemberupdate_setmemberpushnotificationtoken","routeSlug":"/openapi/digital-platform/openapi/loyalty/ocapimemberupdate_setmemberpushnotificationtoken","metadata":{"seo":{"title":"Updates the push notification token of the currently authenticated member allowing\r\ntheir mobile device to receive push notifications","description":"Only one push notification token can be saved on a member entity. Updating the push notification tokenfrom a different mobile device will prevent the previous mobile device from receiving push notifications."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberUpdate_SetMemberPushNotificationToken","name":"Updates the push notification token of the currently authenticated member allowing\r\ntheir mobile device to receive push notifications","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1push-notification-token/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates the push notification token of the currently authenticated member allowing\r\ntheir mobile device to receive push notifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only one push notification token can be saved on a member entity. Updating the push notification token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from a different mobile device will prevent the previous mobile device from receiving push notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No validation will be done to determine if the provided push notification token is usable."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimemberupdate_setmemberpushnotificationtoken/request/loyalty/ocapimemberupdate_setmemberpushnotificationtoken/request/licenses-required","deepLinkHash":"/members/ocapimemberupdate_setmemberpushnotificationtoken#members/ocapimemberupdate_setmemberpushnotificationtoken/request/loyalty/ocapimemberupdate_setmemberpushnotificationtoken/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1push-notification-token/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"}},"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken","pointer":"/paths/~1ocapi~1v1~1members~1current~1push-notification-token/put/requestBody","description":"Push notification token details"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/members/current/push-notification-token","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"}},"responseCodes":["204","400","401"],"pointer":"/ocapi/v1/members/current/push-notification-token","href":"loyalty/ocapimemberupdate_setmemberpushnotificationtoken","openApiOperationId":"OcapiMemberUpdate_SetMemberPushNotificationToken","summary":"Updates the push notification token of the currently authenticated member allowing\r\ntheir mobile device to receive push notifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member push notification token updated."},{"code":"400","description":"Request property is invalid or missing."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1push-notification-token/put/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/push-notification-token"},{"label":"Removes the push notification token of the currently authenticated member\r\npreventing push notification from being received on their mobile device","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/loyalty/ocapimemberupdate_removememberpushnotificationtoken","routeSlug":"/openapi/digital-platform/openapi/loyalty/ocapimemberupdate_removememberpushnotificationtoken","metadata":{"seo":{"title":"Removes the push notification token of the currently authenticated member\r\npreventing push notification from being received on their mobile device","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberUpdate_RemoveMemberPushNotificationToken","name":"Removes the push notification token of the currently authenticated member\r\npreventing push notification from being received on their mobile device","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1push-notification-token/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removes the push notification token of the currently authenticated member\r\npreventing push notification from being received on their mobile device","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimemberupdate_removememberpushnotificationtoken/request/loyalty/ocapimemberupdate_removememberpushnotificationtoken/request/licenses-required","deepLinkHash":"/members/ocapimemberupdate_removememberpushnotificationtoken#members/ocapimemberupdate_removememberpushnotificationtoken/request/loyalty/ocapimemberupdate_removememberpushnotificationtoken/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1push-notification-token/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ocapi/v1/members/current/push-notification-token","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["204","401"],"pointer":"/ocapi/v1/members/current/push-notification-token","href":"loyalty/ocapimemberupdate_removememberpushnotificationtoken","openApiOperationId":"OcapiMemberUpdate_RemoveMemberPushNotificationToken","summary":"Removes the push notification token of the currently authenticated member\r\npreventing push notification from being received on their mobile device"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member push notification token removed."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1push-notification-token/delete/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/push-notification-token"}],"content":{"contentType":"group","meta":{"name":"Loyalty"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Loyalty","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/loyalty-master-data","summary":"Returns reference master data required to build member management UIs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loyalty/ocapiloyaltymasterdata_getmasterdata","deprecated":false},{"title":"/ocapi/v1/members/workstation-authentication-cookie","summary":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loyalty/ocapimemberauthentication_createworkstationauthenticationcookie","deprecated":false},{"title":"/ocapi/v1/members/current/push-notification-token","summary":"Updates the push notification token of the currently authenticated member allowing\r\ntheir mobile device to receive push notifications","prefix":{"name":"put","color":"put"},"badges":[],"link":"/loyalty/ocapimemberupdate_setmemberpushnotificationtoken","deprecated":false},{"title":"/ocapi/v1/members/current/push-notification-token","summary":"Removes the push notification token of the currently authenticated member\r\npreventing push notification from being received on their mobile device","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/loyalty/ocapimemberupdate_removememberpushnotificationtoken","deprecated":false}]}]}]}]}},{"type":"group","label":"Authentication","link":"/openapi/digital-platform/openapi/authentication","routeSlug":"/openapi/digital-platform/openapi/authentication","items":[{"label":"Authenticates a member and creates an member authentication token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_createauthenticationtoken","routeSlug":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_createauthenticationtoken","metadata":{"seo":{"title":"Authenticates a member and creates an member authentication token","description":"This method of authentication is recommended for clients that can securely store the member authentication token access_tokenand member authentication token refresh_token locally."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberAuthentication_CreateAuthenticationToken","name":"Authenticates a member and creates an member authentication token","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1authentication-token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authenticates a member and creates an member authentication token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method of authentication is recommended for clients that can securely store the member authentication token access_token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and member authentication token refresh_token locally."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The member authentication token access_token must be provided as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LoyaltySessionToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header to authenticate subsequent requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sign out is handled by deleting the stored member authentication token access_token and member authentication token refresh_token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method can be used to both create a new access token, or refresh an expired token based on the member authentication request grant_type"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data is to be provided as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/x-www-form-urlencoded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" form parameters in the format of member authentication request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_issuer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" grant type will fail if the provided external authentication token can not be linked to a single Loyalty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"member, and as such is unsuitable for social sign in flows."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"authentication/ocapimemberauthentication_createauthenticationtoken/request/error-response","deepLinkHash":"/authentication/ocapimemberauthentication_createauthenticationtoken#authentication/ocapimemberauthentication_createauthenticationtoken/request/error-response"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Response"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LockOutPeriodInSeconds property will only be present on the response object if the response has the error code 32000."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"authentication/ocapimemberauthentication_createauthenticationtoken/request/licenses-required","deepLinkHash":"/authentication/ocapimemberauthentication_createauthenticationtoken#authentication/ocapimemberauthentication_createauthenticationtoken/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1authentication-token/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_47"}},"schemaId":"schema_47","pointer":"/paths/~1ocapi~1v1~1members~1authentication-token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/authentication-token","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"multipart/form-data":{"schemaId":"schema_47"}},"responseCodes":["200","400","429"],"pointer":"/ocapi/v1/members/authentication-token","href":"authentication/ocapimemberauthentication_createauthenticationtoken","openApiOperationId":"OcapiMemberAuthentication_CreateAuthenticationToken","summary":"Authenticates a member and creates an member authentication token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_47","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_47"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Authentication.MemberAuthenticationToken"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Authentication.MemberAuthenticationToken"},{"code":"400","description":"The provided grant type, credentials, or refresh token are invalid."},{"code":"429","description":"Member locked. Try again later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.MemberLockedError"}},"schemaId":"components/schemas/Ocapi.V1.Errors.MemberLockedError"}],"pointer":"/paths/~1ocapi~1v1~1members~1authentication-token/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Authentication.MemberAuthenticationToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Authentication.MemberAuthenticationToken"}}},{"code":"400"},{"code":"429","schemaId":"components/schemas/Ocapi.V1.Errors.MemberLockedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.MemberLockedError"}}}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/authentication-token"},{"label":"Authenticates a member and returns an HTTP-only authentication cookie","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_createauthenticationcookie","routeSlug":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_createauthenticationcookie","metadata":{"seo":{"title":"Authenticates a member and returns an HTTP-only authentication cookie","description":"This method of authentication is recommended for clients that do not have access to secure storage, as the authentication token is stored in a secure HTTP-only cookie."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberAuthentication_CreateAuthenticationCookie","name":"Authenticates a member and returns an HTTP-only authentication cookie","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1authentication-cookie/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authenticates a member and returns an HTTP-only authentication cookie","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method of authentication is recommended for clients that do not have access to secure storage, as the authentication token is stored in a secure HTTP-only cookie."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Providing this cookie with subsequent requests works as an alternative to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LoyaltySessionToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sign out is handled by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_expireauthenticationcookie"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ExpireAuthenticationCookie"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using cookie-based authentication, the API will automatically refresh the cookie when the access token has expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In addition to the authentication cookie, a second "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vista-loyalty-member-is-authenticated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cookie is returned that can be used by the client to detect whether the patron is authenticated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data is to be provided as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/x-www-form-urlencoded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" form parameters in the format of member authentication request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_issuer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" grant type will fail if the provided external authentication token can not be linked to a single Loyalty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"member, and as such is unsuitable for social sign in flows."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"authentication/ocapimemberauthentication_createauthenticationcookie/request/error-response","deepLinkHash":"/authentication/ocapimemberauthentication_createauthenticationcookie#authentication/ocapimemberauthentication_createauthenticationcookie/request/error-response"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Response"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LockOutPeriodInSeconds property will only be present on the response object if the response has the error code 32000."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"authentication/ocapimemberauthentication_createauthenticationcookie/request/licenses-required","deepLinkHash":"/authentication/ocapimemberauthentication_createauthenticationcookie#authentication/ocapimemberauthentication_createauthenticationcookie/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1authentication-cookie/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_47"}},"schemaId":"schema_47","pointer":"/paths/~1ocapi~1v1~1members~1authentication-cookie/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/authentication-cookie","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"multipart/form-data":{"schemaId":"schema_47"}},"responseCodes":["204","400","429"],"pointer":"/ocapi/v1/members/authentication-cookie","href":"authentication/ocapimemberauthentication_createauthenticationcookie","openApiOperationId":"OcapiMemberAuthentication_CreateAuthenticationCookie","summary":"Authenticates a member and returns an HTTP-only authentication cookie"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_47","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_47"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member authenticated cookies created."},{"code":"400","description":"The provided grant type, credentials, or refresh token are invalid."},{"code":"429","description":"Member locked. Try again later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.MemberLockedError"}},"schemaId":"components/schemas/Ocapi.V1.Errors.MemberLockedError"}],"pointer":"/paths/~1ocapi~1v1~1members~1authentication-cookie/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400"},{"code":"429","schemaId":"components/schemas/Ocapi.V1.Errors.MemberLockedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.MemberLockedError"}}}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/authentication-cookie"},{"label":"Expires the current authentication cookie","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_expireauthenticationcookie","routeSlug":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_expireauthenticationcookie","metadata":{"seo":{"title":"Expires the current authentication cookie","description":"Expires the current authentication cookie created by the CreateAuthenticationCookie or the CreateWorkstationAuthenticationCookie method."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberAuthentication_ExpireAuthenticationCookie","name":"Expires the current authentication cookie","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1authentication-cookie/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Expires the current authentication cookie","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expires the current authentication cookie created by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_createauthenticationcookie"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreateAuthenticationCookie"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/loyalty/ocapimemberauthentication_createworkstationauthenticationcookie"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreateWorkstationAuthenticationCookie"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Due to the authentication cookie being HTTP-only, clients do not have the ability to delete these themselves."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint provides a mechanism for the client to 'sign out' the current member ensuring the cookies on the client are removed."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"authentication/ocapimemberauthentication_expireauthenticationcookie/request/licenses-required","deepLinkHash":"/authentication/ocapimemberauthentication_expireauthenticationcookie#authentication/ocapimemberauthentication_expireauthenticationcookie/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1authentication-cookie/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ocapi/v1/members/authentication-cookie","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["204"],"pointer":"/ocapi/v1/members/authentication-cookie","href":"authentication/ocapimemberauthentication_expireauthenticationcookie","openApiOperationId":"OcapiMemberAuthentication_ExpireAuthenticationCookie","summary":"Expires the current authentication cookie"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Authentication cookie expired."}],"pointer":"/paths/~1ocapi~1v1~1members~1authentication-cookie/delete/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/authentication-cookie"},{"label":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_createworkstationauthenticationcookie","routeSlug":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_createworkstationauthenticationcookie","metadata":{"seo":{"title":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","description":"The HTTP Authorization header must include a Central Identity Management device token (also known as a DIM token)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberAuthentication_CreateWorkstationAuthenticationCookie","name":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1workstation-authentication-cookie/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The HTTP Authorization header must include a Central Identity Management device token (also known as a DIM token)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Providing this cookie with subsequent requests works as an alternative to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LoyaltySessionToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sign out is handled by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_expireauthenticationcookie"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ExpireAuthenticationCookie"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using cookie-based authentication, the API will automatically refresh the cookie when the access token has expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In addition to the authentication cookie, a second "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vista-loyalty-member-is-authenticated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cookie is returned that can be used by the client to detect whether the patron is authenticated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data is to be provided as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/x-www-form-urlencoded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" form parameters in the format of member workstation authentication request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlike the standard member authentication endpoints, the cookie from this endpoint does not have permission to update member details."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimemberauthentication_createworkstationauthenticationcookie/request/authentication/ocapimemberauthentication_createworkstationauthenticationcookie/request/loyalty/ocapimemberauthentication_createworkstationauthenticationcookie/request/error-response","deepLinkHash":"/members/ocapimemberauthentication_createworkstationauthenticationcookie#members/ocapimemberauthentication_createworkstationauthenticationcookie/request/authentication/ocapimemberauthentication_createworkstationauthenticationcookie/request/loyalty/ocapimemberauthentication_createworkstationauthenticationcookie/request/error-response"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Response"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LockOutPeriodInSeconds property will only be present on the response object if the response has the error code 32000."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimemberauthentication_createworkstationauthenticationcookie/request/authentication/ocapimemberauthentication_createworkstationauthenticationcookie/request/loyalty/ocapimemberauthentication_createworkstationauthenticationcookie/request/licenses-required","deepLinkHash":"/members/ocapimemberauthentication_createworkstationauthenticationcookie#members/ocapimemberauthentication_createworkstationauthenticationcookie/request/authentication/ocapimemberauthentication_createworkstationauthenticationcookie/request/loyalty/ocapimemberauthentication_createworkstationauthenticationcookie/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1workstation-authentication-cookie/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_46"}},"schemaId":"schema_46","pointer":"/paths/~1ocapi~1v1~1members~1workstation-authentication-cookie/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/workstation-authentication-cookie","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"multipart/form-data":{"schemaId":"schema_46"}},"responseCodes":["204","400","401","403","429"],"pointer":"/ocapi/v1/members/workstation-authentication-cookie","href":"authentication/ocapimemberauthentication_createworkstationauthenticationcookie","openApiOperationId":"OcapiMemberAuthentication_CreateWorkstationAuthenticationCookie","summary":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_46","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_46"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member authenticated cookies created."},{"code":"400","description":"The provided grant type, credentials, or refresh token are invalid."},{"code":"401","description":"Authentication JWT is missing."},{"code":"403","description":"This endpoint can only be used using a CIM Device Authentication token."},{"code":"429","description":"Member or device locked. Try again later."}],"pointer":"/paths/~1ocapi~1v1~1members~1workstation-authentication-cookie/post/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/workstation-authentication-cookie"}],"content":{"contentType":"group","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/members/authentication-token","summary":"Authenticates a member and creates an member authentication token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/ocapimemberauthentication_createauthenticationtoken","deprecated":false},{"title":"/ocapi/v1/members/authentication-cookie","summary":"Authenticates a member and returns an HTTP-only authentication cookie","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/ocapimemberauthentication_createauthenticationcookie","deprecated":false},{"title":"/ocapi/v1/members/authentication-cookie","summary":"Expires the current authentication cookie","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/authentication/ocapimemberauthentication_expireauthenticationcookie","deprecated":false},{"title":"/ocapi/v1/members/workstation-authentication-cookie","summary":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/ocapimemberauthentication_createworkstationauthenticationcookie","deprecated":false}]}]}]}]}},{"type":"group","label":"Members","link":"/openapi/digital-platform/openapi/members","routeSlug":"/openapi/digital-platform/openapi/members","items":[{"label":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberauthentication_createworkstationauthenticationcookie","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberauthentication_createworkstationauthenticationcookie","metadata":{"seo":{"title":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","description":"The HTTP Authorization header must include a Central Identity Management device token (also known as a DIM token)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberAuthentication_CreateWorkstationAuthenticationCookie","name":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1workstation-authentication-cookie/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The HTTP Authorization header must include a Central Identity Management device token (also known as a DIM token)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Providing this cookie with subsequent requests works as an alternative to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LoyaltySessionToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sign out is handled by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_expireauthenticationcookie"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ExpireAuthenticationCookie"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using cookie-based authentication, the API will automatically refresh the cookie when the access token has expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In addition to the authentication cookie, a second "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vista-loyalty-member-is-authenticated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cookie is returned that can be used by the client to detect whether the patron is authenticated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data is to be provided as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/x-www-form-urlencoded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" form parameters in the format of member workstation authentication request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlike the standard member authentication endpoints, the cookie from this endpoint does not have permission to update member details."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimemberauthentication_createworkstationauthenticationcookie/request/authentication/ocapimemberauthentication_createworkstationauthenticationcookie/request/loyalty/ocapimemberauthentication_createworkstationauthenticationcookie/request/error-response","deepLinkHash":"/members/ocapimemberauthentication_createworkstationauthenticationcookie#members/ocapimemberauthentication_createworkstationauthenticationcookie/request/authentication/ocapimemberauthentication_createworkstationauthenticationcookie/request/loyalty/ocapimemberauthentication_createworkstationauthenticationcookie/request/error-response"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Response"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LockOutPeriodInSeconds property will only be present on the response object if the response has the error code 32000."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimemberauthentication_createworkstationauthenticationcookie/request/authentication/ocapimemberauthentication_createworkstationauthenticationcookie/request/loyalty/ocapimemberauthentication_createworkstationauthenticationcookie/request/licenses-required","deepLinkHash":"/members/ocapimemberauthentication_createworkstationauthenticationcookie#members/ocapimemberauthentication_createworkstationauthenticationcookie/request/authentication/ocapimemberauthentication_createworkstationauthenticationcookie/request/loyalty/ocapimemberauthentication_createworkstationauthenticationcookie/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1workstation-authentication-cookie/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_46"}},"schemaId":"schema_46","pointer":"/paths/~1ocapi~1v1~1members~1workstation-authentication-cookie/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/workstation-authentication-cookie","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"multipart/form-data":{"schemaId":"schema_46"}},"responseCodes":["204","400","401","403","429"],"pointer":"/ocapi/v1/members/workstation-authentication-cookie","href":"members/ocapimemberauthentication_createworkstationauthenticationcookie","openApiOperationId":"OcapiMemberAuthentication_CreateWorkstationAuthenticationCookie","summary":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_46","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_46"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member authenticated cookies created."},{"code":"400","description":"The provided grant type, credentials, or refresh token are invalid."},{"code":"401","description":"Authentication JWT is missing."},{"code":"403","description":"This endpoint can only be used using a CIM Device Authentication token."},{"code":"429","description":"Member or device locked. Try again later."}],"pointer":"/paths/~1ocapi~1v1~1members~1workstation-authentication-cookie/post/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/workstation-authentication-cookie"},{"label":"Gets a list of active member completed order base entities for the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimembercompletedorders_getmemberactivecompletedorders","routeSlug":"/openapi/digital-platform/openapi/members/ocapimembercompletedorders_getmemberactivecompletedorders","metadata":{"seo":{"title":"Gets a list of active member completed order base entities for the currently authenticated member","description":"Active orders are defined as member completed order base entities that have not expired (see member completed order base ExpiresAt)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberCompletedOrders_GetMemberActiveCompletedOrders","name":"Gets a list of active member completed order base entities for the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1completed-orders~1active/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of active member completed order base entities for the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active orders are defined as member completed order base entities that have not expired (see member completed order base ExpiresAt)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active orders are returned in descending order based on the member completed order base CreatedAt date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint does not currently support tab order entities."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimembercompletedorders_getmemberactivecompletedorders/request/completed-orders/ocapimembercompletedorders_getmemberactivecompletedorders/request/licenses-required","deepLinkHash":"/members/ocapimembercompletedorders_getmemberactivecompletedorders#members/ocapimembercompletedorders_getmemberactivecompletedorders/request/completed-orders/ocapimembercompletedorders_getmemberactivecompletedorders/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1completed-orders~1active/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/completed-orders/active","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","401"],"pointer":"/ocapi/v1/members/current/completed-orders/active","href":"members/ocapimembercompletedorders_getmemberactivecompletedorders","openApiOperationId":"OcapiMemberCompletedOrders_GetMemberActiveCompletedOrders","summary":"Gets a list of active member completed order base entities for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderListDetails"},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1completed-orders~1active/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderListDetails"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/completed-orders/active"},{"label":"Gets a list of expired member completed order base entities for the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimembercompletedorders_getmemberexpiredcompletedorders","routeSlug":"/openapi/digital-platform/openapi/members/ocapimembercompletedorders_getmemberexpiredcompletedorders","metadata":{"seo":{"title":"Gets a list of expired member completed order base entities for the currently authenticated member","description":"Expired completed orders are member completed order base entities that have expired (see member completed order base ExpiresAt)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberCompletedOrders_GetMemberExpiredCompletedOrders","name":"Gets a list of expired member completed order base entities for the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1completed-orders~1expired/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of expired member completed order base entities for the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expired completed orders are member completed order base entities that have expired (see member completed order base ExpiresAt)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination is supported as potentially large amounts of historical data is in scope of query."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expired orders are returned in descending order based on the member completed order base CreatedAt date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint does not currently support tab order entities."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimembercompletedorders_getmemberexpiredcompletedorders/request/completed-orders/ocapimembercompletedorders_getmemberexpiredcompletedorders/request/licenses-required","deepLinkHash":"/members/ocapimembercompletedorders_getmemberexpiredcompletedorders#members/ocapimembercompletedorders_getmemberexpiredcompletedorders/request/completed-orders/ocapimembercompletedorders_getmemberexpiredcompletedorders/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_35","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of orders to return in the result set. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_36","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index of the first order to return in the result set. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]}]}]}]}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1completed-orders~1expired/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1completed-orders~1expired/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/completed-orders/expired","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_35"},{"name":"offset","in":"query","schemaId":"schema_36"}],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/ocapi/v1/members/current/completed-orders/expired","href":"members/ocapimembercompletedorders_getmemberexpiredcompletedorders","openApiOperationId":"OcapiMemberCompletedOrders_GetMemberExpiredCompletedOrders","summary":"Gets a list of expired member completed order base entities for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderPaginatedResultSet"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderPaginatedResultSet"},{"code":"400","description":"The provided limit or offset is invalid."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1completed-orders~1expired/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderPaginatedResultSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderPaginatedResultSet"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/completed-orders/expired"},{"label":"Creates a friend code for the currently authenticated Loyalty member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberfriends_createfriendcode","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberfriends_createfriendcode","metadata":{"seo":{"title":"Creates a friend code for the currently authenticated Loyalty member","description":"A friend code can be redeemed by another member to create a member friend"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberFriends_CreateFriendCode","name":"Creates a friend code for the currently authenticated Loyalty member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1friend-code/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a friend code for the currently authenticated Loyalty member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A friend code can be redeemed by another member to create a member friend"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"friends/ocapimemberfriends_createfriendcode/request/members/ocapimemberfriends_createfriendcode/request/licenses-required","deepLinkHash":"/friends/ocapimemberfriends_createfriendcode#friends/ocapimemberfriends_createfriendcode/request/members/ocapimemberfriends_createfriendcode/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Loyalty.Friends"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friend-code/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate","pointer":"/paths/~1ocapi~1v1~1members~1current~1friend-code/post/requestBody","description":"The values needed to create the member friend code"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/current/friend-code","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"}},"responseCodes":["200","400","401","429"],"pointer":"/ocapi/v1/members/current/friend-code","href":"members/ocapimemberfriends_createfriendcode","openApiOperationId":"OcapiMemberFriends_CreateFriendCode","summary":"Creates a friend code for the currently authenticated Loyalty member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCode"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCode"},{"code":"400","description":"Request property is invalid or missing, or member cannot create a friend code."},{"code":"401","description":"No member authenticated."},{"code":"429","description":"Too many requests. Try again later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}},"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friend-code/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCode","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCode"}}},{"code":"400"},{"code":"401"},{"code":"429","schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}}}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/friend-code"},{"label":"Adds a friend by creating a member friend using a friend code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberfriends_addfriendfromcode","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberfriends_addfriendfromcode","metadata":{"seo":{"title":"Adds a friend by creating a member friend using a friend code","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberFriends_AddFriendFromCode","name":"Adds a friend by creating a member friend using a friend code","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1code/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adds a friend by creating a member friend using a friend code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"friends/ocapimemberfriends_addfriendfromcode/request/members/ocapimemberfriends_addfriendfromcode/request/licenses-required","deepLinkHash":"/friends/ocapimemberfriends_addfriendfromcode#friends/ocapimemberfriends_addfriendfromcode/request/members/ocapimemberfriends_addfriendfromcode/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Loyalty.Friends"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1code/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate","pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1code/post/requestBody","description":"The values needed to create the member friend"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/current/friends/code","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"}},"responseCodes":["200","400","401","429"],"pointer":"/ocapi/v1/members/current/friends/code","href":"members/ocapimemberfriends_addfriendfromcode","openApiOperationId":"OcapiMemberFriends_AddFriendFromCode","summary":"Adds a friend by creating a member friend using a friend code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendDetails"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendDetails"},{"code":"400","description":"Request property is invalid or missing, or member cannot add friend."},{"code":"401","description":"No member authenticated."},{"code":"429","description":"Too many requests. Try again later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}},"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1code/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendDetails"}}},{"code":"400"},{"code":"401"},{"code":"429","schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}}}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/friends/code"},{"label":"Removes a friend by deleting a member friend","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberfriends_removefriend","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberfriends_removefriend","metadata":{"seo":{"title":"Removes a friend by deleting a member friend","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberFriends_RemoveFriend","name":"Removes a friend by deleting a member friend","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removes a friend by deleting a member friend","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"friends/ocapimemberfriends_removefriend/request/members/ocapimemberfriends_removefriend/request/licenses-required","deepLinkHash":"/friends/ocapimemberfriends_removefriend#friends/ocapimemberfriends_removefriend/request/members/ocapimemberfriends_removefriend/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Loyalty.Friends"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_48","required":true}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ocapi/v1/members/current/friends/{id}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["204","401"],"pointer":"/ocapi/v1/members/current/friends/{id}","href":"members/ocapimemberfriends_removefriend","openApiOperationId":"OcapiMemberFriends_RemoveFriend","summary":"Removes a friend by deleting a member friend"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Friend removed."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1{id}/delete/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/friends/{id}"},{"label":"Sets the subscription sharing details of a member friend","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberfriends_setsubscriptionsharing","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberfriends_setsubscriptionsharing","metadata":{"seo":{"title":"Sets the subscription sharing details of a member friend","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberFriends_SetSubscriptionSharing","name":"Sets the subscription sharing details of a member friend","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1{id}~1subscription-sharing/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sets the subscription sharing details of a member friend","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"friends/ocapimemberfriends_setsubscriptionsharing/request/members/ocapimemberfriends_setsubscriptionsharing/request/licenses-required","deepLinkHash":"/friends/ocapimemberfriends_setsubscriptionsharing#friends/ocapimemberfriends_setsubscriptionsharing/request/members/ocapimemberfriends_setsubscriptionsharing/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Loyalty.Friends"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_48","required":true}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1{id}~1subscription-sharing/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1{id}~1subscription-sharing/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate","pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1{id}~1subscription-sharing/put/requestBody","description":"The values needed to update the subscription sharing details of a member friend"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/members/current/friends/{id}/subscription-sharing","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"}},"responseCodes":["204","400","401","404"],"pointer":"/ocapi/v1/members/current/friends/{id}/subscription-sharing","href":"members/ocapimemberfriends_setsubscriptionsharing","openApiOperationId":"OcapiMemberFriends_SetSubscriptionSharing","summary":"Sets the subscription sharing details of a member friend"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Friend subscription sharing updated."},{"code":"400","description":"Request property is invalid or missing, or member cannot share subscription."},{"code":"401","description":"No member authenticated."},{"code":"404","description":"Friend does not exist."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1{id}~1subscription-sharing/put/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/friends/{id}/subscription-sharing"},{"label":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberorders_getmembertabordersforsite","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberorders_getmembertabordersforsite","metadata":{"seo":{"title":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberOrders_GetMemberTabOrdersForSite","name":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1orders~1tab~1by-site~1{siteId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tabs/ocapimemberorders_getmembertabordersforsite/request/members/ocapimemberorders_getmembertabordersforsite/request/orders/ocapimemberorders_getmembertabordersforsite/request/licenses-required","deepLinkHash":"/tabs/ocapimemberorders_getmembertabordersforsite#tabs/ocapimemberorders_getmembertabordersforsite/request/members/ocapimemberorders_getmembertabordersforsite/request/orders/ocapimemberorders_getmembertabordersforsite/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.ChecksAPI"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","required":true}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1orders~1tab~1by-site~1{siteId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1orders~1tab~1by-site~1{siteId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/orders/tab/by-site/{siteId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","401","404"],"pointer":"/ocapi/v1/members/current/orders/tab/by-site/{siteId}","href":"members/ocapimemberorders_getmembertabordersforsite","openApiOperationId":"OcapiMemberOrders_GetMemberTabOrdersForSite","summary":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderListDetailsGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressTabOrder"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderListDetailsGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressTabOrder"},{"code":"401","description":"No member authenticated."},{"code":"404","description":"Site does not exist."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1orders~1tab~1by-site~1{siteId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderListDetailsGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressTabOrder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderListDetailsGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressTabOrder"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/orders/tab/by-site/{siteId}"},{"label":"Gets the list of member reward entities for the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberrewards_getmemberrewards","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberrewards_getmemberrewards","metadata":{"seo":{"title":"Gets the list of member reward entities for the currently authenticated member","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberRewards_GetMemberRewards","name":"Gets the list of member reward entities for the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1rewards/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the list of member reward entities for the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"member-rewards/ocapimemberrewards_getmemberrewards/request/members/ocapimemberrewards_getmemberrewards/request/licenses-required","deepLinkHash":"/member-rewards/ocapimemberrewards_getmemberrewards#member-rewards/ocapimemberrewards_getmemberrewards/request/members/ocapimemberrewards_getmemberrewards/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1rewards/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/rewards","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","401"],"pointer":"/ocapi/v1/members/current/rewards","href":"members/ocapimemberrewards_getmemberrewards","openApiOperationId":"OcapiMemberRewards_GetMemberRewards","summary":"Gets the list of member reward entities for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.MemberRewardListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.MemberRewardListDetails"},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1rewards/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.MemberRewardListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.MemberRewardListDetails"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/rewards"},{"label":"Gets the list of member reward availability entities for the currently authenticated\r\nmember and a particular showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime","metadata":{"seo":{"title":"Gets the list of member reward availability entities for the currently authenticated\r\nmember and a particular showtime","description":"member reward availability entities are returned only for reward entities wherereward Restrictions includes reward restriction MemberRewardAvailability"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberRewards_GetMemberRewardAvailabilitiesForShowtime","name":"Gets the list of member reward availability entities for the currently authenticated\r\nmember and a particular showtime","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1reward-availability~1by-showtime~1{showtimeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the list of member reward availability entities for the currently authenticated\r\nmember and a particular showtime","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"member reward availability entities are returned only for reward entities where"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reward Restrictions includes reward restriction MemberRewardAvailability"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of member reward availability entities returned are subject to a configured limit."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If exceeded, the member reward availability entities returned are automatically truncated to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the configured limit."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"member-rewards/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime/request/members/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime/request/licenses-required","deepLinkHash":"/member-rewards/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime#member-rewards/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime/request/members/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"showtimeId","in":"path","schemaId":"schema_33","description":"The unique identifier of the showtime","required":true}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1reward-availability~1by-showtime~1{showtimeId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rewardIds","in":"query","schemaId":"schema_49","description":"Optional. The unique identifier of the reward entities to get member availabilty for"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1reward-availability~1by-showtime~1{showtimeId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1reward-availability~1by-showtime~1{showtimeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/reward-availability/by-showtime/{showtimeId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"showtimeId","in":"path","required":true,"schemaId":"schema_33"}],"query":[{"name":"rewardIds","in":"query","schemaId":"schema_49"}],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","401"],"pointer":"/ocapi/v1/members/current/reward-availability/by-showtime/{showtimeId}","href":"members/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime","openApiOperationId":"OcapiMemberRewards_GetMemberRewardAvailabilitiesForShowtime","summary":"Gets the list of member reward availability entities for the currently authenticated\r\nmember and a particular showtime"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.Availability.MemberRewardAvailabilityListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.Availability.MemberRewardAvailabilityListDetails"},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1reward-availability~1by-showtime~1{showtimeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.Availability.MemberRewardAvailabilityListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.Availability.MemberRewardAvailabilityListDetails"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/reward-availability/by-showtime/{showtimeId}"},{"label":"Gets the details of the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimembers_getcurrentmember","routeSlug":"/openapi/digital-platform/openapi/members/ocapimembers_getcurrentmember","metadata":{"seo":{"title":"Gets the details of the currently authenticated member","description":"The member is always reloaded directly from Loyalty with no caching."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMembers_GetCurrentMember","name":"Gets the details of the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the details of the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The member is always reloaded directly from Loyalty with no caching."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimembers_getcurrentmember/request/licenses-required","deepLinkHash":"/members/ocapimembers_getcurrentmember#members/ocapimembers_getcurrentmember/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","401"],"pointer":"/ocapi/v1/members/current","href":"members/ocapimembers_getcurrentmember","openApiOperationId":"OcapiMembers_GetCurrentMember","summary":"Gets the details of the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.MemberDetails"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.MemberDetails"},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.MemberDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.MemberDetails"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current"},{"label":"Deletes the currently authenticated member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimembers_deletecurrentmember","routeSlug":"/openapi/digital-platform/openapi/members/ocapimembers_deletecurrentmember","metadata":{"seo":{"title":"Deletes the currently authenticated member","description":"The member can no longer be authenticated after this endpoint has been successfully called."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMembers_DeleteCurrentMember","name":"Deletes the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The member can no longer be authenticated after this endpoint has been successfully called."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The member is also marked to be deleted by Vista Loyalty in a configured scheduled task."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The member is completely cleared after 24 hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimembers_deletecurrentmember/request/licenses-required","deepLinkHash":"/members/ocapimembers_deletecurrentmember#members/ocapimembers_deletecurrentmember/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_50"},"text/json":{"schemaId":"schema_50"},"application/*+json":{"schemaId":"schema_50"},"application/json-patch+json":{"schemaId":"schema_50"}},"schemaId":"schema_50","pointer":"/paths/~1ocapi~1v1~1members~1current/delete/requestBody","description":"Details required to delete the member"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ocapi/v1/members/current","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_50"},"text/json":{"schemaId":"schema_50"},"application/*+json":{"schemaId":"schema_50"},"application/json-patch+json":{"schemaId":"schema_50"}},"responseCodes":["204","400","401"],"pointer":"/ocapi/v1/members/current","href":"members/ocapimembers_deletecurrentmember","openApiOperationId":"OcapiMembers_DeleteCurrentMember","summary":"Deletes the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_50","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_50"},"text/json":{"schemaId":"schema_50"},"application/*+json":{"schemaId":"schema_50"},"application/json-patch+json":{"schemaId":"schema_50"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member deleted."},{"code":"400","description":"Request property is invalid or missing, password validation failed, or member cannot be deleted."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current/delete/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current"},{"label":"Creates a member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimembers_createmember","routeSlug":"/openapi/digital-platform/openapi/members/ocapimembers_createmember","metadata":{"seo":{"title":"Creates a member","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMembers_CreateMember","name":"Creates a member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimembers_createmember/request/licenses-required","deepLinkHash":"/members/ocapimembers_createmember#members/ocapimembers_createmember/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Create.MemberCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Create.MemberCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Create.MemberCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Create.MemberCreate"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Create.MemberCreate","pointer":"/paths/~1ocapi~1v1~1members/post/requestBody","description":"Member to create"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Create.MemberCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Create.MemberCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Create.MemberCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Create.MemberCreate"}},"responseCodes":["200","400"],"pointer":"/ocapi/v1/members","href":"members/ocapimembers_createmember","openApiOperationId":"OcapiMembers_CreateMember","summary":"Creates a member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Create.MemberCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Create.MemberCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Create.MemberCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Create.MemberCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Create.MemberCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Create.CreatedMemberDetails"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Create.CreatedMemberDetails"},{"code":"400","description":"Request property is invalid or missing."}],"pointer":"/paths/~1ocapi~1v1~1members/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Create.CreatedMemberDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Create.CreatedMemberDetails"}}},{"code":"400"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members"},{"label":"Gets a list of member transaction entities for the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimembers_getmembertransactions","routeSlug":"/openapi/digital-platform/openapi/members/ocapimembers_getmembertransactions","metadata":{"seo":{"title":"Gets a list of member transaction entities for the currently authenticated member","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMembers_GetMemberTransactions","name":"Gets a list of member transaction entities for the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of member transaction entities for the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimembers_getmembertransactions/request/licenses-required","deepLinkHash":"/members/ocapimembers_getmembertransactions#members/ocapimembers_getmembertransactions/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_51","description":"The maximum number of transactions to return in the result set"},{"name":"offset","in":"query","schemaId":"schema_52","description":"The index of the first transaction to return in the result set"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1transactions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/transactions","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_51"},{"name":"offset","in":"query","schemaId":"schema_52"}],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/ocapi/v1/members/current/transactions","href":"members/ocapimembers_getmembertransactions","openApiOperationId":"OcapiMembers_GetMemberTransactions","summary":"Gets a list of member transaction entities for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionPaginatedResultSet"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionPaginatedResultSet"},{"code":"400","description":"The provided limit or offset is invalid."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionPaginatedResultSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionPaginatedResultSet"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/transactions"},{"label":"Updates the member personal details of the currently authenticated member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberupdate_setmemberpersonaldetails","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberupdate_setmemberpersonaldetails","metadata":{"seo":{"title":"Updates the member personal details of the currently authenticated member","description":"Full personalDetails object from GetMember containing updated values must be sent to this endpoint.If field is not provided then it's considered that it must be cleared."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberUpdate_SetMemberPersonalDetails","name":"Updates the member personal details of the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1personal-details/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates the member personal details of the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full personalDetails object from GetMember containing updated values must be sent to this endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If field is not provided then it's considered that it must be cleared."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: currently Vista Loyalty doesn't support clearing fields. Also enum fields don't support setting value 0 where it is equivalent of clearing field (e.g. NotSpecified)"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimemberupdate_setmemberpersonaldetails/request/licenses-required","deepLinkHash":"/members/ocapimemberupdate_setmemberpersonaldetails#members/ocapimemberupdate_setmemberpersonaldetails/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1personal-details/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberPersonalDetails"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberPersonalDetails"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberPersonalDetails"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberPersonalDetails"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberPersonalDetails","pointer":"/paths/~1ocapi~1v1~1members~1current~1personal-details/put/requestBody","description":"Member personal details to update"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/members/current/personal-details","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberPersonalDetails"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberPersonalDetails"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberPersonalDetails"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberPersonalDetails"}},"responseCodes":["204","400","401"],"pointer":"/ocapi/v1/members/current/personal-details","href":"members/ocapimemberupdate_setmemberpersonaldetails","openApiOperationId":"OcapiMemberUpdate_SetMemberPersonalDetails","summary":"Updates the member personal details of the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberPersonalDetails","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberPersonalDetails"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberPersonalDetails"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberPersonalDetails"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberPersonalDetails"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member personal details updated."},{"code":"400","description":"Request property is invalid or missing."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1personal-details/put/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/personal-details"},{"label":"Updates the member photo of the currently authenticated member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberupdate_setmemberphoto","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberupdate_setmemberphoto","metadata":{"seo":{"title":"Updates the member photo of the currently authenticated member","description":"The photo is uploaded via a form-data key/value pair with type file and the key being \"MemberPhoto\"."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberUpdate_SetMemberPhoto","name":"Updates the member photo of the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1photo/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates the member photo of the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The photo is uploaded via a form-data key/value pair with type file and the key being \"MemberPhoto\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Photo file should be uploaded using the HTTP request body type form-data set to File,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with a Key of MemberPhoto and Value of the photo file to be uploaded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported photo file formats are: JPEG, BMP, PNG, HEIC, WebP."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File size limit and photo dimensions are configured in Loyalty."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file size limit specifies and upper-bound on file size, while photo dimensions are an exact requirement."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An HTTP Bad Request is returned in the following cases:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No Loyalty member is currently logged in."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No photo is uploaded."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Based on Loyalty configuration, the Loyalty member isn't eligible to update their photo"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The photo file size is too large."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The photo dimensions don't match the dimensions configured in Loyalty."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The photo format isn't accepted."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An HTTP Bad Gateway is returned if the connection to Loyalty times out."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimemberupdate_setmemberphoto/request/licenses-required","deepLinkHash":"/members/ocapimemberupdate_setmemberphoto#members/ocapimemberupdate_setmemberphoto/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Loyalty.MemberPhotos"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1photo/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_53"}},"schemaId":"schema_53","pointer":"/paths/~1ocapi~1v1~1members~1current~1photo/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/members/current/photo","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"multipart/form-data":{"schemaId":"schema_53"}},"responseCodes":["200","400","401"],"pointer":"/ocapi/v1/members/current/photo","href":"members/ocapimemberupdate_setmemberphoto","openApiOperationId":"OcapiMemberUpdate_SetMemberPhoto","summary":"Updates the member photo of the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_53","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_53"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Photos.CreatedMemberPhoto"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Photos.CreatedMemberPhoto"},{"code":"400","description":"Provided photo does not meet configured requirements."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1photo/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Photos.CreatedMemberPhoto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Photos.CreatedMemberPhoto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/photo"},{"label":"Updates the push notification token of the currently authenticated member allowing\r\ntheir mobile device to receive push notifications","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberupdate_setmemberpushnotificationtoken","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberupdate_setmemberpushnotificationtoken","metadata":{"seo":{"title":"Updates the push notification token of the currently authenticated member allowing\r\ntheir mobile device to receive push notifications","description":"Only one push notification token can be saved on a member entity. Updating the push notification tokenfrom a different mobile device will prevent the previous mobile device from receiving push notifications."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberUpdate_SetMemberPushNotificationToken","name":"Updates the push notification token of the currently authenticated member allowing\r\ntheir mobile device to receive push notifications","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1push-notification-token/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates the push notification token of the currently authenticated member allowing\r\ntheir mobile device to receive push notifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only one push notification token can be saved on a member entity. Updating the push notification token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from a different mobile device will prevent the previous mobile device from receiving push notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No validation will be done to determine if the provided push notification token is usable."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimemberupdate_setmemberpushnotificationtoken/request/loyalty/ocapimemberupdate_setmemberpushnotificationtoken/request/licenses-required","deepLinkHash":"/members/ocapimemberupdate_setmemberpushnotificationtoken#members/ocapimemberupdate_setmemberpushnotificationtoken/request/loyalty/ocapimemberupdate_setmemberpushnotificationtoken/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1push-notification-token/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"}},"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken","pointer":"/paths/~1ocapi~1v1~1members~1current~1push-notification-token/put/requestBody","description":"Push notification token details"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/members/current/push-notification-token","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"}},"responseCodes":["204","400","401"],"pointer":"/ocapi/v1/members/current/push-notification-token","href":"members/ocapimemberupdate_setmemberpushnotificationtoken","openApiOperationId":"OcapiMemberUpdate_SetMemberPushNotificationToken","summary":"Updates the push notification token of the currently authenticated member allowing\r\ntheir mobile device to receive push notifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.PushNotificationToken"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member push notification token updated."},{"code":"400","description":"Request property is invalid or missing."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1push-notification-token/put/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/push-notification-token"},{"label":"Removes the push notification token of the currently authenticated member\r\npreventing push notification from being received on their mobile device","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberupdate_removememberpushnotificationtoken","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberupdate_removememberpushnotificationtoken","metadata":{"seo":{"title":"Removes the push notification token of the currently authenticated member\r\npreventing push notification from being received on their mobile device","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberUpdate_RemoveMemberPushNotificationToken","name":"Removes the push notification token of the currently authenticated member\r\npreventing push notification from being received on their mobile device","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1push-notification-token/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removes the push notification token of the currently authenticated member\r\npreventing push notification from being received on their mobile device","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimemberupdate_removememberpushnotificationtoken/request/loyalty/ocapimemberupdate_removememberpushnotificationtoken/request/licenses-required","deepLinkHash":"/members/ocapimemberupdate_removememberpushnotificationtoken#members/ocapimemberupdate_removememberpushnotificationtoken/request/loyalty/ocapimemberupdate_removememberpushnotificationtoken/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1push-notification-token/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ocapi/v1/members/current/push-notification-token","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["204","401"],"pointer":"/ocapi/v1/members/current/push-notification-token","href":"members/ocapimemberupdate_removememberpushnotificationtoken","openApiOperationId":"OcapiMemberUpdate_RemoveMemberPushNotificationToken","summary":"Removes the push notification token of the currently authenticated member\r\npreventing push notification from being received on their mobile device"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member push notification token removed."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1push-notification-token/delete/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/push-notification-token"},{"label":"Validates whether an email is available for a new member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimembervalidateemail_validateemailavailability","routeSlug":"/openapi/digital-platform/openapi/members/ocapimembervalidateemail_validateemailavailability","metadata":{"seo":{"title":"Validates whether an email is available for a new member","description":"This endpoint validates email correctly only if the ForceUniqueEmails system setting in Loyalty is set to true."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberValidateEmail_ValidateEmailAvailability","name":"Validates whether an email is available for a new member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1email-availability/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validates whether an email is available for a new member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint validates email correctly only if the ForceUniqueEmails system setting in Loyalty is set to true."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimembervalidateemail_validateemailavailability/request/licenses-required","deepLinkHash":"/members/ocapimembervalidateemail_validateemailavailability#members/ocapimembervalidateemail_validateemailavailability/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1email-availability/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailabilityValidation"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailabilityValidation"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailabilityValidation"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailabilityValidation"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailabilityValidation","pointer":"/paths/~1ocapi~1v1~1members~1email-availability/post/requestBody","description":"Details to validate email availability"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/email-availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailabilityValidation"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailabilityValidation"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailabilityValidation"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailabilityValidation"}},"responseCodes":["200","400"],"pointer":"/ocapi/v1/members/email-availability","href":"members/ocapimembervalidateemail_validateemailavailability","openApiOperationId":"OcapiMemberValidateEmail_ValidateEmailAvailability","summary":"Validates whether an email is available for a new member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailabilityValidation","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailabilityValidation"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailabilityValidation"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailabilityValidation"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailabilityValidation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailability"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailability"},{"code":"400","description":"Request property is invalid or missing."}],"pointer":"/paths/~1ocapi~1v1~1members~1email-availability/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailability","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailability"}}},{"code":"400"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/email-availability"},{"label":"Assigns an in progress tab order to the currently authenticated member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapiordermember_setordermember","routeSlug":"/openapi/digital-platform/openapi/members/ocapiordermember_setordermember","metadata":{"seo":{"title":"Assigns an in progress tab order to the currently authenticated member","description":"This endpoint is not available for in progress standard order,in progress gift shop order or in progress subscription order entities, as theauthenticated member is automatically set when the order is created or modified."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderMember_SetOrderMember","name":"Assigns an in progress tab order to the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1member~1current/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assigns an in progress tab order to the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is not available for in progress standard order,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in progress gift shop order or in progress subscription order entities, as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authenticated member is automatically set when the order is created or modified."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapiordermember_setordermember/request/orders/ocapiordermember_setordermember/request/licenses-required","deepLinkHash":"/members/ocapiordermember_setordermember#members/ocapiordermember_setordermember/request/orders/ocapiordermember_setordermember/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress tab order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1member~1current/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1member~1current/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/orders/{orderId}/member/current","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["204","400","401","404","409"],"pointer":"/ocapi/v1/orders/{orderId}/member/current","href":"members/ocapiordermember_setordermember","openApiOperationId":"OcapiOrderMember_SetOrderMember","summary":"Assigns an in progress tab order to the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Order member updated."},{"code":"400","description":"Invalid order type."},{"code":"401","description":"No member authenticated."},{"code":"404","description":"Order does not exist."},{"code":"409","description":"Order has already been assigned to another member."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1member~1current/put/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/orders/{orderId}/member/current"},{"label":"Gets the order maximum member balance payment for an in progress order base","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapiorderpayments_getmaximummemberbalancepayment","routeSlug":"/openapi/digital-platform/openapi/members/ocapiorderpayments_getmaximummemberbalancepayment","metadata":{"seo":{"title":"Gets the order maximum member balance payment for an in progress order base","description":"The currently authenticated member must have a member card and a supported balance type in order to make a member balance payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderPayments_GetMaximumMemberBalancePayment","name":"Gets the order maximum member balance payment for an in progress order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1maximum-member-balance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the order maximum member balance payment for an in progress order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currently authenticated member must have a member card and a supported balance type in order to make a member balance payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapiorderpayments_getmaximummemberbalancepayment/request/licenses-required","deepLinkHash":"/members/ocapiorderpayments_getmaximummemberbalancepayment#members/ocapiorderpayments_getmaximummemberbalancepayment/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base that the payment is for","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1maximum-member-balance/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1maximum-member-balance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/{orderId}/payments/maximum-member-balance","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","204","401","404"],"pointer":"/ocapi/v1/orders/{orderId}/payments/maximum-member-balance","href":"members/ocapiorderpayments_getmaximummemberbalancepayment","openApiOperationId":"OcapiOrderPayments_GetMaximumMemberBalancePayment","summary":"Gets the order maximum member balance payment for an in progress order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.Maximum.OrderMaximumMemberBalancePaymentDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.Maximum.OrderMaximumMemberBalancePaymentDetails"},{"code":"204","description":"Member has no card, or does not have a supported balance type."},{"code":"401","description":"No member signed in."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1maximum-member-balance/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.Maximum.OrderMaximumMemberBalancePaymentDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.Maximum.OrderMaximumMemberBalancePaymentDetails"}}},{"code":"204"},{"code":"401"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/payments/maximum-member-balance"},{"label":"Sets the order member balance payment for an in progress order base","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapiorderpayments_setmemberbalancepayment","routeSlug":"/openapi/digital-platform/openapi/members/ocapiorderpayments_setmemberbalancepayment","metadata":{"seo":{"title":"Sets the order member balance payment for an in progress order base","description":"The currently authenticated member must have a member card and a supported balance type in order to make a member balance payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderPayments_SetMemberBalancePayment","name":"Sets the order member balance payment for an in progress order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1member-balance/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sets the order member balance payment for an in progress order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currently authenticated member must have a member card and a supported balance type in order to make a member balance payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapiorderpayments_setmemberbalancepayment/request/licenses-required","deepLinkHash":"/members/ocapiorderpayments_setmemberbalancepayment#members/ocapiorderpayments_setmemberbalancepayment/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base that the payment is for","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1member-balance/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1member-balance/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePaymentUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePaymentUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePaymentUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePaymentUpdate"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePaymentUpdate","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1member-balance/put/requestBody","description":"The member balance payment request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/orders/{orderId}/payments/member-balance","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePaymentUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePaymentUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePaymentUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePaymentUpdate"}},"responseCodes":["200","400","401"],"pointer":"/ocapi/v1/orders/{orderId}/payments/member-balance","href":"members/ocapiorderpayments_setmemberbalancepayment","openApiOperationId":"OcapiOrderPayments_SetMemberBalancePayment","summary":"Sets the order member balance payment for an in progress order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePaymentUpdate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePaymentUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePaymentUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePaymentUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePaymentUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePayment"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePayment"},{"code":"400","description":"Member has no card, or a non-positive value was specified."},{"code":"401","description":"No member signed in."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1member-balance/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePayment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePayment"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/payments/member-balance"},{"label":"Gets a list of current journey entities for the currently authenticated member","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberjourneys_getcurrentjourneysformember","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberjourneys_getcurrentjourneysformember","metadata":{"seo":{"title":"Gets a list of current journey entities for the currently authenticated member","description":"Current journeys are defined as journeys that:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberJourneys_GetCurrentJourneysForMember","name":"Gets a list of current journey entities for the currently authenticated member","deprecated":true,"isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1journeys~1current/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of current journey entities for the currently authenticated member","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current journeys are defined as journeys that:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either contain a showtime that has yet to finish or no showtimes and uncollected items."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Have not been fully refunded."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order is by showtime date or date of order (if no showtime present) with earliest first."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimemberjourneys_getcurrentjourneysformember/request/licenses-required","deepLinkHash":"/members/ocapimemberjourneys_getcurrentjourneysformember#members/ocapimemberjourneys_getcurrentjourneysformember/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1journeys~1current/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/journeys/current","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","401"],"pointer":"/ocapi/v1/members/current/journeys/current","href":"members/ocapimemberjourneys_getcurrentjourneysformember","openApiOperationId":"OcapiMemberJourneys_GetCurrentJourneysForMember","summary":"Gets a list of current journey entities for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Journey.JourneyListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Journey.JourneyListDetails"},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1journeys~1current/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Journey.JourneyListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Journey.JourneyListDetails"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/journeys/current"},{"label":"Gets a list of past journey entities for the currently authenticated member","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberjourneys_getpastjourneysformember","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberjourneys_getpastjourneysformember","metadata":{"seo":{"title":"Gets a list of past journey entities for the currently authenticated member","description":"Past journeys are journeys that are not considered current (see GetCurrentJourneysForMember)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberJourneys_GetPastJourneysForMember","name":"Gets a list of past journey entities for the currently authenticated member","deprecated":true,"isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1journeys~1past/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of past journey entities for the currently authenticated member","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Past journeys are journeys that are not considered current (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/members/ocapimemberjourneys_getcurrentjourneysformember"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GetCurrentJourneysForMember"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination is supported as potentially large amounts of historical data is in scope of query."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order is by showtime date or date of order (if no showtime present) with earliest first."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"members/ocapimemberjourneys_getpastjourneysformember/request/licenses-required","deepLinkHash":"/members/ocapimemberjourneys_getpastjourneysformember#members/ocapimemberjourneys_getpastjourneysformember/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_54","description":"The maximum number of journeys to return in the result set"},{"name":"offset","in":"query","schemaId":"schema_52","description":"The index of the first journey to return in the result set"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1journeys~1past/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1journeys~1past/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/journeys/past","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_54"},{"name":"offset","in":"query","schemaId":"schema_52"}],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/ocapi/v1/members/current/journeys/past","href":"members/ocapimemberjourneys_getpastjourneysformember","openApiOperationId":"OcapiMemberJourneys_GetPastJourneysForMember","summary":"Gets a list of past journey entities for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Journey.JourneyPaginatedResultSet"}},"schemaId":"components/schemas/Ocapi.V1.Journey.JourneyPaginatedResultSet"},{"code":"400","description":"The provided limit or offset is invalid."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1journeys~1past/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Journey.JourneyPaginatedResultSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Journey.JourneyPaginatedResultSet"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/journeys/past"}],"content":{"contentType":"group","meta":{"name":"Members"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Members","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/members/workstation-authentication-cookie","summary":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","prefix":{"name":"post","color":"post"},"badges":[],"link":"/members/ocapimemberauthentication_createworkstationauthenticationcookie","deprecated":false},{"title":"/ocapi/v1/members/current/completed-orders/active","summary":"Gets a list of active member completed order base entities for the currently authenticated member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/members/ocapimembercompletedorders_getmemberactivecompletedorders","deprecated":false},{"title":"/ocapi/v1/members/current/completed-orders/expired","summary":"Gets a list of expired member completed order base entities for the currently authenticated member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/members/ocapimembercompletedorders_getmemberexpiredcompletedorders","deprecated":false},{"title":"/ocapi/v1/members/current/friend-code","summary":"Creates a friend code for the currently authenticated Loyalty member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/members/ocapimemberfriends_createfriendcode","deprecated":false},{"title":"/ocapi/v1/members/current/friends/code","summary":"Adds a friend by creating a member friend using a friend code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/members/ocapimemberfriends_addfriendfromcode","deprecated":false},{"title":"/ocapi/v1/members/current/friends/{id}","summary":"Removes a friend by deleting a member friend","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/members/ocapimemberfriends_removefriend","deprecated":false},{"title":"/ocapi/v1/members/current/friends/{id}/subscription-sharing","summary":"Sets the subscription sharing details of a member friend","prefix":{"name":"put","color":"put"},"badges":[],"link":"/members/ocapimemberfriends_setsubscriptionsharing","deprecated":false},{"title":"/ocapi/v1/members/current/orders/tab/by-site/{siteId}","summary":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/members/ocapimemberorders_getmembertabordersforsite","deprecated":false},{"title":"/ocapi/v1/members/current/rewards","summary":"Gets the list of member reward entities for the currently authenticated member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/members/ocapimemberrewards_getmemberrewards","deprecated":false},{"title":"/ocapi/v1/members/current/reward-availability/by-showtime/{showtimeId}","summary":"Gets the list of member reward availability entities for the currently authenticated\r\nmember and a particular showtime","prefix":{"name":"get","color":"get"},"badges":[],"link":"/members/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime","deprecated":false},{"title":"/ocapi/v1/members/current","summary":"Gets the details of the currently authenticated member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/members/ocapimembers_getcurrentmember","deprecated":false},{"title":"/ocapi/v1/members/current","summary":"Deletes the currently authenticated member","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/members/ocapimembers_deletecurrentmember","deprecated":false},{"title":"/ocapi/v1/members","summary":"Creates a member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/members/ocapimembers_createmember","deprecated":false},{"title":"/ocapi/v1/members/current/transactions","summary":"Gets a list of member transaction entities for the currently authenticated member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/members/ocapimembers_getmembertransactions","deprecated":false},{"title":"/ocapi/v1/members/current/personal-details","summary":"Updates the member personal details of the currently authenticated member","prefix":{"name":"put","color":"put"},"badges":[],"link":"/members/ocapimemberupdate_setmemberpersonaldetails","deprecated":false},{"title":"/ocapi/v1/members/current/photo","summary":"Updates the member photo of the currently authenticated member","prefix":{"name":"put","color":"put"},"badges":[],"link":"/members/ocapimemberupdate_setmemberphoto","deprecated":false},{"title":"/ocapi/v1/members/current/push-notification-token","summary":"Updates the push notification token of the currently authenticated member allowing\r\ntheir mobile device to receive push notifications","prefix":{"name":"put","color":"put"},"badges":[],"link":"/members/ocapimemberupdate_setmemberpushnotificationtoken","deprecated":false},{"title":"/ocapi/v1/members/current/push-notification-token","summary":"Removes the push notification token of the currently authenticated member\r\npreventing push notification from being received on their mobile device","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/members/ocapimemberupdate_removememberpushnotificationtoken","deprecated":false},{"title":"/ocapi/v1/members/email-availability","summary":"Validates whether an email is available for a new member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/members/ocapimembervalidateemail_validateemailavailability","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/member/current","summary":"Assigns an in progress tab order to the currently authenticated member","prefix":{"name":"put","color":"put"},"badges":[],"link":"/members/ocapiordermember_setordermember","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/payments/maximum-member-balance","summary":"Gets the order maximum member balance payment for an in progress order base","prefix":{"name":"get","color":"get"},"badges":[],"link":"/members/ocapiorderpayments_getmaximummemberbalancepayment","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/payments/member-balance","summary":"Sets the order member balance payment for an in progress order base","prefix":{"name":"put","color":"put"},"badges":[],"link":"/members/ocapiorderpayments_setmemberbalancepayment","deprecated":false},{"title":"/ocapi/v1/members/current/journeys/current","summary":"Gets a list of current journey entities for the currently authenticated member","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/members/ocapimemberjourneys_getcurrentjourneysformember","deprecated":true},{"title":"/ocapi/v1/members/current/journeys/past","summary":"Gets a list of past journey entities for the currently authenticated member","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/members/ocapimemberjourneys_getpastjourneysformember","deprecated":true}]}]}]}]}},{"type":"group","label":"Friends","link":"/openapi/digital-platform/openapi/friends","routeSlug":"/openapi/digital-platform/openapi/friends","items":[{"label":"Creates a friend code for the currently authenticated Loyalty member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/friends/ocapimemberfriends_createfriendcode","routeSlug":"/openapi/digital-platform/openapi/friends/ocapimemberfriends_createfriendcode","metadata":{"seo":{"title":"Creates a friend code for the currently authenticated Loyalty member","description":"A friend code can be redeemed by another member to create a member friend"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberFriends_CreateFriendCode","name":"Creates a friend code for the currently authenticated Loyalty member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1friend-code/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a friend code for the currently authenticated Loyalty member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A friend code can be redeemed by another member to create a member friend"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"friends/ocapimemberfriends_createfriendcode/request/members/ocapimemberfriends_createfriendcode/request/licenses-required","deepLinkHash":"/friends/ocapimemberfriends_createfriendcode#friends/ocapimemberfriends_createfriendcode/request/members/ocapimemberfriends_createfriendcode/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Loyalty.Friends"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friend-code/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate","pointer":"/paths/~1ocapi~1v1~1members~1current~1friend-code/post/requestBody","description":"The values needed to create the member friend code"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/current/friend-code","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"}},"responseCodes":["200","400","401","429"],"pointer":"/ocapi/v1/members/current/friend-code","href":"friends/ocapimemberfriends_createfriendcode","openApiOperationId":"OcapiMemberFriends_CreateFriendCode","summary":"Creates a friend code for the currently authenticated Loyalty member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCode"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCode"},{"code":"400","description":"Request property is invalid or missing, or member cannot create a friend code."},{"code":"401","description":"No member authenticated."},{"code":"429","description":"Too many requests. Try again later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}},"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friend-code/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCode","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCode"}}},{"code":"400"},{"code":"401"},{"code":"429","schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}}}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/friend-code"},{"label":"Adds a friend by creating a member friend using a friend code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/friends/ocapimemberfriends_addfriendfromcode","routeSlug":"/openapi/digital-platform/openapi/friends/ocapimemberfriends_addfriendfromcode","metadata":{"seo":{"title":"Adds a friend by creating a member friend using a friend code","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberFriends_AddFriendFromCode","name":"Adds a friend by creating a member friend using a friend code","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1code/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adds a friend by creating a member friend using a friend code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"friends/ocapimemberfriends_addfriendfromcode/request/members/ocapimemberfriends_addfriendfromcode/request/licenses-required","deepLinkHash":"/friends/ocapimemberfriends_addfriendfromcode#friends/ocapimemberfriends_addfriendfromcode/request/members/ocapimemberfriends_addfriendfromcode/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Loyalty.Friends"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1code/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate","pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1code/post/requestBody","description":"The values needed to create the member friend"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/current/friends/code","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"}},"responseCodes":["200","400","401","429"],"pointer":"/ocapi/v1/members/current/friends/code","href":"friends/ocapimemberfriends_addfriendfromcode","openApiOperationId":"OcapiMemberFriends_AddFriendFromCode","summary":"Adds a friend by creating a member friend using a friend code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendDetails"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendDetails"},{"code":"400","description":"Request property is invalid or missing, or member cannot add friend."},{"code":"401","description":"No member authenticated."},{"code":"429","description":"Too many requests. Try again later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}},"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1code/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendDetails"}}},{"code":"400"},{"code":"401"},{"code":"429","schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}}}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/friends/code"},{"label":"Removes a friend by deleting a member friend","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/friends/ocapimemberfriends_removefriend","routeSlug":"/openapi/digital-platform/openapi/friends/ocapimemberfriends_removefriend","metadata":{"seo":{"title":"Removes a friend by deleting a member friend","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberFriends_RemoveFriend","name":"Removes a friend by deleting a member friend","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removes a friend by deleting a member friend","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"friends/ocapimemberfriends_removefriend/request/members/ocapimemberfriends_removefriend/request/licenses-required","deepLinkHash":"/friends/ocapimemberfriends_removefriend#friends/ocapimemberfriends_removefriend/request/members/ocapimemberfriends_removefriend/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Loyalty.Friends"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_48","required":true}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ocapi/v1/members/current/friends/{id}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["204","401"],"pointer":"/ocapi/v1/members/current/friends/{id}","href":"friends/ocapimemberfriends_removefriend","openApiOperationId":"OcapiMemberFriends_RemoveFriend","summary":"Removes a friend by deleting a member friend"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Friend removed."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1{id}/delete/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/friends/{id}"},{"label":"Sets the subscription sharing details of a member friend","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/friends/ocapimemberfriends_setsubscriptionsharing","routeSlug":"/openapi/digital-platform/openapi/friends/ocapimemberfriends_setsubscriptionsharing","metadata":{"seo":{"title":"Sets the subscription sharing details of a member friend","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberFriends_SetSubscriptionSharing","name":"Sets the subscription sharing details of a member friend","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1{id}~1subscription-sharing/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sets the subscription sharing details of a member friend","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"friends/ocapimemberfriends_setsubscriptionsharing/request/members/ocapimemberfriends_setsubscriptionsharing/request/licenses-required","deepLinkHash":"/friends/ocapimemberfriends_setsubscriptionsharing#friends/ocapimemberfriends_setsubscriptionsharing/request/members/ocapimemberfriends_setsubscriptionsharing/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Loyalty.Friends"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_48","required":true}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1{id}~1subscription-sharing/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1{id}~1subscription-sharing/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate","pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1{id}~1subscription-sharing/put/requestBody","description":"The values needed to update the subscription sharing details of a member friend"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/members/current/friends/{id}/subscription-sharing","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"}},"responseCodes":["204","400","401","404"],"pointer":"/ocapi/v1/members/current/friends/{id}/subscription-sharing","href":"friends/ocapimemberfriends_setsubscriptionsharing","openApiOperationId":"OcapiMemberFriends_SetSubscriptionSharing","summary":"Sets the subscription sharing details of a member friend"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Friend subscription sharing updated."},{"code":"400","description":"Request property is invalid or missing, or member cannot share subscription."},{"code":"401","description":"No member authenticated."},{"code":"404","description":"Friend does not exist."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1friends~1{id}~1subscription-sharing/put/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/friends/{id}/subscription-sharing"}],"content":{"contentType":"group","meta":{"name":"Friends"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Friends","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/members/current/friend-code","summary":"Creates a friend code for the currently authenticated Loyalty member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/friends/ocapimemberfriends_createfriendcode","deprecated":false},{"title":"/ocapi/v1/members/current/friends/code","summary":"Adds a friend by creating a member friend using a friend code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/friends/ocapimemberfriends_addfriendfromcode","deprecated":false},{"title":"/ocapi/v1/members/current/friends/{id}","summary":"Removes a friend by deleting a member friend","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/friends/ocapimemberfriends_removefriend","deprecated":false},{"title":"/ocapi/v1/members/current/friends/{id}/subscription-sharing","summary":"Sets the subscription sharing details of a member friend","prefix":{"name":"put","color":"put"},"badges":[],"link":"/friends/ocapimemberfriends_setsubscriptionsharing","deprecated":false}]}]}]}]}},{"type":"group","label":"Tabs","link":"/openapi/digital-platform/openapi/tabs","routeSlug":"/openapi/digital-platform/openapi/tabs","items":[{"label":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ocapimemberorders_getmembertabordersforsite","routeSlug":"/openapi/digital-platform/openapi/tabs/ocapimemberorders_getmembertabordersforsite","metadata":{"seo":{"title":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberOrders_GetMemberTabOrdersForSite","name":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1orders~1tab~1by-site~1{siteId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tabs/ocapimemberorders_getmembertabordersforsite/request/members/ocapimemberorders_getmembertabordersforsite/request/orders/ocapimemberorders_getmembertabordersforsite/request/licenses-required","deepLinkHash":"/tabs/ocapimemberorders_getmembertabordersforsite#tabs/ocapimemberorders_getmembertabordersforsite/request/members/ocapimemberorders_getmembertabordersforsite/request/orders/ocapimemberorders_getmembertabordersforsite/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.ChecksAPI"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","required":true}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1orders~1tab~1by-site~1{siteId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1orders~1tab~1by-site~1{siteId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/orders/tab/by-site/{siteId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","401","404"],"pointer":"/ocapi/v1/members/current/orders/tab/by-site/{siteId}","href":"tabs/ocapimemberorders_getmembertabordersforsite","openApiOperationId":"OcapiMemberOrders_GetMemberTabOrdersForSite","summary":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderListDetailsGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressTabOrder"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderListDetailsGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressTabOrder"},{"code":"401","description":"No member authenticated."},{"code":"404","description":"Site does not exist."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1orders~1tab~1by-site~1{siteId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderListDetailsGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressTabOrder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderListDetailsGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressTabOrder"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/orders/tab/by-site/{siteId}"},{"label":"Adds items to an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ocapiorderitems_additems","routeSlug":"/openapi/digital-platform/openapi/tabs/ocapiorderitems_additems","metadata":{"seo":{"title":"Adds items to an in progress tab order","description":"Items cannot be added to an in progress tab order when in progress tab order IsOpen equals false."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderItems_AddItems","name":"Adds items to an in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adds items to an in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items cannot be added to an in progress tab order when in progress tab order IsOpen equals false."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For in progress standard order or in progress gift shop order entities, use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/items/ocapiorderitems_setitems"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SetItems"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items that require preparation are immediately sent to the kitchen."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items cannot be removed or modified once added to an in progress tab order"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tabs/ocapiorderitems_additems/request/items/ocapiorderitems_additems/request/orders/ocapiorderitems_additems/request/licenses-required","deepLinkHash":"/tabs/ocapiorderitems_additems#tabs/ocapiorderitems_additems/request/items/ocapiorderitems_additems/request/orders/ocapiorderitems_additems/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress tab order being modified","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/post/requestBody","description":"The requested items"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/items","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/items","href":"tabs/ocapiorderitems_additems","openApiOperationId":"OcapiOrderItems_AddItems","summary":"Adds items to an in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order items","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase"},{"code":"400","description":"Request property is invalid or missing, or invalid order type."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1items/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/items"},{"label":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ocapiorderpaymentcard_createorderembeddedpaymentcard","routeSlug":"/openapi/digital-platform/openapi/tabs/ocapiorderpaymentcard_createorderembeddedpaymentcard","metadata":{"seo":{"title":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderPaymentCard_CreateOrderEmbeddedPaymentCard","name":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1embedded/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapiorderpaymentcard_createorderembeddedpaymentcard/request/tabs/ocapiorderpaymentcard_createorderembeddedpaymentcard/request/orders/ocapiorderpaymentcard_createorderembeddedpaymentcard/request/licenses-required","deepLinkHash":"/payments/ocapiorderpaymentcard_createorderembeddedpaymentcard#payments/ocapiorderpaymentcard_createorderembeddedpaymentcard/request/tabs/ocapiorderpaymentcard_createorderembeddedpaymentcard/request/orders/ocapiorderpaymentcard_createorderembeddedpaymentcard/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress tab order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1embedded/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1embedded/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1embedded/post/requestBody","description":"The values needed to create an embedded order payment card"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/payment-card/embedded","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/payment-card/embedded","href":"tabs/ocapiorderpaymentcard_createorderembeddedpaymentcard","openApiOperationId":"OcapiOrderPaymentCard_CreateOrderEmbeddedPaymentCard","summary":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardClientData"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardClientData"},{"code":"400","description":"Request property is invalid/missing or Customer Details have not been set."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1embedded/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardClientData","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardClientData"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/payment-card/embedded"},{"label":"Gets the current order payment card for an in progress tab order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ocapiorderpaymentcard_getcurrentorderpaymentcard","routeSlug":"/openapi/digital-platform/openapi/tabs/ocapiorderpaymentcard_getcurrentorderpaymentcard","metadata":{"seo":{"title":"Gets the current order payment card for an in progress tab order","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderPaymentCard_GetCurrentOrderPaymentCard","name":"Gets the current order payment card for an in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1current/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current order payment card for an in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapiorderpaymentcard_getcurrentorderpaymentcard/request/tabs/ocapiorderpaymentcard_getcurrentorderpaymentcard/request/orders/ocapiorderpaymentcard_getcurrentorderpaymentcard/request/licenses-required","deepLinkHash":"/payments/ocapiorderpaymentcard_getcurrentorderpaymentcard#payments/ocapiorderpaymentcard_getcurrentorderpaymentcard/request/tabs/ocapiorderpaymentcard_getcurrentorderpaymentcard/request/orders/ocapiorderpaymentcard_getcurrentorderpaymentcard/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress tab order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1current/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1current/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/{orderId}/payment-card/current","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/payment-card/current","href":"tabs/ocapiorderpaymentcard_getcurrentorderpaymentcard","openApiOperationId":"OcapiOrderPaymentCard_GetCurrentOrderPaymentCard","summary":"Gets the current order payment card for an in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderPaymentCard"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderPaymentCard"},{"code":"400","description":"Order is not a tab order."},{"code":"404","description":"Order does not exist, or payment card has not been created."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1current/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderPaymentCard","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderPaymentCard"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/payment-card/current"},{"label":"Creates an order payment card payment and completes the in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ocapiorderpayments_createpaymentcardpayment","routeSlug":"/openapi/digital-platform/openapi/tabs/ocapiorderpayments_createpaymentcardpayment","metadata":{"seo":{"title":"Creates an order payment card payment and completes the in progress tab order","description":"The order must have an assigned in progress tab order PaymentCard and an unpaid balancein order to create an order payment card payment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderPayments_CreatePaymentCardPayment","name":"Creates an order payment card payment and completes the in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1payment-card/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates an order payment card payment and completes the in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order must have an assigned in progress tab order PaymentCard and an unpaid balance"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in order to create an order payment card payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment card will be charged for the unpaid balance of the in progress tab order"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapiorderpayments_createpaymentcardpayment/request/tabs/ocapiorderpayments_createpaymentcardpayment/request/orders/ocapiorderpayments_createpaymentcardpayment/request/licenses-required","deepLinkHash":"/payments/ocapiorderpayments_createpaymentcardpayment#payments/ocapiorderpayments_createpaymentcardpayment/request/tabs/ocapiorderpayments_createpaymentcardpayment/request/orders/ocapiorderpayments_createpaymentcardpayment/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress tab order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1payment-card/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1payment-card/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/payments/payment-card","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/payments/payment-card","href":"tabs/ocapiorderpayments_createpaymentcardpayment","openApiOperationId":"OcapiOrderPayments_CreatePaymentCardPayment","summary":"Creates an order payment card payment and completes the in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}},"schemaId":"schema_38"},{"code":"400","description":"Order does not contain any concessions or Payment card declined."},{"code":"404","description":"Order or payment card does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1payment-card/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_38","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/payments/payment-card"},{"label":"Gets the in seat location tab availability for a seat within a showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ocapitablocationavailability_getinseatlocationtabavailability","routeSlug":"/openapi/digital-platform/openapi/tabs/ocapitablocationavailability_getinseatlocationtabavailability","metadata":{"seo":{"title":"Gets the in seat location tab availability for a seat within a showtime","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiTabLocationAvailability_GetInSeatLocationTabAvailability","name":"Gets the in seat location tab availability for a seat within a showtime","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seats~1{seatId}~1tab-availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the in seat location tab availability for a seat within a showtime","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"seating/ocapitablocationavailability_getinseatlocationtabavailability/request/tabs/ocapitablocationavailability_getinseatlocationtabavailability/request/showtimes/ocapitablocationavailability_getinseatlocationtabavailability/request/licenses-required","deepLinkHash":"/seating/ocapitablocationavailability_getinseatlocationtabavailability#seating/ocapitablocationavailability_getinseatlocationtabavailability/request/tabs/ocapitablocationavailability_getinseatlocationtabavailability/request/showtimes/ocapitablocationavailability_getinseatlocationtabavailability/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.ChecksAPI"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"showtimeId","in":"path","schemaId":"schema_33","description":"The unique identifier of the showtime","required":true},{"name":"seatId","in":"path","schemaId":"schema_33","description":"The unique identifier of the seat","required":true}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seats~1{seatId}~1tab-availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seats~1{seatId}~1tab-availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/showtimes/{showtimeId}/seats/{seatId}/tab-availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"showtimeId","in":"path","required":true,"schemaId":"schema_33"},{"name":"seatId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/showtimes/{showtimeId}/seats/{seatId}/tab-availability","href":"tabs/ocapitablocationavailability_getinseatlocationtabavailability","openApiOperationId":"OcapiTabLocationAvailability_GetInSeatLocationTabAvailability","summary":"Gets the in seat location tab availability for a seat within a showtime"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.InSeatLocationTabAvailability"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.InSeatLocationTabAvailability"},{"code":"404","description":"Showtime or seat does not exist."}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seats~1{seatId}~1tab-availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.InSeatLocationTabAvailability","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.InSeatLocationTabAvailability"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/showtimes/{showtimeId}/seats/{seatId}/tab-availability"},{"label":"Gets the dining location tab availability for a dining location base","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ocapitablocationavailability_getdininglocationtabavailability","routeSlug":"/openapi/digital-platform/openapi/tabs/ocapitablocationavailability_getdininglocationtabavailability","metadata":{"seo":{"title":"Gets the dining location tab availability for a dining location base","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiTabLocationAvailability_GetDiningLocationTabAvailability","name":"Gets the dining location tab availability for a dining location base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1dining-locations~1{diningLocationId}~1tab-availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the dining location tab availability for a dining location base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tabs/ocapitablocationavailability_getdininglocationtabavailability/request/dining/ocapitablocationavailability_getdininglocationtabavailability/request/licenses-required","deepLinkHash":"/tabs/ocapitablocationavailability_getdininglocationtabavailability#tabs/ocapitablocationavailability_getdininglocationtabavailability/request/dining/ocapitablocationavailability_getdininglocationtabavailability/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.ChecksAPI"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"diningLocationId","in":"path","schemaId":"schema_33","description":"The unique identifier of the dining location base","required":true}],"pointer":"/paths/~1ocapi~1v1~1dining-locations~1{diningLocationId}~1tab-availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1dining-locations~1{diningLocationId}~1tab-availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/dining-locations/{diningLocationId}/tab-availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"diningLocationId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/dining-locations/{diningLocationId}/tab-availability","href":"tabs/ocapitablocationavailability_getdininglocationtabavailability","openApiOperationId":"OcapiTabLocationAvailability_GetDiningLocationTabAvailability","summary":"Gets the dining location tab availability for a dining location base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.DiningLocationTabAvailability"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.DiningLocationTabAvailability"},{"code":"404","description":"Dining location does not exist."}],"pointer":"/paths/~1ocapi~1v1~1dining-locations~1{diningLocationId}~1tab-availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.DiningLocationTabAvailability","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.DiningLocationTabAvailability"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/dining-locations/{diningLocationId}/tab-availability"},{"label":"Creates an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ocapitaborders_createtaborder","routeSlug":"/openapi/digital-platform/openapi/tabs/ocapitaborders_createtaborder","metadata":{"seo":{"title":"Creates an in progress tab order","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiTabOrders_CreateTabOrder","name":"Creates an in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1tab/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates an in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tabs/ocapitaborders_createtaborder/request/sites/ocapitaborders_createtaborder/request/orders/ocapitaborders_createtaborder/request/licenses-required","deepLinkHash":"/tabs/ocapitaborders_createtaborder#tabs/ocapitaborders_createtaborder/request/sites/ocapitaborders_createtaborder/request/orders/ocapitaborders_createtaborder/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.ChecksAPI"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1tab/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate","pointer":"/paths/~1ocapi~1v1~1orders~1tab/post/requestBody","description":"Details of the order to be created"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/tab","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/tab","href":"tabs/ocapitaborders_createtaborder","openApiOperationId":"OcapiTabOrders_CreateTabOrder","summary":"Creates an in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},{"code":"400","description":"Site does not exist."},{"code":"404","description":"Showtime or seat(s) do not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1tab/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/tab"},{"label":"Gets an in progress tab order by its in progress tab order AccessCode","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ocapitaborders_gettaborderbyaccesscode","routeSlug":"/openapi/digital-platform/openapi/tabs/ocapitaborders_gettaborderbyaccesscode","metadata":{"seo":{"title":"Gets an in progress tab order by its in progress tab order AccessCode","description":"The access code is a case-insensitive, human-readable, 5-character alphanumeric string,generated from a restricted character set designed to avoid visually ambiguous characters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiTabOrders_GetTabOrderByAccessCode","name":"Gets an in progress tab order by its in progress tab order AccessCode","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1tab~1by-access-code~1{accessCode}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets an in progress tab order by its in progress tab order AccessCode","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The access code is a case-insensitive, human-readable, 5-character alphanumeric string,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generated from a restricted character set designed to avoid visually ambiguous characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tabs/ocapitaborders_gettaborderbyaccesscode/request/sites/ocapitaborders_gettaborderbyaccesscode/request/orders/ocapitaborders_gettaborderbyaccesscode/request/licenses-required","deepLinkHash":"/tabs/ocapitaborders_gettaborderbyaccesscode#tabs/ocapitaborders_gettaborderbyaccesscode/request/sites/ocapitaborders_gettaborderbyaccesscode/request/orders/ocapitaborders_gettaborderbyaccesscode/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.ChecksAPI"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","required":true},{"name":"accessCode","in":"path","schemaId":"schema_33","description":"The access code for the in progress tab order being retrieved","required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1tab~1by-access-code~1{accessCode}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1tab~1by-access-code~1{accessCode}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}/orders/tab/by-access-code/{accessCode}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"},{"name":"accessCode","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}/orders/tab/by-access-code/{accessCode}","href":"tabs/ocapitaborders_gettaborderbyaccesscode","openApiOperationId":"OcapiTabOrders_GetTabOrderByAccessCode","summary":"Gets an in progress tab order by its in progress tab order AccessCode"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},{"code":"404","description":"Tab order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1orders~1tab~1by-access-code~1{accessCode}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}/orders/tab/by-access-code/{accessCode}"},{"label":"Adds a tip to an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ordertips_addordertip","routeSlug":"/openapi/digital-platform/openapi/tabs/ordertips_addordertip","metadata":{"seo":{"title":"Adds a tip to an in progress tab order","description":"For in progress standard order entities, use SetOrderTip instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OrderTips_AddOrderTip","name":"Adds a tip to an in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tips/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adds a tip to an in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For in progress standard order entities, use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/tips/ordertips_setordertip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SetOrderTip"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tips/ordertips_addordertip/request/tabs/ordertips_addordertip/request/orders/ordertips_addordertip/request/licenses-required","deepLinkHash":"/tips/ordertips_addordertip#tips/ordertips_addordertip/request/tabs/ordertips_addordertip/request/orders/ordertips_addordertip/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress tab order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tips/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tips/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tips/post/requestBody","description":"The tip to add"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/tips","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/tips","href":"tabs/ordertips_addordertip","openApiOperationId":"OrderTips_AddOrderTip","summary":"Adds a tip to an in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/atomsvc+xml","mediaTypes":["application/atomsvc+xml","application/atom+xml; type=feed","application/atom+xml","application/xml","application/atom+xml; type=entry","application/json; odata=minimalmetadata; streaming=true","application/json; odata=minimalmetadata; streaming=false","application/json; odata=minimalmetadata","application/json; odata=fullmetadata; streaming=true","application/json; odata=fullmetadata; streaming=false","application/json; odata=fullmetadata","application/json; odata=nometadata; streaming=true","application/json; odata=nometadata; streaming=false","application/json; odata=nometadata","application/json; odata=verbose","application/json; streaming=true","application/json; streaming=false","application/json","text/xml","text/json","text/plain"],"mediaTypeContent":{"application/atomsvc+xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/atom+xml; type=feed":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/atom+xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/atom+xml; type=entry":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=minimalmetadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=minimalmetadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=minimalmetadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=fullmetadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=fullmetadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=fullmetadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=nometadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=nometadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=nometadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=verbose":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"text/xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"text/plain":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},{"code":"400","description":"Request property is invalid or missing."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tips/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails","mediaTypes":["application/atomsvc+xml","application/atom+xml; type=feed","application/atom+xml","application/xml","application/atom+xml; type=entry","application/json; odata=minimalmetadata; streaming=true","application/json; odata=minimalmetadata; streaming=false","application/json; odata=minimalmetadata","application/json; odata=fullmetadata; streaming=true","application/json; odata=fullmetadata; streaming=false","application/json; odata=fullmetadata","application/json; odata=nometadata; streaming=true","application/json; odata=nometadata; streaming=false","application/json; odata=nometadata","application/json; odata=verbose","application/json; streaming=true","application/json; streaming=false","application/json","text/xml","text/json","text/plain"],"mediaTypeContent":{"application/atomsvc+xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/atom+xml; type=feed":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/atom+xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/atom+xml; type=entry":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=minimalmetadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=minimalmetadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=minimalmetadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=fullmetadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=fullmetadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=fullmetadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=nometadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=nometadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=nometadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=verbose":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"text/xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"text/plain":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/tips"}],"content":{"contentType":"group","meta":{"name":"Tabs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tabs","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/members/current/orders/tab/by-site/{siteId}","summary":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tabs/ocapimemberorders_getmembertabordersforsite","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/items","summary":"Adds items to an in progress tab order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tabs/ocapiorderitems_additems","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/payment-card/embedded","summary":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tabs/ocapiorderpaymentcard_createorderembeddedpaymentcard","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/payment-card/current","summary":"Gets the current order payment card for an in progress tab order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tabs/ocapiorderpaymentcard_getcurrentorderpaymentcard","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/payments/payment-card","summary":"Creates an order payment card payment and completes the in progress tab order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tabs/ocapiorderpayments_createpaymentcardpayment","deprecated":false},{"title":"/ocapi/v1/showtimes/{showtimeId}/seats/{seatId}/tab-availability","summary":"Gets the in seat location tab availability for a seat within a showtime","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tabs/ocapitablocationavailability_getinseatlocationtabavailability","deprecated":false},{"title":"/ocapi/v1/dining-locations/{diningLocationId}/tab-availability","summary":"Gets the dining location tab availability for a dining location base","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tabs/ocapitablocationavailability_getdininglocationtabavailability","deprecated":false},{"title":"/ocapi/v1/orders/tab","summary":"Creates an in progress tab order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tabs/ocapitaborders_createtaborder","deprecated":false},{"title":"/ocapi/v1/sites/{siteId}/orders/tab/by-access-code/{accessCode}","summary":"Gets an in progress tab order by its in progress tab order AccessCode","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tabs/ocapitaborders_gettaborderbyaccesscode","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/tips","summary":"Adds a tip to an in progress tab order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tabs/ordertips_addordertip","deprecated":false}]}]}]}]}},{"type":"group","label":"Password Reset","link":"/openapi/digital-platform/openapi/password-reset","routeSlug":"/openapi/digital-platform/openapi/password-reset","items":[{"label":"Creates a password reset code for a member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/password-reset/ocapimemberpasswordreset_createpasswordresetcode","routeSlug":"/openapi/digital-platform/openapi/password-reset/ocapimemberpasswordreset_createpasswordresetcode","metadata":{"seo":{"title":"Creates a password reset code for a member","description":"Successful response returned regardless of the existence of the provided email/username in Loyalty."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberPasswordReset_CreatePasswordResetCode","name":"Creates a password reset code for a member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1password-reset-code/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a password reset code for a member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Successful response returned regardless of the existence of the provided email/username in Loyalty."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An email with further instructions for completing the request will be sent to the member"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"password-reset/ocapimemberpasswordreset_createpasswordresetcode/request/licenses-required","deepLinkHash":"/password-reset/ocapimemberpasswordreset_createpasswordresetcode#password-reset/ocapimemberpasswordreset_createpasswordresetcode/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1password-reset-code/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeCreate"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeCreate","pointer":"/paths/~1ocapi~1v1~1members~1password-reset-code/post/requestBody","description":"Details to create a password reset code"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/password-reset-code","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeCreate"}},"responseCodes":["204","400"],"pointer":"/ocapi/v1/members/password-reset-code","href":"password-reset/ocapimemberpasswordreset_createpasswordresetcode","openApiOperationId":"OcapiMemberPasswordReset_CreatePasswordResetCode","summary":"Creates a password reset code for a member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Password reset code created and emailed to the member."},{"code":"400","description":"Request property is invalid or missing."}],"pointer":"/paths/~1ocapi~1v1~1members~1password-reset-code/post/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/password-reset-code"},{"label":"Validates a password reset code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/password-reset/ocapimemberpasswordreset_validatepasswordresetcode","routeSlug":"/openapi/digital-platform/openapi/password-reset/ocapimemberpasswordreset_validatepasswordresetcode","metadata":{"seo":{"title":"Validates a password reset code","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberPasswordReset_ValidatePasswordResetCode","name":"Validates a password reset code","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1password-reset-code~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validates a password reset code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"password-reset/ocapimemberpasswordreset_validatepasswordresetcode/request/licenses-required","deepLinkHash":"/password-reset/ocapimemberpasswordreset_validatepasswordresetcode#password-reset/ocapimemberpasswordreset_validatepasswordresetcode/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1password-reset-code~1validate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidation"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidation"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidation"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidation"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidation","pointer":"/paths/~1ocapi~1v1~1members~1password-reset-code~1validate/post/requestBody","description":"Details to validate a reset code"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/password-reset-code/validate","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidation"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidation"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidation"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidation"}},"responseCodes":["200","400"],"pointer":"/ocapi/v1/members/password-reset-code/validate","href":"password-reset/ocapimemberpasswordreset_validatepasswordresetcode","openApiOperationId":"OcapiMemberPasswordReset_ValidatePasswordResetCode","summary":"Validates a password reset code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidation","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidation"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidation"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidation"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidity"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidity"},{"code":"400","description":"Request property is invalid or missing."}],"pointer":"/paths/~1ocapi~1v1~1members~1password-reset-code~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidity","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidity"}}},{"code":"400"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/password-reset-code/validate"},{"label":"Resets a member entity's password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/password-reset/ocapimemberpasswordreset_resetpassword","routeSlug":"/openapi/digital-platform/openapi/password-reset/ocapimemberpasswordreset_resetpassword","metadata":{"seo":{"title":"Resets a member entity's password","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberPasswordReset_ResetPassword","name":"Resets a member entity's password","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1password-reset/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resets a member entity's password","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"password-reset/ocapimemberpasswordreset_resetpassword/request/licenses-required","deepLinkHash":"/password-reset/ocapimemberpasswordreset_resetpassword#password-reset/ocapimemberpasswordreset_resetpassword/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1password-reset/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordReset"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordReset"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordReset"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordReset"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordReset","pointer":"/paths/~1ocapi~1v1~1members~1password-reset/post/requestBody","description":"Details to reset password"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/password-reset","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordReset"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordReset"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordReset"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordReset"}},"responseCodes":["204","400"],"pointer":"/ocapi/v1/members/password-reset","href":"password-reset/ocapimemberpasswordreset_resetpassword","openApiOperationId":"OcapiMemberPasswordReset_ResetPassword","summary":"Resets a member entity's password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordReset","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordReset"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordReset"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordReset"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordReset"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member password updated."},{"code":"400","description":"Request property is invalid or missing, or password reset code has expired."}],"pointer":"/paths/~1ocapi~1v1~1members~1password-reset/post/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/password-reset"}],"content":{"contentType":"group","meta":{"name":"Password Reset"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Password Reset","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/members/password-reset-code","summary":"Creates a password reset code for a member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/password-reset/ocapimemberpasswordreset_createpasswordresetcode","deprecated":false},{"title":"/ocapi/v1/members/password-reset-code/validate","summary":"Validates a password reset code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/password-reset/ocapimemberpasswordreset_validatepasswordresetcode","deprecated":false},{"title":"/ocapi/v1/members/password-reset","summary":"Resets a member entity's password","prefix":{"name":"post","color":"post"},"badges":[],"link":"/password-reset/ocapimemberpasswordreset_resetpassword","deprecated":false}]}]}]}]}},{"type":"group","label":"Payments","link":"/openapi/digital-platform/openapi/payments","routeSlug":"/openapi/digital-platform/openapi/payments","items":[{"label":"Gets the list of member payment card entities for the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_getmemberpaymentcards","routeSlug":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_getmemberpaymentcards","metadata":{"seo":{"title":"Gets the list of member payment card entities for the currently authenticated member","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberPaymentCards_GetMemberPaymentCards","name":"Gets the list of member payment card entities for the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the list of member payment card entities for the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapimemberpaymentcards_getmemberpaymentcards/request/licenses-required","deepLinkHash":"/payments/ocapimemberpaymentcards_getmemberpaymentcards#payments/ocapimemberpaymentcards_getmemberpaymentcards/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/payment-cards","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/ocapi/v1/members/current/payment-cards","href":"payments/ocapimemberpaymentcards_getmemberpaymentcards","openApiOperationId":"OcapiMemberPaymentCards_GetMemberPaymentCards","summary":"Gets the list of member payment card entities for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberPaymentCardListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberPaymentCardListDetails"},{"code":"400","description":"Bad Request"},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberPaymentCardListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberPaymentCardListDetails"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/payment-cards"},{"label":"Gets a member payment card for the currently authenticated member by its unique identifier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_getmemberpaymentcard","routeSlug":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_getmemberpaymentcard","metadata":{"seo":{"title":"Gets a member payment card for the currently authenticated member by its unique identifier","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberPaymentCards_GetMemberPaymentCard","name":"Gets a member payment card for the currently authenticated member by its unique identifier","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards~1{memberPaymentCardId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a member payment card for the currently authenticated member by its unique identifier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapimemberpaymentcards_getmemberpaymentcard/request/licenses-required","deepLinkHash":"/payments/ocapimemberpaymentcards_getmemberpaymentcard#payments/ocapimemberpaymentcards_getmemberpaymentcard/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"memberPaymentCardId","in":"path","schemaId":"schema_33","description":"The member payment card identifier","required":true}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards~1{memberPaymentCardId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards~1{memberPaymentCardId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/payment-cards/{memberPaymentCardId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"memberPaymentCardId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","401","404"],"pointer":"/ocapi/v1/members/current/payment-cards/{memberPaymentCardId}","href":"payments/ocapimemberpaymentcards_getmemberpaymentcard","openApiOperationId":"OcapiMemberPaymentCards_GetMemberPaymentCard","summary":"Gets a member payment card for the currently authenticated member by its unique identifier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberPaymentCard"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberPaymentCard"},{"code":"401","description":"No member authenticated."},{"code":"404","description":"Payment card does not exist."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards~1{memberPaymentCardId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberPaymentCard","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberPaymentCard"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/payment-cards/{memberPaymentCardId}"},{"label":"Removes a member payment card for the currently authenticated member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_removememberpaymentcard","routeSlug":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_removememberpaymentcard","metadata":{"seo":{"title":"Removes a member payment card for the currently authenticated member","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberPaymentCards_RemoveMemberPaymentCard","name":"Removes a member payment card for the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards~1{memberPaymentCardId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removes a member payment card for the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapimemberpaymentcards_removememberpaymentcard/request/licenses-required","deepLinkHash":"/payments/ocapimemberpaymentcards_removememberpaymentcard#payments/ocapimemberpaymentcards_removememberpaymentcard/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"memberPaymentCardId","in":"path","schemaId":"schema_33","description":"The member payment card identifier","required":true}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards~1{memberPaymentCardId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards~1{memberPaymentCardId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ocapi/v1/members/current/payment-cards/{memberPaymentCardId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"memberPaymentCardId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["204","400","401"],"pointer":"/ocapi/v1/members/current/payment-cards/{memberPaymentCardId}","href":"payments/ocapimemberpaymentcards_removememberpaymentcard","openApiOperationId":"OcapiMemberPaymentCards_RemoveMemberPaymentCard","summary":"Removes a member payment card for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member payment card removed."},{"code":"400","description":"Cannot remove primary payment card with an active recurring subscription."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards~1{memberPaymentCardId}/delete/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/payment-cards/{memberPaymentCardId}"},{"label":"Loads and initiates the creation of a member payment card using an embedded UI for the currently authenticated member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_creatememberembeddedpaymentcard","routeSlug":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_creatememberembeddedpaymentcard","metadata":{"seo":{"title":"Loads and initiates the creation of a member payment card using an embedded UI for the currently authenticated member","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberPaymentCards_CreateMemberEmbeddedPaymentCard","name":"Loads and initiates the creation of a member payment card using an embedded UI for the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards~1embedded/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Loads and initiates the creation of a member payment card using an embedded UI for the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapimemberpaymentcards_creatememberembeddedpaymentcard/request/licenses-required","deepLinkHash":"/payments/ocapimemberpaymentcards_creatememberembeddedpaymentcard#payments/ocapimemberpaymentcards_creatememberembeddedpaymentcard/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards~1embedded/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberEmbeddedPaymentCardCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberEmbeddedPaymentCardCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberEmbeddedPaymentCardCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberEmbeddedPaymentCardCreate"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberEmbeddedPaymentCardCreate","pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards~1embedded/post/requestBody","description":"The values needed to create an embedded member payment card"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/current/payment-cards/embedded","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberEmbeddedPaymentCardCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberEmbeddedPaymentCardCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberEmbeddedPaymentCardCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberEmbeddedPaymentCardCreate"}},"responseCodes":["200","400","401"],"pointer":"/ocapi/v1/members/current/payment-cards/embedded","href":"payments/ocapimemberpaymentcards_creatememberembeddedpaymentcard","openApiOperationId":"OcapiMemberPaymentCards_CreateMemberEmbeddedPaymentCard","summary":"Loads and initiates the creation of a member payment card using an embedded UI for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberEmbeddedPaymentCardCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberEmbeddedPaymentCardCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberEmbeddedPaymentCardCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberEmbeddedPaymentCardCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberEmbeddedPaymentCardCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberEmbeddedPaymentCardClientData"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberEmbeddedPaymentCardClientData"},{"code":"400","description":"Request property is invalid or missing."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards~1embedded/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberEmbeddedPaymentCardClientData","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberEmbeddedPaymentCardClientData"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/payment-cards/embedded"},{"label":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapiorderpaymentcard_createorderembeddedpaymentcard","routeSlug":"/openapi/digital-platform/openapi/payments/ocapiorderpaymentcard_createorderembeddedpaymentcard","metadata":{"seo":{"title":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderPaymentCard_CreateOrderEmbeddedPaymentCard","name":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1embedded/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapiorderpaymentcard_createorderembeddedpaymentcard/request/tabs/ocapiorderpaymentcard_createorderembeddedpaymentcard/request/orders/ocapiorderpaymentcard_createorderembeddedpaymentcard/request/licenses-required","deepLinkHash":"/payments/ocapiorderpaymentcard_createorderembeddedpaymentcard#payments/ocapiorderpaymentcard_createorderembeddedpaymentcard/request/tabs/ocapiorderpaymentcard_createorderembeddedpaymentcard/request/orders/ocapiorderpaymentcard_createorderembeddedpaymentcard/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress tab order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1embedded/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1embedded/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1embedded/post/requestBody","description":"The values needed to create an embedded order payment card"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/payment-card/embedded","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/payment-card/embedded","href":"payments/ocapiorderpaymentcard_createorderembeddedpaymentcard","openApiOperationId":"OcapiOrderPaymentCard_CreateOrderEmbeddedPaymentCard","summary":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardClientData"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardClientData"},{"code":"400","description":"Request property is invalid/missing or Customer Details have not been set."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1embedded/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardClientData","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardClientData"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/payment-card/embedded"},{"label":"Gets the current order payment card for an in progress tab order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapiorderpaymentcard_getcurrentorderpaymentcard","routeSlug":"/openapi/digital-platform/openapi/payments/ocapiorderpaymentcard_getcurrentorderpaymentcard","metadata":{"seo":{"title":"Gets the current order payment card for an in progress tab order","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderPaymentCard_GetCurrentOrderPaymentCard","name":"Gets the current order payment card for an in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1current/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current order payment card for an in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapiorderpaymentcard_getcurrentorderpaymentcard/request/tabs/ocapiorderpaymentcard_getcurrentorderpaymentcard/request/orders/ocapiorderpaymentcard_getcurrentorderpaymentcard/request/licenses-required","deepLinkHash":"/payments/ocapiorderpaymentcard_getcurrentorderpaymentcard#payments/ocapiorderpaymentcard_getcurrentorderpaymentcard/request/tabs/ocapiorderpaymentcard_getcurrentorderpaymentcard/request/orders/ocapiorderpaymentcard_getcurrentorderpaymentcard/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress tab order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1current/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1current/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/{orderId}/payment-card/current","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/payment-card/current","href":"payments/ocapiorderpaymentcard_getcurrentorderpaymentcard","openApiOperationId":"OcapiOrderPaymentCard_GetCurrentOrderPaymentCard","summary":"Gets the current order payment card for an in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderPaymentCard"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderPaymentCard"},{"code":"400","description":"Order is not a tab order."},{"code":"404","description":"Order does not exist, or payment card has not been created."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payment-card~1current/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderPaymentCard","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderPaymentCard"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/payment-card/current"},{"label":"Removes an order payment base from an in progress order base","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_removepayment","routeSlug":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_removepayment","metadata":{"seo":{"title":"Removes an order payment base from an in progress order base","description":"Only order gift card payment and order member balance payment entities can be removed at this time."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderPayments_RemovePayment","name":"Removes an order payment base from an in progress order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1{paymentId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removes an order payment base from an in progress order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only order gift card payment and order member balance payment entities can be removed at this time."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapiorderpayments_removepayment/request/orders/ocapiorderpayments_removepayment/request/licenses-required","deepLinkHash":"/payments/ocapiorderpayments_removepayment#payments/ocapiorderpayments_removepayment/request/orders/ocapiorderpayments_removepayment/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base that the payment will be removed from","required":true},{"name":"paymentId","in":"path","schemaId":"schema_33","description":"The unique identifier of the order payment base to be removed","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1{paymentId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1{paymentId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ocapi/v1/orders/{orderId}/payments/{paymentId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"},{"name":"paymentId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["204","400"],"pointer":"/ocapi/v1/orders/{orderId}/payments/{paymentId}","href":"payments/ocapiorderpayments_removepayment","openApiOperationId":"OcapiOrderPayments_RemovePayment","summary":"Removes an order payment base from an in progress order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Payment removed."},{"code":"400","description":"Payment cannot be removed."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1{paymentId}/delete/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/orders/{orderId}/payments/{paymentId}"},{"label":"Creates a order embedded payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_createembeddedpayment","routeSlug":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_createembeddedpayment","metadata":{"seo":{"title":"Creates a order embedded payment","description":"Initiates an order embedded payment with the connector so that the client can render a UI based on the returned order embedded payment client data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderPayments_CreateEmbeddedPayment","name":"Creates a order embedded payment","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1embedded/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a order embedded payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates an order embedded payment with the connector so that the client can render a UI based on the returned order embedded payment client data"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapiorderpayments_createembeddedpayment/request/licenses-required","deepLinkHash":"/payments/ocapiorderpayments_createembeddedpayment#payments/ocapiorderpayments_createembeddedpayment/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.EmbeddedPayment"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the current in progress order base for which the payment is starting","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1embedded/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1embedded/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPaymentCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPaymentCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPaymentCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPaymentCreate"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPaymentCreate","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1embedded/post/requestBody","description":"Values needed to start the embedded payment"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/payments/embedded","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPaymentCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPaymentCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPaymentCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPaymentCreate"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/payments/embedded","href":"payments/ocapiorderpayments_createembeddedpayment","openApiOperationId":"OcapiOrderPayments_CreateEmbeddedPayment","summary":"Creates a order embedded payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPaymentCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPaymentCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPaymentCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPaymentCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPaymentCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.CreatedOrderEmbeddedPayment"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.CreatedOrderEmbeddedPayment"},{"code":"400","description":"Request property is invalid or missing, or payment method does not exist."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1embedded/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.CreatedOrderEmbeddedPayment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.CreatedOrderEmbeddedPayment"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/payments/embedded"},{"label":"Gets the current order embedded payment for an in progress order base","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_getcurrentembeddedpayment","routeSlug":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_getcurrentembeddedpayment","metadata":{"seo":{"title":"Gets the current order embedded payment for an in progress order base","description":"The payment considered current is the most recently created order embedded payment for the in progress order base"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderPayments_GetCurrentEmbeddedPayment","name":"Gets the current order embedded payment for an in progress order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1embedded~1current/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current order embedded payment for an in progress order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment considered current is the most recently created order embedded payment for the in progress order base"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint may be polled to determine the status of the payment after embedded payment process has completed on client."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is required currently due to limitations in the current Web Payment Module payment process around returning payment status"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as part of the UI interaction requiring the client to make this extra call before leaving the payment UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapiorderpayments_getcurrentembeddedpayment/request/licenses-required","deepLinkHash":"/payments/ocapiorderpayments_getcurrentembeddedpayment#payments/ocapiorderpayments_getcurrentembeddedpayment/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.EmbeddedPayment"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1embedded~1current/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1embedded~1current/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/{orderId}/payments/embedded/current","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/orders/{orderId}/payments/embedded/current","href":"payments/ocapiorderpayments_getcurrentembeddedpayment","openApiOperationId":"OcapiOrderPayments_GetCurrentEmbeddedPayment","summary":"Gets the current order embedded payment for an in progress order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPayment"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPayment"},{"code":"404","description":"Order does not exist, or embedded payment has not been created."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1embedded~1current/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPayment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPayment"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/payments/embedded/current"},{"label":"Creates an order redirect payment for an in progress order base","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_createredirectpayment","routeSlug":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_createredirectpayment","metadata":{"seo":{"title":"Creates an order redirect payment for an in progress order base","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderPayments_CreateRedirectPayment","name":"Creates an order redirect payment for an in progress order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1redirect/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates an order redirect payment for an in progress order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapiorderpayments_createredirectpayment/request/licenses-required","deepLinkHash":"/payments/ocapiorderpayments_createredirectpayment#payments/ocapiorderpayments_createredirectpayment/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base that the payment is for","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1redirect/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1redirect/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPaymentCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPaymentCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPaymentCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPaymentCreate"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPaymentCreate","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1redirect/post/requestBody","description":"Values needed to start the redirect payment"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/payments/redirect","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPaymentCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPaymentCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPaymentCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPaymentCreate"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/payments/redirect","href":"payments/ocapiorderpayments_createredirectpayment","openApiOperationId":"OcapiOrderPayments_CreateRedirectPayment","summary":"Creates an order redirect payment for an in progress order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPaymentCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPaymentCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPaymentCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPaymentCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPaymentCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.CreatedOrderRedirectPayment"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.CreatedOrderRedirectPayment"},{"code":"400","description":"Request property is invalid or missing, or payment method does not exist."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1redirect/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.CreatedOrderRedirectPayment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.CreatedOrderRedirectPayment"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/payments/redirect"},{"label":"Gets the current order redirect payment for an in progress order base","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_getcurrentredirectpayment","routeSlug":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_getcurrentredirectpayment","metadata":{"seo":{"title":"Gets the current order redirect payment for an in progress order base","description":"The payment considered current is the most recently created order redirect payment for the in progress order base"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderPayments_GetCurrentRedirectPayment","name":"Gets the current order redirect payment for an in progress order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1redirect~1current/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current order redirect payment for an in progress order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment considered current is the most recently created order redirect payment for the in progress order base"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint may be polled to determine the status of the payment after the redirect payment process has completed on the client."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is required currently due to limitations in the current Web Payment Module payment process around returning payment status"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as part of the UI interaction requiring the client to make this extra call before leaving the payment UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapiorderpayments_getcurrentredirectpayment/request/licenses-required","deepLinkHash":"/payments/ocapiorderpayments_getcurrentredirectpayment#payments/ocapiorderpayments_getcurrentredirectpayment/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1redirect~1current/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1redirect~1current/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/{orderId}/payments/redirect/current","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/orders/{orderId}/payments/redirect/current","href":"payments/ocapiorderpayments_getcurrentredirectpayment","openApiOperationId":"OcapiOrderPayments_GetCurrentRedirectPayment","summary":"Gets the current order redirect payment for an in progress order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPayment"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPayment"},{"code":"404","description":"Order does not exist, or redirect payment has not been created."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1redirect~1current/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPayment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPayment"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/payments/redirect/current"},{"label":"Creates an order payment card payment and completes the in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_createpaymentcardpayment","routeSlug":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_createpaymentcardpayment","metadata":{"seo":{"title":"Creates an order payment card payment and completes the in progress tab order","description":"The order must have an assigned in progress tab order PaymentCard and an unpaid balancein order to create an order payment card payment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderPayments_CreatePaymentCardPayment","name":"Creates an order payment card payment and completes the in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1payment-card/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates an order payment card payment and completes the in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order must have an assigned in progress tab order PaymentCard and an unpaid balance"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in order to create an order payment card payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment card will be charged for the unpaid balance of the in progress tab order"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapiorderpayments_createpaymentcardpayment/request/tabs/ocapiorderpayments_createpaymentcardpayment/request/orders/ocapiorderpayments_createpaymentcardpayment/request/licenses-required","deepLinkHash":"/payments/ocapiorderpayments_createpaymentcardpayment#payments/ocapiorderpayments_createpaymentcardpayment/request/tabs/ocapiorderpayments_createpaymentcardpayment/request/orders/ocapiorderpayments_createpaymentcardpayment/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress tab order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1payment-card/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1payment-card/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/payments/payment-card","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/payments/payment-card","href":"payments/ocapiorderpayments_createpaymentcardpayment","openApiOperationId":"OcapiOrderPayments_CreatePaymentCardPayment","summary":"Creates an order payment card payment and completes the in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}},"schemaId":"schema_38"},{"code":"400","description":"Order does not contain any concessions or Payment card declined."},{"code":"404","description":"Order or payment card does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1payments~1payment-card/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_38","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/payments/payment-card"},{"label":"Gets the web payment method options for an in progress order base, based on the provided order type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapiwebpaymentmethods_getwebpaymentmethods","routeSlug":"/openapi/digital-platform/openapi/payments/ocapiwebpaymentmethods_getwebpaymentmethods","metadata":{"seo":{"title":"Gets the web payment method options for an in progress order base, based on the provided order type","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiWebPaymentMethods_GetWebPaymentMethods","name":"Gets the web payment method options for an in progress order base, based on the provided order type","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1web-payment-methods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the web payment method options for an in progress order base, based on the provided order type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapiwebpaymentmethods_getwebpaymentmethods/request/licenses-required","deepLinkHash":"/payments/ocapiwebpaymentmethods_getwebpaymentmethods#payments/ocapiwebpaymentmethods_getwebpaymentmethods/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"orderType","in":"query","schemaId":"schema_55","description":"The type of the in progress order base that the web payment method entities are available for","required":true},{"name":"siteId","in":"query","schemaId":"schema_33","description":"The unique identifier of the site Only valid for in progress standard order and in progress tab order entities"}],"pointer":"/paths/~1ocapi~1v1~1web-payment-methods/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1web-payment-methods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/web-payment-methods","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"orderType","in":"query","required":true,"schemaId":"components/schemas/Vista.Connect.OrderType"},{"name":"siteId","in":"query","schemaId":"schema_33"}],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/ocapi/v1/web-payment-methods","href":"payments/ocapiwebpaymentmethods_getwebpaymentmethods","openApiOperationId":"OcapiWebPaymentMethods_GetWebPaymentMethods","summary":"Gets the web payment method options for an in progress order base, based on the provided order type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Payments.MasterData.WebPaymentMethodListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Payments.MasterData.WebPaymentMethodListDetails"},{"code":"400","description":"The provided order type, site, or gift shop does not exist."}],"pointer":"/paths/~1ocapi~1v1~1web-payment-methods/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Payments.MasterData.WebPaymentMethodListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Payments.MasterData.WebPaymentMethodListDetails"}}},{"code":"400"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/web-payment-methods"},{"label":"Set the primary member payment card for the currently authenticated member","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_setprimarymemberpaymentcard","routeSlug":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_setprimarymemberpaymentcard","metadata":{"seo":{"title":"Set the primary member payment card for the currently authenticated member","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberPaymentCards_SetPrimaryMemberPaymentCard","name":"Set the primary member payment card for the currently authenticated member","deprecated":true,"isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards~1primary/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set the primary member payment card for the currently authenticated member","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"payments/ocapimemberpaymentcards_setprimarymemberpaymentcard/request/licenses-required","deepLinkHash":"/payments/ocapimemberpaymentcards_setprimarymemberpaymentcard#payments/ocapimemberpaymentcards_setprimarymemberpaymentcard/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards~1primary/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberPrimaryPaymentCardUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberPrimaryPaymentCardUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberPrimaryPaymentCardUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberPrimaryPaymentCardUpdate"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberPrimaryPaymentCardUpdate","pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards~1primary/put/requestBody","description":"The values needed to update the member's primary member payment card"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/members/current/payment-cards/primary","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberPrimaryPaymentCardUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberPrimaryPaymentCardUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberPrimaryPaymentCardUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberPrimaryPaymentCardUpdate"}},"responseCodes":["204","400","401"],"pointer":"/ocapi/v1/members/current/payment-cards/primary","href":"payments/ocapimemberpaymentcards_setprimarymemberpaymentcard","openApiOperationId":"OcapiMemberPaymentCards_SetPrimaryMemberPaymentCard","summary":"Set the primary member payment card for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberPrimaryPaymentCardUpdate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberPrimaryPaymentCardUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberPrimaryPaymentCardUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberPrimaryPaymentCardUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberPrimaryPaymentCardUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member primary payment card updated."},{"code":"400","description":"Member payment card does not exist."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1payment-cards~1primary/put/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/payment-cards/primary"}],"content":{"contentType":"group","meta":{"name":"Payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payments","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/members/current/payment-cards","summary":"Gets the list of member payment card entities for the currently authenticated member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/ocapimemberpaymentcards_getmemberpaymentcards","deprecated":false},{"title":"/ocapi/v1/members/current/payment-cards/{memberPaymentCardId}","summary":"Gets a member payment card for the currently authenticated member by its unique identifier","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/ocapimemberpaymentcards_getmemberpaymentcard","deprecated":false},{"title":"/ocapi/v1/members/current/payment-cards/{memberPaymentCardId}","summary":"Removes a member payment card for the currently authenticated member","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payments/ocapimemberpaymentcards_removememberpaymentcard","deprecated":false},{"title":"/ocapi/v1/members/current/payment-cards/embedded","summary":"Loads and initiates the creation of a member payment card using an embedded UI for the currently authenticated member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/ocapimemberpaymentcards_creatememberembeddedpaymentcard","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/payment-card/embedded","summary":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/ocapiorderpaymentcard_createorderembeddedpaymentcard","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/payment-card/current","summary":"Gets the current order payment card for an in progress tab order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/ocapiorderpaymentcard_getcurrentorderpaymentcard","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/payments/{paymentId}","summary":"Removes an order payment base from an in progress order base","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payments/ocapiorderpayments_removepayment","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/payments/embedded","summary":"Creates a order embedded payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/ocapiorderpayments_createembeddedpayment","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/payments/embedded/current","summary":"Gets the current order embedded payment for an in progress order base","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/ocapiorderpayments_getcurrentembeddedpayment","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/payments/redirect","summary":"Creates an order redirect payment for an in progress order base","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/ocapiorderpayments_createredirectpayment","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/payments/redirect/current","summary":"Gets the current order redirect payment for an in progress order base","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/ocapiorderpayments_getcurrentredirectpayment","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/payments/payment-card","summary":"Creates an order payment card payment and completes the in progress tab order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/ocapiorderpayments_createpaymentcardpayment","deprecated":false},{"title":"/ocapi/v1/web-payment-methods","summary":"Gets the web payment method options for an in progress order base, based on the provided order type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/ocapiwebpaymentmethods_getwebpaymentmethods","deprecated":false},{"title":"/ocapi/v1/members/current/payment-cards/primary","summary":"Set the primary member payment card for the currently authenticated member","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/payments/ocapimemberpaymentcards_setprimarymemberpaymentcard","deprecated":true}]}]}]}]}},{"type":"group","label":"Member Rewards","link":"/openapi/digital-platform/openapi/member-rewards","routeSlug":"/openapi/digital-platform/openapi/member-rewards","items":[{"label":"Gets the list of member reward entities for the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/member-rewards/ocapimemberrewards_getmemberrewards","routeSlug":"/openapi/digital-platform/openapi/member-rewards/ocapimemberrewards_getmemberrewards","metadata":{"seo":{"title":"Gets the list of member reward entities for the currently authenticated member","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberRewards_GetMemberRewards","name":"Gets the list of member reward entities for the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1rewards/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the list of member reward entities for the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"member-rewards/ocapimemberrewards_getmemberrewards/request/members/ocapimemberrewards_getmemberrewards/request/licenses-required","deepLinkHash":"/member-rewards/ocapimemberrewards_getmemberrewards#member-rewards/ocapimemberrewards_getmemberrewards/request/members/ocapimemberrewards_getmemberrewards/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1rewards/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/rewards","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","401"],"pointer":"/ocapi/v1/members/current/rewards","href":"member-rewards/ocapimemberrewards_getmemberrewards","openApiOperationId":"OcapiMemberRewards_GetMemberRewards","summary":"Gets the list of member reward entities for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.MemberRewardListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.MemberRewardListDetails"},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1rewards/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.MemberRewardListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.MemberRewardListDetails"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/rewards"},{"label":"Gets the list of member reward availability entities for the currently authenticated\r\nmember and a particular showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/member-rewards/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime","routeSlug":"/openapi/digital-platform/openapi/member-rewards/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime","metadata":{"seo":{"title":"Gets the list of member reward availability entities for the currently authenticated\r\nmember and a particular showtime","description":"member reward availability entities are returned only for reward entities wherereward Restrictions includes reward restriction MemberRewardAvailability"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberRewards_GetMemberRewardAvailabilitiesForShowtime","name":"Gets the list of member reward availability entities for the currently authenticated\r\nmember and a particular showtime","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1reward-availability~1by-showtime~1{showtimeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the list of member reward availability entities for the currently authenticated\r\nmember and a particular showtime","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"member reward availability entities are returned only for reward entities where"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reward Restrictions includes reward restriction MemberRewardAvailability"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of member reward availability entities returned are subject to a configured limit."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If exceeded, the member reward availability entities returned are automatically truncated to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the configured limit."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"member-rewards/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime/request/members/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime/request/licenses-required","deepLinkHash":"/member-rewards/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime#member-rewards/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime/request/members/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"showtimeId","in":"path","schemaId":"schema_33","description":"The unique identifier of the showtime","required":true}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1reward-availability~1by-showtime~1{showtimeId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rewardIds","in":"query","schemaId":"schema_49","description":"Optional. The unique identifier of the reward entities to get member availabilty for"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1reward-availability~1by-showtime~1{showtimeId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1reward-availability~1by-showtime~1{showtimeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/reward-availability/by-showtime/{showtimeId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"showtimeId","in":"path","required":true,"schemaId":"schema_33"}],"query":[{"name":"rewardIds","in":"query","schemaId":"schema_49"}],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","401"],"pointer":"/ocapi/v1/members/current/reward-availability/by-showtime/{showtimeId}","href":"member-rewards/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime","openApiOperationId":"OcapiMemberRewards_GetMemberRewardAvailabilitiesForShowtime","summary":"Gets the list of member reward availability entities for the currently authenticated\r\nmember and a particular showtime"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.Availability.MemberRewardAvailabilityListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.Availability.MemberRewardAvailabilityListDetails"},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1reward-availability~1by-showtime~1{showtimeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.Availability.MemberRewardAvailabilityListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.Availability.MemberRewardAvailabilityListDetails"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/reward-availability/by-showtime/{showtimeId}"}],"content":{"contentType":"group","meta":{"name":"Member Rewards"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Member Rewards","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/members/current/rewards","summary":"Gets the list of member reward entities for the currently authenticated member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/member-rewards/ocapimemberrewards_getmemberrewards","deprecated":false},{"title":"/ocapi/v1/members/current/reward-availability/by-showtime/{showtimeId}","summary":"Gets the list of member reward availability entities for the currently authenticated\r\nmember and a particular showtime","prefix":{"name":"get","color":"get"},"badges":[],"link":"/member-rewards/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscriptions","link":"/openapi/digital-platform/openapi/subscriptions","routeSlug":"/openapi/digital-platform/openapi/subscriptions","items":[{"label":"Sets Vista as the payment provider for the member subscription belonging to the currently authenticated member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_setvistaassubscriptionpaymentprovider","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_setvistaassubscriptionpaymentprovider","metadata":{"seo":{"title":"Sets Vista as the payment provider for the member subscription belonging to the currently authenticated member","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberSubscription_SetVistaAsSubscriptionPaymentProvider","name":"Sets Vista as the payment provider for the member subscription belonging to the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1current~1billing~1payment-provider~1vista/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sets Vista as the payment provider for the member subscription belonging to the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"subscriptions/ocapimembersubscription_setvistaassubscriptionpaymentprovider/request/licenses-required","deepLinkHash":"/subscriptions/ocapimembersubscription_setvistaassubscriptionpaymentprovider#subscriptions/ocapimembersubscription_setvistaassubscriptionpaymentprovider/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Subscriptions"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1current~1billing~1payment-provider~1vista/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/members/current/subscriptions/current/billing/payment-provider/vista","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["204","400","401"],"pointer":"/ocapi/v1/members/current/subscriptions/current/billing/payment-provider/vista","href":"subscriptions/ocapimembersubscription_setvistaassubscriptionpaymentprovider","openApiOperationId":"OcapiMemberSubscription_SetVistaAsSubscriptionPaymentProvider","summary":"Sets Vista as the payment provider for the member subscription belonging to the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member subscription payment provider updated."},{"code":"400","description":"Member does not have a subscription, or subscription payment provider cannot be updated."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1current~1billing~1payment-provider~1vista/put/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/subscriptions/current/billing/payment-provider/vista"},{"label":"Loads and initiates the creation or selection of a member payment card using an embedded UI for\r\nthe current or future recurring member subscription of the currently authenticated member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_createrecurringsubscriptionembeddedpaymentcard","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_createrecurringsubscriptionembeddedpaymentcard","metadata":{"seo":{"title":"Loads and initiates the creation or selection of a member payment card using an embedded UI for\r\nthe current or future recurring member subscription of the currently authenticated member","description":"The member payment card will be used for recurring subscription billing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberSubscription_CreateRecurringSubscriptionEmbeddedPaymentCard","name":"Loads and initiates the creation or selection of a member payment card using an embedded UI for\r\nthe current or future recurring member subscription of the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1recurring~1payment-card~1embedded/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Loads and initiates the creation or selection of a member payment card using an embedded UI for\r\nthe current or future recurring member subscription of the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The member payment card will be used for recurring subscription billing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the member has a future recurring member subscription, the member payment card"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be authenticated for their future subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"subscriptions/ocapimembersubscription_createrecurringsubscriptionembeddedpaymentcard/request/licenses-required","deepLinkHash":"/subscriptions/ocapimembersubscription_createrecurringsubscriptionembeddedpaymentcard#subscriptions/ocapimembersubscription_createrecurringsubscriptionembeddedpaymentcard/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Subscriptions"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1recurring~1payment-card~1embedded/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.RecurringMemberSubscriptionEmbeddedPaymentCardCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.RecurringMemberSubscriptionEmbeddedPaymentCardCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.RecurringMemberSubscriptionEmbeddedPaymentCardCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.RecurringMemberSubscriptionEmbeddedPaymentCardCreate"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.RecurringMemberSubscriptionEmbeddedPaymentCardCreate","pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1recurring~1payment-card~1embedded/post/requestBody","description":"The values needed to create an embedded member payment card"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/current/subscriptions/recurring/payment-card/embedded","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.RecurringMemberSubscriptionEmbeddedPaymentCardCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.RecurringMemberSubscriptionEmbeddedPaymentCardCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.RecurringMemberSubscriptionEmbeddedPaymentCardCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.RecurringMemberSubscriptionEmbeddedPaymentCardCreate"}},"responseCodes":["200","400","401"],"pointer":"/ocapi/v1/members/current/subscriptions/recurring/payment-card/embedded","href":"subscriptions/ocapimembersubscription_createrecurringsubscriptionembeddedpaymentcard","openApiOperationId":"OcapiMemberSubscription_CreateRecurringSubscriptionEmbeddedPaymentCard","summary":"Loads and initiates the creation or selection of a member payment card using an embedded UI for\r\nthe current or future recurring member subscription of the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.RecurringMemberSubscriptionEmbeddedPaymentCardCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.RecurringMemberSubscriptionEmbeddedPaymentCardCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.RecurringMemberSubscriptionEmbeddedPaymentCardCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.RecurringMemberSubscriptionEmbeddedPaymentCardCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.RecurringMemberSubscriptionEmbeddedPaymentCardCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberEmbeddedPaymentCardClientData"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberEmbeddedPaymentCardClientData"},{"code":"400","description":"Member does not have a current or future recurring subscription."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1recurring~1payment-card~1embedded/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberEmbeddedPaymentCardClientData","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberEmbeddedPaymentCardClientData"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/subscriptions/recurring/payment-card/embedded"},{"label":"Initiates creation of a future recurring member subscription and also loads and initiates the\r\ncreation or selection of a member payment card using an embedded UI for the future recurring\r\nmember subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_createfuturerecurringsubscriptionpaymentcard","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_createfuturerecurringsubscriptionpaymentcard","metadata":{"seo":{"title":"Initiates creation of a future recurring member subscription and also loads and initiates the\r\ncreation or selection of a member payment card using an embedded UI for the future recurring\r\nmember subscription","description":"Upon creating or selecting the member payment card, the member's recurringmember subscriptions Future will be set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberSubscription_CreateFutureRecurringSubscriptionPaymentCard","name":"Initiates creation of a future recurring member subscription and also loads and initiates the\r\ncreation or selection of a member payment card using an embedded UI for the future recurring\r\nmember subscription","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1future-recurring~1payment-card~1embedded/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates creation of a future recurring member subscription and also loads and initiates the\r\ncreation or selection of a member payment card using an embedded UI for the future recurring\r\nmember subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upon creating or selecting the member payment card, the member's recurring"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"member subscriptions Future will be set."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The GetFutureRecurringSubscriptionCreation endpoint should be polled to determine the status of the future"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recurring subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets Vista as the payment provider for the member subscription, if not already set to Vista."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"subscriptions/ocapimembersubscription_createfuturerecurringsubscriptionpaymentcard/request/licenses-required","deepLinkHash":"/subscriptions/ocapimembersubscription_createfuturerecurringsubscriptionpaymentcard#subscriptions/ocapimembersubscription_createfuturerecurringsubscriptionpaymentcard/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Subscriptions"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1future-recurring~1payment-card~1embedded/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.FutureRecurringMemberSubscriptionEmbeddedPaymentCardCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.FutureRecurringMemberSubscriptionEmbeddedPaymentCardCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.FutureRecurringMemberSubscriptionEmbeddedPaymentCardCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.FutureRecurringMemberSubscriptionEmbeddedPaymentCardCreate"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.FutureRecurringMemberSubscriptionEmbeddedPaymentCardCreate","pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1future-recurring~1payment-card~1embedded/post/requestBody","description":"The values needed to create the future recurring subscription payment"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/current/subscriptions/future-recurring/payment-card/embedded","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.FutureRecurringMemberSubscriptionEmbeddedPaymentCardCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.FutureRecurringMemberSubscriptionEmbeddedPaymentCardCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.FutureRecurringMemberSubscriptionEmbeddedPaymentCardCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.FutureRecurringMemberSubscriptionEmbeddedPaymentCardCreate"}},"responseCodes":["200","400","401"],"pointer":"/ocapi/v1/members/current/subscriptions/future-recurring/payment-card/embedded","href":"subscriptions/ocapimembersubscription_createfuturerecurringsubscriptionpaymentcard","openApiOperationId":"OcapiMemberSubscription_CreateFutureRecurringSubscriptionPaymentCard","summary":"Initiates creation of a future recurring member subscription and also loads and initiates the\r\ncreation or selection of a member payment card using an embedded UI for the future recurring\r\nmember subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.FutureRecurringMemberSubscriptionEmbeddedPaymentCardCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.FutureRecurringMemberSubscriptionEmbeddedPaymentCardCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.FutureRecurringMemberSubscriptionEmbeddedPaymentCardCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.FutureRecurringMemberSubscriptionEmbeddedPaymentCardCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.FutureRecurringMemberSubscriptionEmbeddedPaymentCardCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberEmbeddedPaymentCardClientData"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberEmbeddedPaymentCardClientData"},{"code":"400","description":"Request property is invalid or missing, or member cannot set a future subscription."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1future-recurring~1payment-card~1embedded/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberEmbeddedPaymentCardClientData","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberEmbeddedPaymentCardClientData"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/subscriptions/future-recurring/payment-card/embedded"},{"label":"Gets the status of a created future recurring member subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_getfuturerecurringsubscriptioncreation","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_getfuturerecurringsubscriptioncreation","metadata":{"seo":{"title":"Gets the status of a created future recurring member subscription","description":"This endpoint may be polled to determine the creation status of the future recurring subscription after creating a future recurring subscription payment card."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberSubscription_GetFutureRecurringSubscriptionCreation","name":"Gets the status of a created future recurring member subscription","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1future-recurring~1creation/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the status of a created future recurring member subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint may be polled to determine the creation status of the future recurring subscription after creating a future recurring subscription payment card."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"subscriptions/ocapimembersubscription_getfuturerecurringsubscriptioncreation/request/licenses-required","deepLinkHash":"/subscriptions/ocapimembersubscription_getfuturerecurringsubscriptioncreation#subscriptions/ocapimembersubscription_getfuturerecurringsubscriptioncreation/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Subscriptions"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1future-recurring~1creation/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/subscriptions/future-recurring/creation","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","204","401"],"pointer":"/ocapi/v1/members/current/subscriptions/future-recurring/creation","href":"subscriptions/ocapimembersubscription_getfuturerecurringsubscriptioncreation","openApiOperationId":"OcapiMemberSubscription_GetFutureRecurringSubscriptionCreation","summary":"Gets the status of a created future recurring member subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.FutureRecurringMemberSubscriptionCreation"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.FutureRecurringMemberSubscriptionCreation"},{"code":"204","description":"Member does not have a future recurring subscription creation."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1future-recurring~1creation/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.FutureRecurringMemberSubscriptionCreation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.FutureRecurringMemberSubscriptionCreation"}}},{"code":"204"},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/subscriptions/future-recurring/creation"},{"label":"Cancels the current member subscription for the currently authenticated member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_cancelsubscription","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_cancelsubscription","metadata":{"seo":{"title":"Cancels the current member subscription for the currently authenticated member","description":"Members may cancel their member subscription if:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberSubscription_CancelSubscription","name":"Cancels the current member subscription for the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1current/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancels the current member subscription for the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Members may cancel their member subscription if:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Self-cancellation has been enabled in Loyalty;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The member is on a recurring billing option;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The member has an active or frozen account status;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The member has paid for all billing periods before the member subscription ContractedTermEndsAt"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"subscriptions/ocapimembersubscription_cancelsubscription/request/licenses-required","deepLinkHash":"/subscriptions/ocapimembersubscription_cancelsubscription#subscriptions/ocapimembersubscription_cancelsubscription/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Subscriptions"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1current/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ocapi/v1/members/current/subscriptions/current","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["204","400","401"],"pointer":"/ocapi/v1/members/current/subscriptions/current","href":"subscriptions/ocapimembersubscription_cancelsubscription","openApiOperationId":"OcapiMemberSubscription_CancelSubscription","summary":"Cancels the current member subscription for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member current subscription cancelled."},{"code":"400","description":"Member does not have a subscription, or member subscription cannot be cancelled."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1current/delete/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/subscriptions/current"},{"label":"Creates an in progress subscription order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapiorders_createsubscriptionorder","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapiorders_createsubscriptionorder","metadata":{"seo":{"title":"Creates an in progress subscription order","description":"If no subscription order action is provided, the subscription order Action will be defaulted to subscription order action Purchase"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrders_CreateSubscriptionOrder","name":"Creates an in progress subscription order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1subscription/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates an in progress subscription order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no subscription order action is provided, the subscription order Action will be defaulted to subscription order action Purchase"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders with the subscription order action Reactivate action will be created with the subscription order Subscription automatically set to the reactivation billing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"subscriptions/ocapiorders_createsubscriptionorder/request/licenses-required","deepLinkHash":"/subscriptions/ocapiorders_createsubscriptionorder#subscriptions/ocapiorders_createsubscriptionorder/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Subscriptions"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1subscription/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.SubscriptionOrderCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.SubscriptionOrderCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.SubscriptionOrderCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.SubscriptionOrderCreate"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.SubscriptionOrderCreate","pointer":"/paths/~1ocapi~1v1~1orders~1subscription/post/requestBody","description":"Details of the subscription order to be created"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/subscription","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.SubscriptionOrderCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.SubscriptionOrderCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.SubscriptionOrderCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.SubscriptionOrderCreate"}},"responseCodes":["200","400"],"pointer":"/ocapi/v1/orders/subscription","href":"subscriptions/ocapiorders_createsubscriptionorder","openApiOperationId":"OcapiOrders_CreateSubscriptionOrder","summary":"Creates an in progress subscription order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.SubscriptionOrderCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.SubscriptionOrderCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.SubscriptionOrderCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.SubscriptionOrderCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Requests.SubscriptionOrderCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressSubscriptionOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressSubscriptionOrderDetails"},{"code":"400","description":"Gift shop does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1subscription/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressSubscriptionOrderDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressSubscriptionOrderDetails"}}},{"code":"400"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/subscription"},{"label":"Sets the subscription for an in progress subscription order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapiordersubscriptions_setsubscriptionfororder","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapiordersubscriptions_setsubscriptionfororder","metadata":{"seo":{"title":"Sets the subscription for an in progress subscription order","description":"This endpoint cannot be used for an in progress subscription order withsubscription order Action equal to subscription order action Reactivate"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderSubscriptions_SetSubscriptionForOrder","name":"Sets the subscription for an in progress subscription order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1subscription/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sets the subscription for an in progress subscription order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint cannot be used for an in progress subscription order with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription order Action equal to subscription order action Reactivate"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"subscriptions/ocapiordersubscriptions_setsubscriptionfororder/request/licenses-required","deepLinkHash":"/subscriptions/ocapiordersubscriptions_setsubscriptionfororder#subscriptions/ocapiordersubscriptions_setsubscriptionfororder/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Subscriptions"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress subscription order being modified","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1subscription/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1subscription/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Subscriptions.Requests.OrderSubscriptionRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Subscriptions.Requests.OrderSubscriptionRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Subscriptions.Requests.OrderSubscriptionRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Subscriptions.Requests.OrderSubscriptionRequest"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Subscriptions.Requests.OrderSubscriptionRequest","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1subscription/put/requestBody","description":"The requested subscription"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/orders/{orderId}/subscription","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Subscriptions.Requests.OrderSubscriptionRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Subscriptions.Requests.OrderSubscriptionRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Subscriptions.Requests.OrderSubscriptionRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Subscriptions.Requests.OrderSubscriptionRequest"}},"responseCodes":["200","400","401","404"],"pointer":"/ocapi/v1/orders/{orderId}/subscription","href":"subscriptions/ocapiordersubscriptions_setsubscriptionfororder","openApiOperationId":"OcapiOrderSubscriptions_SetSubscriptionForOrder","summary":"Sets the subscription for an in progress subscription order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Subscriptions.Requests.OrderSubscriptionRequest","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Subscriptions.Requests.OrderSubscriptionRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Subscriptions.Requests.OrderSubscriptionRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Subscriptions.Requests.OrderSubscriptionRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Subscriptions.Requests.OrderSubscriptionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressSubscriptionOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressSubscriptionOrderDetails"},{"code":"400","description":"Request property is invalid or missing, or invalid order type."},{"code":"401","description":"No member authenticated."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1subscription/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressSubscriptionOrderDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressSubscriptionOrderDetails"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/subscription"},{"label":"Gets a list of subscription billing options and related data from active subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapisubscriptionbillingoptions_getsubscriptionbillingoptions","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapisubscriptionbillingoptions_getsubscriptionbillingoptions","metadata":{"seo":{"title":"Gets a list of subscription billing options and related data from active subscriptions","description":"Billing options of inactive subscriptions are not returned, as they can not be purchased."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiSubscriptionBillingOptions_GetSubscriptionBillingOptions","name":"Gets a list of subscription billing options and related data from active subscriptions","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1subscription-billing-options/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of subscription billing options and related data from active subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing options of inactive subscriptions are not returned, as they can not be purchased."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"subscriptions/ocapisubscriptionbillingoptions_getsubscriptionbillingoptions/request/licenses-required","deepLinkHash":"/subscriptions/ocapisubscriptionbillingoptions_getsubscriptionbillingoptions#subscriptions/ocapisubscriptionbillingoptions_getsubscriptionbillingoptions/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Subscriptions"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1subscription-billing-options/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/subscription-billing-options","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/ocapi/v1/subscription-billing-options","href":"subscriptions/ocapisubscriptionbillingoptions_getsubscriptionbillingoptions","openApiOperationId":"OcapiSubscriptionBillingOptions_GetSubscriptionBillingOptions","summary":"Gets a list of subscription billing options and related data from active subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.SubscriptionBillingOptions.SubscriptionBillingOptionListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.SubscriptionBillingOptions.SubscriptionBillingOptionListDetails"}],"pointer":"/paths/~1ocapi~1v1~1subscription-billing-options/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.SubscriptionBillingOptions.SubscriptionBillingOptionListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.SubscriptionBillingOptions.SubscriptionBillingOptionListDetails"}}}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/subscription-billing-options"},{"label":"Sets the member subscriptions Future recurring subscription billing option for the currently authenticated member","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_setfuturerecurringsubscription","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_setfuturerecurringsubscription","metadata":{"seo":{"title":"Sets the member subscriptions Future recurring subscription billing option for the currently authenticated member","description":"Members may select a future recurring subscription billing option regardless of their member subscriptions Current subscription, allowing them tochange subscription or extend existing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberSubscription_SetFutureRecurringSubscription","name":"Sets the member subscriptions Future recurring subscription billing option for the currently authenticated member","deprecated":true,"isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1future-recurring/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sets the member subscriptions Future recurring subscription billing option for the currently authenticated member","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Members may select a future recurring subscription billing option regardless of their member subscriptions Current subscription, allowing them to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"change subscription or extend existing."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"subscriptions/ocapimembersubscription_setfuturerecurringsubscription/request/licenses-required","deepLinkHash":"/subscriptions/ocapimembersubscription_setfuturerecurringsubscription#subscriptions/ocapimembersubscription_setfuturerecurringsubscription/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Subscriptions"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1future-recurring/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.MemberFutureRecurringSubscriptionSelection"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.MemberFutureRecurringSubscriptionSelection"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.MemberFutureRecurringSubscriptionSelection"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.MemberFutureRecurringSubscriptionSelection"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.MemberFutureRecurringSubscriptionSelection","pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1future-recurring/post/requestBody","description":"The selected subscription option"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/current/subscriptions/future-recurring","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.MemberFutureRecurringSubscriptionSelection"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.MemberFutureRecurringSubscriptionSelection"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.MemberFutureRecurringSubscriptionSelection"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.MemberFutureRecurringSubscriptionSelection"}},"responseCodes":["204","400","401"],"pointer":"/ocapi/v1/members/current/subscriptions/future-recurring","href":"subscriptions/ocapimembersubscription_setfuturerecurringsubscription","openApiOperationId":"OcapiMemberSubscription_SetFutureRecurringSubscription","summary":"Sets the member subscriptions Future recurring subscription billing option for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.MemberFutureRecurringSubscriptionSelection","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.MemberFutureRecurringSubscriptionSelection"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.MemberFutureRecurringSubscriptionSelection"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.MemberFutureRecurringSubscriptionSelection"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.MemberFutureRecurringSubscriptionSelection"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member future recurring subscription set."},{"code":"400","description":"Request property is invalid or missing, or member cannot set a future subscription."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1future-recurring/post/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/subscriptions/future-recurring"},{"label":"Reactivates the current member subscription for the currently authenticated member","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_reactivatesubscription","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_reactivatesubscription","metadata":{"seo":{"title":"Reactivates the current member subscription for the currently authenticated member","description":"Members may select to reactivate their member subscription after it has been frozen for payment failure.On reactivation this will deduct the money from the member's default member payment card"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberSubscription_ReactivateSubscription","name":"Reactivates the current member subscription for the currently authenticated member","deprecated":true,"isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1current~1reactivate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reactivates the current member subscription for the currently authenticated member","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Members may select to reactivate their member subscription after it has been frozen for payment failure."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On reactivation this will deduct the money from the member's default member payment card"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"subscriptions/ocapimembersubscription_reactivatesubscription/request/licenses-required","deepLinkHash":"/subscriptions/ocapimembersubscription_reactivatesubscription#subscriptions/ocapimembersubscription_reactivatesubscription/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Subscriptions"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1current~1reactivate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/current/subscriptions/current/reactivate","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["204","400","401"],"pointer":"/ocapi/v1/members/current/subscriptions/current/reactivate","href":"subscriptions/ocapimembersubscription_reactivatesubscription","openApiOperationId":"OcapiMemberSubscription_ReactivateSubscription","summary":"Reactivates the current member subscription for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member subscription reactivated."},{"code":"400","description":"Member does not have a subscription, or member subscription cannot be reactivated."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1subscriptions~1current~1reactivate/post/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/subscriptions/current/reactivate"}],"content":{"contentType":"group","meta":{"name":"Subscriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriptions","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/members/current/subscriptions/current/billing/payment-provider/vista","summary":"Sets Vista as the payment provider for the member subscription belonging to the currently authenticated member","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subscriptions/ocapimembersubscription_setvistaassubscriptionpaymentprovider","deprecated":false},{"title":"/ocapi/v1/members/current/subscriptions/recurring/payment-card/embedded","summary":"Loads and initiates the creation or selection of a member payment card using an embedded UI for\r\nthe current or future recurring member subscription of the currently authenticated member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/ocapimembersubscription_createrecurringsubscriptionembeddedpaymentcard","deprecated":false},{"title":"/ocapi/v1/members/current/subscriptions/future-recurring/payment-card/embedded","summary":"Initiates creation of a future recurring member subscription and also loads and initiates the\r\ncreation or selection of a member payment card using an embedded UI for the future recurring\r\nmember subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/ocapimembersubscription_createfuturerecurringsubscriptionpaymentcard","deprecated":false},{"title":"/ocapi/v1/members/current/subscriptions/future-recurring/creation","summary":"Gets the status of a created future recurring member subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/ocapimembersubscription_getfuturerecurringsubscriptioncreation","deprecated":false},{"title":"/ocapi/v1/members/current/subscriptions/current","summary":"Cancels the current member subscription for the currently authenticated member","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscriptions/ocapimembersubscription_cancelsubscription","deprecated":false},{"title":"/ocapi/v1/orders/subscription","summary":"Creates an in progress subscription order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/ocapiorders_createsubscriptionorder","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/subscription","summary":"Sets the subscription for an in progress subscription order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subscriptions/ocapiordersubscriptions_setsubscriptionfororder","deprecated":false},{"title":"/ocapi/v1/subscription-billing-options","summary":"Gets a list of subscription billing options and related data from active subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/ocapisubscriptionbillingoptions_getsubscriptionbillingoptions","deprecated":false},{"title":"/ocapi/v1/members/current/subscriptions/future-recurring","summary":"Sets the member subscriptions Future recurring subscription billing option for the currently authenticated member","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/subscriptions/ocapimembersubscription_setfuturerecurringsubscription","deprecated":true},{"title":"/ocapi/v1/members/current/subscriptions/current/reactivate","summary":"Reactivates the current member subscription for the currently authenticated member","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/subscriptions/ocapimembersubscription_reactivatesubscription","deprecated":true}]}]}]}]}},{"type":"group","label":"Ticket Redemption Cards","link":"/openapi/digital-platform/openapi/ticket-redemption-cards","routeSlug":"/openapi/digital-platform/openapi/ticket-redemption-cards","items":[{"label":"Gets the list of member ticket redemption card base entities for the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/ticket-redemption-cards/ocapimemberticketredemptioncards_getmemberticketredemptioncards","routeSlug":"/openapi/digital-platform/openapi/ticket-redemption-cards/ocapimemberticketredemptioncards_getmemberticketredemptioncards","metadata":{"seo":{"title":"Gets the list of member ticket redemption card base entities for the currently authenticated member","description":"Includes ticket redemption cards which have been shared to the member by their friends."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberTicketRedemptionCards_GetMemberTicketRedemptionCards","name":"Gets the list of member ticket redemption card base entities for the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1ticket-redemption-cards/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the list of member ticket redemption card base entities for the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes ticket redemption cards which have been shared to the member by their friends."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"ticket-redemption-cards/ocapimemberticketredemptioncards_getmemberticketredemptioncards/request/licenses-required","deepLinkHash":"/ticket-redemption-cards/ocapimemberticketredemptioncards_getmemberticketredemptioncards#ticket-redemption-cards/ocapimemberticketredemptioncards_getmemberticketredemptioncards/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1ticket-redemption-cards/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/ticket-redemption-cards","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","401"],"pointer":"/ocapi/v1/members/current/ticket-redemption-cards","href":"ticket-redemption-cards/ocapimemberticketredemptioncards_getmemberticketredemptioncards","openApiOperationId":"OcapiMemberTicketRedemptionCards_GetMemberTicketRedemptionCards","summary":"Gets the list of member ticket redemption card base entities for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.TicketRedemptionCards.MemberTicketRedemptionCardsDetails"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.TicketRedemptionCards.MemberTicketRedemptionCardsDetails"},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1ticket-redemption-cards/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.TicketRedemptionCards.MemberTicketRedemptionCardsDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.TicketRedemptionCards.MemberTicketRedemptionCardsDetails"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/ticket-redemption-cards"},{"label":"Adds a ticket redemption card to an in progress standard order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/ticket-redemption-cards/ocapiorderticketredemptioncards_addticketredemptioncard","routeSlug":"/openapi/digital-platform/openapi/ticket-redemption-cards/ocapiorderticketredemptioncards_addticketredemptioncard","metadata":{"seo":{"title":"Adds a ticket redemption card to an in progress standard order","description":"This endpoint validates the provided third party member card credentials or member ticket redemption card baseand stores a successfully validated card against the order for later use."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderTicketRedemptionCards_AddTicketRedemptionCard","name":"Adds a ticket redemption card to an in progress standard order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1ticket-redemption-cards/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adds a ticket redemption card to an in progress standard order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint validates the provided third party member card credentials or member ticket redemption card base"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and stores a successfully validated card against the order for later use."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For third party member card entities belonging to a third party member scheme that supports partial approvals,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an arbitrarily large number of tickets will be requested to determine how many redemptions are actually available."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For third party member card entities belonging to a third party member scheme that does not support partial approvals,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the number of tickets requested will depend on a preconfigured quantity per showtime, or only one ticket if no quantity has been configured."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint cannot be used for orders that have a parent order (see standard order ParentOrderId)"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"ticket-redemption-cards/ocapiorderticketredemptioncards_addticketredemptioncard/request/licenses-required","deepLinkHash":"/ticket-redemption-cards/ocapiorderticketredemptioncards_addticketredemptioncard#ticket-redemption-cards/ocapiorderticketredemptioncards_addticketredemptioncard/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress standard order being modified","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1ticket-redemption-cards/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1ticket-redemption-cards/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_56"},"text/json":{"schemaId":"schema_56"},"application/*+json":{"schemaId":"schema_56"},"application/json-patch+json":{"schemaId":"schema_56"}},"schemaId":"schema_56","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1ticket-redemption-cards/post/requestBody","description":"The details of the ticket redemption card to be added"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/ticket-redemption-cards","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_56"},"text/json":{"schemaId":"schema_56"},"application/*+json":{"schemaId":"schema_56"},"application/json-patch+json":{"schemaId":"schema_56"}},"responseCodes":["200","400","401","404"],"pointer":"/ocapi/v1/orders/{orderId}/ticket-redemption-cards","href":"ticket-redemption-cards/ocapiorderticketredemptioncards_addticketredemptioncard","openApiOperationId":"OcapiOrderTicketRedemptionCards_AddTicketRedemptionCard","summary":"Adds a ticket redemption card to an in progress standard order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_56","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_56"},"text/json":{"schemaId":"schema_56"},"application/*+json":{"schemaId":"schema_56"},"application/json-patch+json":{"schemaId":"schema_56"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderTicketRedemptionCardDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderTicketRedemptionCardDetails"},{"code":"400","description":"Request property is invalid or missing, or invalid order type/card."},{"code":"401","description":"No member authenticated."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1ticket-redemption-cards/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderTicketRedemptionCardDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderTicketRedemptionCardDetails"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/ticket-redemption-cards"}],"content":{"contentType":"group","meta":{"name":"Ticket Redemption Cards"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Redemption Cards","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/members/current/ticket-redemption-cards","summary":"Gets the list of member ticket redemption card base entities for the currently authenticated member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ticket-redemption-cards/ocapimemberticketredemptioncards_getmemberticketredemptioncards","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/ticket-redemption-cards","summary":"Adds a ticket redemption card to an in progress standard order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ticket-redemption-cards/ocapiorderticketredemptioncards_addticketredemptioncard","deprecated":false}]}]}]}]}},{"type":"group","label":"Credentials","link":"/openapi/digital-platform/openapi/credentials","routeSlug":"/openapi/digital-platform/openapi/credentials","items":[{"label":"Updates the email address of the currently authenticated member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/credentials/ocapimemberupdate_setmemberemail","routeSlug":"/openapi/digital-platform/openapi/credentials/ocapimemberupdate_setmemberemail","metadata":{"seo":{"title":"Updates the email address of the currently authenticated member","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberUpdate_SetMemberEmail","name":"Updates the email address of the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1credentials~1email/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates the email address of the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"credentials/ocapimemberupdate_setmemberemail/request/licenses-required","deepLinkHash":"/credentials/ocapimemberupdate_setmemberemail#credentials/ocapimemberupdate_setmemberemail/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1credentials~1email/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberEmailUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberEmailUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberEmailUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberEmailUpdate"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberEmailUpdate","pointer":"/paths/~1ocapi~1v1~1members~1current~1credentials~1email/put/requestBody","description":"Updated email address and logged in member's current password for verification"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/members/current/credentials/email","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberEmailUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberEmailUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberEmailUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberEmailUpdate"}},"responseCodes":["204","400","401"],"pointer":"/ocapi/v1/members/current/credentials/email","href":"credentials/ocapimemberupdate_setmemberemail","openApiOperationId":"OcapiMemberUpdate_SetMemberEmail","summary":"Updates the email address of the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberEmailUpdate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberEmailUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberEmailUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberEmailUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberEmailUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member email updated."},{"code":"400","description":"Request property is invalid or missing, or password validation failed."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1credentials~1email/put/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/credentials/email"},{"label":"Updates the password of the currently authenticated member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/credentials/ocapimemberupdate_setmemberpassword","routeSlug":"/openapi/digital-platform/openapi/credentials/ocapimemberupdate_setmemberpassword","metadata":{"seo":{"title":"Updates the password of the currently authenticated member","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberUpdate_SetMemberPassword","name":"Updates the password of the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1credentials~1password/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates the password of the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"credentials/ocapimemberupdate_setmemberpassword/request/licenses-required","deepLinkHash":"/credentials/ocapimemberupdate_setmemberpassword#credentials/ocapimemberupdate_setmemberpassword/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1credentials~1password/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberPasswordUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberPasswordUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberPasswordUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberPasswordUpdate"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberPasswordUpdate","pointer":"/paths/~1ocapi~1v1~1members~1current~1credentials~1password/put/requestBody","description":"Updated password and logged in member's current password for verification"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/members/current/credentials/password","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberPasswordUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberPasswordUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberPasswordUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberPasswordUpdate"}},"responseCodes":["204","400","401"],"pointer":"/ocapi/v1/members/current/credentials/password","href":"credentials/ocapimemberupdate_setmemberpassword","openApiOperationId":"OcapiMemberUpdate_SetMemberPassword","summary":"Updates the password of the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberPasswordUpdate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberPasswordUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberPasswordUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberPasswordUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberPasswordUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member password updated."},{"code":"400","description":"Request property is invalid or missing, or password validation failed."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1credentials~1password/put/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/credentials/password"},{"label":"Updates the username of the currently authenticated member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/credentials/ocapimemberupdate_setmemberusername","routeSlug":"/openapi/digital-platform/openapi/credentials/ocapimemberupdate_setmemberusername","metadata":{"seo":{"title":"Updates the username of the currently authenticated member","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberUpdate_SetMemberUsername","name":"Updates the username of the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1credentials~1username/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates the username of the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"credentials/ocapimemberupdate_setmemberusername/request/licenses-required","deepLinkHash":"/credentials/ocapimemberupdate_setmemberusername#credentials/ocapimemberupdate_setmemberusername/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1credentials~1username/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberUsernameUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberUsernameUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberUsernameUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberUsernameUpdate"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberUsernameUpdate","pointer":"/paths/~1ocapi~1v1~1members~1current~1credentials~1username/put/requestBody","description":"Updated username and logged in member's current password for verification"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/members/current/credentials/username","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberUsernameUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberUsernameUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberUsernameUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberUsernameUpdate"}},"responseCodes":["204","400","401"],"pointer":"/ocapi/v1/members/current/credentials/username","href":"credentials/ocapimemberupdate_setmemberusername","openApiOperationId":"OcapiMemberUpdate_SetMemberUsername","summary":"Updates the username of the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberUsernameUpdate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberUsernameUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberUsernameUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberUsernameUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberUsernameUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member username updated."},{"code":"400","description":"Request property is invalid or missing, or password validation failed."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1credentials~1username/put/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/credentials/username"}],"content":{"contentType":"group","meta":{"name":"Credentials"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credentials","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/members/current/credentials/email","summary":"Updates the email address of the currently authenticated member","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credentials/ocapimemberupdate_setmemberemail","deprecated":false},{"title":"/ocapi/v1/members/current/credentials/password","summary":"Updates the password of the currently authenticated member","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credentials/ocapimemberupdate_setmemberpassword","deprecated":false},{"title":"/ocapi/v1/members/current/credentials/username","summary":"Updates the username of the currently authenticated member","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credentials/ocapimemberupdate_setmemberusername","deprecated":false}]}]}]}]}},{"type":"group","label":"Watched Films","link":"/openapi/digital-platform/openapi/watched-films","routeSlug":"/openapi/digital-platform/openapi/watched-films","items":[{"label":"Gets a list of member watched film entities for the currently authenticated member, and their related data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/watched-films/ocapimemberwatchedfilms_getmemberwatchedfilms","routeSlug":"/openapi/digital-platform/openapi/watched-films/ocapimemberwatchedfilms_getmemberwatchedfilms","metadata":{"seo":{"title":"Gets a list of member watched film entities for the currently authenticated member, and their related data","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberWatchedFilms_GetMemberWatchedFilms","name":"Gets a list of member watched film entities for the currently authenticated member, and their related data","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1watched-films/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of member watched film entities for the currently authenticated member, and their related data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"watched-films/ocapimemberwatchedfilms_getmemberwatchedfilms/request/licenses-required","deepLinkHash":"/watched-films/ocapimemberwatchedfilms_getmemberwatchedfilms#watched-films/ocapimemberwatchedfilms_getmemberwatchedfilms/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"year","in":"query","schemaId":"schema_57","description":"The year of the requested member watched film entities","required":true}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1watched-films/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1watched-films/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/watched-films","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"year","in":"query","required":true,"schemaId":"schema_57"}],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/ocapi/v1/members/current/watched-films","href":"watched-films/ocapimemberwatchedfilms_getmemberwatchedfilms","openApiOperationId":"OcapiMemberWatchedFilms_GetMemberWatchedFilms","summary":"Gets a list of member watched film entities for the currently authenticated member, and their related data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchedFilms.MemberWatchedFilmListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchedFilms.MemberWatchedFilmListDetails"},{"code":"400","description":"Invalid year value, must be a positive value greater than zero."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1watched-films/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchedFilms.MemberWatchedFilmListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchedFilms.MemberWatchedFilmListDetails"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/watched-films"}],"content":{"contentType":"group","meta":{"name":"Watched Films"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Watched Films","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/members/current/watched-films","summary":"Gets a list of member watched film entities for the currently authenticated member, and their related data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/watched-films/ocapimemberwatchedfilms_getmemberwatchedfilms","deprecated":false}]}]}]}]}},{"type":"group","label":"Watchlist Films","link":"/openapi/digital-platform/openapi/watchlist-films","routeSlug":"/openapi/digital-platform/openapi/watchlist-films","items":[{"label":"Gets the list of member watchlist film entities for the currently authenticated member, and their related data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/watchlist-films/ocapimemberwatchlistfilms_getwatchlistfilms","routeSlug":"/openapi/digital-platform/openapi/watchlist-films/ocapimemberwatchlistfilms_getwatchlistfilms","metadata":{"seo":{"title":"Gets the list of member watchlist film entities for the currently authenticated member, and their related data","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberWatchlistFilms_GetWatchlistFilms","name":"Gets the list of member watchlist film entities for the currently authenticated member, and their related data","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1watchlist-films/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the list of member watchlist film entities for the currently authenticated member, and their related data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"watchlist-films/ocapimemberwatchlistfilms_getwatchlistfilms/request/licenses-required","deepLinkHash":"/watchlist-films/ocapimemberwatchlistfilms_getwatchlistfilms#watchlist-films/ocapimemberwatchlistfilms_getwatchlistfilms/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1watchlist-films/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/members/current/watchlist-films","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","401"],"pointer":"/ocapi/v1/members/current/watchlist-films","href":"watchlist-films/ocapimemberwatchlistfilms_getwatchlistfilms","openApiOperationId":"OcapiMemberWatchlistFilms_GetWatchlistFilms","summary":"Gets the list of member watchlist film entities for the currently authenticated member, and their related data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmListDetails"},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1watchlist-films/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmListDetails"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/members/current/watchlist-films"},{"label":"Adds a member watchlist film for the currently authenticated member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/watchlist-films/ocapimemberwatchlistfilms_addwatchlistfilm","routeSlug":"/openapi/digital-platform/openapi/watchlist-films/ocapimemberwatchlistfilms_addwatchlistfilm","metadata":{"seo":{"title":"Adds a member watchlist film for the currently authenticated member","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberWatchlistFilms_AddWatchlistFilm","name":"Adds a member watchlist film for the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1watchlist-films/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adds a member watchlist film for the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"watchlist-films/ocapimemberwatchlistfilms_addwatchlistfilm/request/licenses-required","deepLinkHash":"/watchlist-films/ocapimemberwatchlistfilms_addwatchlistfilm#watchlist-films/ocapimemberwatchlistfilms_addwatchlistfilm/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1watchlist-films/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmCreate"}},"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmCreate","pointer":"/paths/~1ocapi~1v1~1members~1current~1watchlist-films/post/requestBody","description":"The details of the film to add to the member's watchlist"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/members/current/watchlist-films","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmCreate"}},"responseCodes":["204","400","401"],"pointer":"/ocapi/v1/members/current/watchlist-films","href":"watchlist-films/ocapimemberwatchlistfilms_addwatchlistfilm","openApiOperationId":"OcapiMemberWatchlistFilms_AddWatchlistFilm","summary":"Adds a member watchlist film for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member watchlist film created."},{"code":"400","description":"Request property is invalid or missing."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1watchlist-films/post/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/watchlist-films"},{"label":"Removes a member watchlist film for the currently authenticated member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/watchlist-films/ocapimemberwatchlistfilms_removewatchlistfilm","routeSlug":"/openapi/digital-platform/openapi/watchlist-films/ocapimemberwatchlistfilms_removewatchlistfilm","metadata":{"seo":{"title":"Removes a member watchlist film for the currently authenticated member","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiMemberWatchlistFilms_RemoveWatchlistFilm","name":"Removes a member watchlist film for the currently authenticated member","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1members~1current~1watchlist-films~1{filmId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removes a member watchlist film for the currently authenticated member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"watchlist-films/ocapimemberwatchlistfilms_removewatchlistfilm/request/licenses-required","deepLinkHash":"/watchlist-films/ocapimemberwatchlistfilms_removewatchlistfilm#watchlist-films/ocapimemberwatchlistfilms_removewatchlistfilm/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"filmId","in":"path","schemaId":"schema_33","description":"The unique identifier of the film to remove from the member's watchlist","required":true}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1watchlist-films~1{filmId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33","description":"Current Loyalty session token, represents a 'signed-in' member"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1watchlist-films~1{filmId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ocapi/v1/members/current/watchlist-films/{filmId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"filmId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"loyaltySessionToken","in":"header","schemaId":"schema_33"},{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["204","401"],"pointer":"/ocapi/v1/members/current/watchlist-films/{filmId}","href":"watchlist-films/ocapimemberwatchlistfilms_removewatchlistfilm","openApiOperationId":"OcapiMemberWatchlistFilms_RemoveWatchlistFilm","summary":"Removes a member watchlist film for the currently authenticated member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Member watchlist film removed."},{"code":"401","description":"No member authenticated."}],"pointer":"/paths/~1ocapi~1v1~1members~1current~1watchlist-films~1{filmId}/delete/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/members/current/watchlist-films/{filmId}"}],"content":{"contentType":"group","meta":{"name":"Watchlist Films"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Watchlist Films","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/members/current/watchlist-films","summary":"Gets the list of member watchlist film entities for the currently authenticated member, and their related data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/watchlist-films/ocapimemberwatchlistfilms_getwatchlistfilms","deprecated":false},{"title":"/ocapi/v1/members/current/watchlist-films","summary":"Adds a member watchlist film for the currently authenticated member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/watchlist-films/ocapimemberwatchlistfilms_addwatchlistfilm","deprecated":false},{"title":"/ocapi/v1/members/current/watchlist-films/{filmId}","summary":"Removes a member watchlist film for the currently authenticated member","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/watchlist-films/ocapimemberwatchlistfilms_removewatchlistfilm","deprecated":false}]}]}]}]}},{"type":"group","label":"Completion","link":"/openapi/digital-platform/openapi/completion","routeSlug":"/openapi/digital-platform/openapi/completion","items":[{"label":"Creates an order completion for an in progress order base","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completion/ocapiordercompletion_createordercompletion","routeSlug":"/openapi/digital-platform/openapi/completion/ocapiordercompletion_createordercompletion","metadata":{"seo":{"title":"Creates an order completion for an in progress order base","description":"An order completion is automatically created upon completion of the following payment types:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderCompletion_CreateOrderCompletion","name":"Creates an order completion for an in progress order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1completion/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates an order completion for an in progress order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An order completion is automatically created upon completion of the following payment types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"list","attrs":{"type":"bullet"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"item","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"description","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\norder embedded payment\n"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"item","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"description","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\norder redirect payment\n"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"item","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"description","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\norder payment card payment\n"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An order completion must be manually created for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"list","attrs":{"type":"bullet"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"item","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"description","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Zero value orders"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"item","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"description","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Unpaid orders"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"item","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"description","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Orders paid entirely by order gift card payment or order member balance payment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n#### Licenses Required\n"},"children":[]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.EmbeddedPayment"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base being completed","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1completion/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1completion/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/completion","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/completion","href":"completion/ocapiordercompletion_createordercompletion","openApiOperationId":"OcapiOrderCompletion_CreateOrderCompletion","summary":"Creates an order completion for an in progress order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}},"schemaId":"schema_38"},{"code":"400","description":"Order cannot be completed."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1completion/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_38","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/completion"},{"label":"Gets the order completion for an in progress order base","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completion/ocapiordercompletion_getordercompletion","routeSlug":"/openapi/digital-platform/openapi/completion/ocapiordercompletion_getordercompletion","metadata":{"seo":{"title":"Gets the order completion for an in progress order base","description":"This endpoint may be polled to determine when the order completion has been finished."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderCompletion_GetOrderCompletion","name":"Gets the order completion for an in progress order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1completion/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the order completion for an in progress order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint may be polled to determine when the order completion has been finished."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"completion/ocapiordercompletion_getordercompletion/request/licenses-required","deepLinkHash":"/completion/ocapiordercompletion_getordercompletion#completion/ocapiordercompletion_getordercompletion/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.EmbeddedPayment"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1completion/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1completion/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/{orderId}/completion","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/orders/{orderId}/completion","href":"completion/ocapiordercompletion_getordercompletion","openApiOperationId":"OcapiOrderCompletion_GetOrderCompletion","summary":"Gets the order completion for an in progress order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}},"schemaId":"schema_38"},{"code":"404","description":"Order does not exist, or completion has not been created."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1completion/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_38","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/completion"}],"content":{"contentType":"group","meta":{"name":"Completion"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Completion","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/orders/{orderId}/completion","summary":"Creates an order completion for an in progress order base","prefix":{"name":"post","color":"post"},"badges":[],"link":"/completion/ocapiordercompletion_createordercompletion","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/completion","summary":"Gets the order completion for an in progress order base","prefix":{"name":"get","color":"get"},"badges":[],"link":"/completion/ocapiordercompletion_getordercompletion","deprecated":false}]}]}]}]}},{"type":"group","label":"Gift shop","link":"/openapi/digital-platform/openapi/gift-shop","routeSlug":"/openapi/digital-platform/openapi/gift-shop","items":[{"label":"Creates an in progress gift shop order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/gift-shop/ocapiorders_creategiftshoporder","routeSlug":"/openapi/digital-platform/openapi/gift-shop/ocapiorders_creategiftshoporder","metadata":{"seo":{"title":"Creates an in progress gift shop order","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrders_CreateGiftShopOrder","name":"Creates an in progress gift shop order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1gift-shop/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates an in progress gift shop order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"gift-shop/ocapiorders_creategiftshoporder/request/licenses-required","deepLinkHash":"/gift-shop/ocapiorders_creategiftshoporder#gift-shop/ocapiorders_creategiftshoporder/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1gift-shop/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/gift-shop","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/ocapi/v1/orders/gift-shop","href":"gift-shop/ocapiorders_creategiftshoporder","openApiOperationId":"OcapiOrders_CreateGiftShopOrder","summary":"Creates an in progress gift shop order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressGiftShopOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressGiftShopOrderDetails"},{"code":"400","description":"Gift shop does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1gift-shop/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressGiftShopOrderDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressGiftShopOrderDetails"}}},{"code":"400"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/gift-shop"}],"content":{"contentType":"group","meta":{"name":"Gift shop"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gift shop","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/orders/gift-shop","summary":"Creates an in progress gift shop order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gift-shop/ocapiorders_creategiftshoporder","deprecated":false}]}]}]}]}},{"type":"group","label":"Vouchers","link":"/openapi/digital-platform/openapi/vouchers","routeSlug":"/openapi/digital-platform/openapi/vouchers","items":[{"label":"Removes a voucher from an in progress order base","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/vouchers/ocapiordervouchers_removevoucher","routeSlug":"/openapi/digital-platform/openapi/vouchers/ocapiordervouchers_removevoucher","metadata":{"seo":{"title":"Removes a voucher from an in progress order base","description":"This endpoint is not available for in progress tab order entities."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderVouchers_RemoveVoucher","name":"Removes a voucher from an in progress order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1vouchers~1{voucherId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removes a voucher from an in progress order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is not available for in progress tab order entities."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the voucher is not a deal voucher, all usages of the voucher on the order must be cancelled before the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"voucher can be removed."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"vouchers/ocapiordervouchers_removevoucher/request/orders/ocapiordervouchers_removevoucher/request/licenses-required","deepLinkHash":"/vouchers/ocapiordervouchers_removevoucher#vouchers/ocapiordervouchers_removevoucher/request/orders/ocapiordervouchers_removevoucher/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base being modified","required":true},{"name":"voucherId","in":"path","schemaId":"schema_33","description":"The unique identifier of the order voucher being removed","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1vouchers~1{voucherId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1vouchers~1{voucherId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ocapi/v1/orders/{orderId}/vouchers/{voucherId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"},{"name":"voucherId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["204","400"],"pointer":"/ocapi/v1/orders/{orderId}/vouchers/{voucherId}","href":"vouchers/ocapiordervouchers_removevoucher","openApiOperationId":"OcapiOrderVouchers_RemoveVoucher","summary":"Removes a voucher from an in progress order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Voucher removed."},{"code":"400","description":"Voucher cannot be removed."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1vouchers~1{voucherId}/delete/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/orders/{orderId}/vouchers/{voucherId}"},{"label":"Adds a voucher to an in progress order base","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/vouchers/ocapiordervouchers_addvoucher","routeSlug":"/openapi/digital-platform/openapi/vouchers/ocapiordervouchers_addvoucher","metadata":{"seo":{"title":"Adds a voucher to an in progress order base","description":"This endpoint is not available for in progress tab order entities."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiOrderVouchers_AddVoucher","name":"Adds a voucher to an in progress order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1vouchers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adds a voucher to an in progress order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is not available for in progress tab order entities."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint validates the provided voucher credentials and stores a successfully validated voucher against the order for later use."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"vouchers/ocapiordervouchers_addvoucher/request/orders/ocapiordervouchers_addvoucher/request/licenses-required","deepLinkHash":"/vouchers/ocapiordervouchers_addvoucher#vouchers/ocapiordervouchers_addvoucher/request/orders/ocapiordervouchers_addvoucher/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress order base being modified","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1vouchers/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1vouchers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_39"},"text/json":{"schemaId":"schema_39"},"application/*+json":{"schemaId":"schema_39"},"application/json-patch+json":{"schemaId":"schema_39"}},"schemaId":"schema_39","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1vouchers/post/requestBody","description":"The details of the voucher to be added to the in progress order base"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/vouchers","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_39"},"text/json":{"schemaId":"schema_39"},"application/*+json":{"schemaId":"schema_39"},"application/json-patch+json":{"schemaId":"schema_39"}},"responseCodes":["200","400","404","429"],"pointer":"/ocapi/v1/orders/{orderId}/vouchers","href":"vouchers/ocapiordervouchers_addvoucher","openApiOperationId":"OcapiOrderVouchers_AddVoucher","summary":"Adds a voucher to an in progress order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_39","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_39"},"text/json":{"schemaId":"schema_39"},"application/*+json":{"schemaId":"schema_39"},"application/json-patch+json":{"schemaId":"schema_39"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucherDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucherDetails"},{"code":"400","description":"Request property is invalid or missing, or invalid order type/voucher."},{"code":"404","description":"Order does not exist."},{"code":"429","description":"Too many requests. Try again later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}},"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1vouchers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucherDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucherDetails"}}},{"code":"400"},{"code":"404"},{"code":"429","schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError"}}}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/vouchers"}],"content":{"contentType":"group","meta":{"name":"Vouchers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Vouchers","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/orders/{orderId}/vouchers/{voucherId}","summary":"Removes a voucher from an in progress order base","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/vouchers/ocapiordervouchers_removevoucher","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/vouchers","summary":"Adds a voucher to an in progress order base","prefix":{"name":"post","color":"post"},"badges":[],"link":"/vouchers/ocapiordervouchers_addvoucher","deprecated":false}]}]}]}]}},{"type":"group","label":"Refunds","link":"/openapi/digital-platform/openapi/refunds","routeSlug":"/openapi/digital-platform/openapi/refunds","items":[{"label":"Creates a full refund for a refundable completed order base","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/refunds/ocapirefunds_createfullorderrefund","routeSlug":"/openapi/digital-platform/openapi/refunds/ocapirefunds_createfullorderrefund","metadata":{"seo":{"title":"Creates a full refund for a refundable completed order base","description":"This endpoint can only be used for completed standard order entities."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiRefunds_CreateFullOrderRefund","name":"Creates a full refund for a refundable completed order base","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1refunds~1full/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a full refund for a refundable completed order base","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint can only be used for completed standard order entities."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A refundable completed order base can only be fully refunded when order refund availability AvailableMethods"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"includes order refund method Full"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Booking fees may or may not be refunded, as indicated by order refund availability IsBookingFeeRefundable"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"refunds/ocapirefunds_createfullorderrefund/request/licenses-required","deepLinkHash":"/refunds/ocapirefunds_createfullorderrefund#refunds/ocapirefunds_createfullorderrefund/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the refundable completed order base","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1refunds~1full/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1refunds~1full/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Refunds.Requests.OrderFullRefundCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Refunds.Requests.OrderFullRefundCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Refunds.Requests.OrderFullRefundCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Refunds.Requests.OrderFullRefundCreate"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Refunds.Requests.OrderFullRefundCreate","pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1refunds~1full/post/requestBody","description":"The properties required to create the full refund"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/completed/{orderId}/refunds/full","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Refunds.Requests.OrderFullRefundCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Refunds.Requests.OrderFullRefundCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Refunds.Requests.OrderFullRefundCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Refunds.Requests.OrderFullRefundCreate"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/refunds/full","href":"refunds/ocapirefunds_createfullorderrefund","openApiOperationId":"OcapiRefunds_CreateFullOrderRefund","summary":"Creates a full refund for a refundable completed order base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Refunds.Requests.OrderFullRefundCreate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Refunds.Requests.OrderFullRefundCreate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Refunds.Requests.OrderFullRefundCreate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Refunds.Requests.OrderFullRefundCreate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Refunds.Requests.OrderFullRefundCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrder"}},"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrder"},{"code":"400","description":"Order cannot be fully refunded."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1refunds~1full/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrder"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/refunds/full"}],"content":{"contentType":"group","meta":{"name":"Refunds"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refunds","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/orders/completed/{orderId}/refunds/full","summary":"Creates a full refund for a refundable completed order base","prefix":{"name":"post","color":"post"},"badges":[],"link":"/refunds/ocapirefunds_createfullorderrefund","deprecated":false}]}]}]}]}},{"type":"group","label":"Seating","link":"/openapi/digital-platform/openapi/seating","routeSlug":"/openapi/digital-platform/openapi/seating","items":[{"label":"Gets the seat availability for a showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/seating/ocapiseatavailability_getseatavailabilityforshowtime","routeSlug":"/openapi/digital-platform/openapi/seating/ocapiseatavailability_getseatavailabilityforshowtime","metadata":{"seo":{"title":"Gets the seat availability for a showtime","description":"The response is output cached for a maximum duration depending on preview."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiSeatAvailability_GetSeatAvailabilityForShowtime","name":"Gets the seat availability for a showtime","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seat-availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the seat availability for a showtime","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response is output cached for a maximum duration depending on preview."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the underlying showtime is unallocated, showtime seat availability SeatAvailabilities"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be set to an empty seat availability[]"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"seating/ocapiseatavailability_getseatavailabilityforshowtime/request/bad-request-response","deepLinkHash":"/seating/ocapiseatavailability_getseatavailabilityforshowtime#seating/ocapiseatavailability_getseatavailabilityforshowtime/request/bad-request-response"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request response"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seat availability for showtime response returns "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status when seat allocation for the showtime is disabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When there are seats for a showtime that are sold out or the showtime is marked as sold out at Cinema,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"seat availability for showtime returns a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status for all seats."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"seating/ocapiseatavailability_getseatavailabilityforshowtime/request/licenses-required","deepLinkHash":"/seating/ocapiseatavailability_getseatavailabilityforshowtime#seating/ocapiseatavailability_getseatavailabilityforshowtime/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"showtimeId","in":"path","schemaId":"schema_33","description":"The unique identifier of the showtime","required":true}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seat-availability/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"preview","in":"query","schemaId":"schema_58","description":"Indicates whether the seat availability is being shown in a preview context, i.e. can be slightly outdated"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seat-availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seat-availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/showtimes/{showtimeId}/seat-availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"showtimeId","in":"path","required":true,"schemaId":"schema_33"}],"query":[{"name":"preview","in":"query","schemaId":"schema_58"}],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/showtimes/{showtimeId}/seat-availability","href":"seating/ocapiseatavailability_getseatavailabilityforshowtime","openApiOperationId":"OcapiSeatAvailability_GetSeatAvailabilityForShowtime","summary":"Gets the seat availability for a showtime"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeSeatAvailability"}},"schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeSeatAvailability"},{"code":"404","description":"Showtime does not exist."}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seat-availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeSeatAvailability","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeSeatAvailability"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/showtimes/{showtimeId}/seat-availability"},{"label":"Gets the seat availability for a showtime in the context of a standard order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/seating/ocapiseatavailability_getseatavailabilityfororder","routeSlug":"/openapi/digital-platform/openapi/seating/ocapiseatavailability_getseatavailabilityfororder","metadata":{"seo":{"title":"Gets the seat availability for a showtime in the context of a standard order","description":"Using this endpoint over GetSeatAvailabilityForShowtime enables order-specific seat availabilityinformation and the pre-blocking of social distance seats."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiSeatAvailability_GetSeatAvailabilityForOrder","name":"Gets the seat availability for a showtime in the context of a standard order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1showtimes~1{showtimeId}~1seat-availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the seat availability for a showtime in the context of a standard order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint over "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/seating/ocapiseatavailability_getseatavailabilityforshowtime"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GetSeatAvailabilityForShowtime"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enables order-specific seat availability"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"information and the pre-blocking of social distance seats."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the underlying showtime is unallocated, showtime seat availability SeatAvailabilities"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be set to an empty seat availability[]"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint cannot be used for orders that do not support ticket selection."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"seating/ocapiseatavailability_getseatavailabilityfororder/request/licenses-required","deepLinkHash":"/seating/ocapiseatavailability_getseatavailabilityfororder#seating/ocapiseatavailability_getseatavailabilityfororder/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the standard order","required":true},{"name":"showtimeId","in":"path","schemaId":"schema_33","description":"The unique identifier of the showtime","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1showtimes~1{showtimeId}~1seat-availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1showtimes~1{showtimeId}~1seat-availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/{orderId}/showtimes/{showtimeId}/seat-availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"},{"name":"showtimeId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/showtimes/{showtimeId}/seat-availability","href":"seating/ocapiseatavailability_getseatavailabilityfororder","openApiOperationId":"OcapiSeatAvailability_GetSeatAvailabilityForOrder","summary":"Gets the seat availability for a showtime in the context of a standard order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeSeatAvailability"}},"schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeSeatAvailability"},{"code":"400","description":"Requested order does not support ticket selection"},{"code":"404","description":"Order or showtime does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1showtimes~1{showtimeId}~1seat-availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeSeatAvailability","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeSeatAvailability"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/showtimes/{showtimeId}/seat-availability"},{"label":"Gets a seat layout by its unique identifier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/seating/ocapiseatlayout_getseatlayout","routeSlug":"/openapi/digital-platform/openapi/seating/ocapiseatlayout_getseatlayout","metadata":{"seo":{"title":"Gets a seat layout by its unique identifier","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiSeatLayout_GetSeatLayout","name":"Gets a seat layout by its unique identifier","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1seat-layouts~1{seatLayoutId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a seat layout by its unique identifier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"seating/ocapiseatlayout_getseatlayout/request/licenses-required","deepLinkHash":"/seating/ocapiseatlayout_getseatlayout#seating/ocapiseatlayout_getseatlayout/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"seatLayoutId","in":"path","schemaId":"schema_33","description":"The unique identifier of the seat layout","required":true}],"pointer":"/paths/~1ocapi~1v1~1seat-layouts~1{seatLayoutId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1seat-layouts~1{seatLayoutId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/seat-layouts/{seatLayoutId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"seatLayoutId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/seat-layouts/{seatLayoutId}","href":"seating/ocapiseatlayout_getseatlayout","openApiOperationId":"OcapiSeatLayout_GetSeatLayout","summary":"Gets a seat layout by its unique identifier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Seating.MasterData.SeatLayoutDetails"}},"schemaId":"components/schemas/Ocapi.V1.Seating.MasterData.SeatLayoutDetails"},{"code":"404","description":"Seat layout does not exist."}],"pointer":"/paths/~1ocapi~1v1~1seat-layouts~1{seatLayoutId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Seating.MasterData.SeatLayoutDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Seating.MasterData.SeatLayoutDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/seat-layouts/{seatLayoutId}"},{"label":"Gets the in seat location tab availability for a seat within a showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/seating/ocapitablocationavailability_getinseatlocationtabavailability","routeSlug":"/openapi/digital-platform/openapi/seating/ocapitablocationavailability_getinseatlocationtabavailability","metadata":{"seo":{"title":"Gets the in seat location tab availability for a seat within a showtime","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiTabLocationAvailability_GetInSeatLocationTabAvailability","name":"Gets the in seat location tab availability for a seat within a showtime","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seats~1{seatId}~1tab-availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the in seat location tab availability for a seat within a showtime","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"seating/ocapitablocationavailability_getinseatlocationtabavailability/request/tabs/ocapitablocationavailability_getinseatlocationtabavailability/request/showtimes/ocapitablocationavailability_getinseatlocationtabavailability/request/licenses-required","deepLinkHash":"/seating/ocapitablocationavailability_getinseatlocationtabavailability#seating/ocapitablocationavailability_getinseatlocationtabavailability/request/tabs/ocapitablocationavailability_getinseatlocationtabavailability/request/showtimes/ocapitablocationavailability_getinseatlocationtabavailability/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.ChecksAPI"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"showtimeId","in":"path","schemaId":"schema_33","description":"The unique identifier of the showtime","required":true},{"name":"seatId","in":"path","schemaId":"schema_33","description":"The unique identifier of the seat","required":true}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seats~1{seatId}~1tab-availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seats~1{seatId}~1tab-availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/showtimes/{showtimeId}/seats/{seatId}/tab-availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"showtimeId","in":"path","required":true,"schemaId":"schema_33"},{"name":"seatId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/showtimes/{showtimeId}/seats/{seatId}/tab-availability","href":"seating/ocapitablocationavailability_getinseatlocationtabavailability","openApiOperationId":"OcapiTabLocationAvailability_GetInSeatLocationTabAvailability","summary":"Gets the in seat location tab availability for a seat within a showtime"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.InSeatLocationTabAvailability"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.InSeatLocationTabAvailability"},{"code":"404","description":"Showtime or seat does not exist."}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seats~1{seatId}~1tab-availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.InSeatLocationTabAvailability","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.InSeatLocationTabAvailability"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/showtimes/{showtimeId}/seats/{seatId}/tab-availability"},{"label":"Gets the seat layout for a showtime","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/seating/ocapiseatlayout_getseatlayoutforshowtime","routeSlug":"/openapi/digital-platform/openapi/seating/ocapiseatlayout_getseatlayoutforshowtime","metadata":{"seo":{"title":"Gets the seat layout for a showtime","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiSeatLayout_GetSeatLayoutForShowtime","name":"Gets the seat layout for a showtime","deprecated":true,"isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seat-layout/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the seat layout for a showtime","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"seating/ocapiseatlayout_getseatlayoutforshowtime/request/licenses-required","deepLinkHash":"/seating/ocapiseatlayout_getseatlayoutforshowtime#seating/ocapiseatlayout_getseatlayoutforshowtime/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"showtimeId","in":"path","schemaId":"schema_33","description":"The unique identifier of the showtime","required":true}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seat-layout/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seat-layout/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/showtimes/{showtimeId}/seat-layout","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"showtimeId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/showtimes/{showtimeId}/seat-layout","href":"seating/ocapiseatlayout_getseatlayoutforshowtime","openApiOperationId":"OcapiSeatLayout_GetSeatLayoutForShowtime","summary":"Gets the seat layout for a showtime"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Seating.MasterData.SeatLayoutDetails"}},"schemaId":"components/schemas/Ocapi.V1.Seating.MasterData.SeatLayoutDetails"},{"code":"404","description":"Showtime does not exist."}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1seat-layout/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Seating.MasterData.SeatLayoutDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Seating.MasterData.SeatLayoutDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/showtimes/{showtimeId}/seat-layout"}],"content":{"contentType":"group","meta":{"name":"Seating"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Seating","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/showtimes/{showtimeId}/seat-availability","summary":"Gets the seat availability for a showtime","prefix":{"name":"get","color":"get"},"badges":[],"link":"/seating/ocapiseatavailability_getseatavailabilityforshowtime","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/showtimes/{showtimeId}/seat-availability","summary":"Gets the seat availability for a showtime in the context of a standard order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/seating/ocapiseatavailability_getseatavailabilityfororder","deprecated":false},{"title":"/ocapi/v1/seat-layouts/{seatLayoutId}","summary":"Gets a seat layout by its unique identifier","prefix":{"name":"get","color":"get"},"badges":[],"link":"/seating/ocapiseatlayout_getseatlayout","deprecated":false},{"title":"/ocapi/v1/showtimes/{showtimeId}/seats/{seatId}/tab-availability","summary":"Gets the in seat location tab availability for a seat within a showtime","prefix":{"name":"get","color":"get"},"badges":[],"link":"/seating/ocapitablocationavailability_getinseatlocationtabavailability","deprecated":false},{"title":"/ocapi/v1/showtimes/{showtimeId}/seat-layout","summary":"Gets the seat layout for a showtime","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/seating/ocapiseatlayout_getseatlayoutforshowtime","deprecated":true}]}]}]}]}},{"type":"group","label":"Browsing","link":"/openapi/digital-platform/openapi/browsing","routeSlug":"/openapi/digital-platform/openapi/browsing","items":[{"label":"Gets the current list of showtime availability entities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/browsing/ocapishowtimeavailability_getshowtimeavailabilities","routeSlug":"/openapi/digital-platform/openapi/browsing/ocapishowtimeavailability_getshowtimeavailabilities","metadata":{"seo":{"title":"Gets the current list of showtime availability entities","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiShowtimeAvailability_GetShowtimeAvailabilities","name":"Gets the current list of showtime availability entities","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1showtimes~1availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current list of showtime availability entities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"browsing/ocapishowtimeavailability_getshowtimeavailabilities/request/showtimes/ocapishowtimeavailability_getshowtimeavailabilities/request/licenses-required","deepLinkHash":"/browsing/ocapishowtimeavailability_getshowtimeavailabilities#browsing/ocapishowtimeavailability_getshowtimeavailabilities/request/showtimes/ocapishowtimeavailability_getshowtimeavailabilities/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"siteIds","in":"query","schemaId":"schema_41","description":"Site filter"},{"name":"filmIds","in":"query","schemaId":"schema_42","description":"Film filter"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/showtimes/availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"siteIds","in":"query","schemaId":"schema_41"},{"name":"filmIds","in":"query","schemaId":"schema_42"}],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/ocapi/v1/showtimes/availability","href":"browsing/ocapishowtimeavailability_getshowtimeavailabilities","openApiOperationId":"OcapiShowtimeAvailability_GetShowtimeAvailabilities","summary":"Gets the current list of showtime availability entities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityListDetails"},{"code":"400","description":"One or more of the provided sites or films do not exist."}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityListDetails"}}},{"code":"400"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/showtimes/availability"},{"label":"Gets the current showtime availability of a particular showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/browsing/ocapishowtimeavailability_getshowtimeavailability","routeSlug":"/openapi/digital-platform/openapi/browsing/ocapishowtimeavailability_getshowtimeavailability","metadata":{"seo":{"title":"Gets the current showtime availability of a particular showtime","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiShowtimeAvailability_GetShowtimeAvailability","name":"Gets the current showtime availability of a particular showtime","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current showtime availability of a particular showtime","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"browsing/ocapishowtimeavailability_getshowtimeavailability/request/showtimes/ocapishowtimeavailability_getshowtimeavailability/request/licenses-required","deepLinkHash":"/browsing/ocapishowtimeavailability_getshowtimeavailability#browsing/ocapishowtimeavailability_getshowtimeavailability/request/showtimes/ocapishowtimeavailability_getshowtimeavailability/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"showtimeId","in":"path","schemaId":"schema_33","description":"The unique identifier of the showtime","required":true}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/showtimes/{showtimeId}/availability","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"showtimeId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/showtimes/{showtimeId}/availability","href":"browsing/ocapishowtimeavailability_getshowtimeavailability","openApiOperationId":"OcapiShowtimeAvailability_GetShowtimeAvailability","summary":"Gets the current showtime availability of a particular showtime"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityDetails"}},"schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityDetails"},{"code":"404","description":"Showtime does not exist."}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/showtimes/{showtimeId}/availability"}],"content":{"contentType":"group","meta":{"name":"Browsing"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Browsing","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/showtimes/availability","summary":"Gets the current list of showtime availability entities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/browsing/ocapishowtimeavailability_getshowtimeavailabilities","deprecated":false},{"title":"/ocapi/v1/showtimes/{showtimeId}/availability","summary":"Gets the current showtime availability of a particular showtime","prefix":{"name":"get","color":"get"},"badges":[],"link":"/browsing/ocapishowtimeavailability_getshowtimeavailability","deprecated":false}]}]}]}]}},{"type":"group","label":"Surveys","link":"/openapi/digital-platform/openapi/surveys","routeSlug":"/openapi/digital-platform/openapi/surveys","items":[{"label":"Gets the survey for a completed standard order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/surveys/ocapisurveys_getordersurvey","routeSlug":"/openapi/digital-platform/openapi/surveys/ocapisurveys_getordersurvey","metadata":{"seo":{"title":"Gets the survey for a completed standard order","description":"Only standard orders with a single showtime are applicable for a survey."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiSurveys_GetOrderSurvey","name":"Gets the survey for a completed standard order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1survey/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the survey for a completed standard order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only standard orders with a single showtime are applicable for a survey."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A survey that has been completed will return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response, where survey IsCompleted equals true."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"surveys/ocapisurveys_getordersurvey/request/completed-orders/ocapisurveys_getordersurvey/request/licenses-required","deepLinkHash":"/surveys/ocapisurveys_getordersurvey#surveys/ocapisurveys_getordersurvey/request/completed-orders/ocapisurveys_getordersurvey/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Surveys"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed standard order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1survey/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1survey/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/orders/completed/{orderId}/survey","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/survey","href":"surveys/ocapisurveys_getordersurvey","openApiOperationId":"OcapiSurveys_GetOrderSurvey","summary":"Gets the survey for a completed standard order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.SurveyDetails"}},"schemaId":"components/schemas/Ocapi.V1.Surveys.SurveyDetails"},{"code":"400","description":"Surveys are not enabled or not applicable for this order."},{"code":"404","description":"Order does not exist, or the survey is not yet available or has expired."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1survey/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Surveys.SurveyDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.SurveyDetails"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/survey"},{"label":"Updates the survey responses for completed standard order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/surveys/ocapisurveys_setordersurveyresponses","routeSlug":"/openapi/digital-platform/openapi/surveys/ocapisurveys_setordersurveyresponses","metadata":{"seo":{"title":"Updates the survey responses for completed standard order","description":"Licenses Required"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiSurveys_SetOrderSurveyResponses","name":"Updates the survey responses for completed standard order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1survey~1responses/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates the survey responses for completed standard order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"surveys/ocapisurveys_setordersurveyresponses/request/completed-orders/ocapisurveys_setordersurveyresponses/request/licenses-required","deepLinkHash":"/surveys/ocapisurveys_setordersurveyresponses#surveys/ocapisurveys_setordersurveyresponses/request/completed-orders/ocapisurveys_setordersurveyresponses/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Surveys"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the completed standard order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1survey~1responses/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1survey~1responses/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"}},"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate","pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1survey~1responses/put/requestBody","description":"The survey responses to be updated"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/orders/completed/{orderId}/survey/responses","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"}},"responseCodes":["204","400","404"],"pointer":"/ocapi/v1/orders/completed/{orderId}/survey/responses","href":"surveys/ocapisurveys_setordersurveyresponses","openApiOperationId":"OcapiSurveys_SetOrderSurveyResponses","summary":"Updates the survey responses for completed standard order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Survey responses updated."},{"code":"400","description":"Survey is expired or already completed, or one or more question responses are missing or invalid."},{"code":"404","description":"Order or survey does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1completed~1{orderId}~1survey~1responses/put/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/orders/completed/{orderId}/survey/responses"}],"content":{"contentType":"group","meta":{"name":"Surveys"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Surveys","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/orders/completed/{orderId}/survey","summary":"Gets the survey for a completed standard order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/surveys/ocapisurveys_getordersurvey","deprecated":false},{"title":"/ocapi/v1/orders/completed/{orderId}/survey/responses","summary":"Updates the survey responses for completed standard order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/surveys/ocapisurveys_setordersurveyresponses","deprecated":false}]}]}]}]}},{"type":"group","label":"Third-Party Member Schemes","link":"/openapi/digital-platform/openapi/third-party-member-schemes","routeSlug":"/openapi/digital-platform/openapi/third-party-member-schemes","items":[{"label":"Gets the list of third party member scheme entities for a specified site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/third-party-member-schemes/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite","routeSlug":"/openapi/digital-platform/openapi/third-party-member-schemes/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite","metadata":{"seo":{"title":"Gets the list of third party member scheme entities for a specified site","description":"This endpoint excludes any third-party member schemes that are validated against Vista Loyalty."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiThirdPartyMemberSchemes_GetThirdPartyMemberSchemesForSite","name":"Gets the list of third party member scheme entities for a specified site","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1third-party-member-schemes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the list of third party member scheme entities for a specified site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint excludes any third-party member schemes that are validated against Vista Loyalty."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loyalty schemes are handled as \"member reward tickets with an availability restriction\" via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/members/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GetMemberRewardAvailabilitiesForShowtime"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"third-party-member-schemes/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite/request/sites/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite/request/licenses-required","deepLinkHash":"/third-party-member-schemes/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite#third-party-member-schemes/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite/request/sites/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_33","description":"The unique identifier of the site","required":true}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1third-party-member-schemes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1third-party-member-schemes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/sites/{siteId}/third-party-member-schemes","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/sites/{siteId}/third-party-member-schemes","href":"third-party-member-schemes/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite","openApiOperationId":"OcapiThirdPartyMemberSchemes_GetThirdPartyMemberSchemesForSite","summary":"Gets the list of third party member scheme entities for a specified site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.ThirdPartyMemberTicketSchemes.ThirdPartyMemberSchemeListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.ThirdPartyMemberTicketSchemes.ThirdPartyMemberSchemeListDetails"},{"code":"404","description":"Site does not exist."}],"pointer":"/paths/~1ocapi~1v1~1sites~1{siteId}~1third-party-member-schemes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.ThirdPartyMemberTicketSchemes.ThirdPartyMemberSchemeListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.ThirdPartyMemberTicketSchemes.ThirdPartyMemberSchemeListDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/sites/{siteId}/third-party-member-schemes"}],"content":{"contentType":"group","meta":{"name":"Third-Party Member Schemes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Third-Party Member Schemes","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/sites/{siteId}/third-party-member-schemes","summary":"Gets the list of third party member scheme entities for a specified site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/third-party-member-schemes/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite","deprecated":false}]}]}]}]}},{"type":"group","label":"Ticket Prices","link":"/openapi/digital-platform/openapi/ticket-prices","routeSlug":"/openapi/digital-platform/openapi/ticket-prices","items":[{"label":"Gets a list of tickets prices for a specified showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/ticket-prices/ocapiticketprices_getticketpricesforshowtime","routeSlug":"/openapi/digital-platform/openapi/ticket-prices/ocapiticketprices_getticketpricesforshowtime","metadata":{"seo":{"title":"Gets a list of tickets prices for a specified showtime","description":"Returns a list of ticket price entities for a showtime with related data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiTicketPrices_GetTicketPricesForShowtime","name":"Gets a list of tickets prices for a specified showtime","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1ticket-prices/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a list of tickets prices for a specified showtime","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of ticket price entities for a showtime with related data."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"ticket-prices/ocapiticketprices_getticketpricesforshowtime/request/restrictions","deepLinkHash":"/ticket-prices/ocapiticketprices_getticketpricesforshowtime#ticket-prices/ocapiticketprices_getticketpricesforshowtime/request/restrictions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restrictions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some ticket prices have restrictions that limit their availability. These restrictions are returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"restrictions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a restriction is returned that a client does not understand, the price must be hidden until the client has implemented handling for said requirement."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current ticket price restrictions include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Member"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - A Loyalty membership is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MemberReward"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Redemption of member reward with the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RewardId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MemberSubscriptionCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - A subscription for the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ThirdPartyMemberSchemeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ThirdPartyMemberCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - A third-party membership card belonging to the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ThirdPartyMemberSchemeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Voucher"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Redemption of a voucher, valid for the ticket type, is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Discount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Redemption of discount with the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"ticket-prices/ocapiticketprices_getticketpricesforshowtime/request/loyalty-based-third-party-member-schemes","deepLinkHash":"/ticket-prices/ocapiticketprices_getticketpricesforshowtime#ticket-prices/ocapiticketprices_getticketpricesforshowtime/request/loyalty-based-third-party-member-schemes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loyalty-based third-party member schemes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ticket prices for Loyalty-based non-subscription third party member schemes will be returned twice:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ThirdPartyMemberCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" restriction intended for legacy clients adding these tickets via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AddTicketRedemptionCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MemberReward"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" restriction intended for clients using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GetMemberRewardAvailabilitiesForShowtime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint and adding these tickets directly using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RewardId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"ticket-prices/ocapiticketprices_getticketpricesforshowtime/request/quantity-limits","deepLinkHash":"/ticket-prices/ocapiticketprices_getticketpricesforshowtime#ticket-prices/ocapiticketprices_getticketpricesforshowtime/request/quantity-limits"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The quantity limits of each ticket price available to the customer is complex."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Due to quantity limits potentially applying across multiple ticket prices, these rules are best calculated on the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The client must keep track of various ticket properties to correctly restrict quantity. These properties include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A client-side max-tickets-per-order setting (this does not exist as omnichannel config yet)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AvailableQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the member reward if applicable."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BalanceCost"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the reward if applicable (checked against member balance + other ticket selections)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Member ticket "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QuantityLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned from third-party member card validation."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discounted ticket price entities are automatically filtered based on the discount restriction Availability"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the showtime"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"ticket-prices/ocapiticketprices_getticketpricesforshowtime/request/licenses-required","deepLinkHash":"/ticket-prices/ocapiticketprices_getticketpricesforshowtime#ticket-prices/ocapiticketprices_getticketpricesforshowtime/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi.TicketPricesForShowtime"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"showtimeId","in":"path","schemaId":"schema_33","description":"The unique identifier of the showtime","required":true}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1ticket-prices/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1ticket-prices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/showtimes/{showtimeId}/ticket-prices","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"showtimeId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/ocapi/v1/showtimes/{showtimeId}/ticket-prices","href":"ticket-prices/ocapiticketprices_getticketpricesforshowtime","openApiOperationId":"OcapiTicketPrices_GetTicketPricesForShowtime","summary":"Gets a list of tickets prices for a specified showtime"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.TicketPrices.TicketPriceListDetails"}},"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.TicketPrices.TicketPriceListDetails"},{"code":"404","description":"Showtime does not exist."}],"pointer":"/paths/~1ocapi~1v1~1showtimes~1{showtimeId}~1ticket-prices/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.TicketPrices.TicketPriceListDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Sales.MasterData.TicketPrices.TicketPriceListDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/showtimes/{showtimeId}/ticket-prices"}],"content":{"contentType":"group","meta":{"name":"Ticket Prices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Prices","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/showtimes/{showtimeId}/ticket-prices","summary":"Gets a list of tickets prices for a specified showtime","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ticket-prices/ocapiticketprices_getticketpricesforshowtime","deprecated":false}]}]}]}]}},{"type":"group","label":"Tracking Events","link":"/openapi/digital-platform/openapi/tracking-events","routeSlug":"/openapi/digital-platform/openapi/tracking-events","items":[{"label":"Returns an HTTP status code that indicates whether a patron has opened a link on their own device to view a digital representation of their order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tracking-events/ocapitrackingevents_getcompletedorderlinkopenedtrackingevent","routeSlug":"/openapi/digital-platform/openapi/tracking-events/ocapitrackingevents_getcompletedorderlinkopenedtrackingevent","metadata":{"seo":{"title":"Returns an HTTP status code that indicates whether a patron has opened a link on their own device to view a digital representation of their order","description":"This endpoint would be used by the Kiosk via short-polling to see if the order confirmation QR code has been scanned yet, so it knowswhen to auto-dismiss the prompt for the patron to scan the QR code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiTrackingEvents_GetCompletedOrderLinkOpenedTrackingEvent","name":"Returns an HTTP status code that indicates whether a patron has opened a link on their own device to view a digital representation of their order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1tracking-events~1completed-order-link-opened~1{trackingId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns an HTTP status code that indicates whether a patron has opened a link on their own device to view a digital representation of their order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint would be used by the Kiosk via short-polling to see if the order confirmation QR code has been scanned yet, so it knows"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when to auto-dismiss the prompt for the patron to scan the QR code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once the tracking event expiry (of 10 minutes) elapses this endpoint will no longer retain a record of this event and will continue returning"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Microsoft.AspNetCore.Http.StatusCodes.Status202Accepted again, as if the event was not set."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tracking-events/ocapitrackingevents_getcompletedorderlinkopenedtrackingevent/request/licenses-required","deepLinkHash":"/tracking-events/ocapitrackingevents_getcompletedorderlinkopenedtrackingevent#tracking-events/ocapitrackingevents_getcompletedorderlinkopenedtrackingevent/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"trackingId","in":"path","schemaId":"schema_33","description":"The identifier of the tracking event, typically the unique identifier of the completed order base that is being monitored","required":true}],"pointer":"/paths/~1ocapi~1v1~1tracking-events~1completed-order-link-opened~1{trackingId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1tracking-events~1completed-order-link-opened~1{trackingId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ocapi/v1/tracking-events/completed-order-link-opened/{trackingId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"trackingId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["202","204"],"pointer":"/ocapi/v1/tracking-events/completed-order-link-opened/{trackingId}","href":"tracking-events/ocapitrackingevents_getcompletedorderlinkopenedtrackingevent","openApiOperationId":"OcapiTrackingEvents_GetCompletedOrderLinkOpenedTrackingEvent","summary":"Returns an HTTP status code that indicates whether a patron has opened a link on their own device to view a digital representation of their order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Completed order link opened event not found, client can keep polling."},{"code":"204","description":"Completed order link has been opened, client can auto-dismiss the prompt to scan the QR code."}],"pointer":"/paths/~1ocapi~1v1~1tracking-events~1completed-order-link-opened~1{trackingId}/get/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/tracking-events/completed-order-link-opened/{trackingId}"},{"label":"Sets a tracking event to record that a patron has opened a link on their own device to view a digital representation of their order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tracking-events/ocapitrackingevents_setcompletedorderlinkopenedtrackingevent","routeSlug":"/openapi/digital-platform/openapi/tracking-events/ocapitrackingevents_setcompletedorderlinkopenedtrackingevent","metadata":{"seo":{"title":"Sets a tracking event to record that a patron has opened a link on their own device to view a digital representation of their order","description":"This endpoint would be used by the web or mobile app that is opened on the patron's device after they have scanned the order confirmationQR code on the Kiosk."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OcapiTrackingEvents_SetCompletedOrderLinkOpenedTrackingEvent","name":"Sets a tracking event to record that a patron has opened a link on their own device to view a digital representation of their order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1tracking-events~1completed-order-link-opened~1{trackingId}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sets a tracking event to record that a patron has opened a link on their own device to view a digital representation of their order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint would be used by the web or mobile app that is opened on the patron's device after they have scanned the order confirmation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QR code on the Kiosk."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This tracking event will not be permanently stored. It will expire after 10 minutes."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tracking-events/ocapitrackingevents_setcompletedorderlinkopenedtrackingevent/request/licenses-required","deepLinkHash":"/tracking-events/ocapitrackingevents_setcompletedorderlinkopenedtrackingevent#tracking-events/ocapitrackingevents_setcompletedorderlinkopenedtrackingevent/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"trackingId","in":"path","schemaId":"schema_33","description":"The identifier of the tracking event, typically the unique identifier of the completed order base that is being monitored","required":true}],"pointer":"/paths/~1ocapi~1v1~1tracking-events~1completed-order-link-opened~1{trackingId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1tracking-events~1completed-order-link-opened~1{trackingId}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/tracking-events/completed-order-link-opened/{trackingId}","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"trackingId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"responseCodes":["204"],"pointer":"/ocapi/v1/tracking-events/completed-order-link-opened/{trackingId}","href":"tracking-events/ocapitrackingevents_setcompletedorderlinkopenedtrackingevent","openApiOperationId":"OcapiTrackingEvents_SetCompletedOrderLinkOpenedTrackingEvent","summary":"Sets a tracking event to record that a patron has opened a link on their own device to view a digital representation of their order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Completed order link opened event has been stored."}],"pointer":"/paths/~1ocapi~1v1~1tracking-events~1completed-order-link-opened~1{trackingId}/put/responses"}],"panels":[]}]},"httpPath":"/ocapi/v1/tracking-events/completed-order-link-opened/{trackingId}"}],"content":{"contentType":"group","meta":{"name":"Tracking Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tracking Events","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/tracking-events/completed-order-link-opened/{trackingId}","summary":"Returns an HTTP status code that indicates whether a patron has opened a link on their own device to view a digital representation of their order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tracking-events/ocapitrackingevents_getcompletedorderlinkopenedtrackingevent","deprecated":false},{"title":"/ocapi/v1/tracking-events/completed-order-link-opened/{trackingId}","summary":"Sets a tracking event to record that a patron has opened a link on their own device to view a digital representation of their order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tracking-events/ocapitrackingevents_setcompletedorderlinkopenedtrackingevent","deprecated":false}]}]}]}]}},{"type":"group","label":"Tips","link":"/openapi/digital-platform/openapi/tips","routeSlug":"/openapi/digital-platform/openapi/tips","items":[{"label":"Sets the tip for an in progress standard order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tips/ordertips_setordertip","routeSlug":"/openapi/digital-platform/openapi/tips/ordertips_setordertip","metadata":{"seo":{"title":"Sets the tip for an in progress standard order","description":"For in progress tab order entities, use AddOrderTip instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OrderTips_SetOrderTip","name":"Sets the tip for an in progress standard order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tip/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sets the tip for an in progress standard order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For in progress tab order entities, use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/orders/ordertips_addordertip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AddOrderTip"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tips/ordertips_setordertip/request/licenses-required","deepLinkHash":"/tips/ordertips_setordertip#tips/ordertips_setordertip/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress standard order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tip/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tip/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tip/put/requestBody","description":"The tip to set"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ocapi/v1/orders/{orderId}/tip","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"}},"responseCodes":["200","404"],"pointer":"/ocapi/v1/orders/{orderId}/tip","href":"tips/ordertips_setordertip","openApiOperationId":"OrderTips_SetOrderTip","summary":"Sets the tip for an in progress standard order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/atomsvc+xml","mediaTypes":["application/atomsvc+xml","application/atom+xml; type=feed","application/atom+xml","application/xml","application/atom+xml; type=entry","application/json; odata=minimalmetadata; streaming=true","application/json; odata=minimalmetadata; streaming=false","application/json; odata=minimalmetadata","application/json; odata=fullmetadata; streaming=true","application/json; odata=fullmetadata; streaming=false","application/json; odata=fullmetadata","application/json; odata=nometadata; streaming=true","application/json; odata=nometadata; streaming=false","application/json; odata=nometadata","application/json; odata=verbose","application/json; streaming=true","application/json; streaming=false","application/json","text/xml","text/json","text/plain"],"mediaTypeContent":{"application/atomsvc+xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/atom+xml; type=feed":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/atom+xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/atom+xml; type=entry":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=minimalmetadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=minimalmetadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=minimalmetadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=fullmetadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=fullmetadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=fullmetadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=nometadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=nometadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=nometadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=verbose":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"text/xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"text/plain":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tip/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails","mediaTypes":["application/atomsvc+xml","application/atom+xml; type=feed","application/atom+xml","application/xml","application/atom+xml; type=entry","application/json; odata=minimalmetadata; streaming=true","application/json; odata=minimalmetadata; streaming=false","application/json; odata=minimalmetadata","application/json; odata=fullmetadata; streaming=true","application/json; odata=fullmetadata; streaming=false","application/json; odata=fullmetadata","application/json; odata=nometadata; streaming=true","application/json; odata=nometadata; streaming=false","application/json; odata=nometadata","application/json; odata=verbose","application/json; streaming=true","application/json; streaming=false","application/json","text/xml","text/json","text/plain"],"mediaTypeContent":{"application/atomsvc+xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/atom+xml; type=feed":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/atom+xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/atom+xml; type=entry":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=minimalmetadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=minimalmetadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=minimalmetadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=fullmetadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=fullmetadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=fullmetadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=nometadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=nometadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=nometadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; odata=verbose":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"text/xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"},"text/plain":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/tip"},{"label":"Adds a tip to an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tips/ordertips_addordertip","routeSlug":"/openapi/digital-platform/openapi/tips/ordertips_addordertip","metadata":{"seo":{"title":"Adds a tip to an in progress tab order","description":"For in progress standard order entities, use SetOrderTip instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OrderTips_AddOrderTip","name":"Adds a tip to an in progress tab order","isWebhook":false,"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tips/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adds a tip to an in progress tab order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For in progress standard order entities, use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/digital-platform/openapi/tips/ordertips_setordertip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SetOrderTip"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"tips/ordertips_addordertip/request/tabs/ordertips_addordertip/request/orders/ordertips_addordertip/request/licenses-required","deepLinkHash":"/tips/ordertips_addordertip#tips/ordertips_addordertip/request/tabs/ordertips_addordertip/request/orders/ordertips_addordertip/request/licenses-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Licenses Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vista.Ocapi"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_33","description":"The unique identifier of the in progress tab order","required":true}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tips/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33","description":"Region Code"}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tips/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"}},"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest","pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tips/post/requestBody","description":"The tip to add"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ocapi/v1/orders/{orderId}/tips","servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_33"}],"query":[],"querystring":[],"header":[{"name":"Connect-Region-Code","in":"header","schemaId":"schema_33"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"}},"responseCodes":["200","400","404"],"pointer":"/ocapi/v1/orders/{orderId}/tips","href":"tips/ordertips_addordertip","openApiOperationId":"OrderTips_AddOrderTip","summary":"Adds a tip to an in progress tab order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/digital-platform/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest","mediaTypes":["application/json","text/json","application/*+json","application/json-patch+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/*+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"},"application/json-patch+json":{"schemaId":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/atomsvc+xml","mediaTypes":["application/atomsvc+xml","application/atom+xml; type=feed","application/atom+xml","application/xml","application/atom+xml; type=entry","application/json; odata=minimalmetadata; streaming=true","application/json; odata=minimalmetadata; streaming=false","application/json; odata=minimalmetadata","application/json; odata=fullmetadata; streaming=true","application/json; odata=fullmetadata; streaming=false","application/json; odata=fullmetadata","application/json; odata=nometadata; streaming=true","application/json; odata=nometadata; streaming=false","application/json; odata=nometadata","application/json; odata=verbose","application/json; streaming=true","application/json; streaming=false","application/json","text/xml","text/json","text/plain"],"mediaTypeContent":{"application/atomsvc+xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/atom+xml; type=feed":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/atom+xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/atom+xml; type=entry":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=minimalmetadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=minimalmetadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=minimalmetadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=fullmetadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=fullmetadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=fullmetadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=nometadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=nometadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=nometadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=verbose":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"text/xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"text/plain":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"}},"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},{"code":"400","description":"Request property is invalid or missing."},{"code":"404","description":"Order does not exist."}],"pointer":"/paths/~1ocapi~1v1~1orders~1{orderId}~1tips/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails","mediaTypes":["application/atomsvc+xml","application/atom+xml; type=feed","application/atom+xml","application/xml","application/atom+xml; type=entry","application/json; odata=minimalmetadata; streaming=true","application/json; odata=minimalmetadata; streaming=false","application/json; odata=minimalmetadata","application/json; odata=fullmetadata; streaming=true","application/json; odata=fullmetadata; streaming=false","application/json; odata=fullmetadata","application/json; odata=nometadata; streaming=true","application/json; odata=nometadata; streaming=false","application/json; odata=nometadata","application/json; odata=verbose","application/json; streaming=true","application/json; streaming=false","application/json","text/xml","text/json","text/plain"],"mediaTypeContent":{"application/atomsvc+xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/atom+xml; type=feed":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/atom+xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/atom+xml; type=entry":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=minimalmetadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=minimalmetadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=minimalmetadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=fullmetadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=fullmetadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=fullmetadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=nometadata; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=nometadata; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=nometadata":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; odata=verbose":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; streaming=true":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json; streaming=false":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"application/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"text/xml":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"text/json":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"},"text/plain":{"schemaId":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/ocapi/v1/orders/{orderId}/tips"}],"content":{"contentType":"group","meta":{"name":"Tips"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tips","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ocapi/v1/orders/{orderId}/tip","summary":"Sets the tip for an in progress standard order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tips/ordertips_setordertip","deprecated":false},{"title":"/ocapi/v1/orders/{orderId}/tips","summary":"Adds a tip to an in progress tab order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tips/ordertips_addordertip","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails":{"id":"components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails","kind":"json-schema","title":"Microsoft.AspNetCore.Mvc.ProblemDetails","data":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}},"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailability":{"id":"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailability","kind":"json-schema","title":"FilmAvailability","data":{"title":"FilmAvailability","required":["advanceBookingPeriods","categories","filmId","showtimeAttributeIds"],"type":"object","properties":{"filmId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the film"},"siteId":{"type":"string","description":"Gets the unique identifier of the site","nullable":true},"categories":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmCategory"},"description":"Gets the list of film category entities"},"showtimeAttributeIds":{"type":"array","items":{"type":"string"},"description":"Gets the list of unique identifiers of the attribute entities being screened"},"advanceBookingPeriods":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.FilmAdvanceBookings.FilmAdvanceBookingPeriod"},"description":"Gets the list of film advance booking period entities"}},"additionalProperties":false,"description":"Represents the current availability of a film"}},"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityDetails":{"id":"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityDetails","kind":"json-schema","title":"FilmAvailabilityDetails","data":{"title":"FilmAvailabilityDetails","required":["filmAvailability","relatedData"],"type":"object","properties":{"filmAvailability":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailability"}],"description":"Gets the film availability"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityRelatedData"}],"description":"Gets the related data for the film availability"}},"additionalProperties":false,"description":"Represents a film availability entity, and its related data"}},"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityListDetails":{"id":"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityListDetails","kind":"json-schema","title":"FilmAvailabilityListDetails","data":{"title":"FilmAvailabilityListDetails","required":["filmAvailabilities","relatedData"],"type":"object","properties":{"filmAvailabilities":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailability"},"description":"Gets the list of film availability entities"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityRelatedData"}],"description":"Gets the related data for the film availability entities"}},"additionalProperties":false,"description":"Represents a list of film availability entities, and their related data"}},"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityRelatedData":{"id":"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmAvailabilityRelatedData","kind":"json-schema","title":"FilmAvailabilityRelatedData","data":{"title":"FilmAvailabilityRelatedData","required":["attributes"],"type":"object","properties":{"attributes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Attributes.Attribute"},"description":"Gets the list of related attribute entities"}},"additionalProperties":false,"description":"Related data for a film availability entity"}},"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmCategory":{"id":"components/schemas/Ocapi.V1.Browsing.Availability.Films.FilmCategory","kind":"json-schema","title":"FilmCategory","data":{"title":"FilmCategory","enum":["NowShowing","ComingSoon","AdvanceBooking"],"type":"string","description":"Represents the category of a film"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Attributes.Attribute":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Attributes.Attribute","kind":"json-schema","title":"Attribute","data":{"title":"Attribute","required":["displayPriority","id","isPromoted","name","shortName"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"shortName":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the short name text, and its translations"},"description":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the description text, and its translations"},"importantMessage":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the important message text, and its translations"},"displayPriority":{"type":"integer","description":"Gets the display priority used for sorting","format":"int32"},"isPromoted":{"type":"boolean","description":"Gets a value indicating whether the attribute should be displayed with prominence"}},"additionalProperties":false,"description":"Represents a notable feature or characteristic of a showtime, film, or screen\r\nE.g. IMAX, 3D"}},"components/schemas/Ocapi.V1.Browsing.MasterData.CastAndCrewMembers.CastAndCrewMember":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.CastAndCrewMembers.CastAndCrewMember","kind":"json-schema","title":"CastAndCrewMember","data":{"title":"CastAndCrewMember","required":["id","name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.PersonName"}],"description":"Gets the person's name"}},"additionalProperties":false,"description":"Represents a person responsible for the creation of a film in some way"}},"components/schemas/Ocapi.V1.Browsing.MasterData.CastAndCrewMembers.CastAndCrewMemberRole":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.CastAndCrewMembers.CastAndCrewMemberRole","kind":"json-schema","title":"CastAndCrewMemberRole","data":{"title":"CastAndCrewMemberRole","enum":["Actor","Director","Producer"],"type":"string","description":"Represents the role that a cast and crew member had in a film"}},"components/schemas/Ocapi.V1.Browsing.MasterData.CensorRatings.CensorRating":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.CensorRatings.CensorRating","kind":"json-schema","title":"CensorRating","data":{"title":"CensorRating","required":["classification","id"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"classification":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the classification text, and its translations"},"classificationDescription":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the censor rating Classification description text, and its translations"},"ageRestriction":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CensorRatings.CensorRatingAgeRestriction"}],"description":"Gets the age restriction, if applicable"}},"additionalProperties":false,"description":"Represents the censor rating of a film, e.g. R18"}},"components/schemas/Ocapi.V1.Browsing.MasterData.CensorRatings.CensorRatingAgeRestriction":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.CensorRatings.CensorRatingAgeRestriction","kind":"json-schema","title":"CensorRatingAgeRestriction","data":{"title":"CensorRatingAgeRestriction","required":["minimumAge"],"type":"object","properties":{"minimumAge":{"type":"integer","description":"Gets the minimum age required","format":"int32"}},"additionalProperties":false,"description":"Represents the age restriction of a censor rating"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Events.Event":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Events.Event","kind":"json-schema","title":"Event","data":{"title":"Event","required":["id","name","schedule","siteIds"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"shortName":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the short name text, and its translations"},"description":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the description text, and its translations"},"schedule":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventSchedule"}],"description":"Gets the schedule"},"siteIds":{"type":"array","items":{"type":"string"},"description":"Gets the list of unique identifiers of the site entities screening the event"}},"additionalProperties":false,"description":"Represents an occasion for which films can be screened and marketed together, e.g. an annual film festival"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventDetails":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventDetails","kind":"json-schema","title":"EventDetails","data":{"title":"EventDetails","required":["event","relatedData"],"type":"object","properties":{"event":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Events.Event"}],"description":"Gets the event entity"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventRelatedData"}],"description":"Gets the related data for the event entity"}},"additionalProperties":false,"description":"Represents the details of an event entity, and its related data"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventListDetails":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventListDetails","kind":"json-schema","title":"EventListDetails","data":{"title":"EventListDetails","required":["events","relatedData"],"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Events.Event"},"description":"Gets the list of event entities"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventListRelatedData"}],"description":"Gets the related data for the event entities"}},"additionalProperties":false,"description":"Represents a list of event entities and their related data"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventListRelatedData":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventListRelatedData","kind":"json-schema","title":"EventListRelatedData","data":{"title":"EventListRelatedData","required":["sites"],"type":"object","properties":{"sites":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.Site"}],"description":"Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities"},"description":"Gets the list of related site entities"}},"additionalProperties":false,"description":"Related data for a list of event entities"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventRelatedData":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventRelatedData","kind":"json-schema","title":"EventRelatedData","data":{"title":"EventRelatedData","required":["sites"],"type":"object","properties":{"sites":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.Site"}],"description":"Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities"},"description":"Gets the list of related site entities"}},"additionalProperties":false,"description":"Related data for an event entity"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventSchedule":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Events.EventSchedule","kind":"json-schema","title":"EventSchedule","data":{"title":"EventSchedule","type":"object","properties":{"startDate":{"type":"string","description":"Gets the start date, if applicable","format":"date-time","nullable":true},"endDate":{"type":"string","description":"Gets the end date, if applicable","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Represents the start and/or end date of an event"}},"components/schemas/Ocapi.V1.Browsing.MasterData.FilmAdvanceBookings.FilmAdvanceBookingPeriod":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.FilmAdvanceBookings.FilmAdvanceBookingPeriod","kind":"json-schema","title":"FilmAdvanceBookingPeriod","data":{"title":"FilmAdvanceBookingPeriod","required":["orderBookingModes","restriction","startsAt"],"type":"object","properties":{"startsAt":{"type":"string","description":"Gets the date and time that the booking period starts","format":"date-time"},"orderBookingModes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Bookings.OrderBookingMode"},"description":"Gets the order booking modes that the booking period applies to"},"restriction":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.FilmAdvanceBookings.FilmAdvanceBookingPeriodRestriction"}],"description":"Gets the restriction"},"rewardId":{"type":"integer","description":"Gets the unique identifier of the reward that the booking period is restricted to","format":"int32","nullable":true}},"additionalProperties":false,"description":"Represents a booking period for a film advance booking rule"}},"components/schemas/Ocapi.V1.Browsing.MasterData.FilmAdvanceBookings.FilmAdvanceBookingPeriodRestriction":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.FilmAdvanceBookings.FilmAdvanceBookingPeriodRestriction","kind":"json-schema","title":"FilmAdvanceBookingPeriodRestriction","data":{"title":"FilmAdvanceBookingPeriodRestriction","enum":["None","MemberReward"],"type":"string","description":"Represents the restriction options for a film advance booking period"}},"components/schemas/Ocapi.V1.Browsing.MasterData.FilmAdvanceBookings.FilmAdvanceBookingRule":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.FilmAdvanceBookings.FilmAdvanceBookingRule","kind":"json-schema","title":"FilmAdvanceBookingRule","data":{"title":"FilmAdvanceBookingRule","required":["bookingPeriods","filmId","id","siteId"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"filmId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the film"},"siteId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the site"},"bookingPeriods":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.FilmAdvanceBookings.FilmAdvanceBookingPeriod"},"description":"Gets the list of film advance booking period entities"}},"additionalProperties":false,"description":"Represents a booking period for a film advance booking rule"}},"components/schemas/Ocapi.V1.Browsing.MasterData.FilmScreenings.FilmScreening":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.FilmScreenings.FilmScreening","kind":"json-schema","title":"FilmScreening","data":{"title":"FilmScreening","required":["filmId","sites"],"type":"object","properties":{"filmId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the film"},"sites":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.FilmScreenings.FilmScreeningSite"},"description":"Gets the list of film screening site entities"}},"additionalProperties":false,"description":"Represents the screening details of a film"}},"components/schemas/Ocapi.V1.Browsing.MasterData.FilmScreenings.FilmScreeningDate":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.FilmScreenings.FilmScreeningDate","kind":"json-schema","title":"FilmScreeningDate","data":{"title":"FilmScreeningDate","required":["businessDate","filmScreenings"],"type":"object","properties":{"businessDate":{"type":"string","description":"Gets the business date","format":"date-time"},"filmScreenings":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.FilmScreenings.FilmScreening"},"description":"Gets the list of film screening entities"}},"additionalProperties":false,"description":"Represents a list of film screening entities for a particular business date"}},"components/schemas/Ocapi.V1.Browsing.MasterData.FilmScreenings.FilmScreeningDateListDetails":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.FilmScreenings.FilmScreeningDateListDetails","kind":"json-schema","title":"FilmScreeningDateListDetails","data":{"title":"FilmScreeningDateListDetails","required":["filmScreeningDates"],"type":"object","properties":{"filmScreeningDates":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.FilmScreenings.FilmScreeningDate"},"description":"Gets the list of film screening date entities"}},"additionalProperties":false,"description":"Represents a list of film screening date entities"}},"components/schemas/Ocapi.V1.Browsing.MasterData.FilmScreenings.FilmScreeningSite":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.FilmScreenings.FilmScreeningSite","kind":"json-schema","title":"FilmScreeningSite","data":{"title":"FilmScreeningSite","required":["showtimeAttributeIds","siteId"],"type":"object","properties":{"siteId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the site"},"showtimeAttributeIds":{"type":"array","items":{"type":"string"},"description":"Gets the list of unique identifiers of the attribute entities being screened"}},"additionalProperties":false,"description":"Represents the details of a site that is screening a film"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Films.Film":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.Film","kind":"json-schema","title":"Film","data":{"title":"Film","required":["actors","castAndCrew","directors","displayPriority","distributorName","externalIds","genreIds","hoCode","id","producers","releaseDate","runtimeInMinutes","title","trailers"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"title":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the title text, and its translations"},"synopsis":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the plot/synopsis text, and its translations"},"shortSynopsis":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the short plot/synopsis text, and its translations"},"censorRatingId":{"type":"string","description":"Gets the unique identifier of the censor rating, if applicable","nullable":true},"censorRatingNote":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets a description of the content in the film that qualifies it for its censor rating, if applicable"},"releaseDate":{"type":"string","description":"Gets the release date of the film","format":"date-time"},"runtimeInMinutes":{"type":"integer","description":"Gets the runtime duration in minutes","format":"int32"},"trailers":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmTrailer"},"description":"Gets the list of film trailer entities"},"trailerUrl":{"type":"string","description":"Gets the trailer video URL","format":"uri","nullable":true},"displayPriority":{"type":"integer","description":"Gets the display priority used for sorting","format":"int32"},"castAndCrew":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmCastAndCrewMemberWithRoles"}},"actors":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmCastAndCrewMember"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmCastAndCrewMemberWithRoles"}],"description":"Represents a cast and crew member in the context of a particular film"},"description":"Gets the list of film cast and crew member entities that acted in the film, sorted by billing order"},"directors":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmCastAndCrewMember"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmCastAndCrewMemberWithRoles"}],"description":"Represents a cast and crew member in the context of a particular film"},"description":"Gets the list of film cast and crew member entities that directed the film, sorted by billing order"},"producers":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmCastAndCrewMember"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmCastAndCrewMemberWithRoles"}],"description":"Represents a cast and crew member in the context of a particular film"},"description":"Gets the list of film cast and crew member entities that produced the film, sorted by billing order"},"genreIds":{"type":"array","items":{"type":"string"},"description":"Gets the list of unique identifiers of the assigned genre entities"},"externalIds":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmExternalIds"}],"description":"Gets the external identifiers"},"hopk":{"type":"string","description":"Gets the Head Office primary key","nullable":true},"hoCode":{"minLength":1,"type":"string","description":"Gets the Head Office code"},"eventId":{"type":"string","description":"Gets the unique identifier of the event the film is assigned to, if applicable","nullable":true},"distributorName":{"minLength":1,"type":"string","description":"Gets the name of the distributor"}},"additionalProperties":false,"description":"Represents a film entity"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmCastAndCrewMember":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmCastAndCrewMember","kind":"json-schema","title":"FilmCastAndCrewMember","data":{"title":"FilmCastAndCrewMember","required":["castAndCrewMemberId"],"type":"object","properties":{"castAndCrewMemberId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the cast and crew member"}},"additionalProperties":false,"description":"Represents a cast and crew member in the context of a particular film"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmCastAndCrewMemberWithRoles":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmCastAndCrewMemberWithRoles","kind":"json-schema","title":"FilmCastAndCrewMemberWithRoles","data":{"title":"FilmCastAndCrewMemberWithRoles","required":["castAndCrewMemberId","roles"],"type":"object","properties":{"castAndCrewMemberId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the cast and crew member"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CastAndCrewMembers.CastAndCrewMemberRole"},"description":"Gets the list of roles"}},"additionalProperties":false,"description":"Represents a film cast and crew member with the list of roles they play in the creation of a film"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmDetails":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmDetails","kind":"json-schema","title":"FilmDetails","data":{"title":"FilmDetails","required":["film","relatedData"],"type":"object","properties":{"film":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.Film"}],"description":"Gets the film entity"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmRelatedData"}],"description":"Gets the related data for the film entity"}},"additionalProperties":false,"description":"Represents the details of a film entity, and its related data"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmExternalIds":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmExternalIds","kind":"json-schema","title":"FilmExternalIds","data":{"title":"FilmExternalIds","type":"object","properties":{"moviexchangeReleaseId":{"type":"string","description":"Gets the unique identifier of the linked movieXchange film release entity","format":"uuid","nullable":true},"corporateId":{"type":"string","description":"Gets the unique corporate identifier","nullable":true}},"additionalProperties":false,"description":"Represents the external identifiers linked to a film"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmListDetails":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmListDetails","kind":"json-schema","title":"FilmListDetails","data":{"title":"FilmListDetails","required":["films","relatedData"],"type":"object","properties":{"films":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.Film"},"description":"Gets the list of film entities"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmListRelatedData"}],"description":"Gets the related data for the film entities"}},"additionalProperties":false,"description":"Represents a list of film entities, and their related data"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmListRelatedData":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmListRelatedData","kind":"json-schema","title":"FilmListRelatedData","data":{"title":"FilmListRelatedData","required":["castAndCrew","censorRatings","events","genres"],"type":"object","properties":{"castAndCrew":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CastAndCrewMembers.CastAndCrewMember"},"description":"Gets the list of related cast and crew member entities"},"genres":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Genres.Genre"},"description":"Gets the list of related genre entities"},"censorRatings":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CensorRatings.CensorRating"},"description":"Gets the list of related censor rating entities"},"events":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Events.Event"},"description":"Gets the list of related event entities"}},"additionalProperties":false,"description":"Related data for a list of film entities"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmRelatedData":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmRelatedData","kind":"json-schema","title":"FilmRelatedData","data":{"title":"FilmRelatedData","required":["castAndCrew","genres"],"type":"object","properties":{"castAndCrew":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CastAndCrewMembers.CastAndCrewMember"},"description":"Gets the list of related cast and crew member entities"},"genres":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Genres.Genre"},"description":"Gets the list of related genre entities"},"censorRating":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CensorRatings.CensorRating"}],"description":"Gets the related censor rating entity, if applicable"},"event":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Events.Event"}],"description":"Gets the related event entity, if applicable"}},"additionalProperties":false,"description":"Related data for a film entity"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmTrailer":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmTrailer","kind":"json-schema","title":"FilmTrailer","data":{"title":"FilmTrailer","required":["provider","uri"],"type":"object","properties":{"provider":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmTrailerProvider"}],"description":"Gets the provider"},"uri":{"type":"string","description":"Gets the address used for retrieving the trailer","format":"uri"}},"additionalProperties":false,"description":"Represents a video trailer for a film"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmTrailerProvider":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmTrailerProvider","kind":"json-schema","title":"FilmTrailerProvider","data":{"title":"FilmTrailerProvider","enum":["Moviexchange","External"],"type":"string","description":"Represents the provider of a film trailer"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Genres.Genre":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Genres.Genre","kind":"json-schema","title":"Genre","data":{"title":"Genre","required":["id","name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"description":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the description text, and its translations"}},"additionalProperties":false,"description":"Represents the genre of a film entity"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Screens.Screen":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Screens.Screen","kind":"json-schema","title":"Screen","data":{"title":"Screen","required":["id","name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier","readOnly":true},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"}},"additionalProperties":false,"description":"Represents a room belonging to a site where film entities are screened"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.EventShowtimeListDetails":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.EventShowtimeListDetails","kind":"json-schema","title":"EventShowtimeListDetails","data":{"title":"EventShowtimeListDetails","required":["eventId","relatedData","showtimes"],"type":"object","properties":{"eventId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the event"},"showtimes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.Showtime"},"description":"Gets the list of showtime entities"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.EventShowtimeListRelatedData"}],"description":"Gets the related data for the showtime entities"}},"additionalProperties":false,"description":"Represents a list of showtime entities for a particular event, and their related data"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.EventShowtimeListRelatedData":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.EventShowtimeListRelatedData","kind":"json-schema","title":"EventShowtimeListRelatedData","data":{"title":"EventShowtimeListRelatedData","required":["areaCategories","attributes","castAndCrew","censorRatings","event","filmAdvanceBookingRules","films","genres","salesTaxes","screens","sites"],"type":"object","properties":{"event":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Events.Event"}],"description":"Gets the related event entity"},"sites":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.Site"}],"description":"Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities"},"description":"Gets the list of related site entities"},"films":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.Film"},"description":"Gets the list of related film entities"},"castAndCrew":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CastAndCrewMembers.CastAndCrewMember"},"description":"Gets the list of related cast and crew member entities"},"genres":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Genres.Genre"},"description":"Gets the list of related genre entities"},"censorRatings":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CensorRatings.CensorRating"},"description":"Gets the list of related censor rating entities"},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Attributes.Attribute"},"description":"Gets the list of related attribute entities"},"screens":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Screens.Screen"},"description":"Gets the list of related screen entities"},"filmAdvanceBookingRules":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.FilmAdvanceBookings.FilmAdvanceBookingRule"},"description":"Gets the list of related film advance booking rule entities"},"areaCategories":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.AreaCategory"},"description":"Gets the list of related area category entities"},"salesTaxes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTax"},"description":"Gets the list of related sales tax entities"}},"additionalProperties":false,"description":"Related data for a list of showtime entities for a particular event"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.FilmShowtimeListDetails":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.FilmShowtimeListDetails","kind":"json-schema","title":"FilmShowtimeListDetails","data":{"title":"FilmShowtimeListDetails","required":["filmId","relatedData","showtimes"],"type":"object","properties":{"filmId":{"minLength":1,"type":"string"},"showtimes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.Showtime"}},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.FilmShowtimeListRelatedData"}]}},"additionalProperties":false,"description":"Represents a list of showtime entities for a particular film and their related data"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.FilmShowtimeListRelatedData":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.FilmShowtimeListRelatedData","kind":"json-schema","title":"FilmShowtimeListRelatedData","data":{"title":"FilmShowtimeListRelatedData","required":["areaCategories","attributes","castAndCrew","censorRatings","events","film","filmAdvanceBookingRules","genres","salesTaxes","screens","sites"],"type":"object","properties":{"film":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.Film"}]},"sites":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.Site"}],"description":"Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Events.Event"}},"castAndCrew":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CastAndCrewMembers.CastAndCrewMember"}},"genres":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Genres.Genre"}},"censorRatings":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CensorRatings.CensorRating"}},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Attributes.Attribute"}},"screens":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Screens.Screen"}},"filmAdvanceBookingRules":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.FilmAdvanceBookings.FilmAdvanceBookingRule"}},"areaCategories":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.AreaCategory"}},"salesTaxes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTax"},"description":"Gets the list of related sales tax entities"}},"additionalProperties":false,"description":"Related data for a list of showtime entities for a particular film"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.Showtime":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.Showtime","kind":"json-schema","title":"Showtime","data":{"title":"Showtime","required":["areaCategories","attributeIds","filmId","id","isAllocatedSeating","isSoldOut","requires3dGlasses","restrictions","schedule","screenId","seatLayoutId","siteId"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier","readOnly":true},"schedule":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeSchedule"}],"description":"Gets the timing schedule"},"isSoldOut":{"type":"boolean","description":"Gets a value indicating whether the showtime is currently sold out"},"seatLayoutId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the seat layout of the screen","readOnly":true},"filmId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the film that is being screened"},"siteId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the site that is screening the film"},"screenId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the screen that the film will be played on"},"areaCategories":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeAreaCategory"},"description":"Gets the list of showtime area category entities"},"attributeIds":{"type":"array","items":{"type":"string"},"description":"Gets the list of unique identifiers of the assigned attribute entities"},"isAllocatedSeating":{"type":"boolean","description":"Gets a value indicating whether the seat entities are allocated"},"requires3dGlasses":{"type":"boolean","description":"Gets a value indicating whether this showtime requires 3D glasses to be viewed"},"eventId":{"type":"string","description":"Gets the unique identifier of the event the showtime is assigned to, if applicable","nullable":true},"restrictions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeRestriction"},"description":"Gets the list of restrictions that apply"},"filmAdvanceBookingRuleId":{"type":"string","description":"Gets the unique identifier of the film advance booking rule that the showtime is restricted to","nullable":true},"inSeatItemDeliveryFee":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryFees.ItemDeliveryFeeFixedPrice"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryFees.ItemDeliveryFeePercentage"}],"description":"Represents the base properties of an item delivery fee"}},"additionalProperties":false,"description":"Represents the presentation of a film on a particular screen at a particular date and time"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeAreaCategory":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeAreaCategory","kind":"json-schema","title":"ShowtimeAreaCategory","data":{"title":"ShowtimeAreaCategory","required":["areaCategoryId","isAllocatedSeating"],"type":"object","properties":{"areaCategoryId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the area category entity"},"isAllocatedSeating":{"type":"boolean","description":"Gets a value indicating whether the seat entities are allocated"}},"additionalProperties":false,"description":"Represents the details of an area category within the context of a showtime"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeBusinessDayListDetails":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeBusinessDayListDetails","kind":"json-schema","title":"ShowtimeBusinessDayListDetails","data":{"title":"ShowtimeBusinessDayListDetails","required":["businessDate","relatedData","showtimes"],"type":"object","properties":{"showtimes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.Showtime"},"description":"Gets the list of showtime entities"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeListRelatedData"}],"description":"Gets the related data for the showtime entities"},"businessDate":{"type":"string","description":"Gets the business date of the showtime entities","format":"date-time"}},"additionalProperties":false,"description":"Represents a list of showtime entities for a particular business day, and their related data"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeDetails":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeDetails","kind":"json-schema","title":"ShowtimeDetails","data":{"title":"ShowtimeDetails","required":["relatedData","showtime"],"type":"object","properties":{"showtime":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.Showtime"}],"description":"Gets the showtime entity"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeRelatedData"}],"description":"Gets the related data for the showtime entity"}},"additionalProperties":false,"description":"Represents the details of a showtime entity, and its related data"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeInSeatItemDeliverySchedule":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeInSeatItemDeliverySchedule","kind":"json-schema","title":"ShowtimeInSeatItemDeliverySchedule","data":{"title":"ShowtimeInSeatItemDeliverySchedule","required":["endsAt","startsAt"],"type":"object","properties":{"startsAt":{"type":"string","description":"Gets the date and time when in-seat item delivery becomes available","format":"date-time"},"endsAt":{"type":"string","description":"Gets the date and time when in-seat item delivery is no longer available","format":"date-time"}},"additionalProperties":false,"description":"Represents when in-seat item delivery is available for a showtime"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeListDetails":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeListDetails","kind":"json-schema","title":"ShowtimeListDetails","data":{"title":"ShowtimeListDetails","required":["relatedData","showtimes"],"type":"object","properties":{"showtimes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.Showtime"},"description":"Gets the list of showtime entities"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeListRelatedData"}],"description":"Gets the related data for the showtime entities"}},"additionalProperties":false,"description":"Represents a list of showtime entities, and their related data"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeListRelatedData":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeListRelatedData","kind":"json-schema","title":"ShowtimeListRelatedData","data":{"title":"ShowtimeListRelatedData","required":["areaCategories","attributes","castAndCrew","censorRatings","events","filmAdvanceBookingRules","films","genres","salesTaxes","screens","sites"],"type":"object","properties":{"sites":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.Site"}],"description":"Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities"},"description":"Gets the list of related site entities"},"films":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.Film"},"description":"Gets the list of related film entities"},"castAndCrew":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CastAndCrewMembers.CastAndCrewMember"},"description":"Gets the list of related cast and crew member entities"},"genres":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Genres.Genre"},"description":"Gets the list of related genre entities"},"censorRatings":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CensorRatings.CensorRating"},"description":"Gets the list of related censor rating entities"},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Attributes.Attribute"},"description":"Gets the list of related attribute entities"},"screens":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Screens.Screen"},"description":"Gets the list of related screen entities"},"events":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Events.Event"},"description":"Gets the list of related event entities"},"filmAdvanceBookingRules":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.FilmAdvanceBookings.FilmAdvanceBookingRule"},"description":"Gets the list of related film advance booking rule entities"},"areaCategories":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.AreaCategory"},"description":"Gets the list of related area category entities"},"salesTaxes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTax"},"description":"Gets the list of related sales tax entities"}},"additionalProperties":false,"description":"Related data for a list of showtime entities"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeRelatedData":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeRelatedData","kind":"json-schema","title":"ShowtimeRelatedData","data":{"title":"ShowtimeRelatedData","required":["areaCategories","attributes","castAndCrew","film","genres","salesTaxes","screen","site"],"type":"object","properties":{"site":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.Site"}],"description":"Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities"},"film":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.Film"}],"description":"Gets the related film entity"},"screen":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Screens.Screen"}],"description":"Gets the related screen entity"},"castAndCrew":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CastAndCrewMembers.CastAndCrewMember"},"description":"Gets the list of related cast and crew member entities"},"genres":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Genres.Genre"},"description":"Gets the list of related genre entities"},"censorRating":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CensorRatings.CensorRating"}],"description":"Gets the related censor rating, if applicable"},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Attributes.Attribute"},"description":"Gets the list of related attribute entities"},"event":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Events.Event"}],"description":"Gets the related event, if applicable"},"filmAdvanceBookingRule":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.FilmAdvanceBookings.FilmAdvanceBookingRule"}],"description":"Gets the related film advance booking rule, if applicable"},"areaCategories":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.AreaCategory"},"description":"Gets the list of related area category entities"},"salesTaxes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTax"},"description":"Gets the list of related sales tax entities"}},"additionalProperties":false,"description":"Related data for a showtime entity"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeRestriction":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeRestriction","kind":"json-schema","title":"ShowtimeRestriction","data":{"title":"ShowtimeRestriction","enum":["FilmAdvanceBookingRule"],"type":"string","description":"Represents the restriction options for a showtime"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeSchedule":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeSchedule","kind":"json-schema","title":"ShowtimeSchedule","data":{"title":"ShowtimeSchedule","required":["businessDate","endsAt","filmEndsAt","filmStartsAt","startsAt"],"type":"object","properties":{"businessDate":{"type":"string","description":"Gets the showtime entity's business date","format":"date-time"},"startsAt":{"type":"string","description":"Gets the date and time that the showtime starts","format":"date-time"},"endsAt":{"type":"string","description":"Gets the date and time that the showtime ends","format":"date-time"},"filmStartsAt":{"type":"string","description":"Gets the date and time that the film screening starts","format":"date-time"},"filmEndsAt":{"type":"string","description":"Gets the date and time that the film screening ends","format":"date-time"},"inSeatItemDelivery":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeInSeatItemDeliverySchedule"}],"description":"Gets the showtime in seat item delivery schedule entity, if applicable"}},"additionalProperties":false,"description":"Represents the dates and times relevant to a showtime, e.g. its start, end, film start, etc"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.SiteShowtimeListDetails":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.SiteShowtimeListDetails","kind":"json-schema","title":"SiteShowtimeListDetails","data":{"title":"SiteShowtimeListDetails","required":["relatedData","showtimes","siteId"],"type":"object","properties":{"siteId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the site"},"showtimes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.Showtime"},"description":"Gets the list of showtime entities"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.SiteShowtimeListRelatedData"}],"description":"Gets the related data for the showtime entities"}},"additionalProperties":false,"description":"Represents a list of showtime entities for a particular site, and their related data"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.SiteShowtimeListRelatedData":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.SiteShowtimeListRelatedData","kind":"json-schema","title":"SiteShowtimeListRelatedData","data":{"title":"SiteShowtimeListRelatedData","required":["areaCategories","attributes","castAndCrew","censorRatings","filmAdvanceBookingRules","films","genres","salesTaxes","screens","sites"],"type":"object","properties":{"films":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.Film"},"description":"Gets the list of related film entities"},"sites":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.Site"}],"description":"Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities"},"description":"Gets the list of related site entities"},"castAndCrew":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CastAndCrewMembers.CastAndCrewMember"},"description":"Gets the list of related cast and crew member entities"},"genres":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Genres.Genre"},"description":"Gets the list of related genre entities"},"censorRatings":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CensorRatings.CensorRating"},"description":"Gets the list of related censor rating entities"},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Attributes.Attribute"},"description":"Gets the list of related attribute entities"},"screens":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Screens.Screen"},"description":"Gets the list of related screen entities"},"filmAdvanceBookingRules":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.FilmAdvanceBookings.FilmAdvanceBookingRule"},"description":"Gets the list of related film advance booking rule entities"},"areaCategories":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.AreaCategory"},"description":"Gets the list of related area category entities"},"salesTaxes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTax"},"description":"Gets the list of related sales tax entities"}},"additionalProperties":false,"description":"Related data for a list of showtime entities for a particular site"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.Site":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.Site","kind":"json-schema","title":"Site","data":{"title":"Site","required":["allowedItemDeliveryMethods","contactDetails","hasSellableItems","ianaTimeZoneName","id","name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"location":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.GeographicLocation"}],"description":"Gets the geographic location"},"contactDetails":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteContactDetails"}],"description":"Gets the contact details"},"ianaTimeZoneName":{"minLength":1,"type":"string","description":"Gets the IANA time zone name","example":"America/New_York"},"hasSellableItems":{"type":"boolean","description":"Gets a value indicating whether the site has any sellable item entities"},"allowedItemDeliveryMethods":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"},"description":"Gets the list of allowed item delivery method entities"}},"additionalProperties":false,"description":"Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteAddress":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteAddress","kind":"json-schema","title":"SiteAddress","data":{"title":"SiteAddress","type":"object","properties":{"line1":{"type":"string","description":"Gets the first line","nullable":true,"example":"60 Khyber Pass Road"},"line2":{"type":"string","description":"Gets the second line","nullable":true,"example":"Grafton"},"city":{"type":"string","description":"Gets the city","nullable":true,"example":"Auckland 1023"}},"additionalProperties":false,"description":"Represents the physical address of a site"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteAddressV2":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteAddressV2","kind":"json-schema","title":"SiteAddressV2","data":{"title":"SiteAddressV2","type":"object","properties":{"line1":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the first line text, and its translations, if applicable"},"line2":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the second line text, and its translations, if applicable"},"line3":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the third line text, and its translations, if applicable"},"line4":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the forth line text, and its translations, if applicable"}},"additionalProperties":false,"description":"Represents the physical address of a site"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteContactDetails":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteContactDetails","kind":"json-schema","title":"SiteContactDetails","data":{"title":"SiteContactDetails","required":["addressV2","phoneNumbers"],"type":"object","properties":{"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.PhoneNumber"},"description":"Gets the list of phone number entities"},"email":{"type":"string","description":"Gets the email address","nullable":true},"address":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteAddress"}],"description":"Gets the physical address"},"addressV2":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteAddressV2"}],"description":"Gets the physical address"}},"additionalProperties":false,"description":"Represents the contact details of a site"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteDetails":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteDetails","kind":"json-schema","title":"SiteDetails","data":{"title":"SiteDetails","required":["site"],"type":"object","properties":{"site":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.Site"}],"description":"Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities"}},"additionalProperties":false,"description":"Represents the details of a site entity"}},"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteListDetails":{"id":"components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteListDetails","kind":"json-schema","title":"SiteListDetails","data":{"title":"SiteListDetails","required":["sites"],"type":"object","properties":{"sites":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.Site"}],"description":"Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities"},"description":"Gets the list of site entities"}},"additionalProperties":false,"description":"Represents a list of site entities"}},"components/schemas/Ocapi.V1.Dining.DiningArea":{"id":"components/schemas/Ocapi.V1.Dining.DiningArea","kind":"json-schema","title":"DiningArea","data":{"title":"DiningArea","required":["id","isDefault","locations","name"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}]},"isDefault":{"type":"boolean"},"locations":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Dining.DiningChair"},{"$ref":"#/components/schemas/Ocapi.V1.Dining.DiningTable"}],"description":"Represents the base properties of a location within a dining layout"}}},"additionalProperties":false,"description":"Represents an area within a dining layout"}},"components/schemas/Ocapi.V1.Dining.DiningChair":{"id":"components/schemas/Ocapi.V1.Dining.DiningChair","kind":"json-schema","title":"DiningChair","data":{"title":"DiningChair","required":["type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Dining.DiningLocationBase"}],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Dining.MasterData.DiningLocationType"}]}},"additionalProperties":false,"description":"Represents a standalone dining chair within a dining layout"}},"components/schemas/Ocapi.V1.Dining.DiningLayout":{"id":"components/schemas/Ocapi.V1.Dining.DiningLayout","kind":"json-schema","title":"DiningLayout","data":{"title":"DiningLayout","required":["areas"],"type":"object","properties":{"areas":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Dining.DiningArea"}}},"additionalProperties":false,"description":"Represents the layout of dining tables and chairs at a site"}},"components/schemas/Ocapi.V1.Dining.DiningLayoutDetails":{"id":"components/schemas/Ocapi.V1.Dining.DiningLayoutDetails","kind":"json-schema","title":"DiningLayoutDetails","data":{"title":"DiningLayoutDetails","required":["diningLayout"],"type":"object","properties":{"diningLayout":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Dining.DiningLayout"}]}},"additionalProperties":false,"description":"Represents the details of a dining layout entity"}},"components/schemas/Ocapi.V1.Dining.DiningLocationBase":{"id":"components/schemas/Ocapi.V1.Dining.DiningLocationBase","kind":"json-schema","title":"DiningLocationBase","data":{"title":"DiningLocationBase","required":["areaName","id","label","type"],"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true},"label":{"minLength":1,"type":"string"},"areaName":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}]},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Dining.MasterData.DiningLocationType"}]}},"additionalProperties":false,"description":"Represents the base properties of a location within a dining layout"}},"components/schemas/Ocapi.V1.Dining.DiningTable":{"id":"components/schemas/Ocapi.V1.Dining.DiningTable","kind":"json-schema","title":"DiningTable","data":{"title":"DiningTable","required":["type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Dining.DiningLocationBase"}],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Dining.MasterData.DiningLocationType"}]}},"additionalProperties":false,"description":"Represents a dining table with one or more chairs within a dining layout"}},"components/schemas/Ocapi.V1.Dining.MasterData.DiningLocationType":{"id":"components/schemas/Ocapi.V1.Dining.MasterData.DiningLocationType","kind":"json-schema","title":"DiningLocationType","data":{"title":"DiningLocationType","enum":["Table","Chair"],"type":"string","description":"Represents the type of a dining location base"}},"components/schemas/Ocapi.V1.DiscountCalculations.DiscountCalculationType":{"id":"components/schemas/Ocapi.V1.DiscountCalculations.DiscountCalculationType","kind":"json-schema","title":"DiscountCalculationType","data":{"title":"DiscountCalculationType","enum":["SpecialPrice","PercentageOff","PriceOff"],"type":"string","description":"Represents the type of a discount calculation base"}},"components/schemas/Ocapi.V1.DiscountCalculations.PercentageOffDiscountCalculation":{"id":"components/schemas/Ocapi.V1.DiscountCalculations.PercentageOffDiscountCalculation","kind":"json-schema","title":"PercentageOffDiscountCalculation","data":{"title":"PercentageOffDiscountCalculation","required":["percentageOff","type"],"type":"object","properties":{"percentageOff":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets the percentage off the default price, e.g. 12.5% off"},"children":[]}]}]}],"format":"double"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.DiscountCalculations.DiscountCalculationType"}],"description":"Gets the calculation type"}},"additionalProperties":false,"description":"Represents a percentage-off type of discount calculation base"}},"components/schemas/Ocapi.V1.DiscountCalculations.PriceOffDiscountCalculation":{"id":"components/schemas/Ocapi.V1.DiscountCalculations.PriceOffDiscountCalculation","kind":"json-schema","title":"PriceOffDiscountCalculation","data":{"title":"PriceOffDiscountCalculation","required":["priceOff","type"],"type":"object","properties":{"priceOff":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets the value of the discount off the default price, e.g. $2.00 off"},"children":[]}]}]}],"format":"double"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.DiscountCalculations.DiscountCalculationType"}],"description":"Gets the calculation type"}},"additionalProperties":false,"description":"Represents a price-off type of discount calculation base"}},"components/schemas/Ocapi.V1.DiscountCalculations.SpecialPriceDiscountCalculation":{"id":"components/schemas/Ocapi.V1.DiscountCalculations.SpecialPriceDiscountCalculation","kind":"json-schema","title":"SpecialPriceDiscountCalculation","data":{"title":"SpecialPriceDiscountCalculation","required":["specialPrice","type"],"type":"object","properties":{"specialPrice":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets the value of the special price defined by the discount, e.g. now $1.50"},"children":[]}]}]}],"format":"double"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.DiscountCalculations.DiscountCalculationType"}],"description":"Gets the calculation type"}},"additionalProperties":false,"description":"Represents a special-price type of discount calculation base"}},"components/schemas/Ocapi.V1.Errors.MemberLockedError":{"id":"components/schemas/Ocapi.V1.Errors.MemberLockedError","kind":"json-schema","title":"MemberLockedError","data":{"title":"MemberLockedError","required":["title"],"type":"object","properties":{"type":{"type":"string","description":"Gets a URI reference that identifies the problem type","nullable":true},"status":{"type":"integer","description":"Gets the HTTP status code generated by the origin server for this occurrence of the problem","format":"int32","nullable":true},"title":{"minLength":1,"type":"string","description":"Gets a short, human-readable summary of the problem type"},"detail":{"type":"string","description":"Gets a human-readable explanation specific to this occurrence of the problem","nullable":true},"instance":{"type":"string","description":"Gets a URI reference that identifies the specific occurrence of the problem.It may or may not yield further information if dereferenced","nullable":true},"correlationId":{"type":"string","description":"Gets the unique correlation identifier of the request if set (for diagnostic purposes)","nullable":true},"originalRequestUrl":{"type":"string","description":"Gets the URL of the request returning the error (for diagnostic purposes)","format":"uri","nullable":true},"errorCode":{"type":"integer","description":"Gets the error code associated with the specific problem type (if applicable)","format":"int32","nullable":true},"lockOutPeriodInSeconds":{"type":"integer","description":"Gets the time in seconds between member being temporarily locked and free to login","format":"int32"}},"additionalProperties":false,"description":"Represents a Loyalty member temporarily locked out of loyalty due to too many failed login attempts"}},"components/schemas/Ocapi.V1.Errors.RateLimitExceededError":{"id":"components/schemas/Ocapi.V1.Errors.RateLimitExceededError","kind":"json-schema","title":"RateLimitExceededError","data":{"title":"RateLimitExceededError","required":["title"],"type":"object","properties":{"type":{"type":"string","description":"Gets a URI reference that identifies the problem type","nullable":true},"status":{"type":"integer","description":"Gets the HTTP status code generated by the origin server for this occurrence of the problem","format":"int32","nullable":true},"title":{"minLength":1,"type":"string","description":"Gets a short, human-readable summary of the problem type"},"detail":{"type":"string","description":"Gets a human-readable explanation specific to this occurrence of the problem","nullable":true},"instance":{"type":"string","description":"Gets a URI reference that identifies the specific occurrence of the problem.It may or may not yield further information if dereferenced","nullable":true},"correlationId":{"type":"string","description":"Gets the unique correlation identifier of the request if set (for diagnostic purposes)","nullable":true},"originalRequestUrl":{"type":"string","description":"Gets the URL of the request returning the error (for diagnostic purposes)","format":"uri","nullable":true},"blockedUntil":{"type":"string","format":"date-time"}},"additionalProperties":false}},"components/schemas/Ocapi.V1.GeographicLocation":{"id":"components/schemas/Ocapi.V1.GeographicLocation","kind":"json-schema","title":"GeographicLocation","data":{"title":"GeographicLocation","required":["latitude","longitude"],"type":"object","properties":{"latitude":{"type":"number","description":"Gets the latitude (expressed in degrees and minutes)","format":"double"},"longitude":{"type":"number","description":"Gets the longitude (expressed in degrees and minutes)","format":"double"}},"additionalProperties":false,"description":"Represents a set of geospatial coordinates; longitude and latitude, that can be used to pinpoint a\r\nlocation on a map"}},"components/schemas/Ocapi.V1.GiftCards.GiftCardCredentials":{"id":"components/schemas/Ocapi.V1.GiftCards.GiftCardCredentials","kind":"json-schema","title":"GiftCardCredentials","data":{"title":"GiftCardCredentials","required":["cardNumber"],"type":"object","properties":{"cardNumber":{"minLength":1,"type":"string","description":"Gets the card number"},"pin":{"type":"string","description":"Gets the PIN","nullable":true}},"additionalProperties":false,"description":"Represents the credentials required to validate a gift card"}},"components/schemas/Ocapi.V1.GiftCards.GiftCardDetails":{"id":"components/schemas/Ocapi.V1.GiftCards.GiftCardDetails","kind":"json-schema","title":"GiftCardDetails","data":{"title":"GiftCardDetails","required":["availableBalance","maskedCardNumber"],"type":"object","properties":{"maskedCardNumber":{"minLength":1,"type":"string","description":"Gets a masked representation of the card number","example":"12.......6789"},"expiresAt":{"type":"string","description":"Gets the expiry date and time, or null if the gift card never expires","format":"date-time","nullable":true},"availableBalance":{"type":"number","description":"Gets the available balance","format":"double"}},"additionalProperties":false,"description":"Represents the details of a validated gift card"}},"components/schemas/Ocapi.V1.Journey.Journey":{"id":"components/schemas/Ocapi.V1.Journey.Journey","kind":"json-schema","title":"Journey","data":{"title":"Journey","required":["createdAt","id","orders","siteId"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"siteId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the site"},"orders":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrder"},"description":"Gets the list of completed standard order entities"},"createdAt":{"type":"string","description":"Gets the date and time that the journey was created","format":"date-time"}},"additionalProperties":false,"description":"Represents a customer's interactions, from start to finish, with Vista software in relation\r\nto one or multiple visits to a site initiated by a single sale"}},"components/schemas/Ocapi.V1.Journey.JourneyDetails":{"id":"components/schemas/Ocapi.V1.Journey.JourneyDetails","kind":"json-schema","title":"JourneyDetails","data":{"title":"JourneyDetails","required":["journey","relatedData"],"type":"object","properties":{"journey":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Journey.Journey"}],"description":"Gets the journey entity"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedData"}],"description":"Gets the related data for the journey entity"}},"additionalProperties":false,"description":"Represents the details of a journey entity, and its related data"}},"components/schemas/Ocapi.V1.Journey.JourneyListDetails":{"id":"components/schemas/Ocapi.V1.Journey.JourneyListDetails","kind":"json-schema","title":"JourneyListDetails","data":{"title":"JourneyListDetails","required":["journeys","relatedData"],"type":"object","properties":{"journeys":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Journey.Journey"},"description":"Gets the list of journey entities"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedData"}],"description":"Gets the related data for the journey entities"}},"additionalProperties":false,"description":"Represents a list of journey entities, and their related data"}},"components/schemas/Ocapi.V1.Journey.JourneyPaginatedResultSet":{"id":"components/schemas/Ocapi.V1.Journey.JourneyPaginatedResultSet","kind":"json-schema","title":"JourneyPaginatedResultSet","data":{"title":"JourneyPaginatedResultSet","required":["hasMoreResults","relatedData","results"],"type":"object","properties":{"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedData"}],"description":"Gets the related data for the journey entities"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Journey.Journey"},"description":"Gets the list of results"},"hasMoreResults":{"type":"boolean","description":"Gets a value indicating whether any more results are available"}},"additionalProperties":false,"description":"Represents a paginated result set of journey entities, and their related data"}},"components/schemas/Ocapi.V1.Loyalty.BalanceTypes.BalanceType":{"id":"components/schemas/Ocapi.V1.Loyalty.BalanceTypes.BalanceType","kind":"json-schema","title":"BalanceType","data":{"title":"BalanceType","required":["id","isPrimary","name","unitDecimalPlaces"],"type":"object","properties":{"id":{"type":"integer","description":"Gets the unique identifier","format":"int32"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"isPrimary":{"type":"boolean","description":"Gets a value indicating whether this is the primary balance type"},"unitName":{"type":"string","description":"Gets the name of the balance units","nullable":true,"example":"Points"},"paymentConversionRate":{"type":"number","description":"Gets the conversion rate that applies when using balance units for an order member balance payment, if applicable","format":"double","nullable":true},"unitDecimalPlaces":{"type":"integer","description":"Gets the number of decimal places used to format and calculate balance unit values","format":"int32"}},"additionalProperties":false,"description":"Represents an account in Vista Loyalty that tracks the spending or activity of a member"}},"components/schemas/Ocapi.V1.Loyalty.Clubs.Club":{"id":"components/schemas/Ocapi.V1.Loyalty.Clubs.Club","kind":"json-schema","title":"Club","data":{"title":"Club","required":["id","name"],"type":"object","properties":{"id":{"type":"integer","description":"Gets the unique identifier","format":"int32"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"}},"additionalProperties":false,"description":"Represents a scheme in Vista Loyalty that member entities join via a member club membership to gain reward entities"}},"components/schemas/Ocapi.V1.Loyalty.Clubs.ClubLevel":{"id":"components/schemas/Ocapi.V1.Loyalty.Clubs.ClubLevel","kind":"json-schema","title":"ClubLevel","data":{"title":"ClubLevel","required":["id","isExemptFromBookingFees","name"],"type":"object","properties":{"id":{"type":"integer","description":"Gets the unique identifier","format":"int32"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"isExemptFromBookingFees":{"type":"boolean","description":"Gets a value indicating whether a member assigned to this club level will be exempt from booking fees"}},"additionalProperties":false,"description":"Represents the level of a club"}},"components/schemas/Ocapi.V1.Loyalty.Delete.ExternallyAuthenticatedMemberDelete":{"id":"components/schemas/Ocapi.V1.Loyalty.Delete.ExternallyAuthenticatedMemberDelete","kind":"json-schema","title":"ExternallyAuthenticatedMemberDelete","data":{"title":"ExternallyAuthenticatedMemberDelete","type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Delete.MemberDeleteBase"}],"additionalProperties":false,"description":"Represents the values needed to securely delete a member that has been externally authenticated"}},"components/schemas/Ocapi.V1.Loyalty.Delete.LoyaltyAuthenticatedMemberDelete":{"id":"components/schemas/Ocapi.V1.Loyalty.Delete.LoyaltyAuthenticatedMemberDelete","kind":"json-schema","title":"LoyaltyAuthenticatedMemberDelete","data":{"title":"LoyaltyAuthenticatedMemberDelete","required":["currentPassword"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Delete.MemberDeleteBase"}],"properties":{"currentPassword":{"minLength":1,"type":"string","description":"Gets the current password of the member"}},"additionalProperties":false,"description":"Represents the values needed to securely delete a member that has been authenticated by\r\nVista Loyalty only"}},"components/schemas/Ocapi.V1.Loyalty.Delete.MemberDeleteBase":{"id":"components/schemas/Ocapi.V1.Loyalty.Delete.MemberDeleteBase","kind":"json-schema","title":"MemberDeleteBase","data":{"title":"MemberDeleteBase","required":["type"],"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.MemberSecureActionValidationType"}],"description":"Gets the validation type"}},"additionalProperties":false,"description":"Represents the values needed to securely delete a member"}},"components/schemas/Ocapi.V1.Loyalty.Items.LoyaltyItem":{"id":"components/schemas/Ocapi.V1.Loyalty.Items.LoyaltyItem","kind":"json-schema","title":"LoyaltyItem","data":{"title":"LoyaltyItem","required":["id","name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"itemClass":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Items.LoyaltyItemClass"}],"description":"Gets the item class"}},"additionalProperties":false,"description":"Represents an item in Vista Loyalty"}},"components/schemas/Ocapi.V1.Loyalty.Items.LoyaltyItemClass":{"id":"components/schemas/Ocapi.V1.Loyalty.Items.LoyaltyItemClass","kind":"json-schema","title":"LoyaltyItemClass","data":{"title":"LoyaltyItemClass","required":["name"],"type":"object","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"group":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Items.LoyaltyItemGroup"}],"description":"Gets the item group"}},"additionalProperties":false,"description":"Represents the class of a loyalty item"}},"components/schemas/Ocapi.V1.Loyalty.Items.LoyaltyItemGroup":{"id":"components/schemas/Ocapi.V1.Loyalty.Items.LoyaltyItemGroup","kind":"json-schema","title":"LoyaltyItemGroup","data":{"title":"LoyaltyItemGroup","required":["name","type"],"type":"object","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Items.LoyaltyItemGroupType"}],"description":"Gets the type"}},"additionalProperties":false,"description":"Represents the group of a loyalty item class"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.Authentication.ExternalAuthenticationIssuer":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.Authentication.ExternalAuthenticationIssuer","kind":"json-schema","title":"ExternalAuthenticationIssuer","data":{"title":"ExternalAuthenticationIssuer","required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier of the external authentication issuer"}},"additionalProperties":false,"description":"Represents an external authentication issuer that has been configured to be capable of authenticating\r\nLoyalty members in place of credentials stored in Loyalty"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.CustomPreferences.CustomPreference":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.CustomPreferences.CustomPreference","kind":"json-schema","title":"CustomPreference","data":{"title":"CustomPreference","required":["id","name","optionQuantityLimit","options"],"type":"object","properties":{"id":{"type":"integer","description":"Gets the unique identifier","format":"int32"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"optionQuantityLimit":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.QuantityLimit"}],"description":"Gets a value indicating the number of options that can be selected by a member"},"options":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.CustomPreferences.CustomPreferenceOption"},"description":"Gets the list of custom preference option entities"}},"additionalProperties":false,"description":"Represents a custom preference in Vista Loyalty with a list of custom preference option entities"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.CustomPreferences.CustomPreferenceOption":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.CustomPreferences.CustomPreferenceOption","kind":"json-schema","title":"CustomPreferenceOption","data":{"title":"CustomPreferenceOption","required":["id","name"],"type":"object","properties":{"id":{"type":"integer","description":"Gets the unique identifier","format":"int32"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"}},"additionalProperties":false,"description":"Represents an option for a custom preference"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.EducationLevels.EducationLevel":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.EducationLevels.EducationLevel","kind":"json-schema","title":"EducationLevel","data":{"title":"EducationLevel","required":["id","name"],"type":"object","properties":{"id":{"type":"integer","description":"Gets the unique identifier","format":"int32"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"}},"additionalProperties":false,"description":"Represents the education level of a member"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.Friends.MemberFriendConfiguration":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.Friends.MemberFriendConfiguration","kind":"json-schema","title":"MemberFriendConfiguration","data":{"title":"MemberFriendConfiguration","required":["friendLimit","isSubscriptionSharingRestrictedToActiveSubscribers"],"type":"object","properties":{"isSubscriptionSharingRestrictedToActiveSubscribers":{"type":"boolean","description":"Gets a value indicating whether the member friend subscription sharing functionality is restricted to\r\nmember entities with an active member subscription"},"friendLimit":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Quantity"}],"description":"Gets the maximum number of member friend entities that a member can have"}},"additionalProperties":false,"description":"Represents the configuration for the member friend functionality"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.Genres.LoyaltyGenre":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.Genres.LoyaltyGenre","kind":"json-schema","title":"LoyaltyGenre","data":{"title":"LoyaltyGenre","required":["id","name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"}},"additionalProperties":false,"description":"Represents a genre in Vista Loyalty"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.Interests.Interest":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.Interests.Interest","kind":"json-schema","title":"Interest","data":{"title":"Interest","required":["displayPriority","id","name"],"type":"object","properties":{"id":{"type":"integer","description":"Gets the unique identifier","format":"int32"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"displayPriority":{"type":"integer","description":"Gets the display priority used for sorting","format":"int32"}},"additionalProperties":false,"description":"Represents an interest that a member can subscribe to"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.Interests.InterestContactMethod":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.Interests.InterestContactMethod","kind":"json-schema","title":"InterestContactMethod","data":{"title":"InterestContactMethod","required":["id","name"],"type":"object","properties":{"id":{"type":"integer","description":"Gets the unique identifier","format":"int32"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"}},"additionalProperties":false,"description":"Represents a contact method that can be used to subscribe to an interest"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.Items.LoyaltyItemGroupType":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.Items.LoyaltyItemGroupType","kind":"json-schema","title":"LoyaltyItemGroupType","data":{"title":"LoyaltyItemGroupType","enum":["Custom","Ticket","Item","Discount"],"type":"string","description":"Represents the type of a loyalty item group"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.LoyaltyMasterData":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.LoyaltyMasterData","kind":"json-schema","title":"LoyaltyMasterData","data":{"title":"LoyaltyMasterData","required":["clubs","customPreferences","educationLevels","externalAuthenticationIssuers","friendConfiguration","genres","interestContactMethods","interests","occupations","photoRequirements","sites"],"type":"object","properties":{"clubs":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Clubs.Club"},"description":"Gets the list of club entities available to a member"},"customPreferences":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.CustomPreferences.CustomPreference"},"description":"Gets the list of custom preference entities used for setting member custom preference entities"},"educationLevels":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.EducationLevels.EducationLevel"},"description":"Gets the list of education level entities used for setting member personal details EducationLevelId"},"genres":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Genres.LoyaltyGenre"},"description":"Gets the list of loyalty genre entities used for setting member genre preferences"},"interests":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Interests.Interest"},"description":"Gets the list of interest entities used for setting member interest subscription InterestId"},"interestContactMethods":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Interests.InterestContactMethod"},"description":"Gets the list of interest contact method entities used for setting member interest subscription InterestContactMethodIds"},"occupations":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Occupations.Occupation"},"description":"Gets the list of occupation entities used for setting member personal details OccupationId"},"photoRequirements":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Photos.MemberPhotoRequirements"}],"description":"Gets the upload requirements for a member photo"},"sites":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite"},"description":"Gets the list of loyalty site entities used for setting member site preferences"},"friendConfiguration":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Friends.MemberFriendConfiguration"}],"description":"Gets the friend configuration"},"externalAuthenticationIssuers":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Authentication.ExternalAuthenticationIssuer"},"description":"Gets the list of external authentication issuer entities that can be used to authenticate Loyalty members without\r\nrequiring them to create a password for Loyalty"}},"additionalProperties":false,"description":"Represents the master data typically used for creating or updating a member"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.Occupations.Occupation":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.Occupations.Occupation","kind":"json-schema","title":"Occupation","data":{"title":"Occupation","required":["id","name"],"type":"object","properties":{"id":{"type":"integer","description":"Gets the unique identifier","format":"int32"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"}},"additionalProperties":false,"description":"Represents the occupation of a member"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.Photos.MemberPhotoDimensions":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.Photos.MemberPhotoDimensions","kind":"json-schema","title":"MemberPhotoDimensions","data":{"title":"MemberPhotoDimensions","required":["height","width"],"type":"object","properties":{"width":{"type":"integer","description":"Gets the required width in pixels","format":"int32"},"height":{"type":"integer","description":"Gets the required height in pixels","format":"int32"}},"additionalProperties":false,"description":"Represents the exact required dimensions of a member photo"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.Photos.MemberPhotoRequirements":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.Photos.MemberPhotoRequirements","kind":"json-schema","title":"MemberPhotoRequirements","data":{"title":"MemberPhotoRequirements","required":["dimensions","maximumFileSizeInKilobytes","minimumDaysBetweenUpdates"],"type":"object","properties":{"dimensions":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Photos.MemberPhotoDimensions"}],"description":"Gets the required dimensions"},"maximumFileSizeInKilobytes":{"type":"integer","description":"Gets the maximum allowed file size in kilobytes","format":"int32"},"minimumDaysBetweenUpdates":{"type":"integer","description":"Gets the minimum number of days allowed between photo updates","format":"int32"}},"additionalProperties":false,"description":"Represents the upload requirements for a member photo"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.Rewards.Reward":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.Rewards.Reward","kind":"json-schema","title":"Reward","data":{"title":"Reward","required":["id","name","restrictions","type"],"type":"object","properties":{"id":{"type":"integer","description":"Gets the unique identifier","format":"int32"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"description":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the description text, and its translations"},"balanceCost":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Rewards.RewardBalanceCost"}],"description":"Gets the balance cost of redeeming the reward"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Rewards.RewardType"}],"description":"Gets the type"},"itemId":{"type":"string","description":"Gets the unique identifier of the associated loyalty item","nullable":true},"limitPerOrder":{"type":"integer","description":"Gets the maximum quantity available to a member per order base","format":"int32","nullable":true},"limitPerShowtime":{"type":"integer","description":"Gets the maximum quantity of admits or seats available to a member per\r\nshowtime if this reward is linked to a third party member scheme","format":"int32","nullable":true},"discountCalculation":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.DiscountCalculations.PercentageOffDiscountCalculation"},{"$ref":"#/components/schemas/Ocapi.V1.DiscountCalculations.PriceOffDiscountCalculation"},{"$ref":"#/components/schemas/Ocapi.V1.DiscountCalculations.SpecialPriceDiscountCalculation"}],"description":"Represents the base properties that describe the calculation of a discount"},"restrictions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Rewards.RewardRestriction"},"description":"Gets the restrictions that apply"}},"additionalProperties":false,"description":"Represents a reward in Vista Loyalty that can be earned by a member"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.Rewards.RewardBalanceCost":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.Rewards.RewardBalanceCost","kind":"json-schema","title":"RewardBalanceCost","data":{"title":"RewardBalanceCost","required":["balanceTypeId","units"],"type":"object","properties":{"balanceTypeId":{"type":"integer","description":"Gets the unique identifier of the balance type","format":"int32"},"units":{"type":"number","description":"Gets the cost in balance type units","format":"double"}},"additionalProperties":false,"description":"Represents a balance cost of redeeming a reward"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.Rewards.RewardRestriction":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.Rewards.RewardRestriction","kind":"json-schema","title":"RewardRestriction","data":{"title":"RewardRestriction","enum":["MemberRewardAvailability"],"type":"string","description":"Represents the restriction options for a reward"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.Rewards.RewardType":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.Rewards.RewardType","kind":"json-schema","title":"RewardType","data":{"title":"RewardType","required":["name"],"type":"object","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"}},"additionalProperties":false,"description":"Represents the type of a reward"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite","kind":"json-schema","title":"LoyaltySite","data":{"title":"LoyaltySite","required":["allowedItemDeliveryMethods","contactDetails","hasSellableItems","ianaTimeZoneName","id","name"],"type":"object","properties":{"location":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.GeographicLocation"}],"description":"Gets the geographic location"},"contactDetails":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.SiteContactDetails"}],"description":"Gets the contact details"},"ianaTimeZoneName":{"minLength":1,"type":"string","description":"Gets the IANA time zone name","example":"America/New_York"},"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"hasSellableItems":{"type":"boolean","description":"Gets a value indicating whether the site has any sellable item entities"},"allowedItemDeliveryMethods":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"},"description":"Gets the list of allowed item delivery method entities"}},"additionalProperties":false,"description":"Represents a site in Vista Loyalty"}},"components/schemas/Ocapi.V1.Loyalty.MasterData.Subscriptions.Subscription":{"id":"components/schemas/Ocapi.V1.Loyalty.MasterData.Subscriptions.Subscription","kind":"json-schema","title":"Subscription","data":{"title":"Subscription","required":["clubId","id","minimumTermBeforeCanPurchaseFutureSubscriptionInMonths","minimumTermInMonths","name"],"type":"object","properties":{"id":{"type":"integer","description":"Gets the unique identifier","format":"int32"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"clubId":{"type":"integer","description":"Gets the unique identifier of the club","format":"int32"},"minimumTermInMonths":{"type":"integer","description":"Gets the minimum number of number of months required for the subscription term","format":"int32"},"minimumTermBeforeCanPurchaseFutureSubscriptionInMonths":{"type":"integer","description":"Gets the minimum number of months that must be completed before purchase of another subscription will be allowed","format":"int32"}},"additionalProperties":false,"description":"Represents a subscription to a paid club in Vista Loyalty"}},"components/schemas/Ocapi.V1.Loyalty.Members.Authentication.MemberAuthenticationToken":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Authentication.MemberAuthenticationToken","kind":"json-schema","title":"MemberAuthenticationToken","data":{"title":"MemberAuthenticationToken","required":["access_token","expires_in","token_type"],"type":"object","properties":{"access_token":{"minLength":1,"type":"string","description":"Gets the access token"},"token_type":{"minLength":1,"type":"string","description":"Gets the type","example":"Bearer"},"expires_in":{"type":"integer","description":"Gets the expiry time in seconds","format":"int32"},"refresh_token":{"type":"string","description":"Gets the refresh token","nullable":true}},"additionalProperties":false,"description":"Represents a successful member authentication response"}},"components/schemas/Ocapi.V1.Loyalty.Members.Authentication.MemberAuthenticationType":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Authentication.MemberAuthenticationType","kind":"json-schema","title":"MemberAuthenticationType","data":{"title":"MemberAuthenticationType","enum":["None","Token","Cookie"],"type":"string","description":"Represents the different types of authentication that can be returned for a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Balances.MemberBalance":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Balances.MemberBalance","kind":"json-schema","title":"MemberBalance","data":{"title":"MemberBalance","required":["availableUnits","balanceTypeId","expiries"],"type":"object","properties":{"balanceTypeId":{"type":"integer","description":"Gets the unique identifier of the balance type","format":"int32"},"availableUnits":{"type":"number","description":"Gets the current available balance type units","format":"double"},"expiries":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Balances.MemberBalanceExpiry"},"description":"Gets the list member balance expiry entities"}},"additionalProperties":false,"description":"Represents an instance of a balance type belonging to a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Balances.MemberBalanceExpiry":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Balances.MemberBalanceExpiry","kind":"json-schema","title":"MemberBalanceExpiry","data":{"title":"MemberBalanceExpiry","required":["expiresAt","units"],"type":"object","properties":{"units":{"type":"number","description":"Gets the number of balance type units that are expiring","format":"double"},"expiresAt":{"type":"string","description":"Gets the date and time that the units expire","format":"date-time"}},"additionalProperties":false,"description":"Represents a number of member balance units that are expiring"}},"components/schemas/Ocapi.V1.Loyalty.Members.Cards.MemberCard":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Cards.MemberCard","kind":"json-schema","title":"MemberCard","data":{"title":"MemberCard","required":["cardNumber","isPrimary"],"type":"object","properties":{"cardNumber":{"minLength":1,"type":"string","description":"Gets the card number"},"isPrimary":{"type":"boolean","description":"Gets a value indicating whether this is the primary card"}},"additionalProperties":false,"description":"Represents a card, used to identify, and in some cases authenticate, a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.ClubMemberships.MemberClubMembership":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.ClubMemberships.MemberClubMembership","kind":"json-schema","title":"MemberClubMembership","data":{"title":"MemberClubMembership","required":["clubId"],"type":"object","properties":{"clubId":{"type":"integer","description":"Gets the unique identifier of the club","format":"int32"},"clubLevelId":{"type":"integer","description":"Gets the unique identifier of the club level, if applicable","format":"int32","nullable":true}},"additionalProperties":false,"description":"Represents a member entity's membership of a club"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.Normal.MemberCompletedOrderNormalItemLine":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.Normal.MemberCompletedOrderNormalItemLine","kind":"json-schema","title":"MemberCompletedOrderNormalItemLine","data":{"title":"MemberCompletedOrderNormalItemLine","required":["id","itemId","refundStatus","type"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType"}],"description":"Gets the item type"},"parentSalesItemId":{"type":"string","description":"Gets the unique identifier of the parent sales item this item is an option for","nullable":true},"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the line within the member completed order base"},"refundStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Lines.OrderLineRefundStatus"}],"description":"Gets the refund status"}},"additionalProperties":false,"description":"Represents a member completed order item line base for a normal item"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.Package.MemberCompletedOrderPackageContentItem":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.Package.MemberCompletedOrderPackageContentItem","kind":"json-schema","title":"MemberCompletedOrderPackageContentItem","data":{"title":"MemberCompletedOrderPackageContentItem","required":["itemId","type"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType"}],"description":"Gets the item type"},"parentSalesItemId":{"type":"string","description":"Gets the unique identifier of the parent sales item this item is an option for","nullable":true}},"additionalProperties":false,"description":"Represents a customized package item content item within a member completed order package item line"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.Package.MemberCompletedOrderPackageItemLine":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.Package.MemberCompletedOrderPackageItemLine","kind":"json-schema","title":"MemberCompletedOrderPackageItemLine","data":{"title":"MemberCompletedOrderPackageItemLine","required":["id","itemId","items","refundStatus","type"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType"}],"description":"Gets the item type"},"parentSalesItemId":{"type":"string","description":"Gets the unique identifier of the parent sales item this item is an option for","nullable":true},"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the line within the member completed order base"},"refundStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Lines.OrderLineRefundStatus"}],"description":"Gets the refund status"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.Package.MemberCompletedOrderPackageContentItem"},"description":"Gets the list of member completed order package content item entities"}},"additionalProperties":false,"description":"Represents a member completed order item line base for a package item"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.Recipe.MemberCompletedOrderRecipeItemLine":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.Recipe.MemberCompletedOrderRecipeItemLine","kind":"json-schema","title":"MemberCompletedOrderRecipeItemLine","data":{"title":"MemberCompletedOrderRecipeItemLine","required":["id","itemId","refundStatus","type"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType"}],"description":"Gets the item type"},"parentSalesItemId":{"type":"string","description":"Gets the unique identifier of the parent sales item this item is an option for","nullable":true},"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the line within the member completed order base"},"refundStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Lines.OrderLineRefundStatus"}],"description":"Gets the refund status"}},"additionalProperties":false,"description":"Represents a member completed order item line base for a recipe item"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.WeightBased.MemberCompletedOrderWeightBasedItemLine":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.WeightBased.MemberCompletedOrderWeightBasedItemLine","kind":"json-schema","title":"MemberCompletedOrderWeightBasedItemLine","data":{"title":"MemberCompletedOrderWeightBasedItemLine","required":["id","itemId","refundStatus","type"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType"}],"description":"Gets the item type"},"parentSalesItemId":{"type":"string","description":"Gets the unique identifier of the parent sales item this item is an option for","nullable":true},"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the line within the member completed order base"},"refundStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Lines.OrderLineRefundStatus"}],"description":"Gets the refund status"}},"additionalProperties":false,"description":"Represents a member completed order item line base for a weight based item"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedGiftShopOrder":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedGiftShopOrder","kind":"json-schema","title":"MemberCompletedGiftShopOrder","data":{"title":"MemberCompletedGiftShopOrder","required":["amountSaved","createdAt","expiresAt","items","totalPrice","type"],"type":"object","properties":{"id":{"type":"string","description":"Gets the unique identifier","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderType"}],"description":"Gets the type"},"totalPrice":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total price to be displayed to the customer"},"amountSaved":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the monetary amount saved via discounted prices"},"expiresAt":{"type":"string","description":"Gets the date and time that the order is set to expire","format":"date-time"},"createdAt":{"type":"string","description":"Gets the date and time that the order was completed","format":"date-time"},"items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.WeightBased.MemberCompletedOrderWeightBasedItemLine"},{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.Recipe.MemberCompletedOrderRecipeItemLine"},{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.Package.MemberCompletedOrderPackageItemLine"},{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.Normal.MemberCompletedOrderNormalItemLine"}],"description":"Represents the base properties of a member completed order line for a top-level instance of an item base\r\nwithin a member completed standard order or member completed gift shop order"},"description":"Gets the list of member completed order item line base entities"}},"additionalProperties":false,"description":"Represents a completed gift shop order belonging to a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderListDetails":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderListDetails","kind":"json-schema","title":"MemberCompletedOrderListDetails","data":{"title":"MemberCompletedOrderListDetails","required":["orders","relatedData"],"type":"object","properties":{"orders":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedGiftShopOrder"},{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedStandardOrder"},{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedSubscriptionOrder"}],"description":"Represents a completed order base belonging to a member"},"description":"Gets the list of member completed order base entities"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderListRelatedData"}],"description":"Gets the related data for the member completed order base entities"}},"additionalProperties":false,"description":"Represents a list of member completed order base entities, and their related data"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderPaginatedResultSet":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedOrderPaginatedResultSet","kind":"json-schema","title":"MemberCompletedOrderPaginatedResultSet","data":{"title":"MemberCompletedOrderPaginatedResultSet","required":["hasMoreResults","relatedData","results"],"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedGiftShopOrder"},{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedStandardOrder"},{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedSubscriptionOrder"}],"description":"Represents a completed order base belonging to a member"},"description":"Gets the list of results"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderListRelatedData"}],"description":"Gets the related data for the member completed order base entities"},"hasMoreResults":{"type":"boolean","description":"Gets a value indicating whether any more results are available"}},"additionalProperties":false,"description":"Represents a paginated result set of member completed order base entities, and their related data"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedStandardOrder":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedStandardOrder","kind":"json-schema","title":"MemberCompletedStandardOrder","data":{"title":"MemberCompletedStandardOrder","required":["amountSaved","createdAt","expiresAt","items","showtimes","siteId","totalPrice","type"],"type":"object","properties":{"id":{"type":"string","description":"Gets the unique identifier","nullable":true},"parentOrderId":{"type":"string","description":"Gets the unique identifier of the parent order, if applicable","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderType"}],"description":"Gets the type"},"totalPrice":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total price to be displayed to the customer"},"amountSaved":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the monetary amount saved via discounted prices"},"expiresAt":{"type":"string","description":"Gets the date and time that the order is set to expire","format":"date-time"},"createdAt":{"type":"string","description":"Gets the date and time that the order was completed","format":"date-time"},"siteId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the site"},"showtimes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Showtimes.MemberCompletedOrderShowtime"},"description":"Gets the list of member completed order showtime entities"},"items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.WeightBased.MemberCompletedOrderWeightBasedItemLine"},{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.Recipe.MemberCompletedOrderRecipeItemLine"},{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.Package.MemberCompletedOrderPackageItemLine"},{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Items.Normal.MemberCompletedOrderNormalItemLine"}],"description":"Represents the base properties of a member completed order line for a top-level instance of an item base\r\nwithin a member completed standard order or member completed gift shop order"},"description":"Gets the list of member completed order item line base entities"}},"additionalProperties":false,"description":"Represents a completed standard order belonging to a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedSubscriptionOrder":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.MemberCompletedSubscriptionOrder","kind":"json-schema","title":"MemberCompletedSubscriptionOrder","data":{"title":"MemberCompletedSubscriptionOrder","required":["amountSaved","createdAt","expiresAt","subscription","totalPrice","type"],"type":"object","properties":{"id":{"type":"string","description":"Gets the unique identifier","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderType"}],"description":"Gets the type"},"totalPrice":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total price to be displayed to the customer"},"amountSaved":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the monetary amount saved via discounted prices"},"expiresAt":{"type":"string","description":"Gets the date and time that the order is set to expire","format":"date-time"},"createdAt":{"type":"string","description":"Gets the date and time that the order was completed","format":"date-time"},"subscription":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Subscriptions.MemberCompletedOrderSubscription"}],"description":"Gets the subscription"}},"additionalProperties":false,"description":"Represents a completed subscription order belonging to a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderListRelatedData":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderListRelatedData","kind":"json-schema","title":"MemberCompletedOrderListRelatedData","data":{"title":"MemberCompletedOrderListRelatedData","required":["censorRatings","films","items","showtimes","sites","subscriptionBillingOptions","subscriptions","ticketTypes"],"type":"object","properties":{"films":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderRelatedFilm"},"description":"Gets the list of related member completed order related film entities"},"ticketTypes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderRelatedTicketType"},"description":"Gets the list of related member completed order related ticket type entities"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderRelatedItem"},"description":"Gets the list of related member completed order related item entities"},"showtimes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderRelatedShowtime"},"description":"Gets the list of related member completed order related showtime entities"},"sites":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.Site"}],"description":"Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities"},"description":"Gets the list of related site entities"},"censorRatings":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CensorRatings.CensorRating"},"description":"Gets the list of related censor rating entities"},"subscriptionBillingOptions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderRelatedSubscriptionBillingOption"},"description":"Gets the list of related member completed order related subscription billing option entities"},"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderRelatedSubscription"},"description":"Gets the list of related member completed order related subscription entities"}},"additionalProperties":false,"description":"Related data for a list of member completed order base entities"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderRelatedFilm":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderRelatedFilm","kind":"json-schema","title":"MemberCompletedOrderRelatedFilm","data":{"title":"MemberCompletedOrderRelatedFilm","required":["externalIds","id","title"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"title":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}]},"censorRatingId":{"type":"string","nullable":true},"censorRatingNote":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}]},"externalIds":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmExternalIds"}]}},"additionalProperties":false,"description":"Represents the film data related to a member completed order base"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderRelatedItem":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderRelatedItem","kind":"json-schema","title":"MemberCompletedOrderRelatedItem","data":{"title":"MemberCompletedOrderRelatedItem","required":["hoCode","id","name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"hoCode":{"minLength":1,"type":"string","description":"Gets the Head Office code"},"hopk":{"type":"string","description":"Gets the Head Office primary key","nullable":true}},"additionalProperties":false,"description":"Represents the item base data related to a member completed order base"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderRelatedShowtime":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderRelatedShowtime","kind":"json-schema","title":"MemberCompletedOrderRelatedShowtime","data":{"title":"MemberCompletedOrderRelatedShowtime","required":["filmId","id","schedule"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"schedule":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeSchedule"}]},"filmId":{"minLength":1,"type":"string"}},"additionalProperties":false,"description":"Represents the showtime data related to a member completed order base"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderRelatedSubscription":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderRelatedSubscription","kind":"json-schema","title":"MemberCompletedOrderRelatedSubscription","data":{"title":"MemberCompletedOrderRelatedSubscription","required":["id","name"],"type":"object","properties":{"id":{"type":"integer","description":"Gets the unique identifier","format":"int32"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"}},"additionalProperties":false,"description":"Represents the subscription data related to a member completed subscription order"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderRelatedSubscriptionBillingOption":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderRelatedSubscriptionBillingOption","kind":"json-schema","title":"MemberCompletedOrderRelatedSubscriptionBillingOption","data":{"title":"MemberCompletedOrderRelatedSubscriptionBillingOption","required":["billingPeriodInMonths","id","isRecurring","name","subscriptionId"],"type":"object","properties":{"subscriptionId":{"type":"integer","format":"int32"},"billingPeriodInMonths":{"type":"integer","format":"int32"},"isRecurring":{"type":"boolean"},"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"}},"additionalProperties":false,"description":"Represents the subscription billing option data related to a member completed subscription order"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderRelatedTicketType":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.RelatedData.MemberCompletedOrderRelatedTicketType","kind":"json-schema","title":"MemberCompletedOrderRelatedTicketType","data":{"title":"MemberCompletedOrderRelatedTicketType","required":["description","id"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"description":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}]}},"additionalProperties":false,"description":"Represents the ticket type base data related to a member completed order base"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Seats.MemberCompletedOrderSeat":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Seats.MemberCompletedOrderSeat","kind":"json-schema","title":"MemberCompletedOrderSeat","data":{"title":"MemberCompletedOrderSeat","required":["rowLabel","seatId"],"type":"object","properties":{"seatId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the seat"},"seatLabel":{"type":"string","description":"Gets the label/physical name of the seat","nullable":true},"rowLabel":{"minLength":1,"type":"string","description":"Gets the label/physical name of the row"}},"additionalProperties":false,"description":"Represents the details of a seat in the context of a member completed order base"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Showtimes.MemberCompletedOrderShowtime":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Showtimes.MemberCompletedOrderShowtime","kind":"json-schema","title":"MemberCompletedOrderShowtime","data":{"title":"MemberCompletedOrderShowtime","required":["seats","showtimeId","tickets"],"type":"object","properties":{"showtimeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the showtime","readOnly":true},"tickets":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Tickets.Package.MemberCompletedOrderPackageTicketLine"},{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Tickets.Normal.MemberCompletedOrderNormalTicketLine"}],"description":"Represents the base properties of a member completed order line for an instance of a ticket type base within a member completed order showtime"},"description":"Gets the list of member completed order ticket line base entities"},"seats":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Seats.MemberCompletedOrderSeat"},"description":"Gets the list of member completed order seat entities"}},"additionalProperties":false,"description":"Represents the selected tickets and/or seats for a showtime within a member completed standard order"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Subscriptions.MemberCompletedOrderSubscription":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Subscriptions.MemberCompletedOrderSubscription","kind":"json-schema","title":"MemberCompletedOrderSubscription","data":{"title":"MemberCompletedOrderSubscription","required":["subscriptionBillingOptionId","subscriptionId"],"type":"object","properties":{"subscriptionId":{"type":"integer","description":"Gets the unique identifier of the subscription","format":"int32"},"subscriptionBillingOptionId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the subscription billing option"}},"additionalProperties":false,"description":"Represents the selected subscription billing option within a member completed subscription order"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Tickets.Normal.MemberCompletedOrderNormalTicketLine":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Tickets.Normal.MemberCompletedOrderNormalTicketLine","kind":"json-schema","title":"MemberCompletedOrderNormalTicketLine","data":{"title":"MemberCompletedOrderNormalTicketLine","required":["id","refundStatus","ticketTypeId","type"],"type":"object","properties":{"ticketTypeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the ticket type base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.TicketTypeType"}],"description":"Gets the type"},"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the line within the member completed order base"},"refundStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Lines.OrderLineRefundStatus"}],"description":"Gets the refund status"}},"additionalProperties":false,"description":"Represents a member completed order ticket line base for an instance of a normal ticket type"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Tickets.Package.MemberCompletedOrderPackageTicketContentItem":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Tickets.Package.MemberCompletedOrderPackageTicketContentItem","kind":"json-schema","title":"MemberCompletedOrderPackageTicketContentItem","data":{"title":"MemberCompletedOrderPackageTicketContentItem","required":["itemId"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base"}},"additionalProperties":false,"description":"Represents an item base within a member completed order package ticket line"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Tickets.Package.MemberCompletedOrderPackageTicketContentTicket":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Tickets.Package.MemberCompletedOrderPackageTicketContentTicket","kind":"json-schema","title":"MemberCompletedOrderPackageTicketContentTicket","data":{"title":"MemberCompletedOrderPackageTicketContentTicket","required":["ticketTypeId"],"type":"object","properties":{"ticketTypeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the normal ticket type"}},"additionalProperties":false,"description":"Represents a normal ticket type within a member completed order package ticket line"}},"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Tickets.Package.MemberCompletedOrderPackageTicketLine":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Tickets.Package.MemberCompletedOrderPackageTicketLine","kind":"json-schema","title":"MemberCompletedOrderPackageTicketLine","data":{"title":"MemberCompletedOrderPackageTicketLine","required":["id","items","refundStatus","tickets","ticketTypeId","type"],"type":"object","properties":{"tickets":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Tickets.Package.MemberCompletedOrderPackageTicketContentTicket"},"description":"Gets the list of member completed order package ticket content ticket entities"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.CompletedOrders.Tickets.Package.MemberCompletedOrderPackageTicketContentItem"},"description":"Gets the list of member completed order package ticket content item entities"},"ticketTypeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the ticket type base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.TicketTypeType"}],"description":"Gets the type"},"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the line within the member completed order base"},"refundStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Lines.OrderLineRefundStatus"}],"description":"Gets the refund status"}},"additionalProperties":false,"description":"Represents a member completed order package ticket line for an instance of a package ticket type"}},"components/schemas/Ocapi.V1.Loyalty.Members.Create.CreatedMemberDetails":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Create.CreatedMemberDetails","kind":"json-schema","title":"CreatedMemberDetails","data":{"title":"CreatedMemberDetails","required":["memberDetails"],"type":"object","properties":{"memberDetails":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.MemberDetails"}],"description":"Gets the member details entity"},"authenticationToken":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Authentication.MemberAuthenticationToken"}],"description":"Gets the member authentication token for the created member, if the\r\nmember authentication type Token authentication type was requested"}},"additionalProperties":false,"description":"Represents a member that has just been created, and its related data.\r\nIncludes an created member details AuthenticationToken for the created member, if requested"}},"components/schemas/Ocapi.V1.Loyalty.Members.Create.MemberCreate":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Create.MemberCreate","kind":"json-schema","title":"MemberCreate","data":{"title":"MemberCreate","required":["acceptedTermsAndConditions","clubMembership","credentials"],"type":"object","properties":{"credentials":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Credentials.MemberCredentialsCreate"}],"description":"Gets the credentials"},"clubMembership":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.ClubMemberships.MemberClubMembership"}],"description":"Gets the club membership details"},"personalDetails":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberPersonalDetails"}],"description":"Gets the personal details"},"acceptedTermsAndConditions":{"type":"boolean","description":"Gets a value indicating whether the member accepted the terms and conditions"},"authenticationType":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Authentication.MemberAuthenticationType"}],"description":"Gets the type of authentication that should be returned along with the created member details"}},"additionalProperties":false,"description":"Represents the values needed to create a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Credentials.MemberCredentials":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Credentials.MemberCredentials","kind":"json-schema","title":"MemberCredentials","data":{"title":"MemberCredentials","type":"object","properties":{"username":{"type":"string","description":"Gets the username","nullable":true},"email":{"type":"string","description":"Gets the email address","nullable":true}},"additionalProperties":false,"description":"Represents the authentication credentials of a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Credentials.MemberCredentialsCreate":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Credentials.MemberCredentialsCreate","kind":"json-schema","title":"MemberCredentialsCreate","data":{"title":"MemberCredentialsCreate","type":"object","properties":{"username":{"type":"string","description":"Gets the username","nullable":true},"password":{"type":"string","description":"Gets the password","nullable":true},"pin":{"type":"string","description":"Gets the PIN","nullable":true},"email":{"type":"string","description":"Gets the email address","nullable":true}},"additionalProperties":false,"description":"Represents the authentication credentials of a member being created"}},"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailability":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailability","kind":"json-schema","title":"EmailAvailability","data":{"title":"EmailAvailability","type":"object","properties":{"isAvailable":{"type":"boolean","description":"Gets a value indicating whether the provided email is available"}},"additionalProperties":false,"description":"Represents the availability of an email address in Vista Loyalty"}},"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailabilityValidation":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.EmailAvailability.EmailAvailabilityValidation","kind":"json-schema","title":"EmailAvailabilityValidation","data":{"title":"EmailAvailabilityValidation","type":"object","properties":{"email":{"type":"string","description":"Gets the email address","nullable":true}},"additionalProperties":false,"description":"Represents the properties required to validate the availability of an email address"}},"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriend":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriend","kind":"json-schema","title":"MemberFriend","data":{"title":"MemberFriend","required":["createdAt","id","name","subscriptionSharing"],"type":"object","properties":{"id":{"type":"string","description":"Gets the unique identifier","format":"uuid"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.PersonName"}],"description":"Gets the name"},"photo":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendPhoto"}],"description":"Gets the photo details"},"subscriptionSharing":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharing"}],"description":"Gets the subscription sharing details"},"createdAt":{"type":"string","description":"Gets the date and time that the friend was created","format":"date-time"}},"additionalProperties":false,"description":"Represents the details of a member that is the friend of another member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCode":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCode","kind":"json-schema","title":"MemberFriendCode","data":{"title":"MemberFriendCode","required":["expiresAt","friendCode"],"type":"object","properties":{"friendCode":{"minLength":1,"type":"string","description":"Gets the friend code"},"expiresAt":{"type":"string","description":"Gets the date and time that the friend code expires","format":"date-time"}},"additionalProperties":false,"description":"Represents the code used to create a member friend"}},"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendCodeCreate","kind":"json-schema","title":"MemberFriendCodeCreate","data":{"title":"MemberFriendCodeCreate","required":["friendCanUseMemberSubscription"],"type":"object","properties":{"friendCanUseMemberSubscription":{"type":"boolean","description":"Gets a value indicating whether the created member friend can use the member entity's member subscription"}},"additionalProperties":false,"description":"Represents the values needed to create a member friend code"}},"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendDetails":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendDetails","kind":"json-schema","title":"MemberFriendDetails","data":{"title":"MemberFriendDetails","required":["friend","relatedData"],"type":"object","properties":{"friend":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriend"}],"description":"Gets the member friend entity"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendRelatedData"}],"description":"Gets the related data for the member friend entity"}},"additionalProperties":false,"description":"Represents the details of a member friend entity, and its related data"}},"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendFromCodeCreate","kind":"json-schema","title":"MemberFriendFromCodeCreate","data":{"title":"MemberFriendFromCodeCreate","required":["friendCode"],"type":"object","properties":{"friendCode":{"minLength":1,"type":"string","description":"Gets the member friend code FriendCode"}},"additionalProperties":false,"description":"Represents the values needed to create a member friend using a member friend code"}},"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendPhoto":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendPhoto","kind":"json-schema","title":"MemberFriendPhoto","data":{"title":"MemberFriendPhoto","type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Photos.MemberPhotoBase"}],"additionalProperties":false,"description":"Represents the details of the photo associated with a member friend"}},"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendRelatedData":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendRelatedData","kind":"json-schema","title":"MemberFriendRelatedData","data":{"title":"MemberFriendRelatedData","required":["subscriptions"],"type":"object","properties":{"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Subscriptions.Subscription"},"description":"Gets the list of related subscription entities"}},"additionalProperties":false,"description":"Related data for a member friend entity"}},"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscription":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscription","kind":"json-schema","title":"MemberFriendSubscription","data":{"title":"MemberFriendSubscription","required":["subscriptionId"],"type":"object","properties":{"subscriptionId":{"type":"integer","description":"Gets the unique identifier of the subscription","format":"int32"}},"additionalProperties":false,"description":"Represents the details of a member subscription that belongs to a member friend and has been shared with the member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharing":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharing","kind":"json-schema","title":"MemberFriendSubscriptionSharing","data":{"title":"MemberFriendSubscriptionSharing","required":["friendCanUseMemberSubscription","friendSubscriptions"],"type":"object","properties":{"friendCanUseMemberSubscription":{"type":"boolean","description":"Gets a value indicating whether the member friend can use the member entity's member subscription"},"friendSubscriptions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscription"},"description":"Gets the list of member friend subscription entities that the member can use"}},"additionalProperties":false,"description":"Represents the details of any member subscription sharing between a member friend and a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriendSubscriptionSharingUpdate","kind":"json-schema","title":"MemberFriendSubscriptionSharingUpdate","data":{"title":"MemberFriendSubscriptionSharingUpdate","required":["friendCanUseMemberSubscription"],"type":"object","properties":{"friendCanUseMemberSubscription":{"type":"boolean","description":"Gets a value indicating whether the member friend can use the member entity's member subscription"}},"additionalProperties":false,"description":"Represents the values needed to set the member friend subscription sharing of a member friend"}},"components/schemas/Ocapi.V1.Loyalty.Members.Member":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Member","kind":"json-schema","title":"Member","data":{"title":"Member","required":["balances","cards","clubMembership","credentials","friends","hash","id","membershipStartDate","personalDetails"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"hash":{"minLength":1,"type":"string","description":"Gets the salted and hashed unique identifier"},"membershipStartDate":{"type":"string","description":"Gets the date that the membership started","format":"date-time"},"credentials":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeCreate"},{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Credentials.MemberCredentials"}],"description":"Represents the authentication credentials of a member"},"clubMembership":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.ClubMemberships.MemberClubMembership"}],"description":"Gets the club membership details"},"personalDetails":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberPersonalDetails"}],"description":"Gets the personal details"},"cards":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Cards.MemberCard"},"description":"Gets the list of member card entities"},"balances":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Balances.MemberBalance"},"description":"Gets the list of member balance entities"},"photo":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Photos.MemberPhoto"}],"description":"Gets the photo details"},"subscriptions":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscriptions"}],"description":"Gets the subscriptions"},"friends":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Friends.MemberFriend"},"description":"Gets the list of member friend entities"}},"additionalProperties":false,"description":"Represents a member in Vista Loyalty"}},"components/schemas/Ocapi.V1.Loyalty.Members.MemberDetails":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.MemberDetails","kind":"json-schema","title":"MemberDetails","data":{"title":"MemberDetails","required":["member","relatedData"],"type":"object","properties":{"member":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Member"}],"description":"Gets the member entity"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.MemberRelatedData"}],"description":"Gets the related data for the member entity"}},"additionalProperties":false,"description":"Represents the details of a member entity, and its related data"}},"components/schemas/Ocapi.V1.Loyalty.Members.MemberRelatedData":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.MemberRelatedData","kind":"json-schema","title":"MemberRelatedData","data":{"title":"MemberRelatedData","required":["balanceTypes","club","customPreferences","genres","interestContactMethods","interests","sites","subscriptions"],"type":"object","properties":{"balanceTypes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.BalanceTypes.BalanceType"},"description":"Gets the list of related balance type entities for the member balance entities"},"club":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Clubs.Club"}],"description":"Gets the related club entity for the member club membership"},"clubLevel":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Clubs.ClubLevel"}],"description":"Gets the related club level entity for the member club membership, if applicable"},"customPreferences":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.CustomPreferences.CustomPreference"},"description":"Gets the list of related custom preference entities for the member custom preference entities"},"educationLevel":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.EducationLevels.EducationLevel"}],"description":"Gets the related education level entity for the member personal details, if applicable"},"genres":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Genres.LoyaltyGenre"},"description":"Gets the list of related loyalty genre entities for the member genre preferences"},"interests":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Interests.Interest"},"description":"Gets the list of related interest entities for the member interest subscription entities"},"interestContactMethods":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Interests.InterestContactMethod"},"description":"Gets the list of related interest contact method entities for the member interest subscription entities"},"occupation":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Occupations.Occupation"}],"description":"Gets the related occupation entity for the member personal details, if applicable"},"sites":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite"},"description":"Gets the list of related loyalty site entities for the member site preferences"},"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Subscriptions.Subscription"},"description":"Gets the list of related subscription entities for the member subscription entities"}},"additionalProperties":false,"description":"Related data for a member entity"}},"components/schemas/Ocapi.V1.Loyalty.Members.MemberSecureActionValidationType":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.MemberSecureActionValidationType","kind":"json-schema","title":"MemberSecureActionValidationType","data":{"title":"MemberSecureActionValidationType","enum":["ValidatePassword","None"],"type":"string","description":"Represents the validation type required for a secure member action"}},"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordReset":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordReset","kind":"json-schema","title":"MemberPasswordReset","data":{"title":"MemberPasswordReset","required":["password","resetCode"],"type":"object","properties":{"resetCode":{"minLength":1,"type":"string","description":"Gets the one-time password reset code"},"password":{"minLength":1,"type":"string","description":"Gets the new password"}},"additionalProperties":false,"description":"Represents a password to be reset"}},"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeCreate":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeCreate","kind":"json-schema","title":"MemberPasswordResetCodeCreate","data":{"title":"MemberPasswordResetCodeCreate","type":"object","properties":{"email":{"type":"string","description":"Gets the email address","nullable":true},"username":{"type":"string","description":"Gets the username","nullable":true},"languageTag":{"type":"string","description":"Gets the IETF (RFC 4646) language tag","nullable":true,"example":"en-US"}},"additionalProperties":false,"description":"Represents a request to create a password reset code"}},"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidation":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidation","kind":"json-schema","title":"MemberPasswordResetCodeValidation","data":{"title":"MemberPasswordResetCodeValidation","required":["resetCode"],"type":"object","properties":{"resetCode":{"minLength":1,"type":"string","description":"Gets the reset code to validate"}},"additionalProperties":false,"description":"Represents a password reset code to be validated"}},"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidity":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.PasswordReset.MemberPasswordResetCodeValidity","kind":"json-schema","title":"MemberPasswordResetCodeValidity","data":{"title":"MemberPasswordResetCodeValidity","required":["isValid"],"type":"object","properties":{"isValid":{"type":"boolean","description":"Gets a value indicating whether the provided password reset code is valid"}},"additionalProperties":false,"description":"Represents the validity of a password reset code"}},"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberEmbeddedPaymentCardClientData":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberEmbeddedPaymentCardClientData","kind":"json-schema","title":"MemberEmbeddedPaymentCardClientData","data":{"title":"MemberEmbeddedPaymentCardClientData","required":["connectorFunctionName","connectorParametersJson","connectorScriptUrls","createCardTokenUrl","isButtonIncluded","isPrimaryCardOptionIncluded","memberPaymentCardId","sdkScriptUrls","webPaymentMethodId"],"type":"object","properties":{"memberPaymentCardId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the member payment card"},"webPaymentMethodId":{"type":"integer","description":"Gets the unique identifier of the web payment method","format":"int32"},"connectorFunctionName":{"minLength":1,"type":"string","description":"Gets the name of the connector function that needs to be called"},"connectorParametersJson":{"minLength":1,"type":"string","description":"Gets the JSON blob of parameters required by the connector"},"createCardTokenUrl":{"type":"string","description":"Gets the create card token URL","format":"uri"},"sdkScriptUrls":{"type":"array","items":{"type":"string"},"description":"Gets the list of SDK script URLs that need to be loaded"},"isButtonIncluded":{"type":"boolean","description":"Gets a value indicating whether the payment connector UI includes a submit button"},"isPrimaryCardOptionIncluded":{"type":"boolean","description":"Gets a value indicating whether the primary card option is included"},"connectorScriptUrls":{"type":"array","items":{"type":"string"},"description":"Gets the list of connector script URLs that need to be loaded"}},"additionalProperties":false,"description":"Represents the details required to initialise the embedded payment UI for adding a member payment card"}},"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberPaymentCard":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberPaymentCard","kind":"json-schema","title":"MemberPaymentCard","data":{"title":"MemberPaymentCard","required":["cardDetails","id","isPrimary","isUsedForRecurringSubscriptionBilling"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"cardDetails":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.PaymentCardDetails"}],"description":"Gets the card details"},"isPrimary":{"type":"boolean","description":"Gets a value indicating whether this is the primary card"},"isUsedForRecurringSubscriptionBilling":{"type":"boolean","description":"Gets a value indicating whether this card is used for automatic payments for a recurring member subscription"}},"additionalProperties":false,"description":"Represents a payment card belonging to a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberPaymentCardListDetails":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberPaymentCardListDetails","kind":"json-schema","title":"MemberPaymentCardListDetails","data":{"title":"MemberPaymentCardListDetails","required":["cards"],"type":"object","properties":{"cards":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.MemberPaymentCard"},"description":"Gets the list of member payment card entities"}},"additionalProperties":false,"description":"Represents a list of member payment card entities"}},"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberEmbeddedPaymentCardCreate":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberEmbeddedPaymentCardCreate","kind":"json-schema","title":"MemberEmbeddedPaymentCardCreate","data":{"title":"MemberEmbeddedPaymentCardCreate","required":["webPaymentMethodId"],"type":"object","properties":{"webPaymentMethodId":{"type":"integer","description":"Gets the unique identifier of the web payment method","format":"int32"},"redirectReturnUrl":{"type":"string","description":"Gets the URL that the browser will be directed to after the embedded payment has finished, if the requested web payment\r\nmethod requires redirect","format":"uri","nullable":true},"languageTag":{"type":"string","description":"Gets the IETF (RFC 4646) language tag","nullable":true}},"additionalProperties":false,"description":"Represents the values needed to create an embedded member payment card for one-off order payments"}},"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberPrimaryPaymentCardUpdate":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.PaymentCards.Requests.MemberPrimaryPaymentCardUpdate","kind":"json-schema","title":"MemberPrimaryPaymentCardUpdate","data":{"title":"MemberPrimaryPaymentCardUpdate","required":["memberPaymentCardId"],"type":"object","properties":{"memberPaymentCardId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the member payment card"}},"additionalProperties":false,"description":"Represents the information required to update a member entity's primary member payment card"}},"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberAddress":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberAddress","kind":"json-schema","title":"MemberAddress","data":{"title":"MemberAddress","type":"object","properties":{"line1":{"type":"string","description":"Gets the first line","nullable":true,"example":"60 Khyber Pass Road"},"suburb":{"type":"string","description":"Gets the suburb","nullable":true,"example":"Grafton"},"city":{"type":"string","description":"Gets the city","nullable":true,"example":"Auckland"},"state":{"type":"string","description":"Gets the state","nullable":true,"example":null},"postCode":{"type":"string","description":"Gets the post code","nullable":true,"example":"1023"},"country":{"type":"string","description":"Gets the country","nullable":true,"example":"New Zealand"}},"additionalProperties":false,"description":"Represents the physical address of a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberContactDetails":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberContactDetails","kind":"json-schema","title":"MemberContactDetails","data":{"title":"MemberContactDetails","required":["phoneNumbers"],"type":"object","properties":{"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.PhoneNumber"},"description":"Gets the list of phone number entities"},"address":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberAddress"}],"description":"Gets the physical address"},"pushNotificationToken":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.PushNotificationToken"}],"description":"Gets the push notification token"}},"additionalProperties":false,"description":"Represents the contact details of a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberGender":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberGender","kind":"json-schema","title":"MemberGender","data":{"title":"MemberGender","enum":["NotSpecified","Male","Female","Other"],"type":"string","description":"Represents the gender of a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberInterestSubscription":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberInterestSubscription","kind":"json-schema","title":"MemberInterestSubscription","data":{"title":"MemberInterestSubscription","required":["interestContactMethodIds","interestId"],"type":"object","properties":{"interestId":{"type":"integer","description":"Gets the unique identifier of the interest","format":"int32"},"interestContactMethodIds":{"type":"array","items":{"type":"integer","format":"int32"},"description":"Gets the list of unique identifiers of the selected interest contact method entities"}},"additionalProperties":false,"description":"Represents a member entity's subscription to an interest"}},"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberMaritalStatus":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberMaritalStatus","kind":"json-schema","title":"MemberMaritalStatus","data":{"title":"MemberMaritalStatus","enum":["NotSpecified","Single","Married","Partnered","Divorced","Other"],"type":"string","description":"Represents the marital status of a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberPersonalDetails":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberPersonalDetails","kind":"json-schema","title":"MemberPersonalDetails","data":{"title":"MemberPersonalDetails","required":["contactDetails","gender","interestSubscriptions","maritalStatus","name","preferences"],"type":"object","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.PersonName"}],"description":"Gets the name"},"contactDetails":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberContactDetails"}],"description":"Gets the contact details"},"interestSubscriptions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberInterestSubscription"},"description":"Gets the list of member interest subscription entities"},"preferences":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberPreferences"}],"description":"Gets the preferences"},"birthDate":{"type":"string","description":"Gets the date of birth, if known","format":"date-time","nullable":true},"maritalStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberMaritalStatus"}],"description":"Gets the marital status"},"gender":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.PersonalDetails.MemberGender"}],"description":"Gets the gender"},"educationLevelId":{"type":"integer","description":"Gets the unique identifier of the education level, if known","format":"int32","nullable":true},"occupationId":{"type":"integer","description":"Gets the unique identifier of the occupation, if known","format":"int32","nullable":true},"householdPersonCount":{"type":"integer","description":"Gets the number of people living in the household, if known","format":"int32","nullable":true},"nationalId":{"type":"string","description":"Gets the national unique identifier, if known","nullable":true},"externalId":{"type":"string","description":"Gets the unique identifier used in a previous loyalty system, if known","nullable":true}},"additionalProperties":false,"description":"Represents the personal details of a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Photos.CreatedMemberPhoto":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Photos.CreatedMemberPhoto","kind":"json-schema","title":"CreatedMemberPhoto","data":{"title":"CreatedMemberPhoto","type":"object","properties":{"memberPhoto":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Photos.MemberPhoto"}],"description":"Gets the member photo entity"}},"additionalProperties":false,"description":"Represents a member photo that has just been created"}},"components/schemas/Ocapi.V1.Loyalty.Members.Photos.MemberPhoto":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Photos.MemberPhoto","kind":"json-schema","title":"MemberPhoto","data":{"title":"MemberPhoto","required":["canBeUpdatedAt","isUpdatable"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Photos.MemberPhotoBase"}],"properties":{"isUpdatable":{"type":"boolean","description":"Gets a value indicating whether the member is currently allowed to update their photo"},"canBeUpdatedAt":{"type":"string","description":"Gets the date and time that the member can update their photo","format":"date-time"}},"additionalProperties":false,"description":"Represents the details of the photo associated with a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Photos.MemberPhotoBase":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Photos.MemberPhotoBase","kind":"json-schema","title":"MemberPhotoBase","data":{"title":"MemberPhotoBase","required":["uri","uriExpiresAt"],"type":"object","properties":{"uriExpiresAt":{"type":"string","description":"Gets the date and time that the URI returned for retrieving the photo is no longer valid","format":"date-time"},"uri":{"type":"string","description":"Gets the address used for retrieving the photo","format":"uri"}},"additionalProperties":false,"description":"Represents the base properties of the photo associated with a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberContactMethod":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberContactMethod","kind":"json-schema","title":"MemberContactMethod","data":{"title":"MemberContactMethod","enum":["Sms","Email","Mail","Phone","Fax"],"type":"string","description":"Represents the methods by which a member can be contacted"}},"components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberContactPreferences":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberContactPreferences","kind":"json-schema","title":"MemberContactPreferences","data":{"title":"MemberContactPreferences","required":["allowThirdPartyContact","contactMethods","mailerFrequency"],"type":"object","properties":{"contactMethods":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberContactMethod"},"description":"Gets the list of preferred member contact method entities"},"mailerFrequency":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberMailerFrequency"}],"description":"Gets the mailer frequency"},"allowThirdPartyContact":{"type":"boolean","description":"Gets a value indicating whether the member has consented to being contacted by third parties"}},"additionalProperties":false,"description":"Represents the contact preferences of a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberCustomPreference":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberCustomPreference","kind":"json-schema","title":"MemberCustomPreference","data":{"title":"MemberCustomPreference","required":["customPreferenceId","customPreferenceOptionIds"],"type":"object","properties":{"customPreferenceId":{"type":"integer","description":"Gets the unique identifier of the custom preference","format":"int32"},"customPreferenceOptionIds":{"type":"array","items":{"type":"integer","format":"int32"},"description":"Gets the list of unique identifiers of the selected custom preference option entities"}},"additionalProperties":false,"description":"Represents the custom preference selections of a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberGenrePreferences":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberGenrePreferences","kind":"json-schema","title":"MemberGenrePreferences","data":{"title":"MemberGenrePreferences","required":["preferredGenreIds"],"type":"object","properties":{"preferredGenreIds":{"type":"array","items":{"type":"string"},"description":"Gets the list of unique identifiers of the preferred loyalty genre entities"}},"additionalProperties":false,"description":"Represents the loyalty genre preferences of a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberMailerFrequency":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberMailerFrequency","kind":"json-schema","title":"MemberMailerFrequency","data":{"title":"MemberMailerFrequency","enum":["Never","Weekly","Fortnightly","Monthly"],"type":"string","description":"Represents how often the member receives a mailer"}},"components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberPreferences":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberPreferences","kind":"json-schema","title":"MemberPreferences","data":{"title":"MemberPreferences","required":["allowThirdPartyProfiling","contact","customPreferences","genres","sites"],"type":"object","properties":{"sites":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberSitePreferences"}],"description":"Gets the site preferences"},"genres":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberGenrePreferences"}],"description":"Gets the genre preferences"},"contact":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberContactPreferences"}],"description":"Gets the contact preferences"},"customPreferences":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberCustomPreference"},"description":"Gets the list of member custom preference entities"},"languageTag":{"type":"string","description":"Gets the IETF (RFC 4646) language tag","nullable":true,"example":"en-US"},"allowThirdPartyProfiling":{"type":"boolean","description":"Gets a value indicating whether the member has consented to third-party profiling"}},"additionalProperties":false,"description":"Represents preferences of a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberSitePreferences":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Preferences.MemberSitePreferences","kind":"json-schema","title":"MemberSitePreferences","data":{"title":"MemberSitePreferences","required":["preferredSiteIds"],"type":"object","properties":{"pickupSiteId":{"type":"string","description":"Gets the unique identifier of the loyalty site used for pickup orders","nullable":true},"primarySiteId":{"type":"string","description":"Gets the unique identifier of the primary loyalty site","nullable":true},"preferredSiteIds":{"type":"array","items":{"type":"string"},"description":"Gets the list of unique identifiers of the preferred loyalty site entities"}},"additionalProperties":false,"description":"Represents the loyalty site preferences of a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.Availability.MemberRewardAvailability":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.Availability.MemberRewardAvailability","kind":"json-schema","title":"MemberRewardAvailability","data":{"title":"MemberRewardAvailability","required":["rewardId","ticketTypes"],"type":"object","properties":{"rewardId":{"type":"integer","description":"Gets the unique identifier of the reward","format":"int32"},"ticketTypes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Rewards.Availability.MemberRewardTicketTypeAvailability"},"description":"Gets the list of member reward ticket type availability entities"}},"additionalProperties":false,"description":"Represents the availability of a member reward"}},"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.Availability.MemberRewardAvailabilityListDetails":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.Availability.MemberRewardAvailabilityListDetails","kind":"json-schema","title":"MemberRewardAvailabilityListDetails","data":{"title":"MemberRewardAvailabilityListDetails","required":["memberRewardAvailabilities"],"type":"object","properties":{"memberRewardAvailabilities":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Rewards.Availability.MemberRewardAvailability"},"description":"Gets the list of member reward availability entities"}},"additionalProperties":false,"description":"Represents a list of member reward availability entities"}},"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.Availability.MemberRewardTicketTypeAvailability":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.Availability.MemberRewardTicketTypeAvailability","kind":"json-schema","title":"MemberRewardTicketTypeAvailability","data":{"title":"MemberRewardTicketTypeAvailability","required":["availableQuantity","isAvailable","ticketTypeId"],"type":"object","properties":{"ticketTypeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the ticket type base"},"isAvailable":{"type":"boolean","description":"Gets a value indicating whether the member reward is available for the\r\nticket type base","readOnly":true},"availableQuantity":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Quantity"}],"description":"Gets the quantity available to the member for the ticket type base"},"unavailableMessage":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the message to display when the member reward is unavailable for the\r\nticket type base"}},"additionalProperties":false,"description":"Represents the availability of a member reward for a ticket type base"}},"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.MemberReward":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.MemberReward","kind":"json-schema","title":"MemberReward","data":{"title":"MemberReward","required":["availableQuantity","instanceNumber","rewardId"],"type":"object","properties":{"rewardId":{"type":"integer","description":"Gets the unique identifier of the reward","format":"int32"},"instanceNumber":{"type":"integer","description":"Gets the instance number","format":"int32"},"availableQuantity":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Quantity"}],"description":"Gets the quantity available to the member"},"expiresAt":{"type":"string","description":"Gets the date and time that the reward expires","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Represents an instance of a reward belonging to a particular member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.MemberRewardListDetails":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.MemberRewardListDetails","kind":"json-schema","title":"MemberRewardListDetails","data":{"title":"MemberRewardListDetails","required":["memberRewards","relatedData"],"type":"object","properties":{"memberRewards":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Rewards.MemberReward"},"description":"Gets the list of member reward entities"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Rewards.MemberRewardListRelatedData"}],"description":"Gets the related data for the member reward entities"}},"additionalProperties":false,"description":"Represents a list of member reward entities, and their related data"}},"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.MemberRewardListRelatedData":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Rewards.MemberRewardListRelatedData","kind":"json-schema","title":"MemberRewardListRelatedData","data":{"title":"MemberRewardListRelatedData","required":["items","rewards"],"type":"object","properties":{"rewards":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Rewards.Reward"},"description":"Gets the list of related reward entities"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Items.LoyaltyItem"},"description":"Gets the list of related loyalty item entities"}},"additionalProperties":false,"description":"Related data for a list of member reward entities"}},"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.FutureRecurringMemberSubscriptionCreation":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.FutureRecurringMemberSubscriptionCreation","kind":"json-schema","title":"FutureRecurringMemberSubscriptionCreation","data":{"title":"FutureRecurringMemberSubscriptionCreation","required":["status","subscriptionBillingOptionId"],"type":"object","properties":{"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.FutureRecurringMemberSubscriptionCreationStatus"}],"description":"Gets the creation status of the future recurring member subscription"},"subscriptionBillingOptionId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the subscription billing option used for the creation of the future recurring member subscription"}},"additionalProperties":false,"description":"Represents the creation of a future recurring member subscription"}},"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.FutureRecurringMemberSubscriptionCreationStatus":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.FutureRecurringMemberSubscriptionCreationStatus","kind":"json-schema","title":"FutureRecurringMemberSubscriptionCreationStatus","data":{"title":"FutureRecurringMemberSubscriptionCreationStatus","enum":["NotStarted","Pending","Failed","Completed"],"type":"string","description":"Represents the creation status of a future recurring member subscription"}},"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.MemberFutureRecurringSubscriptionSelection":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.FutureRecurring.MemberFutureRecurringSubscriptionSelection","kind":"json-schema","title":"MemberFutureRecurringSubscriptionSelection","data":{"title":"MemberFutureRecurringSubscriptionSelection","required":["subscriptionBillingOptionId"],"type":"object","properties":{"subscriptionBillingOptionId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the subscription billing option"}},"additionalProperties":false,"description":"Represents the member subscriptions Future recurring subscription billing option selected by\r\na member with a current member subscription"}},"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscription":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscription","kind":"json-schema","title":"MemberSubscription","data":{"title":"MemberSubscription","required":["billingDetails","contractedTermEndsAt","isCancellationAllowed","startsAt","status","subscriptionId"],"type":"object","properties":{"subscriptionId":{"type":"integer","description":"Gets the unique identifier of the subscription","format":"int32"},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscriptionStatus"}],"description":"Gets the current status"},"startsAt":{"type":"string","description":"Gets the date and time that the subscription starts","format":"date-time"},"expiresAt":{"type":"string","description":"Gets the date and time that the subscription expires","format":"date-time","nullable":true},"contractedTermEndsAt":{"type":"string","description":"Gets the date and time that the contracted subscription MinimumTermInMonths ends","format":"date-time"},"billingDetails":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscriptionBillingDetails"}],"description":"Gets the billing details"},"holdPeriod":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscriptionHoldPeriod"}],"description":"Gets the current hold period"},"isCancellationAllowed":{"type":"boolean","description":"Gets a value indicating whether the member is allowed to cancel the subscription"},"cancelsAt":{"type":"string","description":"Gets the date and time that the subscription will be cancelled, if applicable","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Represents an instance of a subscription belonging to a particular member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscriptionBillingDetails":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscriptionBillingDetails","kind":"json-schema","title":"MemberSubscriptionBillingDetails","data":{"title":"MemberSubscriptionBillingDetails","required":["isRecurring","isUsingThirdPartyPaymentProvider"],"type":"object","properties":{"isRecurring":{"type":"boolean","description":"Gets a value indicating whether billing will occur at a regular interval"},"reactivationPrice":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the price to reactivate a member subscription with a member subscription status Frozen status"},"isUsingThirdPartyPaymentProvider":{"type":"boolean","description":"Gets a value indicating whether the member uses a third-party payment provider to pay for their\r\nmember subscription"},"currentBillingPeriodStartsAt":{"type":"string","description":"Gets the date and time that the current billing period started","format":"date-time","nullable":true},"nextBillingPeriodStartsAt":{"type":"string","description":"Gets the date and time that the current billing period ends and the next billing period starts","format":"date-time","nullable":true},"billingError":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscriptionBillingError"}],"description":"Gets the billing error for the latest billing attempt, if applicable"},"hasLastContractedPaymentBeenMade":{"type":"boolean","description":"Gets a value indicating whether the last contracted payment has been made, if applicable","nullable":true},"hasNextBillingPeriodPriceAdjustment":{"type":"boolean","description":"Gets a value indicating whether there is a billing price adjustment for the next billing period","nullable":true}},"additionalProperties":false,"description":"Represents the billing details of a member subscription"}},"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscriptionBillingError":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscriptionBillingError","kind":"json-schema","title":"MemberSubscriptionBillingError","data":{"title":"MemberSubscriptionBillingError","required":["willBeRetried"],"type":"object","properties":{"willBeRetried":{"type":"boolean","description":"Gets a value indicating whether another billing attempt will be made"}},"additionalProperties":false,"description":"Represents a billing error for a member subscription"}},"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscriptionHoldPeriod":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscriptionHoldPeriod","kind":"json-schema","title":"MemberSubscriptionHoldPeriod","data":{"title":"MemberSubscriptionHoldPeriod","required":["endDate","startDate"],"type":"object","properties":{"startDate":{"type":"string","description":"Gets the date that the hold period starts","format":"date-time"},"endDate":{"type":"string","description":"Gets the date that the hold period ends. The hold period is inclusive of this date","format":"date-time"}},"additionalProperties":false,"description":"Represents the hold period of a member subscription"}},"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscriptionStatus":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscriptionStatus","kind":"json-schema","title":"MemberSubscriptionStatus","data":{"title":"MemberSubscriptionStatus","enum":["Active","Frozen","OnHold","NotStarted"],"type":"string","description":"Represents the status of a member subscription"}},"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscriptions":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscriptions","kind":"json-schema","title":"MemberSubscriptions","data":{"title":"MemberSubscriptions","required":["canPurchaseFutureSubscription","canPurchaseFutureSubscriptionAt","current"],"type":"object","properties":{"current":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscription"}],"description":"Gets the current member subscription entity"},"future":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.MemberSubscription"}],"description":"Gets the future member subscription entity"},"canPurchaseFutureSubscription":{"type":"boolean","description":"Gets a value indicating whether the member can purchase a member subscriptions Future subscription"},"canPurchaseFutureSubscriptionAt":{"type":"string","description":"Gets the date and time that the member can purchase a member subscriptions Future subscription","format":"date-time"}},"additionalProperties":false,"description":"Represents the member subscription entities belonging to a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.FutureRecurringMemberSubscriptionEmbeddedPaymentCardCreate":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.FutureRecurringMemberSubscriptionEmbeddedPaymentCardCreate","kind":"json-schema","title":"FutureRecurringMemberSubscriptionEmbeddedPaymentCardCreate","data":{"title":"FutureRecurringMemberSubscriptionEmbeddedPaymentCardCreate","required":["subscriptionBillingOptionId","webPaymentMethodId"],"type":"object","properties":{"webPaymentMethodId":{"type":"integer","description":"Gets the unique identifier of the web payment method","format":"int32"},"redirectReturnUrl":{"type":"string","description":"Gets the URL that the browser will be directed to after the embedded payment has finished, if the requested web payment\r\nmethod requires redirect","format":"uri","nullable":true},"languageTag":{"type":"string","description":"Gets the IETF (RFC 4646) language tag","nullable":true},"subscriptionBillingOptionId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the subscription billing option that will be regularly charged to the\r\ncreated or selected member payment card"}},"additionalProperties":false,"description":"Represents the values needed to create or select the member payment card used\r\nfor a future recurring member subscription"}},"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.RecurringMemberSubscriptionEmbeddedPaymentCardCreate":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Subscriptions.Requests.RecurringMemberSubscriptionEmbeddedPaymentCardCreate","kind":"json-schema","title":"RecurringMemberSubscriptionEmbeddedPaymentCardCreate","data":{"title":"RecurringMemberSubscriptionEmbeddedPaymentCardCreate","required":["webPaymentMethodId"],"type":"object","properties":{"webPaymentMethodId":{"type":"integer","description":"Gets the unique identifier of the web payment method","format":"int32"},"redirectReturnUrl":{"type":"string","description":"Gets the URL that the browser will be directed to after the embedded payment has finished, if the requested web payment\r\nmethod requires redirect","format":"uri","nullable":true},"languageTag":{"type":"string","description":"Gets the IETF (RFC 4646) language tag","nullable":true}},"additionalProperties":false,"description":"Represents the values needed to create an embedded member payment card for a recurring member subscription"}},"components/schemas/Ocapi.V1.Loyalty.Members.TicketRedemptionCards.MemberSubscriptionTicketRedemptionCard":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.TicketRedemptionCards.MemberSubscriptionTicketRedemptionCard","kind":"json-schema","title":"MemberSubscriptionTicketRedemptionCard","data":{"title":"MemberSubscriptionTicketRedemptionCard","required":["id","status","subscriptionId","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.TicketRedemptionCards.TicketRedemptionCardBase"}],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.TicketRedemptionCards.TicketRedemptionCardType"}],"description":"Gets the type"},"id":{"type":"string","description":"Gets the unique identifier","format":"uuid"},"subscriptionId":{"type":"integer","description":"Gets the unique identifier of the subscription the card is linked to","format":"int32"},"friendId":{"type":"string","description":"Gets the unique identifier of the member friend that the card belongs to","format":"uuid","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.TicketRedemptionCards.MemberSubscriptionTicketRedemptionCardStatus"}],"description":"Gets the current status"}},"additionalProperties":false,"description":"Represents a member subscription card that is linked to a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.TicketRedemptionCards.MemberSubscriptionTicketRedemptionCardStatus":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.TicketRedemptionCards.MemberSubscriptionTicketRedemptionCardStatus","kind":"json-schema","title":"MemberSubscriptionTicketRedemptionCardStatus","data":{"title":"MemberSubscriptionTicketRedemptionCardStatus","enum":["Active","Frozen","OnHold"],"type":"string","description":"Represents the status of a member subscription ticket redemption card"}},"components/schemas/Ocapi.V1.Loyalty.Members.TicketRedemptionCards.MemberTicketRedemptionCardsDetails":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.TicketRedemptionCards.MemberTicketRedemptionCardsDetails","kind":"json-schema","title":"MemberTicketRedemptionCardsDetails","data":{"title":"MemberTicketRedemptionCardsDetails","required":["relatedData","ticketRedemptionCards"],"type":"object","properties":{"ticketRedemptionCards":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.TicketRedemptionCards.MemberSubscriptionTicketRedemptionCard"},"description":"Gets the list of member ticket redemption card base entities"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.TicketRedemptionCards.MemberTicketRedemptionCardsRelatedData"}],"description":"Gets the related data for the member ticket redemption card base entities"}},"additionalProperties":false,"description":"Represents a list of member ticket redemption card base entities that belong to a member, and their related data"}},"components/schemas/Ocapi.V1.Loyalty.Members.TicketRedemptionCards.MemberTicketRedemptionCardsRelatedData":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.TicketRedemptionCards.MemberTicketRedemptionCardsRelatedData","kind":"json-schema","title":"MemberTicketRedemptionCardsRelatedData","data":{"title":"MemberTicketRedemptionCardsRelatedData","required":["subscriptions"],"type":"object","properties":{"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Subscriptions.Subscription"},"description":"Gets the subscriptions"}},"additionalProperties":false,"description":"Related data for a list of member subscription ticket redemption card entities"}},"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransaction":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransaction","kind":"json-schema","title":"MemberTransaction","data":{"title":"MemberTransaction","required":["balanceAdjustments","createdAt","id","items","showtimes","totalPriceIncludingTax"],"type":"object","properties":{"id":{"type":"integer","description":"Gets the unique identifier","format":"int64"},"totalPriceIncludingTax":{"type":"number","description":"Gets the total price including tax","format":"double"},"booking":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionBooking"}],"description":"Gets the booking details, if applicable"},"createdAt":{"type":"string","description":"Gets the date and time that the transaction was created","format":"date-time"},"showtimes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionShowtime"},"description":"Gets the list of member transaction showtime entities"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionItemLine"},"description":"Gets the list of member transaction item line entities"},"balanceAdjustments":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionBalanceAdjustment"},"description":"Gets the list of member transaction balance adjustment entities"}},"additionalProperties":false,"description":"Represents the details of a transaction belonging to a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionBalanceAdjustment":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionBalanceAdjustment","kind":"json-schema","title":"MemberTransactionBalanceAdjustment","data":{"title":"MemberTransactionBalanceAdjustment","required":["availableUnits","balanceTypeId","isManual","units"],"type":"object","properties":{"balanceTypeId":{"type":"integer","description":"Gets the unique identifier of the balance type","format":"int32"},"units":{"type":"number","description":"Gets the value in balance type units","format":"double"},"availableUnits":{"type":"number","description":"Gets the available balance type units after the adjustment","format":"double"},"isManual":{"type":"boolean","description":"Gets a value indicating whether the adjustment was completed outside of\r\na purchase being made by the member"},"manualReason":{"type":"string","description":"Gets the note associated with the manual balance adjustment, if applicable","nullable":true}},"additionalProperties":false,"description":"Represents an adjustment to a member balance related to a member transaction"}},"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionBooking":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionBooking","kind":"json-schema","title":"MemberTransactionBooking","data":{"title":"MemberTransactionBooking","required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier generated by the loyalty site that can be used to identify and collect the booking"}},"additionalProperties":false,"description":"The details of the completed order booking related to a member transaction"}},"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionItemLine":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionItemLine","kind":"json-schema","title":"MemberTransactionItemLine","data":{"title":"MemberTransactionItemLine","required":["itemId","priceIncludingTax"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the loyalty item"},"priceIncludingTax":{"type":"number","description":"Gets the price including tax that the member paid","format":"double"}},"additionalProperties":false,"description":"Represents a member transaction line for an instance of a loyalty item within a member transaction"}},"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionListRelatedData":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionListRelatedData","kind":"json-schema","title":"MemberTransactionListRelatedData","data":{"title":"MemberTransactionListRelatedData","required":["balanceTypes","films","items","showtimes","sites","ticketTypes"],"type":"object","properties":{"sites":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite"},"description":"Gets the list of related loyalty site entities"},"films":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.RelatedData.LoyaltyRelatedFilm"},"description":"Gets the list of related loyalty related film entities"},"showtimes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Transactions.LoyaltyRelatedShowtime"},"description":"Gets the list of related loyalty related showtime entities"},"ticketTypes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Transactions.LoyaltyRelatedTicketType"},"description":"Gets the list of related loyalty related ticket type entities"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Items.LoyaltyItem"},"description":"Gets the list of related loyalty item entities"},"balanceTypes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.BalanceTypes.BalanceType"},"description":"Gets the list of related balance type entities"}},"additionalProperties":false,"description":"Related data for a list of member transaction entities"}},"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionPaginatedResultSet":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionPaginatedResultSet","kind":"json-schema","title":"MemberTransactionPaginatedResultSet","data":{"title":"MemberTransactionPaginatedResultSet","required":["hasMoreResults","relatedData","results"],"type":"object","properties":{"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionListRelatedData"}],"description":"Gets the related data for the member transaction entities"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransaction"},"description":"Gets the list of results"},"hasMoreResults":{"type":"boolean","description":"Gets a value indicating whether any more results are available"}},"additionalProperties":false,"description":"Represents a paginated result set of member transaction entities, and their related data"}},"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionShowtime":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionShowtime","kind":"json-schema","title":"MemberTransactionShowtime","data":{"title":"MemberTransactionShowtime","required":["showtimeId","tickets"],"type":"object","properties":{"showtimeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the loyalty related showtime"},"tickets":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionTicketLine"},"description":"Gets the list of member transaction ticket line entities"}},"additionalProperties":false,"description":"Represents a showtime within a member transaction"}},"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionTicketLine":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Transactions.MemberTransactionTicketLine","kind":"json-schema","title":"MemberTransactionTicketLine","data":{"title":"MemberTransactionTicketLine","required":["priceIncludingTax","ticketTypeId"],"type":"object","properties":{"ticketTypeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the loyalty related ticket type"},"priceIncludingTax":{"type":"number","description":"Gets the price including tax that the member paid","format":"double"}},"additionalProperties":false,"description":"Represents a member transaction line for an instance of a loyalty related ticket type within a member transaction showtime"}},"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberEmailUpdate":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberEmailUpdate","kind":"json-schema","title":"MemberEmailUpdate","data":{"title":"MemberEmailUpdate","required":["currentPassword","email"],"type":"object","properties":{"email":{"minLength":1,"type":"string","description":"Gets the new email address"},"currentPassword":{"minLength":1,"type":"string","description":"Gets the current password of the member"}},"additionalProperties":false,"description":"Represents a secure update of a member entity's email address"}},"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberPasswordUpdate":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberPasswordUpdate","kind":"json-schema","title":"MemberPasswordUpdate","data":{"title":"MemberPasswordUpdate","required":["currentPassword","password"],"type":"object","properties":{"password":{"minLength":1,"type":"string","description":"Gets the new password"},"currentPassword":{"minLength":1,"type":"string","description":"Gets the current password of the member"}},"additionalProperties":false,"description":"Represents a secure update of a member entity's password"}},"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberUsernameUpdate":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.Update.MemberUsernameUpdate","kind":"json-schema","title":"MemberUsernameUpdate","data":{"title":"MemberUsernameUpdate","required":["currentPassword","username"],"type":"object","properties":{"username":{"minLength":1,"type":"string","description":"Gets the new username"},"currentPassword":{"minLength":1,"type":"string","description":"Gets the current password of the member"}},"additionalProperties":false,"description":"Represents a secure update of a member entity's username"}},"components/schemas/Ocapi.V1.Loyalty.Members.WatchedFilms.MemberWatchedFilm":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.WatchedFilms.MemberWatchedFilm","kind":"json-schema","title":"MemberWatchedFilm","data":{"title":"MemberWatchedFilm","required":["filmId","lastWatchedAt","watchCount"],"type":"object","properties":{"filmId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the film"},"watchCount":{"type":"integer","description":"Gets the number of times the film has been watched by the member","format":"int32"},"lastWatchedAt":{"type":"string","description":"Gets the last date and time that the film was watched by the member","format":"date-time"}},"additionalProperties":false,"description":"Represents the details of a film that has been watched by a member"}},"components/schemas/Ocapi.V1.Loyalty.Members.WatchedFilms.MemberWatchedFilmListDetails":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.WatchedFilms.MemberWatchedFilmListDetails","kind":"json-schema","title":"MemberWatchedFilmListDetails","data":{"title":"MemberWatchedFilmListDetails","required":["films","relatedData"],"type":"object","properties":{"films":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.WatchedFilms.MemberWatchedFilm"},"description":"Gets the list of member watched film entities"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.WatchedFilms.MemberWatchedFilmListRelatedData"}],"description":"Gets the related data for the member watched film entities"}},"additionalProperties":false,"description":"Represents a list of member watched film entities, and their related data"}},"components/schemas/Ocapi.V1.Loyalty.Members.WatchedFilms.MemberWatchedFilmListRelatedData":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.WatchedFilms.MemberWatchedFilmListRelatedData","kind":"json-schema","title":"MemberWatchedFilmListRelatedData","data":{"title":"MemberWatchedFilmListRelatedData","required":["castAndCrew","censorRatings","films","genres"],"type":"object","properties":{"films":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.Film"},"description":"Gets the list of related film entities"},"castAndCrew":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CastAndCrewMembers.CastAndCrewMember"},"description":"Gets the list of related cast and crew member entities"},"genres":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Genres.Genre"},"description":"Gets the list of related genre entities"},"censorRatings":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CensorRatings.CensorRating"},"description":"Gets the list of related censor rating entities"}},"additionalProperties":false,"description":"Related data for a list of member watched film entities"}},"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilm":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilm","kind":"json-schema","title":"MemberWatchlistFilm","data":{"title":"MemberWatchlistFilm","required":["addedAt","displayPriority","filmId"],"type":"object","properties":{"filmId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the film"},"addedAt":{"type":"string","description":"Gets the date and time that the film was added to the watchlist","format":"date-time"},"watchedAt":{"type":"string","description":"Gets the date and time that the member watched the film, if applicable","format":"date-time","nullable":true},"displayPriority":{"type":"integer","description":"Gets the display priority used for sorting","format":"int32"}},"additionalProperties":false,"description":"Represents the details of a film that has been added to a member entity's watchlist"}},"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmCreate":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmCreate","kind":"json-schema","title":"MemberWatchlistFilmCreate","data":{"title":"MemberWatchlistFilmCreate","required":["filmId"],"type":"object","properties":{"filmId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the film"}},"additionalProperties":false,"description":"Represents the details of a member watchlist film to be created"}},"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmListDetails":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmListDetails","kind":"json-schema","title":"MemberWatchlistFilmListDetails","data":{"title":"MemberWatchlistFilmListDetails","required":["films","relatedData"],"type":"object","properties":{"films":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilm"},"description":"Gets the list of member watchlist film entities"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmListRelatedData"}],"description":"Gets the related data for the member watchlist film entities"}},"additionalProperties":false,"description":"Represents a list of member watchlist film entities, and their related data"}},"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmListRelatedData":{"id":"components/schemas/Ocapi.V1.Loyalty.Members.WatchlistFilms.MemberWatchlistFilmListRelatedData","kind":"json-schema","title":"MemberWatchlistFilmListRelatedData","data":{"title":"MemberWatchlistFilmListRelatedData","required":["castAndCrew","censorRatings","films","genres"],"type":"object","properties":{"films":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.Film"},"description":"Gets the list of related film entities"},"castAndCrew":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CastAndCrewMembers.CastAndCrewMember"},"description":"Gets the list of related cast and crew member entities"},"genres":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Genres.Genre"},"description":"Gets the list of related genre entities"},"censorRatings":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CensorRatings.CensorRating"},"description":"Gets the list of related censor rating entities"}},"additionalProperties":false,"description":"Related data for a list of member watchlist film entities"}},"components/schemas/Ocapi.V1.Loyalty.RelatedData.LoyaltyRelatedFilm":{"id":"components/schemas/Ocapi.V1.Loyalty.RelatedData.LoyaltyRelatedFilm","kind":"json-schema","title":"LoyaltyRelatedFilm","data":{"title":"LoyaltyRelatedFilm","required":["id","title"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"title":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}]}},"additionalProperties":false,"description":"Represents a film in Vista Loyalty"}},"components/schemas/Ocapi.V1.Loyalty.Transactions.LoyaltyRelatedShowtime":{"id":"components/schemas/Ocapi.V1.Loyalty.Transactions.LoyaltyRelatedShowtime","kind":"json-schema","title":"LoyaltyRelatedShowtime","data":{"title":"LoyaltyRelatedShowtime","required":["filmId","id","siteId"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"filmId":{"minLength":1,"type":"string"},"siteId":{"minLength":1,"type":"string"}},"additionalProperties":false,"description":"Represents a showtime in Vista Loyalty"}},"components/schemas/Ocapi.V1.Loyalty.Transactions.LoyaltyRelatedTicketType":{"id":"components/schemas/Ocapi.V1.Loyalty.Transactions.LoyaltyRelatedTicketType","kind":"json-schema","title":"LoyaltyRelatedTicketType","data":{"title":"LoyaltyRelatedTicketType","required":["description","id"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"description":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}]}},"additionalProperties":false,"description":"Represents a ticket type base in Vista Loyalty"}},"components/schemas/Ocapi.V1.MonetaryValue":{"id":"components/schemas/Ocapi.V1.MonetaryValue","kind":"json-schema","title":"MonetaryValue","data":{"title":"MonetaryValue","required":["tax","valueExcludingTax","valueIncludingTax"],"type":"object","properties":{"valueIncludingTax":{"type":"number","description":"Gets the monetary value including tax","format":"double","readOnly":true},"valueExcludingTax":{"type":"number","description":"Gets the monetary value excluding tax","format":"double","readOnly":true},"tax":{"type":"number","description":"Gets the amount of tax","format":"double","readOnly":true}},"additionalProperties":false,"description":"Represents a monetary value, and its related tax value"}},"components/schemas/Ocapi.V1.Orders.Bookings.CompletedOrderBooking":{"id":"components/schemas/Ocapi.V1.Orders.Bookings.CompletedOrderBooking","kind":"json-schema","title":"CompletedOrderBooking","data":{"title":"CompletedOrderBooking","required":["id","mode","originalBookingFee","totalBookingFee"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier generated by the site that can be used to identify and collect the booking"},"totalBookingFee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total booking fee amount the customer has currently paid"},"originalBookingFee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total booking fee amount for the order at the time it was initially made"},"mode":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Bookings.OrderBookingMode"}],"description":"Gets the order booking mode"}},"additionalProperties":false,"description":"Represents the booking details of a completed standard order"}},"components/schemas/Ocapi.V1.Orders.Bookings.InProgressOrderBooking":{"id":"components/schemas/Ocapi.V1.Orders.Bookings.InProgressOrderBooking","kind":"json-schema","title":"InProgressOrderBooking","data":{"title":"InProgressOrderBooking","required":["mode","totalBookingFee"],"type":"object","properties":{"mode":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Bookings.OrderBookingMode"}],"description":"Gets the order booking mode."},"totalBookingFee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total booking fee amount the customer has currently paid."}},"additionalProperties":false}},"components/schemas/Ocapi.V1.Orders.Bookings.OrderBookingMode":{"id":"components/schemas/Ocapi.V1.Orders.Bookings.OrderBookingMode","kind":"json-schema","title":"OrderBookingMode","data":{"title":"OrderBookingMode","enum":["Paid","Unpaid","UnpaidConfirmed"],"type":"string","description":"Represents the mode of an order booking base"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedGiftShopOrder":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedGiftShopOrder","kind":"json-schema","title":"CompletedGiftShopOrder","data":{"title":"CompletedGiftShopOrder","required":["amountSaved","createdAt","deals","expiresAt","id","itemDeliveries","items","originalItemDeliveryFee","originalPrice","payments","status","totalItemDeliveryFee","totalPrice","type","vouchers"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderType"}],"description":"Gets the type"},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderStatus"}],"description":"Gets the status"},"totalPrice":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total price to be displayed to the customer"},"originalPrice":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total price the customer paid for the order at the time the order was initially completed"},"transaction":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Transactions.OrderTransaction"}],"description":"Gets the transaction details, if applicable"},"vouchers":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucher"},"description":"Gets the list of order voucher entities"},"deals":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Deals.OrderDeal"},"description":"Gets the list of order deal entities"},"payments":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.ExternallyProcessed.OrderExternallyProcessedPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.CinemaProcessed.OrderCinemaProcessedPayment"}],"description":"Represents the base properties of a payment that has been added to an order base"},"description":"Gets the list of order payment base entities"},"items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderItemLine"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderWeightBasedItemLine"}],"description":"Represents the base properties of a collectable order line for a top-level instance of an item base\r\nwithin a standard order or gift shop order"},"description":"Gets the list of order item line base entities"},"amountSaved":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the monetary amount saved via discounted prices"},"expiresAt":{"type":"string","description":"Gets the date and time that the order is set to expire","format":"date-time"},"createdAt":{"type":"string","description":"Gets the date and time that the order was completed","format":"date-time"},"itemDeliveries":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemCounterPickup"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemCustomLocationDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemDiningLocationDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemElectronicDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemInSeatDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemPostalDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemServiceAreaPickup"}],"description":"Represents the base properties of an order item delivery base for a completed order base"},"description":"Gets the list of completed order item delivery base entities for the gift shop order Items"},"originalItemDeliveryFee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total fee for the completed gift shop order ItemDeliveries in the order at the time it was initially made"},"totalItemDeliveryFee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total fee for the completed gift shop order ItemDeliveries"}},"additionalProperties":false,"description":"Represents a gift shop order in a order status Completed state"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderGiftCardItem":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderGiftCardItem","kind":"json-schema","title":"CompletedOrderGiftCardItem","data":{"title":"CompletedOrderGiftCardItem","required":["giftCard","orderLineId","type"],"type":"object","properties":{"orderLineId":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the order item line base within the completed gift shop order"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.CompletedOrders.RedeemableItems.CompletedOrderRedeemableItemType"}],"description":"Gets the type"},"giftCard":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.CompletedOrders.GiftCard"}],"description":"Gets the gift card that was issued"}},"additionalProperties":false,"description":"Represents the details of a gift card purchased via an order item line base"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderPrintStreams":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderPrintStreams","kind":"json-schema","title":"CompletedOrderPrintStreams","data":{"title":"CompletedOrderPrintStreams","required":["itemCollectionVouchers","orderReceipts","tickets"],"type":"object","properties":{"itemCollectionVouchers":{"type":"array","items":{"type":"string"},"description":"Gets the printable item collection vouchers"},"tickets":{"type":"array","items":{"type":"string"},"description":"Gets the printable tickets"},"orderReceipts":{"type":"array","items":{"type":"string"},"description":"Gets the printable order receipts"}},"additionalProperties":false,"description":"Represents the printable print streams for a completed order base"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderRedeemableItemListDetails":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderRedeemableItemListDetails","kind":"json-schema","title":"CompletedOrderRedeemableItemListDetails","data":{"title":"CompletedOrderRedeemableItemListDetails","required":["redeemableItems"],"type":"object","properties":{"redeemableItems":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderGiftCardItem"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderVoucherItem"}],"description":"Represents the base properties of a redeemable item purchased via an order item line base"},"description":"Gets the list of completed order redeemable item base entities"}},"additionalProperties":false,"description":"Represents a list of completed order redeemable item base entities for a completed gift shop order"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderSurveyStatus":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderSurveyStatus","kind":"json-schema","title":"CompletedOrderSurveyStatus","data":{"title":"CompletedOrderSurveyStatus","enum":["NotApplicable","NotReady","Ready","Started","Completed","Expired","NotEnabled"],"type":"string","description":"Represents the status of a survey for a completed standard order"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderVoucherItem":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderVoucherItem","kind":"json-schema","title":"CompletedOrderVoucherItem","data":{"title":"CompletedOrderVoucherItem","required":["orderLineId","type","voucher"],"type":"object","properties":{"orderLineId":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the order item line base within the completed gift shop order"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.CompletedOrders.RedeemableItems.CompletedOrderRedeemableItemType"}],"description":"Gets the type"},"voucher":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.CompletedOrders.Voucher"}],"description":"Gets the voucher that was issued"}},"additionalProperties":false,"description":"Represents the details of a voucher purchased via a order item line base"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrder":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrder","kind":"json-schema","title":"CompletedStandardOrder","data":{"title":"CompletedStandardOrder","required":["amountSaved","createdAt","deals","expiresAt","id","itemDeliveries","items","originalItemDeliveryFee","originalPrice","payments","refundAvailability","showtimes","siteId","status","surveyStatus","ticketRedemptionCards","totalItemDeliveryFee","totalPrice","totalRefunded","type","vouchers"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderType"}],"description":"Gets the type"},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderStatus"}],"description":"Gets the status"},"totalPrice":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total price to be displayed to the customer"},"originalPrice":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total price the customer paid for the order at the time the order was initially completed"},"booking":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Bookings.CompletedOrderBooking"}],"description":"Gets the booking details"},"transaction":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Transactions.OrderTransaction"}],"description":"Gets the transaction details, if applicable"},"vouchers":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucher"},"description":"Gets the list of order voucher entities"},"deals":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Deals.OrderDeal"},"description":"Gets the list of order deal entities"},"payments":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.ExternallyProcessed.OrderExternallyProcessedPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.CinemaProcessed.OrderCinemaProcessedPayment"}],"description":"Represents the base properties of a payment that has been added to an order base"},"description":"Gets the list of order payment base entities"},"showtimes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtime"},"description":"Gets the list of order showtime entities"},"items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderItemLine"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderWeightBasedItemLine"}],"description":"Represents the base properties of a collectable order line for a top-level instance of an item base\r\nwithin a standard order or gift shop order"},"description":"Gets the list of order item line base entities"},"itemDeliveries":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemCounterPickup"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemCustomLocationDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemDiningLocationDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemElectronicDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemInSeatDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemPostalDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemServiceAreaPickup"}],"description":"Represents the base properties of an order item delivery base for a completed order base"},"description":"Gets the list of completed order item delivery base entities for the standard order Items"},"originalItemDeliveryFee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total fee for the completed standard order ItemDeliveries in the order at the time it was initially made"},"totalItemDeliveryFee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total fee for the completed standard order ItemDeliveries"},"ticketRedemptionCards":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderMemberSubscriptionCard"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderThirdPartyMemberCard"}],"description":"Represents the base properties of a ticket redemption card base that has been added to a standard order"},"description":"Gets the list of order ticket redemption card base entities"},"siteId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the site"},"preparation":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Preparations.OrderPreparation"}],"description":"Gets the preparation and collection details"},"amountSaved":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the monetary amount saved via discounted prices"},"journeyReference":{"type":"string","description":"Gets the identifier created on order completion that will be linked to a journey entity","nullable":true},"tip":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tips.OrderTip"}],"description":"Gets the tip"},"refundAvailability":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Refunds.OrderRefundAvailability"}],"description":"Gets the current refund availability"},"totalRefunded":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total amount already refunded to the patron"},"expiresAt":{"type":"string","description":"Gets the date and time that the order is set to expire","format":"date-time"},"parentOrderId":{"type":"string","description":"Gets the unique identifier of the linked parent completed standard order, if applicable","nullable":true},"createdAt":{"type":"string","description":"Gets the date and time that the order was completed","format":"date-time"},"surveyStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedOrderSurveyStatus"}],"description":"Gets the survey status"},"siteOrderLocationId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets the unique identifier of the site order location, if applicable."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"remarks","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will equal null if items are ordered from the default site item profile"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]}]}]}],"nullable":true}},"additionalProperties":false,"description":"Represents a standard order in a order status Completed state"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderDetails":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderDetails","kind":"json-schema","title":"CompletedStandardOrderDetails","data":{"title":"CompletedStandardOrderDetails","required":["linkedOrders","order","relatedData"],"type":"object","properties":{"order":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrder"}],"description":"Gets the completed order base entity"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedData"}],"description":"Gets the related data for the completed order base entity and any linked completed standard order entities"},"linkedOrders":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.CompletedOrders.LinkedCompletedStandardOrder"},"description":"Gets the list of linked completed standard order entities"}},"additionalProperties":false,"description":"Represents a completed standard order entity, and its related data"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderIdentifiers":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrderIdentifiers","kind":"json-schema","title":"CompletedStandardOrderIdentifiers","data":{"title":"CompletedStandardOrderIdentifiers","required":["bookingId","journeyReference","orderId","siteId"],"type":"object","properties":{"orderId":{"minLength":1,"type":"string"},"journeyReference":{"minLength":1,"type":"string"},"siteId":{"minLength":1,"type":"string"},"bookingId":{"minLength":1,"type":"string"},"transactionNumber":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false,"description":"Represents the unique identifiers of a completed standard order"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedSubscriptionOrder":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedSubscriptionOrder","kind":"json-schema","title":"CompletedSubscriptionOrder","data":{"title":"CompletedSubscriptionOrder","required":["action","amountSaved","createdAt","deals","expiresAt","id","originalPrice","payments","status","subscription","totalPrice","type","vouchers"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderType"}],"description":"Gets the type"},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderStatus"}],"description":"Gets the status"},"totalPrice":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total price to be displayed to the customer"},"originalPrice":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total price the customer paid for the order at the time the order was initially completed"},"transaction":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Transactions.OrderTransaction"}],"description":"Gets the transaction details, if applicable"},"vouchers":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucher"},"description":"Gets the list of order voucher entities"},"deals":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Deals.OrderDeal"},"description":"Gets the list of order deal entities"},"payments":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.ExternallyProcessed.OrderExternallyProcessedPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.CinemaProcessed.OrderCinemaProcessedPayment"}],"description":"Represents the base properties of a payment that has been added to an order base"},"description":"Gets the list of order payment base entities"},"amountSaved":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the monetary amount saved via discounted prices"},"subscription":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Subscriptions.OrderSubscription"}]},"action":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Subscriptions.SubscriptionOrderAction"}],"description":"Gets the subscription order action"},"expiresAt":{"type":"string","description":"Gets the date and time that the order is set to expire","format":"date-time"},"createdAt":{"type":"string","description":"Gets the date and time that the order was completed","format":"date-time"}},"additionalProperties":false,"description":"Represents a subscription order in a order status Completed state"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.GiftCard":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.GiftCard","kind":"json-schema","title":"GiftCard","data":{"title":"GiftCard","required":["credentials"],"type":"object","properties":{"credentials":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPaymentCreate"},{"$ref":"#/components/schemas/Ocapi.V1.GiftCards.GiftCardCredentials"}],"description":"Represents the credentials required to validate a gift card"},"expiryDate":{"type":"string","description":"Gets the expiry date, or null if the gift card never expires","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Represents a gift card that can be redeemed via an order base"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.GoogleWalletPass":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.GoogleWalletPass","kind":"json-schema","title":"GoogleWalletPass","data":{"title":"GoogleWalletPass","required":["jwt","url"],"type":"object","properties":{"jwt":{"minLength":1,"type":"string","description":"Gets the encoded and signed JSON Web Token (JWT)","example":"eyJhbGci6IkpXVCJ9.eyJhdWQiO...6EkC1Ahp6A"},"url":{"type":"string","description":"Gets the URL that can be used to create an 'Add to Google Wallet' link for web, email, or SMS","format":"uri","example":"https://pay.google.com/gp/v/save/eyJhbGci6IkpXVCJ9.eyJhdWQiO...6EkC1Ahp6A"}},"additionalProperties":false,"description":"Represents the details of a Google Wallet pass"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.ICompletedOrderDetailsBaseGeneric-Ocapi.V1.Orders.CompletedOrders.ICompletedOrderBase","kind":"json-schema","title":"ICompletedOrderDetailsBase`1","data":{"title":"ICompletedOrderDetailsBase`1","required":["order","relatedData"],"type":"object","properties":{"order":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedGiftShopOrder"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrder"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedSubscriptionOrder"}],"description":"Gets the completed order base entity","readOnly":true},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedData"}],"description":"Gets the related data for the completed order base entity and any linked completed standard order entities"}},"additionalProperties":false,"description":"Represents a completed order base entity, and its related data"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.LinkedCompletedStandardOrder":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.LinkedCompletedStandardOrder","kind":"json-schema","title":"LinkedCompletedStandardOrder","data":{"title":"LinkedCompletedStandardOrder","required":["order","relationship"],"type":"object","properties":{"relationship":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.CompletedOrders.LinkedCompletedStandardOrderRelationship"}],"description":"Gets the relationship of the linked completed standard order Order to the other completed standard order entity"},"order":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.CompletedOrders.CompletedStandardOrder"}],"description":"Gets the linked completed standard order entity"}},"additionalProperties":false,"description":"Represents a completed standard order linked to another completed standard order"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.LinkedCompletedStandardOrderRelationship":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.LinkedCompletedStandardOrderRelationship","kind":"json-schema","title":"LinkedCompletedStandardOrderRelationship","data":{"title":"LinkedCompletedStandardOrderRelationship","enum":["Parent","Child","Sibling"],"type":"string","description":"Represents the relationship of a linked completed standard order"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.RedeemableItems.CompletedOrderRedeemableItemType":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.RedeemableItems.CompletedOrderRedeemableItemType","kind":"json-schema","title":"CompletedOrderRedeemableItemType","data":{"title":"CompletedOrderRedeemableItemType","enum":["Voucher","GiftCard"],"type":"string","description":"Represents the type of a completed order redeemable item base"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderCollectionStatusUpdate":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderCollectionStatusUpdate","kind":"json-schema","title":"OrderCollectionStatusUpdate","data":{"title":"OrderCollectionStatusUpdate","type":"object","properties":{"includeChildOrders":{"type":"boolean","description":"Gets a value indicating whether to include all linked completed standard order entities of type linked completed standard order relationship Child in the request"}},"additionalProperties":false,"description":"Represents additional request options when requesting to set a completed order base to order line collection status Collected"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderItemDeliveriesPreparationStatusUpdate":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Requests.OrderItemDeliveriesPreparationStatusUpdate","kind":"json-schema","title":"OrderItemDeliveriesPreparationStatusUpdate","data":{"title":"OrderItemDeliveriesPreparationStatusUpdate","type":"object","properties":{"includeChildOrders":{"type":"boolean","description":"Gets a value indicating whether to include all linked completed standard order entities of type linked completed standard order relationship Child in the request"}},"additionalProperties":false,"description":"Represents additional request options when requesting to prepare completed order item delivery base entities in a completed standard order"}},"components/schemas/Ocapi.V1.Orders.CompletedOrders.Voucher":{"id":"components/schemas/Ocapi.V1.Orders.CompletedOrders.Voucher","kind":"json-schema","title":"Voucher","data":{"title":"Voucher","required":["credentials"],"type":"object","properties":{"credentials":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Vouchers.VoucherCredentials"}],"description":"Gets the credentials"},"expiryDate":{"type":"string","description":"Gets the expiry date, or null if the voucher never expires","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Represents a voucher that can be redeemed via an order base"}},"components/schemas/Ocapi.V1.Orders.Completions.OrderCompletion":{"id":"components/schemas/Ocapi.V1.Orders.Completions.OrderCompletion","kind":"json-schema","title":"OrderCompletion","data":{"title":"OrderCompletion","required":["orderId","orderType","status"],"type":"object","properties":{"orderId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the in progress order base"},"orderType":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderType"}],"description":"Gets the type of the in progress order base"},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Completions.OrderCompletionStatus"}],"description":"Gets the status"},"transactionNumber":{"type":"integer","description":"Gets the number generated by the site that can be used to identify and collect the transaction","format":"int32","nullable":true},"updatedOrderExpiresAt":{"type":"string","description":"Gets the updated date and time that the in progress order base expires","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Represents the completion of an in progress order base"}},"components/schemas/Ocapi.V1.Orders.Completions.OrderCompletionStatus":{"id":"components/schemas/Ocapi.V1.Orders.Completions.OrderCompletionStatus","kind":"json-schema","title":"OrderCompletionStatus","data":{"title":"OrderCompletionStatus","enum":["Pending","Completed","Failed"],"type":"string","description":"Represents the status of an order completion"}},"components/schemas/Ocapi.V1.Orders.Completions.StandardOrderCompletion":{"id":"components/schemas/Ocapi.V1.Orders.Completions.StandardOrderCompletion","kind":"json-schema","title":"StandardOrderCompletion","data":{"title":"StandardOrderCompletion","required":["bookingId","journeyReference","orderId","orderType","status"],"type":"object","properties":{"orderId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the in progress order base"},"orderType":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderType"}],"description":"Gets the type of the in progress order base"},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Completions.OrderCompletionStatus"}],"description":"Gets the status"},"transactionNumber":{"type":"integer","description":"Gets the number generated by the site that can be used to identify and collect the transaction","format":"int32","nullable":true},"updatedOrderExpiresAt":{"type":"string","description":"Gets the updated date and time that the in progress order base expires","format":"date-time","nullable":true},"journeyReference":{"minLength":1,"type":"string","description":"Gets the identifier created on order completion that will be linked to a journey entity"},"bookingId":{"minLength":1,"type":"string","description":"Gets the booking identifier generated by the site that can be used to identify and collect the booking"}},"additionalProperties":false,"description":"Represents the completion of an in progress standard order"}},"components/schemas/Ocapi.V1.Orders.Customers.OrderCustomer":{"id":"components/schemas/Ocapi.V1.Orders.Customers.OrderCustomer","kind":"json-schema","title":"OrderCustomer","data":{"title":"OrderCustomer","required":["email","preferences","taxDetails"],"type":"object","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.PersonName"}],"description":"Gets the name, if known"},"email":{"maxLength":255,"minLength":0,"type":"string","description":"Gets the email address"},"phoneNumber":{"maxLength":25,"minLength":0,"type":"string","description":"Gets the phone number, if known","nullable":true},"preferences":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerPreferences"}],"description":"Gets the preferences"},"taxDetails":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerTaxDetails"}],"description":"Gets the tax details"},"deliveryAddress":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerAddress"}],"description":"Gets the postal delivery address, if applicable"},"billingAddress":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerAddress"}],"description":"Gets the billing address, if applicable"}},"additionalProperties":false,"description":"Represents the details of a customer set against an order base"}},"components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerAddress":{"id":"components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerAddress","kind":"json-schema","title":"OrderCustomerAddress","data":{"title":"OrderCustomerAddress","type":"object","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.PersonName"}],"description":"Gets the name of the recipient"},"companyName":{"type":"string","description":"Gets the name of the company, if applicable","nullable":true},"phoneNumber":{"type":"string","description":"Gets the phone number of the recipient, if applicable","nullable":true},"line1":{"type":"string","description":"Gets the first line","nullable":true},"suburb":{"type":"string","description":"Gets the suburb","nullable":true},"city":{"type":"string","description":"Gets the city","nullable":true},"state":{"type":"string","description":"Gets the state","nullable":true,"example":null},"postCode":{"type":"string","description":"Gets the post code","nullable":true},"country":{"type":"string","description":"Gets the country","nullable":true}},"additionalProperties":false,"description":"Represents the details of a postal/billing address of an order customer"}},"components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerDetails":{"id":"components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerDetails","kind":"json-schema","title":"OrderCustomerDetails","data":{"title":"OrderCustomerDetails","type":"object","properties":{"customer":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Customers.OrderCustomer"}],"description":"Gets the customer, if set"}},"additionalProperties":false,"description":"Represents the details of a customer set against an order base"}},"components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerPreferences":{"id":"components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerPreferences","kind":"json-schema","title":"OrderCustomerPreferences","data":{"title":"OrderCustomerPreferences","type":"object","properties":{"languageTag":{"type":"string","description":"Gets the IETF (RFC 4646) language tag","nullable":true,"example":"en-US"}},"additionalProperties":false,"description":"Represents the preferences of an order customer"}},"components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerTaxDetails":{"id":"components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerTaxDetails","kind":"json-schema","title":"OrderCustomerTaxDetails","data":{"title":"OrderCustomerTaxDetails","type":"object","properties":{"name":{"type":"string","description":"Gets the tax name, if known","nullable":true},"number":{"type":"string","description":"Gets the tax number, if known","nullable":true}},"additionalProperties":false,"description":"Represents the tax details of an order customer"}},"components/schemas/Ocapi.V1.Orders.Customers.Requests.OrderCustomerUpdate":{"id":"components/schemas/Ocapi.V1.Orders.Customers.Requests.OrderCustomerUpdate","kind":"json-schema","title":"OrderCustomerUpdate","data":{"title":"OrderCustomerUpdate","required":["email"],"type":"object","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.PersonName"}],"description":"Gets the name"},"email":{"maxLength":255,"minLength":0,"type":"string","description":"Gets the email address"},"phoneNumber":{"maxLength":25,"minLength":0,"type":"string","description":"Gets the phone number","nullable":true},"preferences":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerPreferences"}],"description":"Gets the preferences"},"taxDetails":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerTaxDetails"}],"description":"Gets the tax details"},"deliveryAddress":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerAddress"}],"description":"Gets the postal delivery address, if applicable"},"billingAddress":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Customers.OrderCustomerAddress"}],"description":"Gets the billing address, if applicable"}},"additionalProperties":false,"description":"Represents the properties required to update the details of an order customer"}},"components/schemas/Ocapi.V1.Orders.Deals.OrderDeal":{"id":"components/schemas/Ocapi.V1.Orders.Deals.OrderDeal","kind":"json-schema","title":"OrderDeal","data":{"title":"OrderDeal","required":["dealId","id"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the deal within the order base","readOnly":true},"dealId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the deal base used","readOnly":true},"voucherId":{"type":"string","description":"Gets the unique identifier of the order voucher used, if applicable","nullable":true}},"additionalProperties":false,"description":"Represents an instance of a deal base that has been added to an order base"}},"components/schemas/Ocapi.V1.Orders.DiningLocations.OrderDiningLocation":{"id":"components/schemas/Ocapi.V1.Orders.DiningLocations.OrderDiningLocation","kind":"json-schema","title":"OrderDiningLocation","data":{"title":"OrderDiningLocation","required":["areaName","diningLocationId","label","type"],"type":"object","properties":{"diningLocationId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the dining location base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Dining.MasterData.DiningLocationType"}],"description":"Gets the type"},"label":{"minLength":1,"type":"string","description":"Gets the label/physical name of the dining location base","example":"5"},"areaName":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name of the dining area"}},"additionalProperties":false,"description":"Represents the details of a dining location base in the context of an order base"}},"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase":{"id":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderDetailsBaseGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressOrderBase","kind":"json-schema","title":"IInProgressOrderDetailsBase`1","data":{"title":"IInProgressOrderDetailsBase`1","required":["order","relatedData"],"type":"object","properties":{"order":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressGiftShopOrder"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrder"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressSubscriptionOrder"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrder"}],"description":"Gets the in progress order base entity","readOnly":true},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedData"}],"description":"Gets the related data for the in progress order base entity"}},"additionalProperties":false,"description":"Represents an in progress order base entity, and its related data"}},"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderListDetailsGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressTabOrder":{"id":"components/schemas/Ocapi.V1.Orders.InProgressOrders.IInProgressOrderListDetailsGeneric-Ocapi.V1.Orders.InProgressOrders.IInProgressTabOrder","kind":"json-schema","title":"IInProgressOrderListDetails`1","data":{"title":"IInProgressOrderListDetails`1","required":["orders","relatedData"],"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrder"},"description":"Gets the list of in progress order base entities","readOnly":true},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderListRelatedData"}],"description":"Gets the related data for the in progress order base entities"}},"additionalProperties":false,"description":"Represents a list of in progress order base entities, and their related data"}},"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressGiftShopOrder":{"id":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressGiftShopOrder","kind":"json-schema","title":"InProgressGiftShopOrder","data":{"title":"InProgressGiftShopOrder","required":["amountSaved","deals","expiresAt","hasCustomer","id","itemDeliveries","items","payments","status","totalItemDeliveryFee","totalPrice","type","vouchers"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderType"}],"description":"Gets the type"},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderStatus"}],"description":"Gets the status"},"totalPrice":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total price to be displayed to the customer"},"vouchers":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucher"},"description":"Gets the list of order voucher entities"},"deals":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Deals.OrderDeal"},"description":"Gets the list of order deal entities"},"payments":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.ExternallyProcessed.OrderExternallyProcessedPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.CinemaProcessed.OrderCinemaProcessedPayment"}],"description":"Represents the base properties of a payment that has been added to an order base"},"description":"Gets the list of order payment base entities"},"items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderItemLine"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderWeightBasedItemLine"}],"description":"Represents the base properties of a collectable order line for a top-level instance of an item base\r\nwithin a standard order or gift shop order"},"description":"Gets the list of order item line base entities"},"expiresAt":{"type":"string","description":"Gets the date and time that the order is set to expire","format":"date-time"},"hasCustomer":{"type":"boolean","description":"Gets a value indicating whether the order customer has been set"},"amountSaved":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the monetary amount saved via discounted prices"},"itemDeliveries":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemCounterPickup"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemCustomLocationDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDiningLocationDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemElectronicDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemInSeatDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemPostalDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemServiceAreaPickup"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemCounterPickup"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemCustomLocationDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemDiningLocationDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemElectronicDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemInSeatDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemPostalDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemServiceAreaPickup"}],"description":"Represents the base properties of the delivery of one or more order item line base entities"},"description":"Gets the list of order item delivery base entities for the gift shop order Items"},"totalItemDeliveryFee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total fee for the in progress gift shop order ItemDeliveries"}},"additionalProperties":false,"description":"Represents a gift shop order in an order status InProgress state"}},"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressGiftShopOrderDetails":{"id":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressGiftShopOrderDetails","kind":"json-schema","title":"InProgressGiftShopOrderDetails","data":{"title":"InProgressGiftShopOrderDetails","required":["order","relatedData"],"type":"object","properties":{"order":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressGiftShopOrder"}],"description":"Gets the in progress order base entity"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedData"}],"description":"Gets the related data for the in progress order base entity"}},"additionalProperties":false,"description":"Represents an in progress gift shop order entity, and its related data"}},"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrder":{"id":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrder","kind":"json-schema","title":"InProgressStandardOrder","data":{"title":"InProgressStandardOrder","required":["amountSaved","booking","deals","expiresAt","hasCustomer","id","itemDeliveries","items","payments","showtimes","siteId","status","ticketRedemptionCards","totalItemDeliveryFee","totalPrice","type","vouchers"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderType"}],"description":"Gets the type"},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderStatus"}],"description":"Gets the status"},"totalPrice":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total price to be displayed to the customer"},"booking":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Bookings.InProgressOrderBooking"}],"description":"Gets the booking details"},"showtimes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtime"},"description":"Gets the list of order showtime entities"},"items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderItemLine"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderWeightBasedItemLine"}],"description":"Represents the base properties of a collectable order line for a top-level instance of an item base\r\nwithin a standard order or gift shop order"},"description":"Gets the list of order item line base entities"},"itemDeliveries":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemCounterPickup"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemCustomLocationDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDiningLocationDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemElectronicDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemInSeatDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemPostalDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemServiceAreaPickup"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemCounterPickup"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemCustomLocationDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemDiningLocationDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemElectronicDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemInSeatDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemPostalDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemServiceAreaPickup"}],"description":"Represents the base properties of the delivery of one or more order item line base entities"},"description":"Gets the list of order item delivery base entities for the standard order Items"},"totalItemDeliveryFee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total fee for the in progress standard order ItemDeliveries"},"payments":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.ExternallyProcessed.OrderExternallyProcessedPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.CinemaProcessed.OrderCinemaProcessedPayment"}],"description":"Represents the base properties of a payment that has been added to an order base"},"description":"Gets the list of order payment base entities"},"vouchers":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucher"},"description":"Gets the list of order voucher entities"},"deals":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Deals.OrderDeal"},"description":"Gets the list of order deal entities"},"ticketRedemptionCards":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderMemberSubscriptionCard"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderThirdPartyMemberCard"}],"description":"Represents the base properties of a ticket redemption card base that has been added to a standard order"},"description":"Gets the list of order ticket redemption card base entities"},"expiresAt":{"type":"string","description":"Gets the date and time that the order is set to expire","format":"date-time"},"siteId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the site"},"hasCustomer":{"type":"boolean","description":"Gets a value indicating whether the order customer has been set"},"amountSaved":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the monetary amount saved via discounted prices"},"tip":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tips.OrderTip"}],"description":"Gets the tip"},"parentOrderId":{"type":"string","description":"Gets the unique identifier of the linked parent completed standard order, if applicable","nullable":true},"siteOrderLocationId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets the unique identifier of the site order location, if applicable."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"remarks","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will equal null if items are ordered from the default site item profile"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]}]}]}],"nullable":true}},"additionalProperties":false,"description":"Represents a standard order in an order status InProgress state"}},"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails":{"id":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrderDetails","kind":"json-schema","title":"InProgressStandardOrderDetails","data":{"title":"InProgressStandardOrderDetails","required":["order","relatedData"],"type":"object","properties":{"order":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressStandardOrder"}],"description":"Gets the in progress order base entity"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedData"}],"description":"Gets the related data for the in progress order base entity"}},"additionalProperties":false,"description":"Represents an in progress standard order entity, and its related data"}},"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressSubscriptionOrder":{"id":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressSubscriptionOrder","kind":"json-schema","title":"InProgressSubscriptionOrder","data":{"title":"InProgressSubscriptionOrder","required":["action","amountSaved","deals","expiresAt","hasCustomer","id","payments","status","totalPrice","type","vouchers"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderType"}],"description":"Gets the type"},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderStatus"}],"description":"Gets the status"},"totalPrice":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total price to be displayed to the customer"},"vouchers":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucher"},"description":"Gets the list of order voucher entities"},"deals":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Deals.OrderDeal"},"description":"Gets the list of order deal entities"},"payments":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.ExternallyProcessed.OrderExternallyProcessedPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.CinemaProcessed.OrderCinemaProcessedPayment"}],"description":"Represents the base properties of a payment that has been added to an order base"},"description":"Gets the list of order payment base entities"},"subscription":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Subscriptions.OrderSubscription"}],"description":"Gets the subscription"},"action":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Subscriptions.SubscriptionOrderAction"}],"description":"Gets the subscription order action"},"expiresAt":{"type":"string","description":"Gets the date and time that the order is set to expire","format":"date-time"},"hasCustomer":{"type":"boolean","description":"Gets a value indicating whether the order customer has been set"},"amountSaved":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the monetary amount saved via discounted prices"}},"additionalProperties":false,"description":"Represents a subscription order in an order status InProgress state"}},"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressSubscriptionOrderDetails":{"id":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressSubscriptionOrderDetails","kind":"json-schema","title":"InProgressSubscriptionOrderDetails","data":{"title":"InProgressSubscriptionOrderDetails","required":["order","relatedData"],"type":"object","properties":{"order":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressSubscriptionOrder"}],"description":"Gets the in progress order base entity"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedData"}],"description":"Gets the related data for the in progress order base entity"}},"additionalProperties":false,"description":"Represents an in progress subscription order entity, and its related data"}},"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrder":{"id":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrder","kind":"json-schema","title":"InProgressTabOrder","data":{"title":"InProgressTabOrder","required":["accessCode","amountSaved","deals","expiresAt","hasCustomer","id","isOpen","itemDeliveries","items","location","patronCount","payments","siteId","spendingLimits","status","tips","totalPrice","totalTip","type"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Represents a tab order in an order status InProgress state"},"isOpen":{"type":"boolean","description":"Gets a value indicating whether the tab is open at Cinema for ordering items"},"accessCode":{"minLength":1,"type":"string","description":"Gets the access code","example":"7J9TN"},"patronCount":{"type":"integer","description":"Gets the number of patrons","format":"int32"},"location":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tabs.Locations.TabOrderDiningLocation"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tabs.Locations.TabOrderInSeatLocation"}],"description":"Represents the base properties of the location of a tab order"},"spendingLimits":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tabs.TabOrderSpendingLimits"}],"description":"Gets the spending limits"},"paymentCard":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderPaymentCard"}],"description":"Gets the payment card"},"member":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Members.OrderMember"}],"description":"Gets the member details"},"itemDeliveries":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemCounterPickup"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemCustomLocationDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDiningLocationDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemElectronicDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemInSeatDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemPostalDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemServiceAreaPickup"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemCounterPickup"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemCustomLocationDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemDiningLocationDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemElectronicDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemInSeatDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemPostalDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemServiceAreaPickup"}],"description":"Represents the base properties of the delivery of one or more order item line base entities"},"description":"Gets the list of order item delivery base entities for the tab order Items"},"siteId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the site"},"items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderItemLine"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderWeightBasedItemLine"}],"description":"Represents the base properties of a collectable order line for a top-level instance of an item base\r\nwithin a standard order or gift shop order"},"description":"Gets the list of order item line base entities"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderType"}],"description":"Gets the type"},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderStatus"}],"description":"Represents a tab order in an order status InProgress state"},"totalPrice":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Represents a tab order in an order status InProgress state"},"amountSaved":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Represents a tab order in an order status InProgress state"},"deals":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Deals.OrderDeal"},"description":"Represents a tab order in an order status InProgress state"},"payments":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.ExternallyProcessed.OrderExternallyProcessedPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPayment"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.CinemaProcessed.OrderCinemaProcessedPayment"}],"description":"Represents the base properties of a payment that has been added to an order base"},"description":"Represents a tab order in an order status InProgress state"},"expiresAt":{"type":"string","description":"Represents a tab order in an order status InProgress state","format":"date-time"},"hasCustomer":{"type":"boolean","description":"Represents a tab order in an order status InProgress state"},"tips":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tips.OrderTip"},"description":"Gets the list of order tip entities"},"totalTip":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total tip to be displayed to the customer"}},"additionalProperties":false,"description":"Represents a tab order in an order status InProgress state"}},"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails":{"id":"components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrderDetails","kind":"json-schema","title":"InProgressTabOrderDetails","data":{"title":"InProgressTabOrderDetails","required":["order","relatedData"],"type":"object","properties":{"order":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.InProgressOrders.InProgressTabOrder"}],"description":"Gets the in progress order base entity"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedData"}],"description":"Gets the related data for the in progress order base entity"}},"additionalProperties":false,"description":"Represents an in progress tab order entity, and its related data"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemCounterPickup":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemCounterPickup","kind":"json-schema","title":"CompletedOrderItemCounterPickup","data":{"title":"CompletedOrderItemCounterPickup","required":["id","method"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the delivery within the order base"},"fee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryFeeLine"}],"description":"Gets the delivery fee, if applicable"},"method":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"}],"description":"Gets the delivery method"}},"additionalProperties":false,"description":"Represents an order item counter pickup for a completed order base"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemCustomLocationDelivery":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemCustomLocationDelivery","kind":"json-schema","title":"CompletedOrderItemCustomLocationDelivery","data":{"title":"CompletedOrderItemCustomLocationDelivery","required":["id","locationName","method","preparation","schedule"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the delivery within the order base"},"fee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryFeeLine"}],"description":"Gets the delivery fee, if applicable"},"locationName":{"minLength":1,"type":"string"},"schedule":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleImmediate"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleOnRequest"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleShowtimeDeliveryWindow"}],"description":"Represents the base properties of a schedule that determines when an order item delivery base\r\nshould be delivered or ready for pickup"},"method":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"}]},"comment":{"type":"string","nullable":true},"preparation":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Preparations.CompletedOrderItemDeliveryPreparation"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Preparations.CompletedOrderItemInSeatDeliveryPreparation"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Preparations.CompletedOrderItemServiceAreaPickupPreparation"}],"description":"Represents the preparation details of a completed order item delivery base that requires preparation"}},"additionalProperties":false,"description":"Represents an order item custom location delivery for a completed order base"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemDiningLocationDelivery":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemDiningLocationDelivery","kind":"json-schema","title":"CompletedOrderItemDiningLocationDelivery","data":{"title":"CompletedOrderItemDiningLocationDelivery","required":["diningLocation","id","method","preparation","schedule"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the delivery within the order base"},"fee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryFeeLine"}],"description":"Gets the delivery fee, if applicable"},"diningLocation":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.DiningLocations.OrderDiningLocation"}]},"schedule":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleImmediate"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleOnRequest"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleShowtimeDeliveryWindow"}],"description":"Represents the base properties of a schedule that determines when an order item delivery base\r\nshould be delivered or ready for pickup"},"comment":{"type":"string","nullable":true},"method":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"}]},"preparation":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Preparations.CompletedOrderItemDeliveryPreparation"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Preparations.CompletedOrderItemInSeatDeliveryPreparation"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Preparations.CompletedOrderItemServiceAreaPickupPreparation"}],"description":"Represents the preparation details of a completed order item delivery base that requires preparation"}},"additionalProperties":false,"description":"Represents an order item dining location delivery for a completed order base"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemElectronicDelivery":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemElectronicDelivery","kind":"json-schema","title":"CompletedOrderItemElectronicDelivery","data":{"title":"CompletedOrderItemElectronicDelivery","required":["id","method"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the delivery within the order base"},"fee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryFeeLine"}],"description":"Gets the delivery fee, if applicable"},"method":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"}],"description":"Gets the delivery method"}},"additionalProperties":false,"description":"Represents an order item electronic delivery for a completed order base"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemInSeatDelivery":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemInSeatDelivery","kind":"json-schema","title":"CompletedOrderItemInSeatDelivery","data":{"title":"CompletedOrderItemInSeatDelivery","required":["id","method","preparation","schedule","seats","showtimeId"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the delivery within the order base"},"fee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryFeeLine"}],"description":"Gets the delivery fee, if applicable"},"showtimeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the showtime"},"seats":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Seats.OrderSeat"},"description":"Gets the list of order seat entities the items will be delivered to"},"schedule":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleImmediate"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleOnRequest"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleShowtimeDeliveryWindow"}],"description":"Represents the base properties of a schedule that determines when an order item delivery base\r\nshould be delivered or ready for pickup"},"method":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"}],"description":"Gets the delivery method"},"comment":{"type":"string","nullable":true},"preparation":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Preparations.CompletedOrderItemInSeatDeliveryPreparation"}],"description":"Gets the completed order item in seat delivery preparation entity"}},"additionalProperties":false,"description":"Represents an order item in seat delivery for a completed order base"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemPostalDelivery":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemPostalDelivery","kind":"json-schema","title":"CompletedOrderItemPostalDelivery","data":{"title":"CompletedOrderItemPostalDelivery","required":["deliveryFee","id","postalDeliveryMethodId"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the delivery within the order base"},"fee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryFeeLine"}],"description":"Gets the delivery fee, if applicable"},"method":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"}]},"postalDeliveryMethodId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item postal delivery method"},"deliveryFee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the delivery fee"}},"additionalProperties":false,"description":"Represents an order item delivery base for items that are delivered to a postal address"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemServiceAreaPickup":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemServiceAreaPickup","kind":"json-schema","title":"CompletedOrderItemServiceAreaPickup","data":{"title":"CompletedOrderItemServiceAreaPickup","required":["id","method","preparation","schedule","serviceAreaIds"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the delivery within the order base"},"fee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryFeeLine"}],"description":"Gets the delivery fee, if applicable"},"schedule":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleImmediate"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleOnRequest"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleShowtimeDeliveryWindow"}],"description":"Represents the base properties of a schedule that determines when an order item delivery base\r\nshould be delivered or ready for pickup"},"method":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"}],"description":"Gets the delivery method"},"comment":{"type":"string","description":"Gets the patron's comment, if applicable","nullable":true},"serviceAreaIds":{"type":"array","items":{"type":"string"},"description":"Gets the list of unique identifiers of the item service area entities"},"preparation":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Preparations.CompletedOrderItemServiceAreaPickupPreparation"}],"description":"Gets the completed order item service area pickup preparation entity"}},"additionalProperties":false,"description":"Represents an order item service area pickup for a completed order base"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.Preparations.CompletedOrderItemDeliveryPreparationStatus":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.Preparations.CompletedOrderItemDeliveryPreparationStatus","kind":"json-schema","title":"CompletedOrderItemDeliveryPreparationStatus","data":{"title":"CompletedOrderItemDeliveryPreparationStatus","enum":["OnHold","Requested","InProgress","Ready","Delivered","Cancelled"],"type":"string","description":"Represents the status of a completed order item delivery preparation"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemCustomLocationDeliveryCreate":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemCustomLocationDeliveryCreate","kind":"json-schema","title":"OrderItemCustomLocationDeliveryCreate","data":{"title":"OrderItemCustomLocationDeliveryCreate","required":["locationName","schedule"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemDeliveryCreateBase"}],"properties":{"locationName":{"minLength":1,"type":"string"},"schedule":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleImmediate"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleOnRequest"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleShowtimeDeliveryWindow"}],"description":"Represents the base properties of a schedule that determines when an order item delivery base\r\nshould be delivered or ready for pickup"},"comment":{"type":"string","nullable":true}},"additionalProperties":false,"description":"Represents the values needed to create an order item custom location delivery"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemDeliveryCreateBase":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemDeliveryCreateBase","kind":"json-schema","title":"OrderItemDeliveryCreateBase","data":{"title":"OrderItemDeliveryCreateBase","required":["id","method"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the delivery within the in progress order base"},"method":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"}],"description":"Gets the delivery method"}},"additionalProperties":false,"description":"Represents the base properties required to create an order item delivery base"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemDiningLocationDeliveryCreate":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemDiningLocationDeliveryCreate","kind":"json-schema","title":"OrderItemDiningLocationDeliveryCreate","data":{"title":"OrderItemDiningLocationDeliveryCreate","required":["diningLocationId","schedule"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemDeliveryCreateBase"}],"properties":{"diningLocationId":{"minLength":1,"type":"string"},"schedule":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleImmediate"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleOnRequest"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleShowtimeDeliveryWindow"}],"description":"Represents the base properties of a schedule that determines when an order item delivery base\r\nshould be delivered or ready for pickup"},"comment":{"type":"string","nullable":true}},"additionalProperties":false,"description":"Represents the values needed to create an order item dining location delivery"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemInSeatDeliveryCreate":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemInSeatDeliveryCreate","kind":"json-schema","title":"OrderItemInSeatDeliveryCreate","data":{"title":"OrderItemInSeatDeliveryCreate","required":["schedule","seatIds","showtimeId"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemDeliveryCreateBase"}],"properties":{"showtimeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the showtime"},"seatIds":{"type":"array","items":{"type":"string"},"description":"Gets the list of unique identifiers of the seat entities the items will be\r\ndelivered to"},"schedule":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleImmediate"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleOnRequest"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleShowtimeDeliveryWindow"}],"description":"Represents the base properties of a schedule that determines when an order item delivery base\r\nshould be delivered or ready for pickup"},"comment":{"type":"string","description":"Gets the patron's comment, if applicable","nullable":true}},"additionalProperties":false,"description":"Represents the values needed to create an order item in seat delivery"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemPostalDeliveryCreate":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemPostalDeliveryCreate","kind":"json-schema","title":"OrderItemPostalDeliveryCreate","data":{"title":"OrderItemPostalDeliveryCreate","required":["postalDeliveryMethodId"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemDeliveryCreateBase"}],"properties":{"postalDeliveryMethodId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item postal delivery method"}},"additionalProperties":false,"description":"Represents the values needed to create an order item postal delivery"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemServiceAreaPickupCreate":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemServiceAreaPickupCreate","kind":"json-schema","title":"OrderItemServiceAreaPickupCreate","data":{"title":"OrderItemServiceAreaPickupCreate","required":["schedule"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemDeliveryCreateBase"}],"properties":{"schedule":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleImmediate"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleOnRequest"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleShowtimeDeliveryWindow"}],"description":"Represents the base properties of a schedule that determines when an order item delivery base\r\nshould be delivered or ready for pickup"},"comment":{"type":"string","description":"Gets the patron's comment, if applicable","nullable":true}},"additionalProperties":false,"description":"Represents the values needed to create an order item service area pickup"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemCounterPickup":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemCounterPickup","kind":"json-schema","title":"OrderItemCounterPickup","data":{"title":"OrderItemCounterPickup","required":["method"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryBase"}],"properties":{"method":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"}],"description":"Gets the delivery method"}},"additionalProperties":false,"description":"Represents an order item delivery base for items that can be\r\npicked up by the patron from the counter at any time, as they do not require preparation"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemCustomLocationDelivery":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemCustomLocationDelivery","kind":"json-schema","title":"OrderItemCustomLocationDelivery","data":{"title":"OrderItemCustomLocationDelivery","required":["locationName","method","schedule"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryBase"}],"properties":{"locationName":{"minLength":1,"type":"string"},"schedule":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleImmediate"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleOnRequest"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleShowtimeDeliveryWindow"}],"description":"Represents the base properties of a schedule that determines when an order item delivery base\r\nshould be delivered or ready for pickup"},"method":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"}]},"comment":{"type":"string","nullable":true}},"additionalProperties":false,"description":"Represents an order item delivery base for items that are\r\ndelivered to the patron at a custom location, defined by the client"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryBase":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryBase","kind":"json-schema","title":"OrderItemDeliveryBase","data":{"title":"OrderItemDeliveryBase","required":["id","method"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the delivery within the order base"},"method":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"}],"description":"Gets the delivery method"},"fee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryFeeLine"}],"description":"Gets the delivery fee, if applicable"}},"additionalProperties":false,"description":"Represents the base properties of the delivery of one or more order item line base entities"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryFeeLine":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryFeeLine","kind":"json-schema","title":"OrderItemDeliveryFeeLine","data":{"title":"OrderItemDeliveryFeeLine","required":["amount","id","refundAvailability","refundStatus"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the line within the order base"},"amount":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the monetary amount to be displayed to the customer"},"refundStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Lines.OrderLineRefundStatus"}],"description":"Gets the refund status"},"refundAvailability":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Refunds.CompletedOrderLineRefundAvailability"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Refunds.CompletedWeightBasedOrderLineRefundAvailability"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Refunds.InProgressOrderLineRefundAvailability"}],"description":"Represents the refund availability of an order line"}},"additionalProperties":false,"description":"Represents a fee incurred by an order item delivery base"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDiningLocationDelivery":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDiningLocationDelivery","kind":"json-schema","title":"OrderItemDiningLocationDelivery","data":{"title":"OrderItemDiningLocationDelivery","required":["diningLocation","method","schedule"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryBase"}],"properties":{"diningLocation":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.DiningLocations.OrderDiningLocation"}]},"schedule":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleImmediate"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleOnRequest"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleShowtimeDeliveryWindow"}],"description":"Represents the base properties of a schedule that determines when an order item delivery base\r\nshould be delivered or ready for pickup"},"comment":{"type":"string","nullable":true},"method":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"}]}},"additionalProperties":false,"description":"Represents an order item delivery base for items that are\r\ndelivered to the patron at a dining location base"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemElectronicDelivery":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemElectronicDelivery","kind":"json-schema","title":"OrderItemElectronicDelivery","data":{"title":"OrderItemElectronicDelivery","required":["method"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryBase"}],"properties":{"method":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"}],"description":"Gets the delivery method"}},"additionalProperties":false,"description":"Represents an order item delivery base for items that are\r\ndelivered to the patron electronically"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemInSeatDelivery":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemInSeatDelivery","kind":"json-schema","title":"OrderItemInSeatDelivery","data":{"title":"OrderItemInSeatDelivery","required":["method","schedule","seats","showtimeId"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryBase"}],"properties":{"showtimeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the showtime"},"seats":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Seats.OrderSeat"},"description":"Gets the list of order seat entities the items will be delivered to"},"schedule":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleImmediate"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleOnRequest"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleShowtimeDeliveryWindow"}],"description":"Represents the base properties of a schedule that determines when an order item delivery base\r\nshould be delivered or ready for pickup"},"method":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"}],"description":"Gets the delivery method"},"comment":{"type":"string","nullable":true}},"additionalProperties":false,"description":"Represents an order item delivery base for items that are\r\ndelivered to the patron at one or more seat entities"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemPostalDelivery":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemPostalDelivery","kind":"json-schema","title":"OrderItemPostalDelivery","data":{"title":"OrderItemPostalDelivery","required":["deliveryFee","postalDeliveryMethodId"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryBase"}],"properties":{"method":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"}]},"postalDeliveryMethodId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item postal delivery method"},"deliveryFee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the delivery fee"}},"additionalProperties":false,"description":"Represents an order item delivery base for items that are delivered to a postal address"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemServiceAreaPickup":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemServiceAreaPickup","kind":"json-schema","title":"OrderItemServiceAreaPickup","data":{"title":"OrderItemServiceAreaPickup","required":["method","schedule"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.OrderItemDeliveryBase"}],"properties":{"schedule":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleImmediate"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleOnRequest"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleShowtimeDeliveryWindow"}],"description":"Represents the base properties of a schedule that determines when an order item delivery base\r\nshould be delivered or ready for pickup"},"method":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"}],"description":"Gets the delivery method"},"comment":{"type":"string","description":"Gets the patron's comment, if applicable","nullable":true}},"additionalProperties":false,"description":"Represents an order item delivery base for items that are\r\npicked up from the relevant item service area locations by the patron after preparation"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Preparations.CompletedOrderItemDeliveryPreparation":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Preparations.CompletedOrderItemDeliveryPreparation","kind":"json-schema","title":"CompletedOrderItemDeliveryPreparation","data":{"title":"CompletedOrderItemDeliveryPreparation","required":["status"],"type":"object","properties":{"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.Preparations.CompletedOrderItemDeliveryPreparationStatus"}],"description":"Gets the current status"}},"additionalProperties":false,"description":"Represents the preparation details of a completed order item delivery base that requires preparation"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Preparations.CompletedOrderItemInSeatDeliveryPreparation":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Preparations.CompletedOrderItemInSeatDeliveryPreparation","kind":"json-schema","title":"CompletedOrderItemInSeatDeliveryPreparation","data":{"title":"CompletedOrderItemInSeatDeliveryPreparation","required":["availableAt","status","unavailableAt"],"type":"object","properties":{"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.Preparations.CompletedOrderItemDeliveryPreparationStatus"}],"description":"Gets the current status"},"availableAt":{"type":"string","description":"Gets the earliest date and time that preparation is available, i.e. when item preparation can be started","format":"date-time"},"unavailableAt":{"type":"string","description":"Gets the date and time when in-seat item delivery is no longer available, i.e. when item preparation must be completed by","format":"date-time"}},"additionalProperties":false,"description":"Represents a completed order item delivery preparation for an order item in seat delivery"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Preparations.CompletedOrderItemServiceAreaPickupPreparation":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Preparations.CompletedOrderItemServiceAreaPickupPreparation","kind":"json-schema","title":"CompletedOrderItemServiceAreaPickupPreparation","data":{"title":"CompletedOrderItemServiceAreaPickupPreparation","required":["availableAt","status"],"type":"object","properties":{"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.Preparations.CompletedOrderItemDeliveryPreparationStatus"}],"description":"Gets the current status"},"pickupNumber":{"type":"integer","description":"Gets the pickup number, if applicable","format":"int32","nullable":true},"availableAt":{"type":"string","description":"Gets the earliest date and time that preparation is available, i.e. when item preparation can be started","format":"date-time"}},"additionalProperties":false,"description":"Represents a completed order item delivery preparation for an order item service area pickup"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleBase":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleBase","kind":"json-schema","title":"OrderItemDeliveryScheduleBase","data":{"title":"OrderItemDeliveryScheduleBase","required":["type"],"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleType"}],"description":"Gets the type"}},"additionalProperties":false,"description":"Represents the base properties of a schedule that determines when an order item delivery base\r\nshould be delivered or ready for pickup"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleImmediate":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleImmediate","kind":"json-schema","title":"OrderItemDeliveryScheduleImmediate","data":{"title":"OrderItemDeliveryScheduleImmediate","required":["type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleBase"}],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleType"}],"description":"Gets the type"}},"additionalProperties":false,"description":"Represents an order item delivery schedule base that should be sent for preparation immediately"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleOnRequest":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleOnRequest","kind":"json-schema","title":"OrderItemDeliveryScheduleOnRequest","data":{"title":"OrderItemDeliveryScheduleOnRequest","required":["type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleBase"}],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleType"}],"description":"Gets the type"}},"additionalProperties":false,"description":"Represents an order item delivery schedule base that should be sent for preparation upon the patron's request"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleShowtimeDeliveryWindow":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleShowtimeDeliveryWindow","kind":"json-schema","title":"OrderItemDeliveryScheduleShowtimeDeliveryWindow","data":{"title":"OrderItemDeliveryScheduleShowtimeDeliveryWindow","required":["showtimeDeliveryWindowId","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleBase"}],"properties":{"showtimeDeliveryWindowId":{"minLength":1,"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleType"}]}},"additionalProperties":false,"description":"Represents an order item delivery schedule base that uses an item showtime delivery window base\r\nto determine when it should be ready for delivery or pickup"}},"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleType":{"id":"components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleType","kind":"json-schema","title":"OrderItemDeliveryScheduleType","data":{"title":"OrderItemDeliveryScheduleType","enum":["Immediate","OnRequest","ShowtimeDeliveryWindow"],"type":"string","description":"Represents the type of an order item delivery schedule base"}},"components/schemas/Ocapi.V1.Orders.Items.OrderItemElementDelivery":{"id":"components/schemas/Ocapi.V1.Orders.Items.OrderItemElementDelivery","kind":"json-schema","title":"OrderItemElementDelivery","data":{"title":"OrderItemElementDelivery","required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier of the order item delivery base"},"seat":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Seats.OrderSeat"}],"description":"Gets the order seat the item will be delivered to, if applicable"},"comment":{"type":"string","description":"Gets the patron's comment, if applicable","nullable":true}},"additionalProperties":false,"description":"Represents the delivery details of a order item element base"}},"components/schemas/Ocapi.V1.Orders.Items.OrderItemLine":{"id":"components/schemas/Ocapi.V1.Orders.Items.OrderItemLine","kind":"json-schema","title":"OrderItemLine","data":{"title":"OrderItemLine","required":["components","delivery","deliveryId","items","modifierGroups"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderItemLineBase"}],"properties":{"modifierGroups":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderItemModifierGroup"},"description":"Gets the list of order item modifier group entities"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderPackageItemContentItem"},"description":"Gets the list of order package item content item base entities"},"components":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderRecipeItemNormalComponent"},"description":"Gets the components of the recipe item"},"delivery":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderItemElementDelivery"}],"description":"Gets the delivery details"},"deliveryId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the order item delivery base"},"comment":{"type":"string","description":"Gets the patron's comment, if applicable","nullable":true}},"additionalProperties":false,"description":"Represents the base properties of a collectable order line for a top-level instance of an item base\r\nwithin a standard order or gift shop order"}},"components/schemas/Ocapi.V1.Orders.Items.OrderItemModifier":{"id":"components/schemas/Ocapi.V1.Orders.Items.OrderItemModifier","kind":"json-schema","title":"OrderItemModifier","data":{"title":"OrderItemModifier","required":["amountSaved","itemId","price"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base"},"price":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the price to be displayed to the customer"},"amountSaved":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total amount saved on the item due to all discounts and deals"}},"additionalProperties":false,"description":"Represents an instance of an item modifier within an order item modifier group"}},"components/schemas/Ocapi.V1.Orders.Items.OrderItemModifierGroup":{"id":"components/schemas/Ocapi.V1.Orders.Items.OrderItemModifierGroup","kind":"json-schema","title":"OrderItemModifierGroup","data":{"title":"OrderItemModifierGroup","required":["itemModifierGroupId","modifiers"],"type":"object","properties":{"itemModifierGroupId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item modifier group","readOnly":true},"modifiers":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderItemModifier"},"description":"Gets the list of order item modifier entities"}},"additionalProperties":false,"description":"Represents the additions made to an order item line base for a particular item modifier group"}},"components/schemas/Ocapi.V1.Orders.Items.OrderPackageItemContentItem":{"id":"components/schemas/Ocapi.V1.Orders.Items.OrderPackageItemContentItem","kind":"json-schema","title":"OrderPackageItemContentItem","data":{"title":"OrderPackageItemContentItem","required":["amountSaved","components","delivery","deliveryId","itemId","modifierGroups","price","type"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType"}],"description":"Gets the item type"},"price":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the price to be displayed to the customer"},"amountSaved":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total amount saved on the item due to all discounts and deals"},"parentSalesItemId":{"type":"string","description":"Gets the unique identifier of the parent sales item this item is an option for","nullable":true},"modifierGroups":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderItemModifierGroup"},"description":"Gets the list of order item modifier group entities"},"components":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderRecipeItemNormalComponent"},"description":"Gets the components of the recipe item"},"delivery":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderItemElementDelivery"}],"description":"Gets the delivery details"},"deliveryId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the order item delivery base"},"comment":{"type":"string","description":"Gets the patron's comment, if applicable","nullable":true}},"additionalProperties":false,"description":"Represents the base properties of the customisation of a package item content item within an order package item line"}},"components/schemas/Ocapi.V1.Orders.Items.OrderRecipeItemNormalComponent":{"id":"components/schemas/Ocapi.V1.Orders.Items.OrderRecipeItemNormalComponent","kind":"json-schema","title":"OrderRecipeItemNormalComponent","data":{"title":"OrderRecipeItemNormalComponent","required":["amountSaved","itemId","modification","modifierGroups","price","type"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType"}],"description":"Gets the item type"},"price":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the price to be displayed to the customer"},"amountSaved":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total amount saved on the item due to all discounts and deals"},"modification":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Recipes.OrderRecipeItemComponentModification"}],"description":"Gets the modification"},"modifierGroups":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderItemModifierGroup"},"description":"Gets the list of order item modifier group entities"},"parentSalesItemId":{"type":"string","description":"Gets the unique identifier of the parent sales item this item is an option for","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Represents an order recipe item component base that is a normal item"}},"components/schemas/Ocapi.V1.Orders.Items.OrderWeightBasedItemLine":{"id":"components/schemas/Ocapi.V1.Orders.Items.OrderWeightBasedItemLine","kind":"json-schema","title":"OrderWeightBasedItemLine","data":{"title":"OrderWeightBasedItemLine","required":["delivery","deliveryId","unitAbbreviation","weight"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.OrderItemLineBase"}],"properties":{"weight":{"type":"number","format":"double"},"unitAbbreviation":{"minLength":1,"type":"string"},"delivery":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.OrderItemElementDelivery"}],"description":"Gets the delivery details"},"deliveryId":{"minLength":1,"type":"string"},"comment":{"type":"string","nullable":true}},"additionalProperties":false,"description":"Represents a order item line base for a weight based item"}},"components/schemas/Ocapi.V1.Orders.Items.Recipes.OrderRecipeItemComponentModification":{"id":"components/schemas/Ocapi.V1.Orders.Items.Recipes.OrderRecipeItemComponentModification","kind":"json-schema","title":"OrderRecipeItemComponentModification","data":{"title":"OrderRecipeItemComponentModification","enum":["None","Remove","Extra","OnTheSide","ExtraOnTheSide"],"type":"string","description":"Represents the modification of an order recipe item component base"}},"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemElementDeliveryRequest":{"id":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemElementDeliveryRequest","kind":"json-schema","title":"OrderItemElementDeliveryRequest","data":{"title":"OrderItemElementDeliveryRequest","type":"object","properties":{"id":{"type":"string","description":"Gets the unique identifier of the order item delivery create base, if applicable","nullable":true},"seatId":{"type":"string","description":"Gets the unique identifier of the single seat the item will be delivered to, if applicable","nullable":true},"comment":{"type":"string","description":"Gets the patron's comment that is sent to the kitchen, if applicable","nullable":true}},"additionalProperties":false,"description":"Represents the delivery details of a requested order item element base"}},"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemModifierGroupRequest":{"id":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemModifierGroupRequest","kind":"json-schema","title":"OrderItemModifierGroupRequest","data":{"title":"OrderItemModifierGroupRequest","required":["itemModifierGroupId","modifiers"],"type":"object","properties":{"itemModifierGroupId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item modifier group"},"modifiers":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemModifierRequest"},"description":"Gets the list of order item modifier request entities"}},"additionalProperties":false,"description":"Represents the details of a requested order item modifier group"}},"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemModifierRequest":{"id":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemModifierRequest","kind":"json-schema","title":"OrderItemModifierRequest","data":{"title":"OrderItemModifierRequest","required":["itemId"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base"}},"additionalProperties":false,"description":"Represents the details of a requested order item modifier"}},"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemRequest":{"id":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemRequest","kind":"json-schema","title":"OrderItemRequest","data":{"title":"OrderItemRequest","required":["itemId","type"],"type":"object","properties":{"id":{"type":"string","description":"Gets the identifier that can be used to uniquely identify the item within the order base","nullable":true},"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType"}],"description":"Gets the item type"},"rewardId":{"type":"integer","description":"Gets the unique identifier of the reward used, if applicable","format":"int32","nullable":true},"discountId":{"type":"string","description":"Gets the unique identifier of the discount used, if applicable","nullable":true},"delivery":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemElementDeliveryRequest"}],"description":"Gets the delivery details, if applicable"},"deliveryId":{"type":"string","description":"Gets the unique identifier of the order item delivery create base, if applicable","nullable":true},"comment":{"type":"string","description":"Gets the patron's comment that is sent to the kitchen, if applicable","nullable":true},"parentSalesItemId":{"type":"string","description":"Gets the unique identifier of the parent sales item this item is an option for","nullable":true},"modifierGroups":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemModifierGroupRequest"},"description":"Gets the list of order item modifier group request entities","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Requests.OrderPackageItemContentItemRequest"},"description":"Gets the list of order package item content item request base entities that require customisation","nullable":true},"components":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Requests.OrderRecipeItemNormalComponentRequest"},"description":"Gets the list of order recipe item component request base entities for the recipe item component entities that require customisation","nullable":true}},"additionalProperties":false,"description":"Represents the base properties of a requested order item line base"}},"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest":{"id":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemsRequest","kind":"json-schema","title":"OrderItemsRequest","data":{"title":"OrderItemsRequest","required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemRequest"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Requests.OrderWeightBasedItemRequest"}],"description":"Represents the base properties of a requested order item line base"},"description":"Gets the list of order item request base entities"},"itemDeliveries":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemCustomLocationDeliveryCreate"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemDiningLocationDeliveryCreate"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemInSeatDeliveryCreate"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemPostalDeliveryCreate"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Create.OrderItemServiceAreaPickupCreate"}],"description":"Represents the base properties required to create an order item delivery base"},"description":"Gets the list of order item delivery create base entities, if applicable","nullable":true},"itemDeliveriesComment":{"type":"string","description":"Gets the comment that applies to all order item delivery with comment entities (including any\r\ndefault deliveries)","nullable":true},"serviceAreaPickupSchedule":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleImmediate"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleOnRequest"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Schedules.OrderItemDeliveryScheduleShowtimeDeliveryWindow"}],"description":"Represents the base properties of a schedule that determines when an order item delivery base\r\nshould be delivered or ready for pickup"}},"additionalProperties":false,"description":"Represents a list of order item request base entities for an in progress standard order,\r\nin progress gift shop order or in progress tab order"}},"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderPackageItemContentItemRequest":{"id":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderPackageItemContentItemRequest","kind":"json-schema","title":"OrderPackageItemContentItemRequest","data":{"title":"OrderPackageItemContentItemRequest","required":["itemId","type"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType"}],"description":"Gets the item type"},"parentSalesItemId":{"type":"string","description":"Gets the unique identifier of the parent sales item this item is an option for","nullable":true},"modifierGroups":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemModifierGroupRequest"},"description":"Gets the list of order item modifier group request entities","nullable":true},"components":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Requests.OrderRecipeItemNormalComponentRequest"},"description":"Gets the list of order recipe item component request base entities for the recipe item component entities that require customisation","nullable":true},"delivery":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemElementDeliveryRequest"}],"description":"Gets the delivery details, if applicable"},"deliveryId":{"type":"string","description":"Gets the unique identifier of the order item delivery create base, if applicable","nullable":true},"comment":{"type":"string","description":"Gets the patron's comment that is sent to the kitchen, if applicable","nullable":true}},"additionalProperties":false,"description":"Represents the base properties of a requested order package item content item base"}},"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderRecipeItemNormalComponentRequest":{"id":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderRecipeItemNormalComponentRequest","kind":"json-schema","title":"OrderRecipeItemNormalComponentRequest","data":{"title":"OrderRecipeItemNormalComponentRequest","required":["itemId","type"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType"}],"description":"Gets the item type"},"parentSalesItemId":{"type":"string","description":"Gets the unique identifier of the parent sales item this item is an option for","nullable":true},"modifierGroups":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemModifierGroupRequest"},"description":"Gets the list of order item modifier group request entities","nullable":true},"modification":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Recipes.OrderRecipeItemComponentModification"}],"description":"Gets the modification, if applicable"}},"additionalProperties":false,"description":"Represents the details of a requested order recipe item normal component"}},"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderWeightBasedItemRequest":{"id":"components/schemas/Ocapi.V1.Orders.Items.Requests.OrderWeightBasedItemRequest","kind":"json-schema","title":"OrderWeightBasedItemRequest","data":{"title":"OrderWeightBasedItemRequest","required":["itemId","type","weight"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType"}]},"parentSalesItemId":{"type":"string","nullable":true},"id":{"type":"string","nullable":true},"rewardId":{"type":"integer","format":"int32","nullable":true},"discountId":{"type":"string","nullable":true},"delivery":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Requests.OrderItemElementDeliveryRequest"}]},"deliveryId":{"type":"string","nullable":true},"comment":{"type":"string","nullable":true},"weight":{"type":"number","format":"double"}},"additionalProperties":false,"description":"Represents the details of a requested order weight based item line"}},"components/schemas/Ocapi.V1.Orders.Lines.OrderLineCollectionStatus":{"id":"components/schemas/Ocapi.V1.Orders.Lines.OrderLineCollectionStatus","kind":"json-schema","title":"OrderLineCollectionStatus","data":{"title":"OrderLineCollectionStatus","enum":["NotCollected","Collected"],"type":"string","description":"Represents the collection status of a collectable order line"}},"components/schemas/Ocapi.V1.Orders.Lines.OrderLineRefundStatus":{"id":"components/schemas/Ocapi.V1.Orders.Lines.OrderLineRefundStatus","kind":"json-schema","title":"OrderLineRefundStatus","data":{"title":"OrderLineRefundStatus","enum":["NotRefunded","Refunded"],"type":"string","description":"Represents the refund status of an order line"}},"components/schemas/Ocapi.V1.Orders.Lines.OrderLineRefundUnavailableReason":{"id":"components/schemas/Ocapi.V1.Orders.Lines.OrderLineRefundUnavailableReason","kind":"json-schema","title":"OrderLineRefundUnavailableReason","data":{"title":"OrderLineRefundUnavailableReason","enum":["NotApplicable","NotEnabled","OrderNotCompleted","AlreadyCollected","AlreadyRefunded","ItemDeliveryPreparationStarted","ShowtimeRefundWindowEnded","VoucherRedeemed","RedeemableItemIssued","OrderExpired","WeightBasedItem"],"type":"string","description":"Represents the reasons that an order line cannot be refunded"}},"components/schemas/Ocapi.V1.Orders.Members.OrderMember":{"id":"components/schemas/Ocapi.V1.Orders.Members.OrderMember","kind":"json-schema","title":"OrderMember","data":{"title":"OrderMember","required":["hash","name"],"type":"object","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.PersonName"}]},"hash":{"minLength":1,"type":"string"}},"additionalProperties":false}},"components/schemas/Ocapi.V1.Orders.OrderItemLineBase":{"id":"components/schemas/Ocapi.V1.Orders.OrderItemLineBase","kind":"json-schema","title":"OrderItemLineBase","data":{"title":"OrderItemLineBase","required":["amountSaved","collectionStatus","id","itemId","price","refundAvailability","refundStatus","type"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string"},"id":{"minLength":1,"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType"}]},"price":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}]},"amountSaved":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}]},"parentSalesItemId":{"type":"string","nullable":true,"readOnly":true},"collectionStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Lines.OrderLineCollectionStatus"}]},"refundStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Lines.OrderLineRefundStatus"}]},"refundAvailability":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Refunds.CompletedOrderLineRefundAvailability"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Refunds.CompletedWeightBasedOrderLineRefundAvailability"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Refunds.InProgressOrderLineRefundAvailability"}],"description":"Represents the refund availability of an order line"},"rewardId":{"type":"integer","format":"int32","nullable":true},"discountId":{"type":"string","nullable":true,"readOnly":true},"dealId":{"type":"string","nullable":true}},"additionalProperties":false,"description":"Represents the base properties of a collectable order line for a top-level instance of an item base\r\nwithin a standard order or gift shop order"}},"components/schemas/Ocapi.V1.Orders.OrderStatus":{"id":"components/schemas/Ocapi.V1.Orders.OrderStatus","kind":"json-schema","title":"OrderStatus","data":{"title":"OrderStatus","enum":["InProgress","Completed"],"type":"string","description":"Represents the life-cycle stages of an order base"}},"components/schemas/Ocapi.V1.Orders.OrderType":{"id":"components/schemas/Ocapi.V1.Orders.OrderType","kind":"json-schema","title":"OrderType","data":{"title":"OrderType","enum":["Standard","GiftShop","Subscription","Tab"],"type":"string","description":"Represents the type of an order base"}},"components/schemas/Ocapi.V1.Orders.PaymentCards.OrderPaymentCardStatus":{"id":"components/schemas/Ocapi.V1.Orders.PaymentCards.OrderPaymentCardStatus","kind":"json-schema","title":"OrderPaymentCardStatus","data":{"title":"OrderPaymentCardStatus","enum":["Pending","Declined","Approved"],"type":"string","description":"Represents the status of an order payment card"}},"components/schemas/Ocapi.V1.Orders.Payments.CinemaProcessed.OrderCinemaProcessedPayment":{"id":"components/schemas/Ocapi.V1.Orders.Payments.CinemaProcessed.OrderCinemaProcessedPayment","kind":"json-schema","title":"OrderCinemaProcessedPayment","data":{"title":"OrderCinemaProcessedPayment","required":["id","status","type","value"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the payment within the order base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.OrderPaymentType"}],"description":"Gets the type"},"value":{"type":"number","description":"Gets the monetary value","format":"double"},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.OrderPaymentStatus"}],"description":"Gets the status"}},"additionalProperties":false,"description":"Represents a cinema processed payment that has been added to an order base"}},"components/schemas/Ocapi.V1.Orders.Payments.CinemaProcessed.OrderEmbeddedPaymentClientData":{"id":"components/schemas/Ocapi.V1.Orders.Payments.CinemaProcessed.OrderEmbeddedPaymentClientData","kind":"json-schema","title":"OrderEmbeddedPaymentClientData","data":{"title":"OrderEmbeddedPaymentClientData","required":["completePaymentUrl","connectorFunctionName","connectorParametersJson","connectorScriptUrls","isPaymentButtonIncluded","sdkScriptUrls"],"type":"object","properties":{"connectorParametersJson":{"minLength":1,"type":"string","description":"Gets the JSON blob of parameters required by the connector"},"completePaymentUrl":{"type":"string","description":"Gets the URL that needs to be called after the payment has been accepted","format":"uri"},"sdkScriptUrls":{"type":"array","items":{"type":"string"},"description":"Gets the list of SDK script URLs that need to be loaded"},"connectorScriptUrls":{"type":"array","items":{"type":"string"},"description":"Gets the list of connector script URLs that need to be loaded"},"connectorFunctionName":{"minLength":1,"type":"string","description":"Gets the name of the connector function that needs to be called"},"isPaymentButtonIncluded":{"type":"boolean","description":"Gets a value indicating whether or not the payment connector UI includes a payment button"}},"additionalProperties":false,"description":"Represents the details required to initialise the embedded payment UI to complete a created order embedded payment"}},"components/schemas/Ocapi.V1.Orders.Payments.Embedded.CreatedOrderEmbeddedPayment":{"id":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.CreatedOrderEmbeddedPayment","kind":"json-schema","title":"CreatedOrderEmbeddedPayment","data":{"title":"CreatedOrderEmbeddedPayment","required":["clientData","embeddedPayment","updatedOrderExpiresAt"],"type":"object","properties":{"embeddedPayment":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPayment"}],"description":"Gets the order embedded payment entity"},"clientData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.CinemaProcessed.OrderEmbeddedPaymentClientData"}],"description":"Gets the order embedded payment client data entity"},"updatedOrderExpiresAt":{"type":"string","description":"Gets the updated date and time that the in progress order base expires","format":"date-time"}},"additionalProperties":false,"description":"Represents an order embedded payment that has just been created,\r\nand the order embedded payment client data required to initialise the UI"}},"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPayment":{"id":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPayment","kind":"json-schema","title":"OrderEmbeddedPayment","data":{"title":"OrderEmbeddedPayment","required":["id","status","type","value"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the payment within the order base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.OrderPaymentType"}],"description":"Gets the type"},"value":{"type":"number","description":"Gets the monetary value","format":"double"},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.OrderPaymentStatus"}],"description":"Gets the status"}},"additionalProperties":false,"description":"Represents an embedded payment that has been added to an order base"}},"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPaymentCreate":{"id":"components/schemas/Ocapi.V1.Orders.Payments.Embedded.OrderEmbeddedPaymentCreate","kind":"json-schema","title":"OrderEmbeddedPaymentCreate","data":{"title":"OrderEmbeddedPaymentCreate","required":["webPaymentMethodId"],"type":"object","properties":{"webPaymentMethodId":{"type":"integer","description":"Gets the unique identifier of the web payment method","format":"int32"},"redirectReturnUrl":{"type":"string","description":"Gets the URL that the browser will be directed to after the embedded payment has finished, if the requested web payment\r\nmethod requires redirect","format":"uri","nullable":true},"languageTag":{"type":"string","description":"Gets the IETF (RFC 4646) language tag","nullable":true}},"additionalProperties":false,"description":"Represents the values required to create an order embedded payment"}},"components/schemas/Ocapi.V1.Orders.Payments.ExternallyProcessed.OrderExternallyProcessedPayment":{"id":"components/schemas/Ocapi.V1.Orders.Payments.ExternallyProcessed.OrderExternallyProcessedPayment","kind":"json-schema","title":"OrderExternallyProcessedPayment","data":{"title":"OrderExternallyProcessedPayment","required":["id","status","type","value"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the payment within the order base"},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.OrderPaymentStatus"}],"description":"Gets the status"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.OrderPaymentType"}],"description":"Gets the type"},"value":{"type":"number","description":"Gets the monetary value","format":"double"}},"additionalProperties":false,"description":"Represents an externally processed payment that has been added to an order base"}},"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPayment":{"id":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPayment","kind":"json-schema","title":"OrderGiftCardPayment","data":{"title":"OrderGiftCardPayment","required":["id","maskedCardNumber","status","type","value"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the payment within the order base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.OrderPaymentType"}],"description":"Gets the type"},"maskedCardNumber":{"minLength":1,"type":"string","description":"Gets a masked representation of the card number","example":"12.......6789"},"value":{"type":"number","description":"Gets the monetary value","format":"double"},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.OrderPaymentStatus"}],"description":"Gets the status"}},"additionalProperties":false,"description":"Represents a gift card payment that has been added to an order base"}},"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPaymentCreate":{"id":"components/schemas/Ocapi.V1.Orders.Payments.GiftCards.OrderGiftCardPaymentCreate","kind":"json-schema","title":"OrderGiftCardPaymentCreate","data":{"title":"OrderGiftCardPaymentCreate","required":["cardNumber"],"type":"object","properties":{"cardNumber":{"minLength":1,"type":"string","description":"Gets the card number"},"pin":{"type":"string","description":"Gets the PIN","nullable":true}},"additionalProperties":false,"description":"Represents the values required to create an order gift card payment"}},"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.Maximum.OrderMaximumMemberBalancePayment":{"id":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.Maximum.OrderMaximumMemberBalancePayment","kind":"json-schema","title":"OrderMaximumMemberBalancePayment","data":{"title":"OrderMaximumMemberBalancePayment","required":["availableUnits","balanceTypeId","maximumUnits","maximumValue"],"type":"object","properties":{"balanceTypeId":{"type":"integer","description":"Gets the unique identifier of the balance type","format":"int32"},"maximumValue":{"type":"number","description":"Gets the maximum eligible monetary value","format":"double"},"maximumUnits":{"type":"number","description":"Gets the maximum eligible value in balance type units","format":"double"},"availableUnits":{"type":"number","description":"Gets the total available member balance units, including those not eligible to be used as payment for the in progress order base","format":"double"}},"additionalProperties":false,"description":"Represents the maximum order member balance payment value for an in progress order base"}},"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.Maximum.OrderMaximumMemberBalancePaymentDetails":{"id":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.Maximum.OrderMaximumMemberBalancePaymentDetails","kind":"json-schema","title":"OrderMaximumMemberBalancePaymentDetails","data":{"title":"OrderMaximumMemberBalancePaymentDetails","required":["payment","relatedData"],"type":"object","properties":{"payment":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.Maximum.OrderMaximumMemberBalancePayment"}],"description":"Gets the order maximum member balance payment entity"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.Maximum.OrderMaximumMemberBalancePaymentRelatedData"}],"description":"Gets the related data for the order maximum member balance payment entity"}},"additionalProperties":false,"description":"Represents an order maximum member balance payment entity, and its related data"}},"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.Maximum.OrderMaximumMemberBalancePaymentRelatedData":{"id":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.Maximum.OrderMaximumMemberBalancePaymentRelatedData","kind":"json-schema","title":"OrderMaximumMemberBalancePaymentRelatedData","data":{"title":"OrderMaximumMemberBalancePaymentRelatedData","required":["balanceType"],"type":"object","properties":{"balanceType":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.BalanceTypes.BalanceType"}],"description":"Gets the related balance type entity"}},"additionalProperties":false,"description":"Related data for an order maximum member balance payment entity"}},"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePayment":{"id":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePayment","kind":"json-schema","title":"OrderMemberBalancePayment","data":{"title":"OrderMemberBalancePayment","required":["balanceTypeId","id","status","type","units","value"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the payment within the order base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.OrderPaymentType"}],"description":"Gets the type"},"value":{"type":"number","description":"Gets the monetary value","format":"double"},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.OrderPaymentStatus"}],"description":"Gets the status"},"balanceTypeId":{"type":"integer","description":"Gets the unique identifier of the balance type","format":"int32"},"units":{"type":"number","description":"Gets the value in balance type units","format":"double"}},"additionalProperties":false,"description":"Represents a member balance payment that has been added to an order base"}},"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePaymentUpdate":{"id":"components/schemas/Ocapi.V1.Orders.Payments.MemberBalance.OrderMemberBalancePaymentUpdate","kind":"json-schema","title":"OrderMemberBalancePaymentUpdate","data":{"title":"OrderMemberBalancePaymentUpdate","type":"object","properties":{"value":{"type":"number","description":"Gets the monetary value, if applicable","format":"double","nullable":true}},"additionalProperties":false,"description":"Represents the values required to update an order member balance payment"}},"components/schemas/Ocapi.V1.Orders.Payments.OrderPaymentStatus":{"id":"components/schemas/Ocapi.V1.Orders.Payments.OrderPaymentStatus","kind":"json-schema","title":"OrderPaymentStatus","data":{"title":"OrderPaymentStatus","enum":["NotStarted","Pending","Declined","Completed"],"type":"string","description":"Represents the status of an order payment base"}},"components/schemas/Ocapi.V1.Orders.Payments.OrderPaymentType":{"id":"components/schemas/Ocapi.V1.Orders.Payments.OrderPaymentType","kind":"json-schema","title":"OrderPaymentType","data":{"title":"OrderPaymentType","enum":["CinemaProcessed","Embedded","GiftCard","Redirect","MemberBalance","ExternallyProcessed","PaymentCard"],"type":"string","description":"Represents the type of an order payment base"}},"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardClientData":{"id":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardClientData","kind":"json-schema","title":"OrderEmbeddedPaymentCardClientData","data":{"title":"OrderEmbeddedPaymentCardClientData","required":["connectorFunctionName","connectorParametersJson","connectorScriptUrls","createCardTokenUrl","isButtonIncluded","sdkScriptUrls","webPaymentMethodId"],"type":"object","properties":{"webPaymentMethodId":{"type":"integer","description":"Gets the unique identifier of the web payment method","format":"int32"},"createCardTokenUrl":{"type":"string","description":"Gets the create card token URL","format":"uri"},"isButtonIncluded":{"type":"boolean","description":"Gets a value indicating whether the payment connector UI includes a submit button"},"connectorParametersJson":{"minLength":1,"type":"string","description":"Gets the JSON blob of parameters required by the connector"},"sdkScriptUrls":{"type":"array","items":{"type":"string"},"description":"Gets the list of SDK script URLs that need to be loaded"},"connectorScriptUrls":{"type":"array","items":{"type":"string"},"description":"Gets the list of connector script URLs that need to be loaded"},"connectorFunctionName":{"minLength":1,"type":"string","description":"Gets the name of the connector function that needs to be called"}},"additionalProperties":false,"description":"Represents the details required to initialise the embedded payment UI for creating an order payment card"}},"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate":{"id":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderEmbeddedPaymentCardCreate","kind":"json-schema","title":"OrderEmbeddedPaymentCardCreate","data":{"title":"OrderEmbeddedPaymentCardCreate","required":["webPaymentMethodId"],"type":"object","properties":{"webPaymentMethodId":{"type":"integer","description":"Gets the unique identifier of the web payment method","format":"int32"},"redirectReturnUrl":{"type":"string","description":"Gets the URL that the browser will be directed to after the embedded payment has finished, if the requested web payment\r\nmethod requires redirect","format":"uri","nullable":true},"languageTag":{"type":"string","description":"Gets the IETF (RFC 4646) language tag","nullable":true}},"additionalProperties":false,"description":"Represents the values needed to create an embedded order payment card"}},"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderPaymentCard":{"id":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.OrderPaymentCard","kind":"json-schema","title":"OrderPaymentCard","data":{"title":"OrderPaymentCard","required":["status"],"type":"object","properties":{"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.PaymentCards.OrderPaymentCardStatus"}]},"cardDetails":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.PaymentCardDetails"}]}},"additionalProperties":false,"description":"Represents a payment card assigned to an in progress tab order"}},"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.PaymentCardDetails":{"id":"components/schemas/Ocapi.V1.Orders.Payments.PaymentCard.PaymentCardDetails","kind":"json-schema","title":"PaymentCardDetails","data":{"title":"PaymentCardDetails","required":["maskedCardNumber"],"type":"object","properties":{"maskedCardNumber":{"minLength":1,"type":"string","description":"Gets the masked card number","example":"411111......1111"},"type":{"type":"string","description":"Gets the card type","nullable":true,"example":"VISA"},"expiryMonth":{"type":"integer","description":"Gets the card expiry month","format":"int32","nullable":true,"example":1},"expiryYear":{"type":"integer","description":"Gets the card expiry year","format":"int32","nullable":true,"example":27}},"additionalProperties":false,"description":"Represents the details of a credit, debit, or eftpos card used for a payment"}},"components/schemas/Ocapi.V1.Orders.Payments.Redirect.CreatedOrderRedirectPayment":{"id":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.CreatedOrderRedirectPayment","kind":"json-schema","title":"CreatedOrderRedirectPayment","data":{"title":"CreatedOrderRedirectPayment","required":["redirectPayment","redirectUrl","updatedOrderExpiresAt"],"type":"object","properties":{"redirectPayment":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPayment"}],"description":"Gets the order redirect payment entity"},"redirectUrl":{"type":"string","description":"Gets the URL of the payment page","format":"uri"},"updatedOrderExpiresAt":{"type":"string","description":"Gets the updated date and time that the in progress order base expires","format":"date-time"}},"additionalProperties":false,"description":"Represents an order redirect payment that has just been created, and the created order redirect payment RedirectUrl to the payment page"}},"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPayment":{"id":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPayment","kind":"json-schema","title":"OrderRedirectPayment","data":{"title":"OrderRedirectPayment","required":["id","status","type","value"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the payment within the order base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.OrderPaymentType"}],"description":"Gets the type"},"value":{"type":"number","description":"Gets the monetary value","format":"double"},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Payments.OrderPaymentStatus"}],"description":"Gets the status"}},"additionalProperties":false,"description":"Represents a redirect payment that has been added to an order base"}},"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPaymentCreate":{"id":"components/schemas/Ocapi.V1.Orders.Payments.Redirect.OrderRedirectPaymentCreate","kind":"json-schema","title":"OrderRedirectPaymentCreate","data":{"title":"OrderRedirectPaymentCreate","required":["redirectReturnUrl","webPaymentMethodId"],"type":"object","properties":{"webPaymentMethodId":{"type":"integer","description":"Gets the unique identifier of the web payment method","format":"int32"},"redirectReturnUrl":{"type":"string","description":"Gets the URL that the browser will be directed to after the after successful or cancelled payment","format":"uri"},"languageTag":{"type":"string","description":"Gets the IETF (RFC 4646) language tag","nullable":true}},"additionalProperties":false,"description":"Represents the values required to create an order redirect payment"}},"components/schemas/Ocapi.V1.Orders.Preparations.OrderPreparation":{"id":"components/schemas/Ocapi.V1.Orders.Preparations.OrderPreparation","kind":"json-schema","title":"OrderPreparation","data":{"title":"OrderPreparation","required":["status"],"type":"object","properties":{"collectionNumber":{"type":"integer","description":"Gets the number generated by the site that can be used to collect the completed standard order when the order preparation Status\r\nequals order preparation status Completed","format":"int32","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Preparations.OrderPreparationStatus"}],"description":"Gets the current status"}},"additionalProperties":false,"description":"Represents the preparation and collection details of a completed standard order"}},"components/schemas/Ocapi.V1.Orders.Preparations.OrderPreparationStatus":{"id":"components/schemas/Ocapi.V1.Orders.Preparations.OrderPreparationStatus","kind":"json-schema","title":"OrderPreparationStatus","data":{"title":"OrderPreparationStatus","enum":["NotStarted","Started","Completed","Collected","Cancelled"],"type":"string","description":"Represents the status of an order preparation"}},"components/schemas/Ocapi.V1.Orders.Refunds.CompletedOrderLineRefundAvailability":{"id":"components/schemas/Ocapi.V1.Orders.Refunds.CompletedOrderLineRefundAvailability","kind":"json-schema","title":"CompletedOrderLineRefundAvailability","data":{"title":"CompletedOrderLineRefundAvailability","required":["isAvailable","unavailableReason"],"type":"object","properties":{"isAvailable":{"type":"boolean","description":"Gets a value indicating whether the order line can be refunded","readOnly":true},"unavailableReason":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Lines.OrderLineRefundUnavailableReason"}],"description":"Gets the reason the order line cannot be refunded"}},"additionalProperties":false,"description":"Represents the refund availability of an order line"}},"components/schemas/Ocapi.V1.Orders.Refunds.CompletedWeightBasedOrderLineRefundAvailability":{"id":"components/schemas/Ocapi.V1.Orders.Refunds.CompletedWeightBasedOrderLineRefundAvailability","kind":"json-schema","title":"CompletedWeightBasedOrderLineRefundAvailability","data":{"title":"CompletedWeightBasedOrderLineRefundAvailability","required":["isAvailable","unavailableReason"],"type":"object","properties":{"isAvailable":{"type":"boolean","readOnly":true},"unavailableReason":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Lines.OrderLineRefundUnavailableReason"}]}},"additionalProperties":false,"description":"Represents the refund availability of an order line"}},"components/schemas/Ocapi.V1.Orders.Refunds.InProgressOrderLineRefundAvailability":{"id":"components/schemas/Ocapi.V1.Orders.Refunds.InProgressOrderLineRefundAvailability","kind":"json-schema","title":"InProgressOrderLineRefundAvailability","data":{"title":"InProgressOrderLineRefundAvailability","required":["isAvailable","unavailableReason"],"type":"object","properties":{"isAvailable":{"type":"boolean","description":"Gets a value indicating whether the order line can be refunded","readOnly":true},"unavailableReason":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Lines.OrderLineRefundUnavailableReason"}],"description":"Gets the reason the order line cannot be refunded"}},"additionalProperties":false,"description":"Represents the refund availability of an order line"}},"components/schemas/Ocapi.V1.Orders.Refunds.OrderRefundAvailability":{"id":"components/schemas/Ocapi.V1.Orders.Refunds.OrderRefundAvailability","kind":"json-schema","title":"OrderRefundAvailability","data":{"title":"OrderRefundAvailability","required":["availableMethods","isAvailable","isBookingFeeRefundable","unavailableReason"],"type":"object","properties":{"isAvailable":{"type":"boolean","description":"Gets a value indicating whether the refundable completed order base can be refunded","readOnly":true},"unavailableReason":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Refunds.OrderRefundUnavailableReason"}],"description":"Gets the reason the refundable completed order base cannot be refunded"},"availableMethods":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Refunds.OrderRefundMethod"},"description":"Gets the list of available refund methods"},"isBookingFeeRefundable":{"type":"boolean","description":"Gets a value indicating whether the booking fee can be refunded"}},"additionalProperties":false,"description":"Represents the refund availability of a refundable completed order base"}},"components/schemas/Ocapi.V1.Orders.Refunds.OrderRefundMethod":{"id":"components/schemas/Ocapi.V1.Orders.Refunds.OrderRefundMethod","kind":"json-schema","title":"OrderRefundMethod","data":{"title":"OrderRefundMethod","enum":["Full","Partial"],"type":"string","description":"Represents the methods that can be used to refund a refundable completed order base"}},"components/schemas/Ocapi.V1.Orders.Refunds.OrderRefundUnavailableReason":{"id":"components/schemas/Ocapi.V1.Orders.Refunds.OrderRefundUnavailableReason","kind":"json-schema","title":"OrderRefundUnavailableReason","data":{"title":"OrderRefundUnavailableReason","enum":["NotApplicable","NotEnabled","AlreadyRefunded","UnsupportedPaymentMethod","NoRefundableOrderLines","UnpaidBooking","OrderExpired","ActiveChildOrders"],"type":"string","description":"Represents the reasons that a refundable completed order base cannot be refunded"}},"components/schemas/Ocapi.V1.Orders.Refunds.Requests.OrderFullRefundCreate":{"id":"components/schemas/Ocapi.V1.Orders.Refunds.Requests.OrderFullRefundCreate","kind":"json-schema","title":"OrderFullRefundCreate","data":{"title":"OrderFullRefundCreate","type":"object","properties":{"reason":{"type":"string","description":"Gets the reason for the refund","nullable":true}},"additionalProperties":false,"description":"Represents the properties required to create a full refund for a refundable completed order base"}},"components/schemas/Ocapi.V1.Orders.RelatedData.OrderListRelatedData":{"id":"components/schemas/Ocapi.V1.Orders.RelatedData.OrderListRelatedData","kind":"json-schema","title":"OrderListRelatedData","data":{"title":"OrderListRelatedData","required":["areaCategories","balanceTypes","censorRatings","films","items","itemServiceAreas","itemShowtimeDeliveryWindows","screens","showtimes","sites","subscriptionBillingOptions","subscriptions","ticketTypes"],"type":"object","properties":{"films":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedFilm"}},"ticketTypes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedTicketType"}},"items":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedItem"}},"itemServiceAreas":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemServiceArea"}},"itemShowtimeDeliveryWindows":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ShowtimeDeliveryWindows.ItemShowtimeDeliveryWindowMinutesFromStart"}},"showtimes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedShowtime"}},"sites":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.Site"}],"description":"Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities"}},"screens":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Screens.Screen"}},"censorRatings":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CensorRatings.CensorRating"}},"areaCategories":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.AreaCategory"}},"subscriptionBillingOptions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedSubscriptionBillingOption"}},"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedSubscription"}},"balanceTypes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.BalanceTypes.BalanceType"}}},"additionalProperties":false,"description":"Related data for a list of order base entities"}},"components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedData":{"id":"components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedData","kind":"json-schema","title":"OrderRelatedData","data":{"title":"OrderRelatedData","required":["areaCategories","censorRatings","films","itemPostalDeliveryMethods","items","itemServiceAreas","itemShowtimeDeliveryWindows","screens","showtimes","sites","ticketTypes"],"type":"object","properties":{"films":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedFilm"},"description":"Gets the list of related order related film entities"},"ticketTypes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedTicketType"},"description":"Gets the list of related order related ticket type entities"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedItem"},"description":"Gets the list of related order related item entities"},"showtimes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedShowtime"},"description":"Gets the list of related order related showtime entities"},"sites":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.Site"}],"description":"Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities"},"description":"Gets the list of related site entities"},"screens":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Screens.Screen"},"description":"Gets the list of related screen entities"},"censorRatings":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CensorRatings.CensorRating"},"description":"Gets the list of related censor rating entities"},"itemServiceAreas":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemServiceArea"},"description":"Gets the list of related item service area entities"},"itemShowtimeDeliveryWindows":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ShowtimeDeliveryWindows.ItemShowtimeDeliveryWindowMinutesFromStart"},"description":"Gets the list of related item showtime delivery window base entities"},"subscriptionBillingOption":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedSubscriptionBillingOption"}],"description":"Gets the related order related subscription billing option entity"},"subscription":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedSubscription"}],"description":"Gets the related order related subscription entity"},"balanceType":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.BalanceTypes.BalanceType"}],"description":"Gets the related balance type entity, if applicable"},"areaCategories":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.AreaCategory"},"description":"Gets the list of related area category entities"},"itemPostalDeliveryMethods":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedItemPostalDeliveryMethod"},"description":"Gets the list of related order related item postal delivery method entities"}},"additionalProperties":false,"description":"Related data for an order base entity"}},"components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedFilm":{"id":"components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedFilm","kind":"json-schema","title":"OrderRelatedFilm","data":{"title":"OrderRelatedFilm","required":["externalIds","id","title"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"title":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}]},"externalIds":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmExternalIds"}]},"censorRatingId":{"type":"string","nullable":true},"censorRatingNote":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}]}},"additionalProperties":false,"description":"Represents the film data related to an order base"}},"components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedItem":{"id":"components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedItem","kind":"json-schema","title":"OrderRelatedItem","data":{"title":"OrderRelatedItem","required":["hoCode","id","name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier","readOnly":true},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"hoCode":{"minLength":1,"type":"string","description":"Gets the Head Office code"},"hopk":{"type":"string","description":"Gets the Head Office primary key","nullable":true},"isSundry":{"type":"boolean","description":"Gets a value indicating whether this is a sundry item"},"isPreparationRequired":{"type":"boolean","description":"Gets a value indicating whether the item requires preparation"}},"additionalProperties":false,"description":"Represents the item base data related to an order base"}},"components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedItemPostalDeliveryMethod":{"id":"components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedItemPostalDeliveryMethod","kind":"json-schema","title":"OrderRelatedItemPostalDeliveryMethod","data":{"title":"OrderRelatedItemPostalDeliveryMethod","required":["id","isDefault","name"],"type":"object","properties":{"isDefault":{"type":"boolean","description":"Gets a value indicating whether this is the default delivery method"},"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"}},"additionalProperties":false,"description":"Represents the item postal delivery method data related to an order base"}},"components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedShowtime":{"id":"components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedShowtime","kind":"json-schema","title":"OrderRelatedShowtime","data":{"title":"OrderRelatedShowtime","required":["filmId","id","schedule","screenId","siteId"],"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true},"schedule":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeSchedule"}]},"filmId":{"minLength":1,"type":"string"},"siteId":{"minLength":1,"type":"string"},"screenId":{"minLength":1,"type":"string","readOnly":true}},"additionalProperties":false,"description":"Represents the showtime data related to an order base"}},"components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedSubscription":{"id":"components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedSubscription","kind":"json-schema","title":"OrderRelatedSubscription","data":{"title":"OrderRelatedSubscription","required":["id","name"],"type":"object","properties":{"id":{"type":"integer","description":"Gets the unique identifier","format":"int32"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"}},"additionalProperties":false,"description":"Represents the subscription data related to a subscription order"}},"components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedSubscriptionBillingOption":{"id":"components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedSubscriptionBillingOption","kind":"json-schema","title":"OrderRelatedSubscriptionBillingOption","data":{"title":"OrderRelatedSubscriptionBillingOption","required":["billingPeriodInMonths","id","isRecurring","name","subscriptionId"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations."},"subscriptionId":{"type":"integer","format":"int32"},"billingPeriodInMonths":{"type":"integer","format":"int32"},"isRecurring":{"type":"boolean"}},"additionalProperties":false}},"components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedTicketType":{"id":"components/schemas/Ocapi.V1.Orders.RelatedData.OrderRelatedTicketType","kind":"json-schema","title":"OrderRelatedTicketType","data":{"title":"OrderRelatedTicketType","required":["description","id","longDescription"],"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true},"description":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}]},"longDescription":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}]}},"additionalProperties":false,"description":"Represents the ticket type base data related to an order base"}},"components/schemas/Ocapi.V1.Orders.Requests.StandardOrderAsBookingCreate":{"id":"components/schemas/Ocapi.V1.Orders.Requests.StandardOrderAsBookingCreate","kind":"json-schema","title":"StandardOrderAsBookingCreate","data":{"title":"StandardOrderAsBookingCreate","required":["bookingMode","siteId"],"type":"object","properties":{"siteId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the site"},"bookingMode":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Bookings.OrderBookingMode"}],"description":"Gets the booking mode"},"siteOrderLocationId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets the unique identifier of the site order location, if applicable."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"remarks","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If null, items will be ordered from the default site item profile"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]}]}]}],"nullable":true}},"additionalProperties":false,"description":"Represents the details required to create a standard order as an order booking base"}},"components/schemas/Ocapi.V1.Orders.Requests.SubscriptionOrderCreate":{"id":"components/schemas/Ocapi.V1.Orders.Requests.SubscriptionOrderCreate","kind":"json-schema","title":"SubscriptionOrderCreate","data":{"title":"SubscriptionOrderCreate","required":["action"],"type":"object","properties":{"action":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Subscriptions.SubscriptionOrderAction"}],"description":"Gets the subscription order action"}},"additionalProperties":false,"description":"Represents the details of a subscription order to be created"}},"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate":{"id":"components/schemas/Ocapi.V1.Orders.Requests.TabOrderCreate","kind":"json-schema","title":"TabOrderCreate","data":{"title":"TabOrderCreate","required":["location","patronCount","siteId"],"type":"object","properties":{"siteId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the site"},"location":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tabs.Locations.Requests.TabOrderDiningLocationCreate"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tabs.Locations.Requests.TabOrderInSeatLocationCreate"}],"description":"Represents the base properties required to create a tab order location base"},"patronCount":{"type":"integer","description":"Gets the number of patrons","format":"int32"}},"additionalProperties":false,"description":"Represents the details of a tab order to be created"}},"components/schemas/Ocapi.V1.Orders.Seats.OrderSeat":{"id":"components/schemas/Ocapi.V1.Orders.Seats.OrderSeat","kind":"json-schema","title":"OrderSeat","data":{"title":"OrderSeat","required":["areaCategoryId","areaName","position","rowLabel","seatId"],"type":"object","properties":{"seatId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the seat"},"seatLabel":{"type":"string","description":"Gets the label/physical name of the seat","nullable":true,"example":"5"},"rowLabel":{"minLength":1,"type":"string","description":"Gets the label/physical name of the row"},"areaName":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the area name text, and its translations"},"areaCategoryId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the area category the seat belongs to"},"position":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.SeatPosition"}],"description":"Gets the seat position"}},"additionalProperties":false,"description":"Represents the details of a seat in the context of an order base"}},"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtime":{"id":"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtime","kind":"json-schema","title":"OrderShowtime","data":{"title":"OrderShowtime","required":["seats","seatSwapStatus","showtimeId","tickets"],"type":"object","properties":{"showtimeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the showtime","readOnly":true},"tickets":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tickets.Package.OrderPackageTicketLine"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tickets.Normal.OrderNormalTicketLine"}],"description":"Represents the base properties of a collectable order line for an instance of a ticket type base within an order showtime"},"description":"Gets the list of order ticket line base entities"},"seats":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Seats.OrderSeat"},"description":"Gets the list of order seat entities"},"seatSwapStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatSwapStatus"}],"description":"Gets the seat swap status"}},"additionalProperties":false,"description":"Represents the selected tickets and/or seats for a showtime within a standard order"}},"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatSwapStatus":{"id":"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatSwapStatus","kind":"json-schema","title":"OrderShowtimeSeatSwapStatus","data":{"title":"OrderShowtimeSeatSwapStatus","required":["isAvailable","unavailableReason"],"type":"object","properties":{"isAvailable":{"type":"boolean","description":"Gets a value indicating whether the order showtime Seats can be swapped"},"unavailableReason":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatSwapUnavailableReason"}],"description":"Gets the reason the seats cannot be swapped"}},"additionalProperties":false,"description":"Represents the status of the seat swap availability for an order showtime"}},"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatSwapUnavailableReason":{"id":"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatSwapUnavailableReason","kind":"json-schema","title":"OrderShowtimeSeatSwapUnavailableReason","data":{"title":"OrderShowtimeSeatSwapUnavailableReason","enum":["NotApplicable","NotEnabled","UnallocatedSeating","NoSeats","PackageTickets","InSeatDeliveryItems","OrderNotCompleted","OrderRefunded","UnpaidBooking","ShowtimeEnded"],"type":"string","description":"Represents the reasons that seat swaps may be unavailable for an order showtime"}},"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeats":{"id":"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeats","kind":"json-schema","title":"OrderShowtimeSeats","data":{"title":"OrderShowtimeSeats","required":["seats","showtimeId"],"type":"object","properties":{"showtimeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the showtime"},"seats":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Seats.OrderSeat"},"description":"Gets the list of order seat entities"}},"additionalProperties":false,"description":"Represents a list of order seat entities belonging to an order"}},"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatsDetails":{"id":"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatsDetails","kind":"json-schema","title":"OrderShowtimeSeatsDetails","data":{"title":"OrderShowtimeSeatsDetails","required":["relatedData","showtimeSeats"],"type":"object","properties":{"showtimeSeats":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeats"},"description":"Gets the list of order showtime seats entities"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatsRelatedData"}],"description":"Gets the related data for the order showtime seats"}},"additionalProperties":false,"description":"Represents a list of order showtime seats entities, and their related data"}},"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatsRelatedData":{"id":"components/schemas/Ocapi.V1.Orders.Showtimes.OrderShowtimeSeatsRelatedData","kind":"json-schema","title":"OrderShowtimeSeatsRelatedData","data":{"title":"OrderShowtimeSeatsRelatedData","required":["areaCategories","attributes","castAndCrew","censorRatings","events","filmAdvanceBookingRules","films","genres","screens","showtimes","sites"],"type":"object","properties":{"showtimes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.Showtime"},"description":"Gets the list of related showtime entities"},"areaCategories":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.AreaCategory"},"description":"Gets the list of related area category entities"},"films":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.Film"},"description":"Gets the list of related film entities"},"castAndCrew":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CastAndCrewMembers.CastAndCrewMember"},"description":"Gets the list of related cast and crew member entities"},"censorRatings":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.CensorRatings.CensorRating"},"description":"Gets the related censor rating entities"},"sites":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.Site"}],"description":"Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities"},"description":"Gets the related site entities"},"screens":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Screens.Screen"},"description":"Gets the related screen entities"},"genres":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Genres.Genre"},"description":"Gets the list of related genre entities"},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Attributes.Attribute"},"description":"Gets the list of related attribute entities"},"filmAdvanceBookingRules":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.FilmAdvanceBookings.FilmAdvanceBookingRule"},"description":"Gets the related film advance booking rule entities"},"events":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Events.Event"},"description":"Gets the related event entities"}},"additionalProperties":false,"description":"Related data for an order showtime seats entity"}},"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeRequest":{"id":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeRequest","kind":"json-schema","title":"OrderShowtimeRequest","data":{"title":"OrderShowtimeRequest","type":"object","properties":{"tickets":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tickets.Requests.OrderTicketRequest"},"description":"Gets the list of order ticket request entities","nullable":true},"seats":{"type":"array","items":{"type":"string"},"description":"Gets the list of unique identifiers of the requested seat entities","nullable":true}},"additionalProperties":false,"description":"Represents the requested tickets and/or seats for an order showtime"}},"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeSeatSwapRequest":{"id":"components/schemas/Ocapi.V1.Orders.Showtimes.Requests.OrderShowtimeSeatSwapRequest","kind":"json-schema","title":"OrderShowtimeSeatSwapRequest","data":{"title":"OrderShowtimeSeatSwapRequest","required":["seats"],"type":"object","properties":{"seats":{"type":"array","items":{"type":"string"},"description":"Gets the list of unique identifiers of the requested seat entities"}},"additionalProperties":false,"description":"Represents the requested replacement seat entities for an order showtime within a standard order"}},"components/schemas/Ocapi.V1.Orders.Subscriptions.OrderSubscription":{"id":"components/schemas/Ocapi.V1.Orders.Subscriptions.OrderSubscription","kind":"json-schema","title":"OrderSubscription","data":{"title":"OrderSubscription","required":["price","subscriptionBillingOptionId","subscriptionId"],"type":"object","properties":{"subscriptionBillingOptionId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the subscription billing option"},"price":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the price to be displayed to the customer"},"subscriptionId":{"type":"integer","description":"Gets the unique identifier of the subscription","format":"int32"},"discountId":{"type":"string","description":"Gets the unique identifier of the discount used, if applicable","nullable":true,"readOnly":true},"voucherId":{"type":"string","description":"Gets the unique identifier of the order voucher used, if applicable","nullable":true}},"additionalProperties":false,"description":"Represents the selected subscription billing option within a subscription order"}},"components/schemas/Ocapi.V1.Orders.Subscriptions.Requests.OrderSubscriptionRequest":{"id":"components/schemas/Ocapi.V1.Orders.Subscriptions.Requests.OrderSubscriptionRequest","kind":"json-schema","title":"OrderSubscriptionRequest","data":{"title":"OrderSubscriptionRequest","required":["subscriptionBillingOptionId"],"type":"object","properties":{"subscriptionBillingOptionId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the subscription billing option"},"discountId":{"type":"string","description":"Gets the unique identifier of the discount used, if applicable","nullable":true},"voucherId":{"type":"string","description":"Gets the unique identifier of the order voucher used, if applicable","nullable":true}},"additionalProperties":false,"description":"Represents the details of a subscription billing option entity requested for an in progress subscription order"}},"components/schemas/Ocapi.V1.Orders.Subscriptions.SubscriptionOrderAction":{"id":"components/schemas/Ocapi.V1.Orders.Subscriptions.SubscriptionOrderAction","kind":"json-schema","title":"SubscriptionOrderAction","data":{"title":"SubscriptionOrderAction","enum":["Purchase","Reactivate"],"type":"string","description":"Represents the action that will be performed during a subscription order"}},"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.DiningLocationTabAvailability":{"id":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.DiningLocationTabAvailability","kind":"json-schema","title":"DiningLocationTabAvailability","data":{"title":"DiningLocationTabAvailability","type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.TabLocationAvailabilityBase"}],"additionalProperties":false}},"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.InSeatLocationTabAvailability":{"id":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.InSeatLocationTabAvailability","kind":"json-schema","title":"InSeatLocationTabAvailability","data":{"title":"InSeatLocationTabAvailability","required":["completedOrderSeats"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.TabLocationAvailabilityBase"}],"properties":{"completedOrderSeats":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Seats.OrderSeat"}}},"additionalProperties":false}},"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.TabLocationAvailabilityBase":{"id":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.TabLocationAvailabilityBase","kind":"json-schema","title":"TabLocationAvailabilityBase","data":{"title":"TabLocationAvailabilityBase","required":["status","type"],"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tabs.Locations.TabOrderLocationType"}]},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.TabLocationAvailabilityStatus"}]},"inProgressTabOrder":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.TabLocationAvailabilityInProgressTabOrder"}]}},"additionalProperties":false}},"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.TabLocationAvailabilityInProgressTabOrder":{"id":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.TabLocationAvailabilityInProgressTabOrder","kind":"json-schema","title":"TabLocationAvailabilityInProgressTabOrder","data":{"title":"TabLocationAvailabilityInProgressTabOrder","type":"object","properties":{"member":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.TabLocationAvailabilityInProgressTabOrderMember"}]},"id":{"type":"string","nullable":true}},"additionalProperties":false,"description":"Represents an in progress tab order for a tab location availability base"}},"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.TabLocationAvailabilityInProgressTabOrderMember":{"id":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.TabLocationAvailabilityInProgressTabOrderMember","kind":"json-schema","title":"TabLocationAvailabilityInProgressTabOrderMember","data":{"title":"TabLocationAvailabilityInProgressTabOrderMember","required":["maskedEmail"],"type":"object","properties":{"maskedEmail":{"minLength":1,"type":"string"}},"additionalProperties":false,"description":"Represents a member of an in-progress tab order"}},"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.TabLocationAvailabilityStatus":{"id":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Availability.TabLocationAvailabilityStatus","kind":"json-schema","title":"TabLocationAvailabilityStatus","data":{"title":"TabLocationAvailabilityStatus","enum":["Available","InProgress","Unavailable"],"type":"string","description":"Represents the availability status of a tab order location base"}},"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Requests.TabOrderDiningLocationCreate":{"id":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Requests.TabOrderDiningLocationCreate","kind":"json-schema","title":"TabOrderDiningLocationCreate","data":{"title":"TabOrderDiningLocationCreate","required":["diningLocationId","type"],"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tabs.Locations.TabOrderLocationType"}],"description":"Gets the type"},"diningLocationId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the dining location base"}},"additionalProperties":false,"description":"Represents the properties required to create a tab order dining location"}},"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Requests.TabOrderInSeatLocationCreate":{"id":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.Requests.TabOrderInSeatLocationCreate","kind":"json-schema","title":"TabOrderInSeatLocationCreate","data":{"title":"TabOrderInSeatLocationCreate","required":["seatIds","showtimeId","type"],"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tabs.Locations.TabOrderLocationType"}],"description":"Gets the type"},"showtimeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the showtime"},"seatIds":{"type":"array","items":{"type":"string"},"description":"Gets the list of unique identifiers of the seat entities"}},"additionalProperties":false,"description":"Represents the properties required to create a tab order in seat location"}},"components/schemas/Ocapi.V1.Orders.Tabs.Locations.TabOrderDiningLocation":{"id":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.TabOrderDiningLocation","kind":"json-schema","title":"TabOrderDiningLocation","data":{"title":"TabOrderDiningLocation","required":["diningLocation","type"],"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tabs.Locations.TabOrderLocationType"}],"description":"Gets the type"},"diningLocation":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.DiningLocations.OrderDiningLocation"}],"description":"Gets the order dining location"}},"additionalProperties":false,"description":"Represents a tab order location base for a dining location base"}},"components/schemas/Ocapi.V1.Orders.Tabs.Locations.TabOrderInSeatLocation":{"id":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.TabOrderInSeatLocation","kind":"json-schema","title":"TabOrderInSeatLocation","data":{"title":"TabOrderInSeatLocation","required":["seats","showtimeId","type"],"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tabs.Locations.TabOrderLocationType"}],"description":"Gets the type"},"showtimeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the showtime"},"seats":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Seats.OrderSeat"},"description":"Gets the list of order seat entities"}},"additionalProperties":false,"description":"Represents a tab order location base for one or more seat entities"}},"components/schemas/Ocapi.V1.Orders.Tabs.Locations.TabOrderLocationType":{"id":"components/schemas/Ocapi.V1.Orders.Tabs.Locations.TabOrderLocationType","kind":"json-schema","title":"TabOrderLocationType","data":{"title":"TabOrderLocationType","enum":["InSeat","DiningLocation"],"type":"string","description":"Represents the type of a tab order location base"}},"components/schemas/Ocapi.V1.Orders.Tabs.TabOrderSpendingLimits":{"id":"components/schemas/Ocapi.V1.Orders.Tabs.TabOrderSpendingLimits","kind":"json-schema","title":"TabOrderSpendingLimits","data":{"title":"TabOrderSpendingLimits","required":["maximumAddItemsPriceIncludingTax","maximumTotalPriceIncludingTax"],"type":"object","properties":{"maximumTotalPriceIncludingTax":{"type":"number","description":"Gets the maximum total price including tax allowed for the tab order, if applicable","format":"double"},"maximumAddItemsPriceIncludingTax":{"type":"number","description":"Gets the maximum price including tax allowed for each add items request, if applicable","format":"double"}},"additionalProperties":false,"description":"Represents the spending limits for a tab order"}},"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderMemberSubscriptionCard":{"id":"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderMemberSubscriptionCard","kind":"json-schema","title":"OrderMemberSubscriptionCard","data":{"title":"OrderMemberSubscriptionCard","required":["id","subscriptionId","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.TicketRedemptionCards.TicketRedemptionCardBase"}],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.TicketRedemptionCards.TicketRedemptionCardType"}],"description":"Gets the type"},"id":{"type":"string","description":"Gets the unique identifier that can be used to uniquely identify the card within the standard order","format":"uuid"},"subscriptionId":{"type":"integer","description":"Gets the unique identifier of the subscription the card is linked to","format":"int32"}},"additionalProperties":false,"description":"Represents a member subscription card that has been added to a standard order"}},"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderThirdPartyMemberCard":{"id":"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderThirdPartyMemberCard","kind":"json-schema","title":"OrderThirdPartyMemberCard","data":{"title":"OrderThirdPartyMemberCard","required":["id","thirdPartyMemberSchemeId","ticketTypeId","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.TicketRedemptionCards.TicketRedemptionCardBase"}],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.TicketRedemptionCards.TicketRedemptionCardType"}],"description":"Gets the type"},"id":{"type":"string","description":"Gets the unique identifier that can be used to uniquely identify the card within the standard order","format":"uuid"},"thirdPartyMemberSchemeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the third party member scheme the card belongs to"},"ticketTypeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the ticket type base that the card has been validated for"}},"additionalProperties":false,"description":"Represents a third party member card that has been added to a standard order"}},"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderTicketRedemptionCardDetails":{"id":"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderTicketRedemptionCardDetails","kind":"json-schema","title":"OrderTicketRedemptionCardDetails","data":{"title":"OrderTicketRedemptionCardDetails","required":["redemptionLimit","ticketRedemptionCard","ticketTypeAvailabilities"],"type":"object","properties":{"ticketRedemptionCard":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderMemberSubscriptionCard"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderThirdPartyMemberCard"}],"description":"Represents the base properties of a ticket redemption card base that has been added to a standard order"},"redemptionLimit":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.QuantityLimit"}],"description":"Gets the maximum number of tickets that can be redeemed for the particular showtime"},"ticketTypeAvailabilities":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderTicketRedemptionCardTicketTypeAvailability"},"description":"Gets the list of order ticket redemption card ticket type availability entities"}},"additionalProperties":false,"description":"Represents the details of an order ticket redemption card base that has been added to an in progress standard order,\r\nand its order ticket redemption card ticket type availability entities"}},"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderTicketRedemptionCardTicketTypeAvailability":{"id":"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.OrderTicketRedemptionCardTicketTypeAvailability","kind":"json-schema","title":"OrderTicketRedemptionCardTicketTypeAvailability","data":{"title":"OrderTicketRedemptionCardTicketTypeAvailability","required":["availableQuantity","isAvailable","ticketTypeId"],"type":"object","properties":{"ticketTypeId":{"minLength":1,"type":"string"},"isAvailable":{"type":"boolean"},"availableQuantity":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Quantity"}]},"unavailableMessage":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}]}},"additionalProperties":false,"description":"Represents the availability of an order ticket redemption card base for a ticket type base"}},"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.Requests.OrderMemberTicketRedemptionCardRequest":{"id":"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.Requests.OrderMemberTicketRedemptionCardRequest","kind":"json-schema","title":"OrderMemberTicketRedemptionCardRequest","data":{"title":"OrderMemberTicketRedemptionCardRequest","required":["memberTicketRedemptionCardId","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.Requests.OrderTicketRedemptionCardRequestBase"}],"properties":{"memberTicketRedemptionCardId":{"type":"string","description":"Gets the unique identifier of the member ticket redemption card base","format":"uuid"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.Requests.OrderTicketRedemptionCardRequestType"}],"description":"Gets the type"}},"additionalProperties":false,"description":"Represents the information required to add a member ticket redemption card base to an in progress standard order"}},"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.Requests.OrderThirdPartyMemberCardRequest":{"id":"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.Requests.OrderThirdPartyMemberCardRequest","kind":"json-schema","title":"OrderThirdPartyMemberCardRequest","data":{"title":"OrderThirdPartyMemberCardRequest","required":["credentials","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.Requests.OrderTicketRedemptionCardRequestBase"}],"properties":{"credentials":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.TicketRedemptionCards.ThirdPartyMemberCardCredentials"}],"description":"Gets the credentials"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.Requests.OrderTicketRedemptionCardRequestType"}],"description":"Gets the type"},"ticketTypeId":{"type":"string","description":"Gets the unique identifier of the ticket type base, if provided","nullable":true}},"additionalProperties":false,"description":"Represents the information required to add a third party member card to an in progress standard order"}},"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.Requests.OrderTicketRedemptionCardRequestBase":{"id":"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.Requests.OrderTicketRedemptionCardRequestBase","kind":"json-schema","title":"OrderTicketRedemptionCardRequestBase","data":{"title":"OrderTicketRedemptionCardRequestBase","required":["showtimeId","type"],"type":"object","properties":{"showtimeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the showtime that the ticket redemption card will be validated for"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.Requests.OrderTicketRedemptionCardRequestType"}],"description":"Gets the type"}},"additionalProperties":false,"description":"Represents the information required to add an order ticket redemption card base to an in progress standard order"}},"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.Requests.OrderTicketRedemptionCardRequestType":{"id":"components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.Requests.OrderTicketRedemptionCardRequestType","kind":"json-schema","title":"OrderTicketRedemptionCardRequestType","data":{"title":"OrderTicketRedemptionCardRequestType","enum":["ThirdPartyMemberCard","MemberTicketRedemptionCard"],"type":"string","description":"Represents the type of an order third party member card request"}},"components/schemas/Ocapi.V1.Orders.Tickets.Normal.OrderNormalTicketLine":{"id":"components/schemas/Ocapi.V1.Orders.Tickets.Normal.OrderNormalTicketLine","kind":"json-schema","title":"OrderNormalTicketLine","data":{"title":"OrderNormalTicketLine","required":["admissionStatus","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tickets.OrderTicketLineBase"}],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.TicketTypeType"}],"description":"Gets the type"},"admissionStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tickets.OrderTicketAdmissionStatus"}],"description":"Gets the admission status"}},"additionalProperties":false,"description":"Represents an order ticket line base for an instance of a normal ticket type"}},"components/schemas/Ocapi.V1.Orders.Tickets.OrderBookingFeeLine":{"id":"components/schemas/Ocapi.V1.Orders.Tickets.OrderBookingFeeLine","kind":"json-schema","title":"OrderBookingFeeLine","data":{"title":"OrderBookingFeeLine","required":["amount","collectionStatus","id","refundAvailability","refundStatus"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the line within the order base"},"amount":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the monetary amount to be displayed to the customer"},"collectionStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Lines.OrderLineCollectionStatus"}],"description":"Gets the collection status"},"refundStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Lines.OrderLineRefundStatus"}],"description":"Gets the refund status"},"refundAvailability":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Refunds.CompletedOrderLineRefundAvailability"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Refunds.CompletedWeightBasedOrderLineRefundAvailability"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Refunds.InProgressOrderLineRefundAvailability"}],"description":"Represents the refund availability of an order line"}},"additionalProperties":false,"description":"Represents a booking fee incurred by an order ticket line base"}},"components/schemas/Ocapi.V1.Orders.Tickets.OrderTicketAdmissionStatus":{"id":"components/schemas/Ocapi.V1.Orders.Tickets.OrderTicketAdmissionStatus","kind":"json-schema","title":"OrderTicketAdmissionStatus","data":{"title":"OrderTicketAdmissionStatus","enum":["NotAdmitted","Admitted","Exited"],"type":"string","description":"Represents the admission status of an order normal ticket line or order package ticket content ticket"}},"components/schemas/Ocapi.V1.Orders.Tickets.OrderTicketLineBase":{"id":"components/schemas/Ocapi.V1.Orders.Tickets.OrderTicketLineBase","kind":"json-schema","title":"OrderTicketLineBase","data":{"title":"OrderTicketLineBase","required":["amountSaved","collectionStatus","id","price","refundAvailability","refundStatus","ticketTypeId","type"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the line within the order base"},"collectionStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Lines.OrderLineCollectionStatus"}],"description":"Gets the collection status"},"refundStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Lines.OrderLineRefundStatus"}],"description":"Gets the refund status"},"ticketTypeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the ticket type base","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.TicketTypeType"}],"description":"Gets the type"},"price":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the price to be displayed to the customer"},"amountSaved":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the total amount saved on the ticket due to all discounts and deals"},"bookingFee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tickets.OrderBookingFeeLine"}],"description":"Gets the booking fee incurred for the ticket, if applicable"},"rewardId":{"type":"integer","description":"Gets the unique identifier of the reward used, if applicable","format":"int32","nullable":true},"ticketRedemptionCardId":{"type":"string","description":"Gets the unique identifier of the order ticket redemption card base used, if applicable","format":"uuid","nullable":true},"voucherId":{"type":"string","description":"Gets the unique identifier of the order voucher used, if applicable","nullable":true},"discountId":{"type":"string","description":"Gets the unique identifier of the discount used, if applicable","nullable":true,"readOnly":true},"dealId":{"type":"string","description":"Gets the unique identifier of the order deal used, if applicable","nullable":true},"refundAvailability":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Refunds.CompletedOrderLineRefundAvailability"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Refunds.CompletedWeightBasedOrderLineRefundAvailability"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Refunds.InProgressOrderLineRefundAvailability"}],"description":"Represents the refund availability of an order line"}},"additionalProperties":false,"description":"Represents the base properties of a collectable order line for an instance of a ticket type base within an order showtime"}},"components/schemas/Ocapi.V1.Orders.Tickets.Package.OrderPackageTicketContentItem":{"id":"components/schemas/Ocapi.V1.Orders.Tickets.Package.OrderPackageTicketContentItem","kind":"json-schema","title":"OrderPackageTicketContentItem","data":{"title":"OrderPackageTicketContentItem","required":["itemId"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base"}},"additionalProperties":false,"description":"Represents an item base within an order package ticket line"}},"components/schemas/Ocapi.V1.Orders.Tickets.Package.OrderPackageTicketContentTicket":{"id":"components/schemas/Ocapi.V1.Orders.Tickets.Package.OrderPackageTicketContentTicket","kind":"json-schema","title":"OrderPackageTicketContentTicket","data":{"title":"OrderPackageTicketContentTicket","required":["admissionStatus","ticketTypeId"],"type":"object","properties":{"ticketTypeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the normal ticket type"},"admissionStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tickets.OrderTicketAdmissionStatus"}],"description":"Gets the admission status"}},"additionalProperties":false,"description":"Represents a normal ticket type within an order package ticket line"}},"components/schemas/Ocapi.V1.Orders.Tickets.Package.OrderPackageTicketLine":{"id":"components/schemas/Ocapi.V1.Orders.Tickets.Package.OrderPackageTicketLine","kind":"json-schema","title":"OrderPackageTicketLine","data":{"title":"OrderPackageTicketLine","required":["items","tickets","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tickets.OrderTicketLineBase"}],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.TicketTypeType"}],"description":"Gets the type"},"tickets":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tickets.Package.OrderPackageTicketContentTicket"},"description":"Gets the list of order package ticket content ticket entities"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Orders.Tickets.Package.OrderPackageTicketContentItem"},"description":"Gets the list of order package ticket content item entities"}},"additionalProperties":false,"description":"Represents an order ticket line base for an instance of a package ticket type"}},"components/schemas/Ocapi.V1.Orders.Tickets.Requests.OrderTicketRequest":{"id":"components/schemas/Ocapi.V1.Orders.Tickets.Requests.OrderTicketRequest","kind":"json-schema","title":"OrderTicketRequest","data":{"title":"OrderTicketRequest","required":["ticketTypeId"],"type":"object","properties":{"id":{"type":"string","description":"Gets the identifier that can be used to uniquely identify the ticket within the order base","nullable":true},"ticketTypeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the ticket type base"},"rewardId":{"type":"integer","description":"Gets the unique identifier of the reward used, if applicable","format":"int32","nullable":true},"ticketRedemptionCardId":{"type":"string","description":"Gets the unique identifier of the order ticket redemption card base used, if applicable","format":"uuid","nullable":true},"voucherId":{"type":"string","description":"Gets the unique identifier of the order voucher used, if applicable","nullable":true},"discountId":{"type":"string","description":"Gets the unique identifier of the discount used, if applicable","nullable":true}},"additionalProperties":false,"description":"Represents the details of a requested order ticket line base for an order showtime"}},"components/schemas/Ocapi.V1.Orders.Tips.OrderTip":{"id":"components/schemas/Ocapi.V1.Orders.Tips.OrderTip","kind":"json-schema","title":"OrderTip","data":{"title":"OrderTip","required":["amount","collectionStatus","id","refundAvailability","refundStatus"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the line within the order base"},"amount":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the monetary amount"},"collectionStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Lines.OrderLineCollectionStatus"}],"description":"Gets the collection status"},"refundStatus":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Lines.OrderLineRefundStatus"}],"description":"Gets the refund status"},"refundAvailability":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Refunds.CompletedOrderLineRefundAvailability"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Refunds.CompletedWeightBasedOrderLineRefundAvailability"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Refunds.InProgressOrderLineRefundAvailability"}],"description":"Represents the refund availability of an order line"}},"additionalProperties":false,"description":"Represents the tip associated with a order base"}},"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest":{"id":"components/schemas/Ocapi.V1.Orders.Tips.Requests.OrderTipRequest","kind":"json-schema","title":"OrderTipRequest","data":{"title":"OrderTipRequest","required":["amount"],"type":"object","properties":{"amount":{"type":"number","description":"Gets the monetary amount","format":"double"}},"additionalProperties":false}},"components/schemas/Ocapi.V1.Orders.Transactions.OrderTransaction":{"id":"components/schemas/Ocapi.V1.Orders.Transactions.OrderTransaction","kind":"json-schema","title":"OrderTransaction","data":{"title":"OrderTransaction","required":["barcode","createdAt","number"],"type":"object","properties":{"number":{"type":"integer","description":"Gets the number generated by the site that can be used to identify and collect the transaction","format":"int32"},"barcode":{"minLength":1,"type":"string","description":"Gets the barcode generated by the site that can be used to identify and collect the transaction","example":"T00210738425"},"createdAt":{"type":"string","description":"Gets the date and time that the transaction was created","format":"date-time"}},"additionalProperties":false,"description":"Represents the transaction details of a completed order base"}},"components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucher":{"id":"components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucher","kind":"json-schema","title":"OrderVoucher","data":{"title":"OrderVoucher","required":["id","maskedBarcode","type","voucherTypeCode"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the voucher within the order base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Vouchers.VoucherType"}],"description":"Gets the type"},"maskedBarcode":{"minLength":1,"type":"string","description":"Gets a masked representation of the barcode","example":"12.......6789"},"voucherTypeCode":{"minLength":1,"type":"string","description":"Gets the unique identifier of the voucher type"},"voucherTypeDescription":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the voucher type description text, and its translations"}},"additionalProperties":false,"description":"Represents a voucher that has been added to an order base"}},"components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucherDetails":{"id":"components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucherDetails","kind":"json-schema","title":"OrderVoucherDetails","data":{"title":"OrderVoucherDetails","required":["availableRedemptions","voucher"],"type":"object","properties":{"voucher":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Vouchers.OrderVoucher"}],"description":"Gets the order voucher entity"},"availableRedemptions":{"type":"integer","description":"Gets the maximum number of times that the order voucher details Voucher can be redeemed","format":"int32"}},"additionalProperties":false,"description":"Represents a voucher that has been added to the order"}},"components/schemas/Ocapi.V1.Orders.Vouchers.Requests.OrderDealVoucherRequest":{"id":"components/schemas/Ocapi.V1.Orders.Vouchers.Requests.OrderDealVoucherRequest","kind":"json-schema","title":"OrderDealVoucherRequest","data":{"title":"OrderDealVoucherRequest","type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Vouchers.Requests.OrderVoucherRequestBase"}],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Vouchers.VoucherType"}],"description":"Gets the type"}},"additionalProperties":false,"description":"Represents the information required to add an order voucher of type voucher type Deal to an in progress standard order"}},"components/schemas/Ocapi.V1.Orders.Vouchers.Requests.OrderSubscriptionVoucherRequest":{"id":"components/schemas/Ocapi.V1.Orders.Vouchers.Requests.OrderSubscriptionVoucherRequest","kind":"json-schema","title":"OrderSubscriptionVoucherRequest","data":{"title":"OrderSubscriptionVoucherRequest","type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Vouchers.Requests.OrderVoucherRequestBase"}],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Vouchers.VoucherType"}],"description":"Gets the type"}},"additionalProperties":false,"description":"Represents the information required to add an order voucher for an order subscription to an in progress subscription order"}},"components/schemas/Ocapi.V1.Orders.Vouchers.Requests.OrderTicketVoucherRequest":{"id":"components/schemas/Ocapi.V1.Orders.Vouchers.Requests.OrderTicketVoucherRequest","kind":"json-schema","title":"OrderTicketVoucherRequest","data":{"title":"OrderTicketVoucherRequest","required":["showtimeId"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Vouchers.Requests.OrderVoucherRequestBase"}],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Vouchers.VoucherType"}],"description":"Gets the type"},"showtimeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the showtime that the voucher will be validated for"}},"additionalProperties":false,"description":"Represents the information required to add an order voucher for an order ticket line base to an in progress standard order"}},"components/schemas/Ocapi.V1.Orders.Vouchers.Requests.OrderVoucherRequestBase":{"id":"components/schemas/Ocapi.V1.Orders.Vouchers.Requests.OrderVoucherRequestBase","kind":"json-schema","title":"OrderVoucherRequestBase","data":{"title":"OrderVoucherRequestBase","required":["credentials","type"],"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Vouchers.VoucherType"}],"description":"Gets the type"},"credentials":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Vouchers.VoucherCredentials"}],"description":"Gets the credentials"}},"additionalProperties":false,"description":"Represents the information required to add an order voucher to an in progress order base"}},"components/schemas/Ocapi.V1.Payments.MasterData.WebPaymentMethod":{"id":"components/schemas/Ocapi.V1.Payments.MasterData.WebPaymentMethod","kind":"json-schema","title":"WebPaymentMethod","data":{"title":"WebPaymentMethod","required":["displayPriority","id","isDefault","isRecurringBillingSupported","name","type"],"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Payments.MasterData.WebPaymentMethods.WebPaymentMethodType"}],"description":"Gets the type"},"isDefault":{"type":"boolean","description":"Gets a value indicating whether this is the default web payment method"},"id":{"type":"integer","description":"Gets the unique identifier","format":"int32"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"displayPriority":{"type":"integer","description":"Gets the display priority used for sorting","format":"int32"},"isRecurringBillingSupported":{"type":"boolean","description":"Gets a value indicating whether recurring billing is supported"}},"additionalProperties":false,"description":"Represents a payment method that can be used to pay via Web Payment Module"}},"components/schemas/Ocapi.V1.Payments.MasterData.WebPaymentMethodListDetails":{"id":"components/schemas/Ocapi.V1.Payments.MasterData.WebPaymentMethodListDetails","kind":"json-schema","title":"WebPaymentMethodListDetails","data":{"title":"WebPaymentMethodListDetails","required":["webPaymentMethods"],"type":"object","properties":{"webPaymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Payments.MasterData.WebPaymentMethod"},"description":"Gets the list of web payment method entities"}},"additionalProperties":false,"description":"Represents a list of web payment method entities"}},"components/schemas/Ocapi.V1.Payments.MasterData.WebPaymentMethods.WebPaymentMethodType":{"id":"components/schemas/Ocapi.V1.Payments.MasterData.WebPaymentMethods.WebPaymentMethodType","kind":"json-schema","title":"WebPaymentMethodType","data":{"title":"WebPaymentMethodType","enum":["Redirect","Embedded"],"type":"string","description":"Represents the type of a web payment method"}},"components/schemas/Ocapi.V1.PersonName":{"id":"components/schemas/Ocapi.V1.PersonName","kind":"json-schema","title":"PersonName","data":{"title":"PersonName","type":"object","properties":{"givenName":{"type":"string","description":"Gets the given name","nullable":true},"familyName":{"type":"string","description":"Gets the family name","nullable":true},"middleName":{"type":"string","description":"Gets the middle or any additional name","nullable":true}},"additionalProperties":false,"description":"Represents the parts of a person's name"}},"components/schemas/Ocapi.V1.PhoneNumber":{"id":"components/schemas/Ocapi.V1.PhoneNumber","kind":"json-schema","title":"PhoneNumber","data":{"title":"PhoneNumber","required":["number","type"],"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.PhoneNumberType"}],"description":"Gets the type"},"number":{"minLength":1,"type":"string","description":"Gets the phone number"}},"additionalProperties":false,"description":"Represents a phone number"}},"components/schemas/Ocapi.V1.PhoneNumberType":{"id":"components/schemas/Ocapi.V1.PhoneNumberType","kind":"json-schema","title":"PhoneNumberType","data":{"title":"PhoneNumberType","enum":["Home","Mobile","Work","Business","Fax"],"type":"string","description":"Represents the type of a phone number"}},"components/schemas/Ocapi.V1.PushNotificationToken":{"id":"components/schemas/Ocapi.V1.PushNotificationToken","kind":"json-schema","title":"PushNotificationToken","data":{"title":"PushNotificationToken","required":["id","type"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.PushNotificationTokenType"}],"description":"Gets the type"}},"additionalProperties":false,"description":"Represents a token used for push notifications"}},"components/schemas/Ocapi.V1.PushNotificationTokenType":{"id":"components/schemas/Ocapi.V1.PushNotificationTokenType","kind":"json-schema","title":"PushNotificationTokenType","data":{"title":"PushNotificationTokenType","enum":["Android","Ios"],"type":"string","description":"Represents the type of a push notification token"}},"components/schemas/Ocapi.V1.Quantity":{"id":"components/schemas/Ocapi.V1.Quantity","kind":"json-schema","title":"Quantity","data":{"title":"Quantity","required":["isUnlimited"],"type":"object","properties":{"isUnlimited":{"type":"boolean","description":"Gets a value indicating whether the quantity is unlimited"},"value":{"type":"integer","description":"Gets the value","format":"int32","nullable":true}},"additionalProperties":false,"description":"Represents a limited or unlimited quantity"}},"components/schemas/Ocapi.V1.QuantityLimit":{"id":"components/schemas/Ocapi.V1.QuantityLimit","kind":"json-schema","title":"QuantityLimit","data":{"title":"QuantityLimit","required":["isUnlimited","minimum"],"type":"object","properties":{"isUnlimited":{"type":"boolean","description":"Gets a value indicating whether the quantity is unlimited"},"maximum":{"type":"integer","description":"Gets the maximum quantity allowed","format":"int32","nullable":true},"minimum":{"type":"integer","description":"Gets the minimum quantity allowed (0 by default)","format":"int32"}},"additionalProperties":false,"description":"Represents a limited or unlimited quantity"}},"components/schemas/Ocapi.V1.Sales.Availability.DiscountAvailability":{"id":"components/schemas/Ocapi.V1.Sales.Availability.DiscountAvailability","kind":"json-schema","title":"DiscountAvailability","data":{"title":"DiscountAvailability","required":["discountId","isAvailable","unavailableReason"],"type":"object","properties":{"discountId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the discount","readOnly":true},"isAvailable":{"type":"boolean","description":"Gets a value indicating whether the discount is available","readOnly":true},"unavailableReason":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.Availability.Discounts.DiscountUnavailableReason"}],"description":"Gets the reason the discount is unavailable"}},"additionalProperties":false,"description":"Represents the availability of a discount"}},"components/schemas/Ocapi.V1.Sales.Availability.DiscountAvailabilityListDetails":{"id":"components/schemas/Ocapi.V1.Sales.Availability.DiscountAvailabilityListDetails","kind":"json-schema","title":"DiscountAvailabilityListDetails","data":{"title":"DiscountAvailabilityListDetails","required":["discountAvailabilities"],"type":"object","properties":{"discountAvailabilities":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.Availability.DiscountAvailability"},"description":"Gets the list of discount availability entities"}},"additionalProperties":false,"description":"Represents a list of discount availability entities"}},"components/schemas/Ocapi.V1.Sales.Availability.Discounts.DiscountUnavailableReason":{"id":"components/schemas/Ocapi.V1.Sales.Availability.Discounts.DiscountUnavailableReason","kind":"json-schema","title":"DiscountUnavailableReason","data":{"title":"DiscountUnavailableReason","enum":["NotApplicable","UnavailableForFilm","UnavailableForDistributor","UnavailableForPublicHoliday","UnavailableForDayOfWeek","UnavailableForTime","UnavailableForDate"],"type":"string","description":"Represents the reasons that a discount may not be available"}},"components/schemas/Ocapi.V1.Sales.Availability.ItemAvailability":{"id":"components/schemas/Ocapi.V1.Sales.Availability.ItemAvailability","kind":"json-schema","title":"ItemAvailability","data":{"title":"ItemAvailability","required":["itemId","status"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base"},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.Availability.Items.ItemAvailabilityStatus"}],"description":"Gets the availability status of the item base"}},"additionalProperties":false,"description":"Represents the current availability of an item base"}},"components/schemas/Ocapi.V1.Sales.Availability.ItemAvailabilityListDetails":{"id":"components/schemas/Ocapi.V1.Sales.Availability.ItemAvailabilityListDetails","kind":"json-schema","title":"ItemAvailabilityListDetails","data":{"title":"ItemAvailabilityListDetails","required":["itemAvailabilities"],"type":"object","properties":{"itemAvailabilities":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.Availability.ItemAvailability"},"description":"Gets the list of item availability entities"}},"additionalProperties":false,"description":"Represents a list of item availability entities"}},"components/schemas/Ocapi.V1.Sales.Availability.Items.ItemAvailabilityStatus":{"id":"components/schemas/Ocapi.V1.Sales.Availability.Items.ItemAvailabilityStatus","kind":"json-schema","title":"ItemAvailabilityStatus","data":{"title":"ItemAvailabilityStatus","enum":["Available","SoldOutForCurrentBusinessDate","SoldOutIndefinitely"],"type":"string","description":"Represents the availability status of an item base"}},"components/schemas/Ocapi.V1.Sales.Availability.SiteDiscountAvailabilityListDetails":{"id":"components/schemas/Ocapi.V1.Sales.Availability.SiteDiscountAvailabilityListDetails","kind":"json-schema","title":"SiteDiscountAvailabilityListDetails","data":{"title":"SiteDiscountAvailabilityListDetails","required":["discountAvailabilities","isDefault","siteId"],"type":"object","properties":{"discountAvailabilities":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.Availability.DiscountAvailability"},"description":"Gets the list of discount availability entities"},"siteId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the site"},"isDefault":{"type":"boolean","description":"Gets a value indicating whether this is the default discount availability list details for the site"},"siteOrderLocationId":{"type":"string","description":"Gets the unique identifier of the site order location, if applicable","nullable":true}},"additionalProperties":false,"description":"Represents a list of discount availability entities for a particular site"}},"components/schemas/Ocapi.V1.Sales.Availability.SiteItemAvailabilityListDetails":{"id":"components/schemas/Ocapi.V1.Sales.Availability.SiteItemAvailabilityListDetails","kind":"json-schema","title":"SiteItemAvailabilityListDetails","data":{"title":"SiteItemAvailabilityListDetails","required":["isDefault","itemAvailabilities","relatedData","siteId"],"type":"object","properties":{"itemAvailabilities":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.Availability.ItemAvailability"},"description":"Gets the list of item availability entities"},"siteId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the site"},"isDefault":{"type":"boolean","description":"Gets a value indicating whether this is the default item availability list details for the site"},"siteOrderLocationId":{"type":"string","description":"Gets the unique identifier of the site order location, if applicable","nullable":true},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.Availability.SiteItemAvailabilityListRelatedData"}],"description":"Gets the related data for the item availability entities"}},"additionalProperties":false,"description":"Represents a list of item availability entities for a particular site, and their related\r\ndata"}},"components/schemas/Ocapi.V1.Sales.Availability.SiteItemAvailabilityListRelatedData":{"id":"components/schemas/Ocapi.V1.Sales.Availability.SiteItemAvailabilityListRelatedData","kind":"json-schema","title":"SiteItemAvailabilityListRelatedData","data":{"title":"SiteItemAvailabilityListRelatedData","required":["site"],"type":"object","properties":{"site":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.Site"}],"description":"Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities"}},"additionalProperties":false,"description":"Related data for a list of item availability entities"}},"components/schemas/Ocapi.V1.Sales.MasterData.AvailableHours.AvailableHours":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.AvailableHours.AvailableHours","kind":"json-schema","title":"AvailableHours","data":{"title":"AvailableHours","required":["days","id","siteId"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier","readOnly":true},"siteId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the site"},"days":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.AvailableHours.AvailableHoursForDay"},"description":"Gets the available hours for the days of the week"}},"additionalProperties":false,"description":"Represents the available days and times an entity can be used or sold"}},"components/schemas/Ocapi.V1.Sales.MasterData.AvailableHours.AvailableHoursForDay":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.AvailableHours.AvailableHoursForDay","kind":"json-schema","title":"AvailableHoursForDay","data":{"title":"AvailableHoursForDay","required":["day","endTime","startTime"],"type":"object","properties":{"day":{"allOf":[{"$ref":"#/components/schemas/System.DayOfWeek"}],"description":"Gets the day of week"},"startTime":{"type":"string","description":"Gets the start time","format":"date-time"},"endTime":{"type":"string","description":"Gets the end time","format":"date-time"}},"additionalProperties":false,"description":"Represents an available time range for a specific day of the week"}},"components/schemas/Ocapi.V1.Sales.MasterData.Discounts.Discount":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Discounts.Discount","kind":"json-schema","title":"Discount","data":{"title":"Discount","required":["expiresAt","id","name","restriction","restrictions","rewardIds","voucherTypeCodes"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier","readOnly":true},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"restriction":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Discounts.DiscountRestriction"}],"description":"Gets the restriction"},"restrictions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Discounts.DiscountRestriction"},"description":"Gets the restrictions"},"rewardIds":{"type":"array","items":{"type":"integer","format":"int32"},"description":"Gets the list of unique identifiers of the reward entities that the discount is restricted to"},"voucherTypeCodes":{"type":"array","items":{"type":"string"},"description":"Gets the list of unique identifiers of the voucher types that the discount is restricted to"},"expiresAt":{"type":"string","description":"Gets the date and time that the discount expires","format":"date-time"}},"additionalProperties":false,"description":"Represents a discount"}},"components/schemas/Ocapi.V1.Sales.MasterData.Discounts.DiscountRestriction":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Discounts.DiscountRestriction","kind":"json-schema","title":"DiscountRestriction","data":{"title":"DiscountRestriction","enum":["None","Multiple","MemberReward","Voucher","Availability"],"type":"string","description":"Represents the restriction options for a discount"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryFees.ItemDeliveryFeeFixedPrice":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryFees.ItemDeliveryFeeFixedPrice","kind":"json-schema","title":"ItemDeliveryFeeFixedPrice","data":{"title":"ItemDeliveryFeeFixedPrice","required":["price","type"],"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryFees.ItemDeliveryFeeType"}],"description":"Gets the type"},"price":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the price"}},"additionalProperties":false,"description":"Represents an item delivery fee base that is a fixed price"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryFees.ItemDeliveryFeePercentage":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryFees.ItemDeliveryFeePercentage","kind":"json-schema","title":"ItemDeliveryFeePercentage","data":{"title":"ItemDeliveryFeePercentage","required":["percentage","salesTaxId","type"],"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryFees.ItemDeliveryFeeType"}],"description":"Gets the type"},"percentage":{"type":"number","description":"Gets the percentage","format":"double"},"salesTaxId":{"minLength":1,"type":"string","description":"Gets the identifier of the sales tax"}},"additionalProperties":false,"description":"Represents an item delivery fee base that is based on a percentage of the overall item delivery price"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryFees.ItemDeliveryFeeType":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryFees.ItemDeliveryFeeType","kind":"json-schema","title":"ItemDeliveryFeeType","data":{"title":"ItemDeliveryFeeType","enum":["FixedPrice","Percentage"],"type":"string","description":"Represents the type of delivery fee for an item delivery fee base"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod","kind":"json-schema","title":"ItemDeliveryMethod","data":{"title":"ItemDeliveryMethod","enum":["CounterPickup","ServiceAreaPickup","ElectronicDelivery","InSeatDelivery","DiningLocationDelivery","CustomLocationDelivery","PostalDelivery"],"type":"string","description":"Represents the delivery method of an item base"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemPostalDeliveryMethod":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemPostalDeliveryMethod","kind":"json-schema","title":"ItemPostalDeliveryMethod","data":{"title":"ItemPostalDeliveryMethod","required":["id","isDefault","name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"isDefault":{"type":"boolean","description":"Gets a value indicating whether this is the default delivery method"},"deliveryFee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryFees.ItemDeliveryFeeFixedPrice"}],"description":"Gets the delivery fee, if applicable"}},"additionalProperties":false,"description":"Represents a method for delivering items to a postal address"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemBase":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemBase","kind":"json-schema","title":"ItemBase","data":{"title":"ItemBase","required":["allowedDeliveryMethods","barcodes","hoCode","id","isPreparationRequired","isSundry","name","restrictions","shortName","type"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier","readOnly":true},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"shortName":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the short name text, and its translations"},"description":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the description text, and its translations"},"restrictions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemRestriction"},"description":"Gets the restrictions that apply"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType"}],"description":"Gets the type"},"itemClassId":{"type":"string","description":"Gets the unique identifier of the item class the item belongs to, if applicable","nullable":true},"hopk":{"type":"string","description":"Gets the Head Office primary key","nullable":true},"hoCode":{"minLength":1,"type":"string","description":"Gets the Head Office code"},"isSundry":{"type":"boolean","description":"Gets a value indicating whether this is a sundry item"},"isPreparationRequired":{"type":"boolean","description":"Gets a value indicating whether the item requires preparation"},"allowedDeliveryMethods":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"},"description":"Gets the list of allowed item delivery method entities"},"availableHoursId":{"type":"string","description":"Gets the unique identifier of the available hours entity","nullable":true,"readOnly":true},"barcodes":{"type":"array","items":{"type":"string"},"description":"Gets the list of barcodes configured on the item at cinema"}},"additionalProperties":false,"description":"Represents the base properties of an item that is available for sale"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemRestriction":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemRestriction","kind":"json-schema","title":"ItemRestriction","data":{"title":"ItemRestriction","enum":["Member","AvailableHours"],"type":"string","description":"Represents the restriction options for an item base"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemServiceArea":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemServiceArea","kind":"json-schema","title":"ItemServiceArea","data":{"title":"ItemServiceArea","required":["id","name","shortName"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"shortName":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the short name text, and its translations"}},"additionalProperties":false,"description":"Represents a physical location within a site used for preparation and/or pickup of a sellable item"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType","kind":"json-schema","title":"ItemType","data":{"title":"ItemType","enum":["Normal","ParentSales","Package","Recipe","WeightBased"],"type":"string","description":"Represents the type of an item base entity"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Modifiers.ItemModifier":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Modifiers.ItemModifier","kind":"json-schema","title":"ItemModifier","data":{"title":"ItemModifier","required":["displayPriority","itemId","prices"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base entity"},"prices":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Prices.ItemPrice"},"description":"Gets the list of item price entities"},"displayPriority":{"type":"integer","description":"Gets the display priority used for sorting","format":"int32"}},"additionalProperties":false,"description":"Represents a modifier that can be added to a supported normal item, e.g. sauce, cheese, tomato"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Modifiers.ItemModifierGroup":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Modifiers.ItemModifierGroup","kind":"json-schema","title":"ItemModifierGroup","data":{"title":"ItemModifierGroup","required":["id","includedQuantity","modifiers","name","quantityLimit","shortName"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier","readOnly":true},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"shortName":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the short name text, and its translations"},"promptText":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the prompt text, and its translations"},"quantityLimit":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.QuantityLimit"}],"description":"Gets a value indicating the number of item modifier entities that can or must be added to a supported normal item"},"includedQuantity":{"type":"integer","description":"Gets a value indicating the number of item modifier entities that can be added to a supported normal item at no additional charge","format":"int32"},"modifiers":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Modifiers.ItemModifier"},"description":"Gets the list of item modifier entities"}},"additionalProperties":false,"description":"Represents a list of related item modifier entities that can be added to a supported normal item"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Normal.NormalItem":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Normal.NormalItem","kind":"json-schema","title":"NormalItem","data":{"title":"NormalItem","required":["modifierGroups","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemBase"}],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType"}],"description":"Gets the type"},"modifierGroups":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Normal.NormalItemModifierGroup"},"description":"Gets the list of normal item modifier group entities"}},"additionalProperties":false,"description":"Represents an item base that supports item modifier group entities, e.g. a chocolate bar, or a burger with optional extras"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Normal.NormalItemModifierGroup":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Normal.NormalItemModifierGroup","kind":"json-schema","title":"NormalItemModifierGroup","data":{"title":"NormalItemModifierGroup","required":["displayPriority","itemModifierGroupId"],"type":"object","properties":{"itemModifierGroupId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item modifier group","readOnly":true},"displayPriority":{"type":"integer","description":"Gets the display priority used for sorting","format":"int32"}},"additionalProperties":false}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Packages.PackageItem":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Packages.PackageItem","kind":"json-schema","title":"PackageItem","data":{"title":"PackageItem","required":["items","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemBase"}],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType"}],"description":"Gets the type"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Packages.PackageItemContentItem"},"description":"Gets the list of package item content item entities"}},"additionalProperties":false,"description":"Represents an item base that contains one or more package item Items, e.g. a combo that contains a drink, ice cream, and popcorn"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Packages.PackageItemContentItem":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Packages.PackageItemContentItem","kind":"json-schema","title":"PackageItemContentItem","data":{"title":"PackageItemContentItem","required":["displayPriority","itemId","quantity"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base entity"},"quantity":{"type":"integer","description":"Gets the quantity","format":"int32"},"displayPriority":{"type":"integer","description":"Gets the display priority used for sorting","format":"int32"}},"additionalProperties":false,"description":"Represents an item base within a package item"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.ParentSales.ParentSalesItem":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.ParentSales.ParentSalesItem","kind":"json-schema","title":"ParentSalesItem","data":{"title":"ParentSalesItem","required":["options","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemBase"}],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType"}],"description":"Gets the type"},"options":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ParentSales.ParentSalesItemOption"},"description":"Gets the list of parent sales item option entities"},"promptText":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the prompt text, and its translations"}},"additionalProperties":false,"description":"Represents an item base that has a number of parent sales item Options that can be purchased, e.g. a collection of medium drink options"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.ParentSales.ParentSalesItemOption":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.ParentSales.ParentSalesItemOption","kind":"json-schema","title":"ParentSalesItemOption","data":{"title":"ParentSalesItemOption","required":["displayPriority","itemId","prices"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base entity"},"displayPriority":{"type":"integer","description":"Gets the display priority used for sorting","format":"int32"},"prices":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Prices.ItemPrice"},"description":"Gets the list of item price entities"}},"additionalProperties":false,"description":"Represents an option for a parent sales item"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Prices.ItemPrice":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Prices.ItemPrice","kind":"json-schema","title":"ItemPrice","data":{"title":"ItemPrice","required":["isDefault","price","restrictions"],"type":"object","properties":{"price":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the price to be displayed to the customer"},"isDefault":{"type":"boolean","description":"Gets a value indicating whether this is the default price"},"restrictions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Prices.ItemPriceRestriction"},"description":"Gets the restrictions that apply"},"rewardId":{"type":"integer","description":"Gets the unique identifier of the reward that the price is restricted to","format":"int32","nullable":true},"discount":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Prices.PriceDiscount"}],"description":"Gets the discount details"},"discountId":{"type":"string","description":"Gets the unique identifier of the discount that the price is restricted to","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Represents the price of an item base"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Prices.ItemPriceRestriction":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Prices.ItemPriceRestriction","kind":"json-schema","title":"ItemPriceRestriction","data":{"title":"ItemPriceRestriction","enum":["MemberReward","InheritedMemberReward","Discount","InheritedDiscount"],"type":"string","description":"Represents the restriction options for an item price"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.GiftShopItemProfile":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.GiftShopItemProfile","kind":"json-schema","title":"GiftShopItemProfile","data":{"title":"GiftShopItemProfile","required":["itemPostalDeliveryMethods","pages"],"type":"object","properties":{"pages":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.ItemProfilePage"},"description":"Gets the list of item profile page entities"},"itemPostalDeliveryMethods":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemPostalDeliveryMethod"},"description":"Gets the list of related item postal delivery method entities"}},"additionalProperties":false,"description":"Represents an item profile for the gift shop"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.GiftShopItemProfileDetails":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.GiftShopItemProfileDetails","kind":"json-schema","title":"GiftShopItemProfileDetails","data":{"title":"GiftShopItemProfileDetails","required":["itemProfile","relatedData"],"type":"object","properties":{"itemProfile":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.GiftShopItemProfile"}],"description":"Gets the gift shop item profile entity"},"relatedData":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.ItemProfileRelatedData"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.SiteItemProfileRelatedData"}],"description":"Related data for an item profile entity"}},"additionalProperties":false,"description":"Represents the details of a gift shop item profile entity, and its related data"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.ItemProfileButton":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.ItemProfileButton","kind":"json-schema","title":"ItemProfileButton","data":{"title":"ItemProfileButton","required":["displayPriority","itemId","prices","title"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base entity"},"prices":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Prices.ItemPrice"},"description":"Gets the list of item price entities"},"title":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the title text, and its translations"},"displayPriority":{"type":"integer","description":"Gets the display priority used for sorting","format":"int32"}},"additionalProperties":false,"description":"Represents a button within an item profile page that's used to display a sellable item"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.ItemProfilePage":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.ItemProfilePage","kind":"json-schema","title":"ItemProfilePage","data":{"title":"ItemProfilePage","required":["buttons","displayPriority","number","title"],"type":"object","properties":{"number":{"type":"integer","description":"Gets the number that can be used to uniquely identify the page within the item profile","format":"int32"},"title":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the title text, and its translations"},"buttons":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.ItemProfileButton"},"description":"Gets the list of item profile button entities"},"displayPriority":{"type":"integer","description":"Gets the display priority used for sorting","format":"int32"}},"additionalProperties":false,"description":"Represents a page within an item profile"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.ItemProfileRelatedData":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.ItemProfileRelatedData","kind":"json-schema","title":"ItemProfileRelatedData","data":{"title":"ItemProfileRelatedData","required":["discounts","itemModifierGroups","items"],"type":"object","properties":{"discounts":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Discounts.Discount"},"description":"Gets the list of related discount entities"},"items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.WeightBased.WeightBasedItem"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Recipe.RecipeItem"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ParentSales.ParentSalesItem"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Packages.PackageItem"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Normal.NormalItem"}],"description":"Represents the base properties of an item that is available for sale"},"description":"Gets the list of related item base entities"},"itemModifierGroups":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Modifiers.ItemModifierGroup"},"description":"Gets the list of related item modifier group entities"}},"additionalProperties":false,"description":"Related data for an item profile entity"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.SiteItemProfile":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.SiteItemProfile","kind":"json-schema","title":"SiteItemProfile","data":{"title":"SiteItemProfile","required":["isDefault","itemShowtimeDeliveryWindows","orderTipOptions","pages","siteId"],"type":"object","properties":{"pages":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.ItemProfilePage"},"description":"Gets the list of item profile page entities"},"siteId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the site"},"isDefault":{"type":"boolean","description":"Gets a value indicating whether this is the default item profile for the site"},"orderTipOptions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.OrderTipOptions.OrderTipOption"},"description":"Gets the list of order tip option entities"},"itemShowtimeDeliveryWindows":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ShowtimeDeliveryWindows.ItemShowtimeDeliveryWindowMinutesFromStart"},"description":"Gets the list of item showtime delivery window base entities"},"customLocationItemDeliveryFee":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryFees.ItemDeliveryFeeFixedPrice"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryFees.ItemDeliveryFeePercentage"}],"description":"Represents the base properties of an item delivery fee"},"counterItemPickupFee":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryFees.ItemDeliveryFeeFixedPrice"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryFees.ItemDeliveryFeePercentage"}],"description":"Represents the base properties of an item delivery fee"},"serviceAreaItemPickupFee":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryFees.ItemDeliveryFeeFixedPrice"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryFees.ItemDeliveryFeePercentage"}],"description":"Represents the base properties of an item delivery fee"},"siteOrderLocationId":{"type":"string","description":"Gets the unique identifier of the site order location, if applicable","nullable":true}},"additionalProperties":false,"description":"Represents an item profile for a site"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.SiteItemProfileDetails":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.SiteItemProfileDetails","kind":"json-schema","title":"SiteItemProfileDetails","data":{"title":"SiteItemProfileDetails","required":["itemProfile","relatedData"],"type":"object","properties":{"itemProfile":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.SiteItemProfile"}],"description":"Gets the site item profile entity"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.SiteItemProfileRelatedData"}],"description":"Gets the related data for the site item profile entity"}},"additionalProperties":false,"description":"Represents the details of a site item profile entity, and its related data"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.SiteItemProfileRelatedData":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.SiteItemProfileRelatedData","kind":"json-schema","title":"SiteItemProfileRelatedData","data":{"title":"SiteItemProfileRelatedData","required":["availableHours","discounts","itemModifierGroups","items","salesTaxes","site"],"type":"object","properties":{"discounts":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Discounts.Discount"},"description":"Gets the list of related discount entities"},"items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.WeightBased.WeightBasedItem"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Recipe.RecipeItem"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ParentSales.ParentSalesItem"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Packages.PackageItem"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Normal.NormalItem"}],"description":"Represents the base properties of an item that is available for sale"},"description":"Gets the list of related item base entities"},"itemModifierGroups":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Modifiers.ItemModifierGroup"},"description":"Gets the list of related item modifier group entities"},"site":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Sites.LoyaltySite"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Sites.Site"}],"description":"Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities"},"availableHours":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.AvailableHours.AvailableHours"},"description":"Gets the list of related available hours entities"},"salesTaxes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTax"},"description":"Gets the list of related sales tax entities"}},"additionalProperties":false,"description":"Related data for a site item profile entity"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Recipe.RecipeItem":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Recipe.RecipeItem","kind":"json-schema","title":"RecipeItem","data":{"title":"RecipeItem","required":["allowedDeliveryMethods","barcodes","components","hoCode","id","isPreparationRequired","isSundry","modifierGroups","name","restrictions","shortName","type"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier","readOnly":true},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"shortName":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the short name text, and its translations"},"description":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the description text, and its translations"},"restrictions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemRestriction"},"description":"Gets the restrictions that apply"},"itemClassId":{"type":"string","description":"Gets the unique identifier of the item class the item belongs to, if applicable","nullable":true},"hopk":{"type":"string","description":"Gets the Head Office primary key","nullable":true},"hoCode":{"minLength":1,"type":"string","description":"Gets the Head Office code"},"isSundry":{"type":"boolean","description":"Gets a value indicating whether this is a sundry item"},"isPreparationRequired":{"type":"boolean","description":"Gets a value indicating whether the item requires preparation"},"allowedDeliveryMethods":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.DeliveryMethods.ItemDeliveryMethod"},"description":"Gets the list of allowed item delivery method entities"},"availableHoursId":{"type":"string","description":"Gets the unique identifier of the available hours entity","nullable":true,"readOnly":true},"barcodes":{"type":"array","items":{"type":"string"},"description":"Gets the list of barcodes configured on the item at cinema"},"modifierGroups":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Normal.NormalItemModifierGroup"},"description":"Gets the list of normal item modifier group entities"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType"}],"description":"Gets the type"},"components":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Recipe.RecipeItemComponent"},"description":"Gets the list of recipe item component entities"}},"additionalProperties":false,"description":"Represents an item base that supports item modifier group entities and has one or more recipe item Components,\r\ne.g. a drink made up of a cup, straw, post-mix syrup, and ice"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Recipe.RecipeItemComponent":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Recipe.RecipeItemComponent","kind":"json-schema","title":"RecipeItemComponent","data":{"title":"RecipeItemComponent","required":["displayPriority","isModifiable","itemId","prices"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base entity"},"isModifiable":{"type":"boolean","description":"Gets a value indicating whether the component can be modified via an order recipe item component modification"},"displayPriority":{"type":"integer","description":"Gets the display priority used for sorting","format":"int32"},"prices":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Prices.ItemPrice"},"description":"Gets the list of item price entities incurred when adding extra of the component to the recipe"}},"additionalProperties":false,"description":"Represents a component within a recipe item"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Sellable.SellableItem":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Sellable.SellableItem","kind":"json-schema","title":"SellableItem","data":{"title":"SellableItem","required":["itemId","prices"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base entity"},"prices":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Prices.ItemPrice"},"description":"Gets the list of item price entities"}},"additionalProperties":false,"description":"Represents the details of an item base entity that can be purchased directly"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Sellable.SellableItemDetails":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Sellable.SellableItemDetails","kind":"json-schema","title":"SellableItemDetails","data":{"title":"SellableItemDetails","required":["relatedData","sellableItem"],"type":"object","properties":{"sellableItem":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Sellable.SellableItem"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Profiles.ItemProfileButton"}],"description":"Represents the details of an item base entity that can be purchased directly"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Sellable.SellableItemRelatedData"}],"description":"Gets the related data for the sellable item entity"}},"additionalProperties":false,"description":"Represents the details of a sellable item entity, and its related data"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.Sellable.SellableItemRelatedData":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.Sellable.SellableItemRelatedData","kind":"json-schema","title":"SellableItemRelatedData","data":{"title":"SellableItemRelatedData","required":["discounts","item","itemModifierGroups"],"type":"object","properties":{"item":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.WeightBased.WeightBasedItem"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Recipe.RecipeItem"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ParentSales.ParentSalesItem"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Packages.PackageItem"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Normal.NormalItem"}],"description":"Represents the base properties of an item that is available for sale"},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Discounts.Discount"},"description":"Gets the list of related discount entities"},"itemModifierGroups":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Modifiers.ItemModifierGroup"},"description":"Gets the list of related item modifier group entities"}},"additionalProperties":false,"description":"Related data for a sellable item entity"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.ShowtimeDeliveryWindows.ItemShowtimeDeliveryWindowBase":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.ShowtimeDeliveryWindows.ItemShowtimeDeliveryWindowBase","kind":"json-schema","title":"ItemShowtimeDeliveryWindowBase","data":{"title":"ItemShowtimeDeliveryWindowBase","required":["id","name","type"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier","readOnly":true},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ShowtimeDeliveryWindows.ItemShowtimeDeliveryWindowType"}],"description":"Gets the type"}},"additionalProperties":false,"description":"Represents the base properties of a targeted item delivery time that is in the context of a showtime"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.ShowtimeDeliveryWindows.ItemShowtimeDeliveryWindowMinutesFromStart":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.ShowtimeDeliveryWindows.ItemShowtimeDeliveryWindowMinutesFromStart","kind":"json-schema","title":"ItemShowtimeDeliveryWindowMinutesFromStart","data":{"title":"ItemShowtimeDeliveryWindowMinutesFromStart","required":["minutes","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ShowtimeDeliveryWindows.ItemShowtimeDeliveryWindowBase"}],"properties":{"minutes":{"type":"integer","description":"Gets the targeted delivery time, as a number of minutes from showtime schedule StartsAt","format":"int32"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ShowtimeDeliveryWindows.ItemShowtimeDeliveryWindowType"}],"description":"Gets the type"}},"additionalProperties":false,"description":"Represents an item showtime delivery window base that is a number of minutes from showtime schedule StartsAt"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.ShowtimeDeliveryWindows.ItemShowtimeDeliveryWindowType":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.ShowtimeDeliveryWindows.ItemShowtimeDeliveryWindowType","kind":"json-schema","title":"ItemShowtimeDeliveryWindowType","data":{"title":"ItemShowtimeDeliveryWindowType","enum":["MinutesFromStart"],"type":"string","description":"Represents the type of an item showtime delivery window base"}},"components/schemas/Ocapi.V1.Sales.MasterData.Items.WeightBased.WeightBasedItem":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Items.WeightBased.WeightBasedItem","kind":"json-schema","title":"WeightBasedItem","data":{"title":"WeightBasedItem","required":["unitAbbreviation"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemBase"}],"properties":{"unitAbbreviation":{"minLength":1,"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ItemType"}]}},"additionalProperties":false,"description":"Represents an item base that is sold by weight, e.g. bulk candies"}},"components/schemas/Ocapi.V1.Sales.MasterData.OrderTipOptions.OrderTipOption":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.OrderTipOptions.OrderTipOption","kind":"json-schema","title":"OrderTipOption","data":{"title":"OrderTipOption","required":["isDefault","percentage"],"type":"object","properties":{"percentage":{"type":"integer","description":"Gets the amount to tip, as a percentage of the total cost of the standard order Items","format":"int32"},"isDefault":{"type":"boolean","description":"Gets a value indicating whether this option is applied to an in progress standard order by default"}},"additionalProperties":false,"description":"An option the patron can select to tip a specific percentage amount for an in progress standard order"}},"components/schemas/Ocapi.V1.Sales.MasterData.Prices.PriceDiscount":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Prices.PriceDiscount","kind":"json-schema","title":"PriceDiscount","data":{"title":"PriceDiscount","required":["amountSaved","calculation"],"type":"object","properties":{"calculation":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.DiscountCalculations.PercentageOffDiscountCalculation"},{"$ref":"#/components/schemas/Ocapi.V1.DiscountCalculations.PriceOffDiscountCalculation"},{"$ref":"#/components/schemas/Ocapi.V1.DiscountCalculations.SpecialPriceDiscountCalculation"}],"description":"Represents the base properties that describe the calculation of a discount"},"amountSaved":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the monetary amount saved compared to the default price"}},"additionalProperties":false,"description":"Represents the calculation logic and savings associated with a discounted price"}},"components/schemas/Ocapi.V1.Sales.MasterData.SalesTaxes.SalesTaxLevelType":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.SalesTaxes.SalesTaxLevelType","kind":"json-schema","title":"SalesTaxLevelType","data":{"title":"SalesTaxLevelType","enum":["FixedPrice","Percentage"],"type":"string","description":"Discriminator for various types of sales tax level base entities"}},"components/schemas/Ocapi.V1.Sales.MasterData.SubscriptionBillingOptions.SubscriptionBillingOption":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.SubscriptionBillingOptions.SubscriptionBillingOption","kind":"json-schema","title":"SubscriptionBillingOption","data":{"title":"SubscriptionBillingOption","required":["billingPeriodInMonths","id","isRecurring","name","prices","shortName","subscriptionId"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"description":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the description text, and its translations"},"shortName":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the short name text, and its translations"},"prices":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.SubscriptionBillingOptions.SubscriptionBillingOptionPrice"},"description":"Gets the list of subscription billing option price entities"},"subscriptionId":{"type":"integer","description":"Gets the unique identifier of the subscription","format":"int32"},"billingPeriodInMonths":{"type":"integer","description":"Gets the number of months between billing cycles","format":"int32"},"isRecurring":{"type":"boolean","description":"Gets a value indicating whether the billing option is purchased once or if payment\r\nis regularly taken after purchase"}},"additionalProperties":false,"description":"Represents a billing option for purchasing a new, or renewing an existing, subscription"}},"components/schemas/Ocapi.V1.Sales.MasterData.SubscriptionBillingOptions.SubscriptionBillingOptionListDetails":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.SubscriptionBillingOptions.SubscriptionBillingOptionListDetails","kind":"json-schema","title":"SubscriptionBillingOptionListDetails","data":{"title":"SubscriptionBillingOptionListDetails","required":["billingOptions","relatedData"],"type":"object","properties":{"billingOptions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.SubscriptionBillingOptions.SubscriptionBillingOption"},"description":"Gets the list of subscription billing option entities"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.SubscriptionBillingOptions.SubscriptionBillingOptionListRelatedData"}],"description":"Gets the related data for the subscription billing option entities"}},"additionalProperties":false,"description":"Represents a list of subscription billing option entities, and their related data"}},"components/schemas/Ocapi.V1.Sales.MasterData.SubscriptionBillingOptions.SubscriptionBillingOptionListRelatedData":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.SubscriptionBillingOptions.SubscriptionBillingOptionListRelatedData","kind":"json-schema","title":"SubscriptionBillingOptionListRelatedData","data":{"title":"SubscriptionBillingOptionListRelatedData","required":["discounts","subscriptions"],"type":"object","properties":{"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.MasterData.Subscriptions.Subscription"},"description":"Gets the list of related subscription entities"},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Discounts.Discount"},"description":"Gets the list of related discount entities"}},"additionalProperties":false,"description":"Related data for a list of subscription billing option entities"}},"components/schemas/Ocapi.V1.Sales.MasterData.SubscriptionBillingOptions.SubscriptionBillingOptionPrice":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.SubscriptionBillingOptions.SubscriptionBillingOptionPrice","kind":"json-schema","title":"SubscriptionBillingOptionPrice","data":{"title":"SubscriptionBillingOptionPrice","required":["isDefault","price","restrictions"],"type":"object","properties":{"price":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the price to be displayed to the customer"},"isDefault":{"type":"boolean","description":"Gets a value indicating whether this is the default price"},"discount":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Prices.PriceDiscount"}],"description":"Gets the discount details"},"restrictions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.SubscriptionBillingOptions.SubscriptionBillingOptionPriceRestriction"}},"discountId":{"type":"string","description":"Gets the unique identifier of the discount that the price is restricted to","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Represents the price of a subscription billing option that can be purchased"}},"components/schemas/Ocapi.V1.Sales.MasterData.SubscriptionBillingOptions.SubscriptionBillingOptionPriceRestriction":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.SubscriptionBillingOptions.SubscriptionBillingOptionPriceRestriction","kind":"json-schema","title":"SubscriptionBillingOptionPriceRestriction","data":{"title":"SubscriptionBillingOptionPriceRestriction","enum":["Discount"],"type":"string","description":"Represents the restriction options for a subscription billing option price"}},"components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTax":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTax","kind":"json-schema","title":"SalesTax","data":{"title":"SalesTax","required":["id","level1","level2","level3","level4"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"level1":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTaxLevelFixedPrice"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTaxLevelPercentage"}],"description":"Represents a tax level of a sales tax"},"level2":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTaxLevelFixedPrice"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTaxLevelPercentage"}],"description":"Represents a tax level of a sales tax"},"level3":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTaxLevelFixedPrice"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTaxLevelPercentage"}],"description":"Represents a tax level of a sales tax"},"level4":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTaxLevelFixedPrice"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTaxLevelPercentage"}],"description":"Represents a tax level of a sales tax"}},"additionalProperties":false,"description":"Represents the metadata of a sales tax"}},"components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTaxLevelFixedPrice":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTaxLevelFixedPrice","kind":"json-schema","title":"SalesTaxLevelFixedPrice","data":{"title":"SalesTaxLevelFixedPrice","required":["price","type"],"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.SalesTaxes.SalesTaxLevelType"}],"description":"Gets the type"},"price":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets the value of the fixed tax price, e.g. 5.00 to represent $5.00"},"children":[]}]}]}],"format":"double"}},"additionalProperties":false,"description":"Represents a fixed monetary value sales tax level base"}},"components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTaxLevelPercentage":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.Tax.SalesTaxLevelPercentage","kind":"json-schema","title":"SalesTaxLevelPercentage","data":{"title":"SalesTaxLevelPercentage","required":["percentage","type"],"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.SalesTaxes.SalesTaxLevelType"}],"description":"Gets the type"},"percentage":{"type":"number","description":"Gets the percentage","format":"double"}},"additionalProperties":false,"description":"Represents a percentage based sales tax level base"}},"components/schemas/Ocapi.V1.Sales.MasterData.ThirdPartyMemberTicketSchemes.ThirdPartyMemberScheme":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.ThirdPartyMemberTicketSchemes.ThirdPartyMemberScheme","kind":"json-schema","title":"ThirdPartyMemberScheme","data":{"title":"ThirdPartyMemberScheme","required":["cardNumberFormat","id","name","seatLimitPerCard"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"cardNumberFormat":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.ThirdPartyMemberTicketSchemes.ThirdPartyMemberSchemeCardNumberFormat"}],"description":"Gets the card number format"},"seatLimitPerCard":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Quantity"}],"description":"Gets the maximum number of admits or seats across all ticket types for the scheme that can be ordered for an\r\nindividual order ticket redemption card base for a specific showtime"}},"additionalProperties":false,"description":"Represents a third-party member scheme, used to purchase a ticket type base\r\nwith a ticket price restriction ThirdPartyMemberCard restriction"}},"components/schemas/Ocapi.V1.Sales.MasterData.ThirdPartyMemberTicketSchemes.ThirdPartyMemberSchemeCardNumberFormat":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.ThirdPartyMemberTicketSchemes.ThirdPartyMemberSchemeCardNumberFormat","kind":"json-schema","title":"ThirdPartyMemberSchemeCardNumberFormat","data":{"title":"ThirdPartyMemberSchemeCardNumberFormat","type":"object","properties":{"partialFormat":{"type":"string","description":"Gets the regular expression that can be used to determine whether a partially-entered card number matches the format","nullable":true},"fullFormat":{"type":"string","description":"Gets the regular expression that can be used to determine whether a full card number matches the format","nullable":true},"prefixLength":{"type":"integer","description":"Gets the prefix length","format":"int32"}},"additionalProperties":false,"description":"Represents the card number format for cards belonging to a third party member scheme"}},"components/schemas/Ocapi.V1.Sales.MasterData.ThirdPartyMemberTicketSchemes.ThirdPartyMemberSchemeListDetails":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.ThirdPartyMemberTicketSchemes.ThirdPartyMemberSchemeListDetails","kind":"json-schema","title":"ThirdPartyMemberSchemeListDetails","data":{"title":"ThirdPartyMemberSchemeListDetails","required":["thirdPartyMemberSchemes"],"type":"object","properties":{"thirdPartyMemberSchemes":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.ThirdPartyMemberTicketSchemes.ThirdPartyMemberScheme"},"description":"Gets the list of third party member scheme entities"}},"additionalProperties":false,"description":"Represents a list of third party member scheme entities"}},"components/schemas/Ocapi.V1.Sales.MasterData.TicketPrices.TicketPrice":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.TicketPrices.TicketPrice","kind":"json-schema","title":"TicketPrice","data":{"title":"TicketPrice","required":["displayPriority","isDefault","isShownAsPreviewWhenRestricted","price","restrictions","ticketTypeId","voucherTypeCodes"],"type":"object","properties":{"ticketTypeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the ticket type base"},"price":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.MonetaryValue"}],"description":"Gets the price to be displayed to the customer"},"isDefault":{"type":"boolean","description":"Gets a value indicating whether this is the default price"},"bookingFee":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.TicketPrices.TicketPriceBookingFee"}],"description":"Gets the booking fee that will be incurred, if applicable"},"restrictions":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.TicketPrices.TicketPriceRestriction"},"description":"Gets the restrictions that apply"},"rewardId":{"type":"integer","description":"Gets the unique identifier of the reward that the price is restricted to","format":"int32","nullable":true},"voucherTypeCodes":{"type":"array","items":{"type":"string"},"description":"Gets the list of unique identifiers of the voucher types that the price is restricted to"},"thirdPartyMemberSchemeId":{"type":"string","description":"Gets the unique identifier of the third party member scheme that the price is restricted to","nullable":true},"isShownAsPreviewWhenRestricted":{"type":"boolean","description":"Gets a value indicating whether this price should be previewed to the user if it is not available for purchase due to some unmet restriction"},"displayPriority":{"type":"integer","description":"Gets the display priority used for sorting","format":"int32"},"subscriptionId":{"type":"integer","description":"Gets the unique identifier of the subscription that the price is restricted to","format":"int32","nullable":true},"discountId":{"type":"string","description":"Gets the unique identifier of the discount that the price is restricted to","nullable":true,"readOnly":true},"discount":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Prices.PriceDiscount"}],"description":"Gets the discount details"}},"additionalProperties":false,"description":"Represents the price of a ticket type base that can be purchased"}},"components/schemas/Ocapi.V1.Sales.MasterData.TicketPrices.TicketPriceBookingFee":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.TicketPrices.TicketPriceBookingFee","kind":"json-schema","title":"TicketPriceBookingFee","data":{"title":"TicketPriceBookingFee","required":["amountIncludingTax"],"type":"object","properties":{"amountIncludingTax":{"type":"number","description":"Gets the monetary amount including tax to be displayed to the customer","format":"double"}},"additionalProperties":false,"description":"Represents a booking fee that will be incurred with the purchase of a ticket price"}},"components/schemas/Ocapi.V1.Sales.MasterData.TicketPrices.TicketPriceListDetails":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.TicketPrices.TicketPriceListDetails","kind":"json-schema","title":"TicketPriceListDetails","data":{"title":"TicketPriceListDetails","required":["relatedData","ticketPrices"],"type":"object","properties":{"ticketPrices":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.TicketPrices.TicketPrice"},"description":"Gets the list of ticket price entities"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.TicketPrices.TicketPriceListRelatedData"}],"description":"Gets the related data for the ticket price entities"}},"additionalProperties":false,"description":"Represents a list of ticket price entities, and their related data"}},"components/schemas/Ocapi.V1.Sales.MasterData.TicketPrices.TicketPriceListRelatedData":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.TicketPrices.TicketPriceListRelatedData","kind":"json-schema","title":"TicketPriceListRelatedData","data":{"title":"TicketPriceListRelatedData","required":["discounts","items","ticketTypes"],"type":"object","properties":{"ticketTypes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.Package.PackageTicketType"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.Normal.NormalTicketType"}],"description":"Represents the base properties of a ticket type"},"description":"Gets the list of related ticket type base entities"},"items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.WeightBased.WeightBasedItem"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Recipe.RecipeItem"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.ParentSales.ParentSalesItem"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Packages.PackageItem"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Items.Normal.NormalItem"}],"description":"Represents the base properties of an item that is available for sale"},"description":"Gets the list of related item base entities for any package ticket type entities"},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.Discounts.Discount"},"description":"Gets the list of related discount entities"}},"additionalProperties":false,"description":"Related data for a list of ticket price entities"}},"components/schemas/Ocapi.V1.Sales.MasterData.TicketPrices.TicketPriceRestriction":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.TicketPrices.TicketPriceRestriction","kind":"json-schema","title":"TicketPriceRestriction","data":{"title":"TicketPriceRestriction","enum":["Member","ThirdPartyMemberCard","Voucher","MemberReward","MemberSubscriptionCard","Discount"],"type":"string","description":"Represents the restriction options for a ticket price"}},"components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.Normal.NormalTicketType":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.Normal.NormalTicketType","kind":"json-schema","title":"NormalTicketType","data":{"title":"NormalTicketType","required":["type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.TicketTypeBase"}],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.TicketTypeType"}],"description":"Gets the type"}},"additionalProperties":false,"description":"Represents a normal ticket type base that contains a single ticket"}},"components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.Package.PackageTicketType":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.Package.PackageTicketType","kind":"json-schema","title":"PackageTicketType","data":{"title":"PackageTicketType","required":["items","tickets","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.TicketTypeBase"}],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.TicketTypeType"}],"description":"Gets the type"},"tickets":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.Package.PackageTicketTypeContentTicket"},"description":"Gets the list of package ticket type content ticket entities"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.Package.PackageTicketTypeContentItem"},"description":"Gets the list of package ticket type content item entities"}},"additionalProperties":false,"description":"Represents a ticket type base that has package contents"}},"components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.Package.PackageTicketTypeContentItem":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.Package.PackageTicketTypeContentItem","kind":"json-schema","title":"PackageTicketTypeContentItem","data":{"title":"PackageTicketTypeContentItem","required":["itemId","quantity"],"type":"object","properties":{"itemId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the item base"},"quantity":{"type":"integer","description":"Gets the quantity","format":"int32"}},"additionalProperties":false,"description":"Represents an item base within a package ticket type"}},"components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.Package.PackageTicketTypeContentTicket":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.Package.PackageTicketTypeContentTicket","kind":"json-schema","title":"PackageTicketTypeContentTicket","data":{"title":"PackageTicketTypeContentTicket","required":["quantity","ticketTypeId"],"type":"object","properties":{"ticketTypeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the normal ticket type"},"quantity":{"type":"integer","description":"Gets the quantity","format":"int32"}},"additionalProperties":false,"description":"Represents a normal ticket type within a package ticket type"}},"components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.TicketTypeBase":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.TicketTypeBase","kind":"json-schema","title":"TicketTypeBase","data":{"title":"TicketTypeBase","required":["areaCategoryId","description","displayPriority","hoCode","id","isChildTicket","isRestrictedToMembers","type"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.TicketTypeType"}],"description":"Gets the type."},"description":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the description text, and its translations."},"longDescription":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the long description text, and its translations."},"areaCategoryId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the area category the ticket type belongs to","readOnly":true},"isRestrictedToMembers":{"type":"boolean","description":"Gets a value indicating whether this ticket type is restricted to member entities"},"displayPriority":{"type":"integer","description":"Gets the display priority used for sorting","format":"int32"},"isChildTicket":{"type":"boolean","description":"Gets a value indicating whether this ticket is intended for children and may be subject to sale restrictions based on film and/or censor rating rules"},"hopk":{"type":"string","nullable":true},"ticketCode":{"type":"string","nullable":true},"hoCode":{"minLength":1,"type":"string"}},"additionalProperties":false}},"components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.TicketTypeType":{"id":"components/schemas/Ocapi.V1.Sales.MasterData.TicketTypes.TicketTypeType","kind":"json-schema","title":"TicketTypeType","data":{"title":"TicketTypeType","enum":["Normal","Package"],"type":"string","description":"Represents the type of a ticket type base entity"}},"components/schemas/Ocapi.V1.Seating.Availability.AreaCategorySeatAvailabilitySummary":{"id":"components/schemas/Ocapi.V1.Seating.Availability.AreaCategorySeatAvailabilitySummary","kind":"json-schema","title":"AreaCategorySeatAvailabilitySummary","data":{"title":"AreaCategorySeatAvailabilitySummary","required":["areaCategoryId","availableCount","totalCount"],"type":"object","properties":{"areaCategoryId":{"minLength":1,"type":"string"},"totalCount":{"type":"integer","format":"int32"},"availableCount":{"type":"integer","format":"int32"}},"additionalProperties":false,"description":"Represents a seat availability summary for an area category"}},"components/schemas/Ocapi.V1.Seating.Availability.SeatAvailability":{"id":"components/schemas/Ocapi.V1.Seating.Availability.SeatAvailability","kind":"json-schema","title":"SeatAvailability","data":{"title":"SeatAvailability","required":["seatId","status"],"type":"object","properties":{"seatId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the seat"},"status":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Seating.Availability.SeatAvailabilityStatus"}],"description":"Gets the availability status"}},"additionalProperties":false,"description":"Represents the current availability of a seat"}},"components/schemas/Ocapi.V1.Seating.Availability.SeatAvailabilityStatus":{"id":"components/schemas/Ocapi.V1.Seating.Availability.SeatAvailabilityStatus","kind":"json-schema","title":"SeatAvailabilityStatus","data":{"title":"SeatAvailabilityStatus","enum":["Available","Sold","Broken","House"],"type":"string","description":"Represents the availability status of a seat"}},"components/schemas/Ocapi.V1.Seating.Availability.SeatAvailabilitySummary":{"id":"components/schemas/Ocapi.V1.Seating.Availability.SeatAvailabilitySummary","kind":"json-schema","title":"SeatAvailabilitySummary","data":{"title":"SeatAvailabilitySummary","required":["availableCount","totalCount"],"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"availableCount":{"type":"integer","format":"int32"}},"additionalProperties":false}},"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailability":{"id":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailability","kind":"json-schema","title":"ShowtimeAvailability","data":{"title":"ShowtimeAvailability","required":["areaCategorySeatSummaries","isSoldOut","seatSummary","showtimeId"],"type":"object","properties":{"showtimeId":{"minLength":1,"type":"string","readOnly":true},"isSoldOut":{"type":"boolean"},"seatSummary":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Seating.Availability.AreaCategorySeatAvailabilitySummary"},{"$ref":"#/components/schemas/Ocapi.V1.Seating.Availability.SeatAvailabilitySummary"}],"description":"Represents a seat availability summary for a list of seat entities"},"areaCategorySeatSummaries":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Seating.Availability.AreaCategorySeatAvailabilitySummary"}}},"additionalProperties":false,"description":"Represents the current availability of a showtime"}},"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityDetails":{"id":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityDetails","kind":"json-schema","title":"ShowtimeAvailabilityDetails","data":{"title":"ShowtimeAvailabilityDetails","required":["showtimeAvailability"],"type":"object","properties":{"showtimeAvailability":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailability"}]}},"additionalProperties":false,"description":"Represents a showtime availability entity"}},"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityListDetails":{"id":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailabilityListDetails","kind":"json-schema","title":"ShowtimeAvailabilityListDetails","data":{"title":"ShowtimeAvailabilityListDetails","required":["showtimeAvailabilities"],"type":"object","properties":{"showtimeAvailabilities":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Seating.Availability.ShowtimeAvailability"}}},"additionalProperties":false,"description":"Represents a list of showtime availability entities"}},"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeSeatAvailability":{"id":"components/schemas/Ocapi.V1.Seating.Availability.ShowtimeSeatAvailability","kind":"json-schema","title":"ShowtimeSeatAvailability","data":{"title":"ShowtimeSeatAvailability","required":["areaCategorySummaries","isSoldOut","seatAvailabilities","summary"],"type":"object","properties":{"seatAvailabilities":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Seating.Availability.SeatAvailability"}},"isSoldOut":{"type":"boolean"},"summary":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Seating.Availability.AreaCategorySeatAvailabilitySummary"},{"$ref":"#/components/schemas/Ocapi.V1.Seating.Availability.SeatAvailabilitySummary"}],"description":"Represents a seat availability summary for a list of seat entities"},"areaCategorySummaries":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Seating.Availability.AreaCategorySeatAvailabilitySummary"}}},"additionalProperties":false,"description":"Represents a list of seat availability entities for a particular showtime"}},"components/schemas/Ocapi.V1.Seating.MasterData.Area":{"id":"components/schemas/Ocapi.V1.Seating.MasterData.Area","kind":"json-schema","title":"Area","data":{"title":"Area","required":["areaCategoryId","boundary","columnCount","name","number","rowCount","rows"],"type":"object","properties":{"number":{"type":"integer","description":"Gets the number that can be used to uniquely identify the area within the seat layout","format":"int32"},"areaCategoryId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the area category the area belongs to"},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"boundary":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.AreaBoundary"}],"description":"Gets the boundary"},"columnCount":{"type":"integer","description":"Gets the number of columns","format":"int32"},"rowCount":{"type":"integer","description":"Gets the number of rows","format":"int32"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.Row"},"description":"Gets the list of row entities"}},"additionalProperties":false,"description":"Represents an area (a block of seats) within a seat layout"}},"components/schemas/Ocapi.V1.Seating.MasterData.AreaBoundary":{"id":"components/schemas/Ocapi.V1.Seating.MasterData.AreaBoundary","kind":"json-schema","title":"AreaBoundary","data":{"title":"AreaBoundary","required":["bottom","left","right","top"],"type":"object","properties":{"left":{"type":"number","description":"Gets the leftmost coordinate, in grid units","format":"double"},"top":{"type":"number","description":"Gets the topmost coordinate, in grid units","format":"double"},"right":{"type":"number","description":"Gets the rightmost coordinate, in grid units","format":"double"},"bottom":{"type":"number","description":"Gets the bottommost coordinate, in grid units","format":"double"}},"additionalProperties":false,"description":"Represents a set of four grid coordinates that describe the position and dimensions of an area within the seat layout"}},"components/schemas/Ocapi.V1.Seating.MasterData.AreaCategory":{"id":"components/schemas/Ocapi.V1.Seating.MasterData.AreaCategory","kind":"json-schema","title":"AreaCategory","data":{"title":"AreaCategory","required":["id","isAllocatedSeating","isInSeatItemDeliveryAvailable","name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier","readOnly":true},"name":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the name text, and its translations"},"hopk":{"type":"string","description":"Gets the Head Office primary key","nullable":true},"isAllocatedSeating":{"type":"boolean","description":"Gets a value indicating whether the seat entities are allocated"},"isInSeatItemDeliveryAvailable":{"type":"boolean","description":"Gets a value indicating whether in-seat item delivery is available for seats belonging to this area category"}},"additionalProperties":false,"description":"Represents the classification of one or more area entities"}},"components/schemas/Ocapi.V1.Seating.MasterData.Row":{"id":"components/schemas/Ocapi.V1.Seating.MasterData.Row","kind":"json-schema","title":"Row","data":{"title":"Row","required":["label","number","seats"],"type":"object","properties":{"number":{"type":"integer","description":"Gets the number that can be used to uniquely identify the row within the area","format":"int32"},"label":{"minLength":1,"type":"string","description":"Gets the label/physical name","example":"G"},"seats":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.Seat"},"description":"Gets the list of seat entities"}},"additionalProperties":false,"description":"Represents a row of seat entities within an area"}},"components/schemas/Ocapi.V1.Seating.MasterData.ScreenBoundary":{"id":"components/schemas/Ocapi.V1.Seating.MasterData.ScreenBoundary","kind":"json-schema","title":"ScreenBoundary","data":{"title":"ScreenBoundary","required":["left","right"],"type":"object","properties":{"left":{"type":"number","description":"Gets the leftmost coordinate, in grid units","format":"double"},"right":{"type":"number","description":"Gets the rightmost coordinate, in grid units","format":"double"}},"additionalProperties":false,"description":"Represents a pair of grid coordinates that describe the width of the screen within the seat layout"}},"components/schemas/Ocapi.V1.Seating.MasterData.Seat":{"id":"components/schemas/Ocapi.V1.Seating.MasterData.Seat","kind":"json-schema","title":"Seat","data":{"title":"Seat","required":["areaCategoryId","id","position","rowLabel","seatGroupIds","type"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the seat within the seat layout"},"position":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.SeatPosition"}],"description":"Gets the position"},"seatGroupIds":{"type":"array","items":{"type":"string"},"description":"Gets the list of unique identifiers of the seat entities that share the same group"},"label":{"type":"string","description":"Gets the label/physical name of the seat","nullable":true,"example":"5"},"rowLabel":{"minLength":1,"type":"string","description":"Gets the label/physical name of the row","example":"G"},"areaCategoryId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the area category the seat belongs to"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.SeatType"}],"description":"Gets the type"}},"additionalProperties":false,"description":"Represents a space within a row that a single customer may occupy during a showtime"}},"components/schemas/Ocapi.V1.Seating.MasterData.SeatLayout":{"id":"components/schemas/Ocapi.V1.Seating.MasterData.SeatLayout","kind":"json-schema","title":"SeatLayout","data":{"title":"SeatLayout","required":["areas","boundary","id","screenBoundary","screenId"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the unique identifier","readOnly":true},"screenId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the screen"},"boundary":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.SeatLayoutBoundary"}],"description":"Gets the boundary"},"screenBoundary":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.ScreenBoundary"}],"description":"Gets the screen boundary"},"areas":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.Area"},"description":"Gets the list area entities"}},"additionalProperties":false,"description":"Represents a floor plan associated with a screen"}},"components/schemas/Ocapi.V1.Seating.MasterData.SeatLayoutBoundary":{"id":"components/schemas/Ocapi.V1.Seating.MasterData.SeatLayoutBoundary","kind":"json-schema","title":"SeatLayoutBoundary","data":{"title":"SeatLayoutBoundary","required":["left","right","top"],"type":"object","properties":{"right":{"type":"number","description":"Gets the rightmost coordinate, in grid units","format":"double"},"left":{"type":"number","description":"Gets the leftmost coordinate, in grid units","format":"double"},"top":{"type":"number","description":"Gets the topmost coordinate, in grid units","format":"double"}},"additionalProperties":false,"description":"Represents a set of three grid coordinates that describe the boundary of a seat layout"}},"components/schemas/Ocapi.V1.Seating.MasterData.SeatLayoutDetails":{"id":"components/schemas/Ocapi.V1.Seating.MasterData.SeatLayoutDetails","kind":"json-schema","title":"SeatLayoutDetails","data":{"title":"SeatLayoutDetails","required":["relatedData","seatLayout"],"type":"object","properties":{"seatLayout":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.SeatLayout"}],"description":"Gets the seat layout entity"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.SeatLayoutRelatedData"}],"description":"Gets the related data for the seat layout entity"}},"additionalProperties":false,"description":"Represents the details of a seat layout entity, and its related data"}},"components/schemas/Ocapi.V1.Seating.MasterData.SeatLayoutRelatedData":{"id":"components/schemas/Ocapi.V1.Seating.MasterData.SeatLayoutRelatedData","kind":"json-schema","title":"SeatLayoutRelatedData","data":{"title":"SeatLayoutRelatedData","required":["areaCategories","screen"],"type":"object","properties":{"screen":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Screens.Screen"}],"description":"Gets the related screen entity"},"areaCategories":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Seating.MasterData.AreaCategory"},"description":"Gets the list of related area category entities"}},"additionalProperties":false,"description":"Related data for a seat layout entity"}},"components/schemas/Ocapi.V1.Seating.MasterData.SeatPosition":{"id":"components/schemas/Ocapi.V1.Seating.MasterData.SeatPosition","kind":"json-schema","title":"SeatPosition","data":{"title":"SeatPosition","required":["areaNumber","columnNumber","rowNumber"],"type":"object","properties":{"areaNumber":{"type":"integer","description":"Gets the number that can be used to uniquely identify the area within the seat layout","format":"int32"},"columnNumber":{"type":"integer","description":"Gets the number that can be used to uniquely identify the column of the seat entity within the area","format":"int32"},"rowNumber":{"type":"integer","description":"Gets the number that can be used to uniquely identify the row within the area","format":"int32"}},"additionalProperties":false,"description":"Represents the position of a seat within the seat layout"}},"components/schemas/Ocapi.V1.Seating.MasterData.SeatType":{"id":"components/schemas/Ocapi.V1.Seating.MasterData.SeatType","kind":"json-schema","title":"SeatType","data":{"title":"SeatType","enum":["Normal","Wheelchair","Companion","SofaLeft","SofaMiddle","SofaRight"],"type":"string","description":"Represents the type of a seat"}},"components/schemas/Ocapi.V1.Surveys.Questions.FilmRatingScaleSurveyQuestion":{"id":"components/schemas/Ocapi.V1.Surveys.Questions.FilmRatingScaleSurveyQuestion","kind":"json-schema","title":"FilmRatingScaleSurveyQuestion","data":{"title":"FilmRatingScaleSurveyQuestion","required":["displayType","filmId","id","isRequired","number","range","title","type"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the question within the survey"},"number":{"type":"integer","description":"Gets the number that can be used to uniquely identify the question within the survey page","format":"int32"},"title":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the title text, and its translations"},"isRequired":{"type":"boolean","description":"Gets a value indicating whether a response is required"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.SurveyQuestionType"}],"description":"Gets the type"},"displayType":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.RatingScaleSurveyQuestionDisplayType"}],"description":"Gets the display type"},"range":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.RatingScaleSurveyQuestionRange"}],"description":"Gets the range"},"notApplicableOptionField":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.SurveyQuestionNotApplicableOptionField"}],"description":"Gets the survey question not applicable option field entity, if applicable"},"commentField":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.SurveyQuestionComment"}],"description":"Gets the survey question comment field entity, if applicable"},"filmId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the film"}},"additionalProperties":false,"description":"Represents a rating scale survey question that asks the patron to rate an associated film"}},"components/schemas/Ocapi.V1.Surveys.Questions.FilmSuggestionYesNoUnsureSurveyQuestion":{"id":"components/schemas/Ocapi.V1.Surveys.Questions.FilmSuggestionYesNoUnsureSurveyQuestion","kind":"json-schema","title":"FilmSuggestionYesNoUnsureSurveyQuestion","data":{"title":"FilmSuggestionYesNoUnsureSurveyQuestion","required":["filmId","id","isRequired","noOptionLabel","number","title","type","unsureOptionLabel","yesOptionLabel"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the question within the survey"},"number":{"type":"integer","description":"Gets the number that can be used to uniquely identify the question within the survey page","format":"int32"},"title":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the title text, and its translations"},"isRequired":{"type":"boolean","description":"Gets a value indicating whether a response is required"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.SurveyQuestionType"}],"description":"Gets the type"},"yesOptionLabel":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the label for the \"Yes\" option"},"noOptionLabel":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the label for the \"No\" option"},"unsureOptionLabel":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the label for the \"Unsure\" option"},"filmId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the film"}},"additionalProperties":false,"description":"Represents a yes no unsure survey question associated with a suggested film"}},"components/schemas/Ocapi.V1.Surveys.Questions.RatingScaleSurveyQuestion":{"id":"components/schemas/Ocapi.V1.Surveys.Questions.RatingScaleSurveyQuestion","kind":"json-schema","title":"RatingScaleSurveyQuestion","data":{"title":"RatingScaleSurveyQuestion","required":["displayType","id","isRequired","number","range","title","type"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the question within the survey"},"number":{"type":"integer","description":"Gets the number that can be used to uniquely identify the question within the survey page","format":"int32"},"title":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the title text, and its translations"},"isRequired":{"type":"boolean","description":"Gets a value indicating whether a response is required"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.SurveyQuestionType"}],"description":"Gets the type"},"displayType":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.RatingScaleSurveyQuestionDisplayType"}],"description":"Gets the display type"},"range":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.RatingScaleSurveyQuestionRange"}],"description":"Gets the range"},"notApplicableOptionField":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.SurveyQuestionNotApplicableOptionField"}],"description":"Gets the survey question not applicable option field entity, if applicable"},"commentField":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.SurveyQuestionComment"}],"description":"Gets the survey question comment field entity, if applicable"}},"additionalProperties":false,"description":"Represents a survey question base of type survey question type RatingScale"}},"components/schemas/Ocapi.V1.Surveys.Questions.RatingScaleSurveyQuestionDisplayType":{"id":"components/schemas/Ocapi.V1.Surveys.Questions.RatingScaleSurveyQuestionDisplayType","kind":"json-schema","title":"RatingScaleSurveyQuestionDisplayType","data":{"title":"RatingScaleSurveyQuestionDisplayType","enum":["Stars","Numbers"],"type":"string","description":"Represents the display type of a rating scale survey question"}},"components/schemas/Ocapi.V1.Surveys.Questions.RatingScaleSurveyQuestionRange":{"id":"components/schemas/Ocapi.V1.Surveys.Questions.RatingScaleSurveyQuestionRange","kind":"json-schema","title":"RatingScaleSurveyQuestionRange","data":{"title":"RatingScaleSurveyQuestionRange","required":["maximum","minimum","step"],"type":"object","properties":{"minimum":{"type":"number","description":"Gets the minimum value","format":"double"},"maximum":{"type":"number","description":"Gets the maximum value","format":"double"},"step":{"type":"number","description":"Gets the step value","format":"double"},"minimumLabel":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the label for the rating scale survey question range Minimum value, and its translations, if applicable"},"maximumLabel":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the label for the rating scale survey question range Maximum value, and its translations, if applicable"}},"additionalProperties":false,"description":"Represents the range for a rating scale associated with a rating scale survey question"}},"components/schemas/Ocapi.V1.Surveys.Questions.SurveyQuestionComment":{"id":"components/schemas/Ocapi.V1.Surveys.Questions.SurveyQuestionComment","kind":"json-schema","title":"SurveyQuestionComment","data":{"title":"SurveyQuestionComment","required":["label","maximumLength","minimumLength"],"type":"object","properties":{"label":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the label text, and its translations"},"minimumLength":{"type":"integer","description":"Gets the minimum comment length","format":"int32"},"maximumLength":{"type":"integer","description":"Gets the maximum comment length","format":"int32"}},"additionalProperties":false,"description":"Represents the comment field for a survey question base"}},"components/schemas/Ocapi.V1.Surveys.Questions.SurveyQuestionNotApplicableOptionField":{"id":"components/schemas/Ocapi.V1.Surveys.Questions.SurveyQuestionNotApplicableOptionField","kind":"json-schema","title":"SurveyQuestionNotApplicableOptionField","data":{"title":"SurveyQuestionNotApplicableOptionField","required":["label"],"type":"object","properties":{"label":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the label text, and its translations"}},"additionalProperties":false,"description":"Represents the \"not applicable\" option field for a survey question base"}},"components/schemas/Ocapi.V1.Surveys.Questions.SurveyQuestionType":{"id":"components/schemas/Ocapi.V1.Surveys.Questions.SurveyQuestionType","kind":"json-schema","title":"SurveyQuestionType","data":{"title":"SurveyQuestionType","enum":["RatingScale","Text","YesNoUnsure"],"type":"string","description":"Represents the type of a survey question base"}},"components/schemas/Ocapi.V1.Surveys.Questions.TextSurveyQuestion":{"id":"components/schemas/Ocapi.V1.Surveys.Questions.TextSurveyQuestion","kind":"json-schema","title":"TextSurveyQuestion","data":{"title":"TextSurveyQuestion","required":["format","id","isRequired","number","title","type"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the question within the survey"},"number":{"type":"integer","description":"Gets the number that can be used to uniquely identify the question within the survey page","format":"int32"},"title":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the title text, and its translations"},"isRequired":{"type":"boolean","description":"Gets a value indicating whether a response is required"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.SurveyQuestionType"}],"description":"Gets the type"},"format":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.TextSurveyQuestionFormat"}],"description":"Gets the format"}},"additionalProperties":false,"description":"Represents a survey question base of type survey question type Text"}},"components/schemas/Ocapi.V1.Surveys.Questions.TextSurveyQuestionFormat":{"id":"components/schemas/Ocapi.V1.Surveys.Questions.TextSurveyQuestionFormat","kind":"json-schema","title":"TextSurveyQuestionFormat","data":{"title":"TextSurveyQuestionFormat","required":["isMultiline","maximumLength","minimumLength"],"type":"object","properties":{"isMultiline":{"type":"boolean","description":"Gets a value indicating whether the response input should be displayed as multiline"},"minimumLength":{"type":"integer","description":"Gets the minimum response length","format":"int32"},"maximumLength":{"type":"integer","description":"Gets the maximum response length","format":"int32"}},"additionalProperties":false,"description":"Represents the required response format for a text survey question"}},"components/schemas/Ocapi.V1.Surveys.Questions.YesNoUnsureSurveyQuestion":{"id":"components/schemas/Ocapi.V1.Surveys.Questions.YesNoUnsureSurveyQuestion","kind":"json-schema","title":"YesNoUnsureSurveyQuestion","data":{"title":"YesNoUnsureSurveyQuestion","required":["id","isRequired","noOptionLabel","number","title","type","unsureOptionLabel","yesOptionLabel"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Gets the identifier that can be used to uniquely identify the question within the survey"},"number":{"type":"integer","description":"Gets the number that can be used to uniquely identify the question within the survey page","format":"int32"},"title":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the title text, and its translations"},"isRequired":{"type":"boolean","description":"Gets a value indicating whether a response is required"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.SurveyQuestionType"}],"description":"Gets the type"},"yesOptionLabel":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the label for the \"Yes\" option"},"noOptionLabel":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the label for the \"No\" option"},"unsureOptionLabel":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the label for the \"Unsure\" option"}},"additionalProperties":false,"description":"Represents a survey question base of type survey question type YesNoUnsure"}},"components/schemas/Ocapi.V1.Surveys.RelatedData.SurveyRelatedData":{"id":"components/schemas/Ocapi.V1.Surveys.RelatedData.SurveyRelatedData","kind":"json-schema","title":"SurveyRelatedData","data":{"title":"SurveyRelatedData","required":["films"],"type":"object","properties":{"films":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Surveys.RelatedData.SurveyRelatedFilm"},"description":"Gets the list of survey related film entities"}},"additionalProperties":false,"description":"Related data for a survey entity"}},"components/schemas/Ocapi.V1.Surveys.RelatedData.SurveyRelatedFilm":{"id":"components/schemas/Ocapi.V1.Surveys.RelatedData.SurveyRelatedFilm","kind":"json-schema","title":"SurveyRelatedFilm","data":{"title":"SurveyRelatedFilm","required":["externalIds","id","title"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"title":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}]},"externalIds":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Films.FilmExternalIds"}]}},"additionalProperties":false,"description":"Represents the film data related to a survey"}},"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate":{"id":"components/schemas/Ocapi.V1.Surveys.Requests.SurveyResponsesUpdate","kind":"json-schema","title":"SurveyResponsesUpdate","data":{"title":"SurveyResponsesUpdate","required":["isCompleted","responses"],"type":"object","properties":{"responses":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Responses.RatingScaleSurveyQuestionResponse"},{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Responses.TextSurveyQuestionResponse"},{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Responses.YesNoUnsureSurveyQuestionResponse"}],"description":"Represents the base properties of a response to a survey question base"},"description":"Gets the list of survey question response base entities"},"isCompleted":{"type":"boolean","description":"Gets a value indicating whether the survey is completed"},"languageTag":{"type":"string","description":"Gets the IETF (RFC 4646) language tag","nullable":true}},"additionalProperties":false,"description":"Represents the values needed to update the responses for a survey"}},"components/schemas/Ocapi.V1.Surveys.Responses.RatingScaleSurveyQuestionResponse":{"id":"components/schemas/Ocapi.V1.Surveys.Responses.RatingScaleSurveyQuestionResponse","kind":"json-schema","title":"RatingScaleSurveyQuestionResponse","data":{"title":"RatingScaleSurveyQuestionResponse","required":["questionId","type"],"type":"object","properties":{"questionId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the survey question base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.SurveyQuestionType"}],"description":"Gets the question type"},"response":{"type":"number","description":"Gets the response, if applicable","format":"double","nullable":true},"isNotApplicableOptionSelected":{"type":"boolean","description":"Gets a value indicating whether the \"not applicable\" option was selected by the patron, if applicable","nullable":true},"comment":{"type":"string","description":"Gets the comment, if applicable","nullable":true}},"additionalProperties":false,"description":"Represents the patron's response to a rating scale survey question"}},"components/schemas/Ocapi.V1.Surveys.Responses.TextSurveyQuestionResponse":{"id":"components/schemas/Ocapi.V1.Surveys.Responses.TextSurveyQuestionResponse","kind":"json-schema","title":"TextSurveyQuestionResponse","data":{"title":"TextSurveyQuestionResponse","required":["questionId","type"],"type":"object","properties":{"questionId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the survey question base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.SurveyQuestionType"}],"description":"Gets the question type"},"response":{"type":"string","description":"Gets the response, if applicable","nullable":true}},"additionalProperties":false,"description":"Represents the patron's response to a text survey question"}},"components/schemas/Ocapi.V1.Surveys.Responses.YesNoUnsureResponse":{"id":"components/schemas/Ocapi.V1.Surveys.Responses.YesNoUnsureResponse","kind":"json-schema","title":"YesNoUnsureResponse","data":{"title":"YesNoUnsureResponse","enum":["Yes","No","Unsure"],"type":"string","description":"Represents the possible responses to a yes no unsure survey question"}},"components/schemas/Ocapi.V1.Surveys.Responses.YesNoUnsureSurveyQuestionResponse":{"id":"components/schemas/Ocapi.V1.Surveys.Responses.YesNoUnsureSurveyQuestionResponse","kind":"json-schema","title":"YesNoUnsureSurveyQuestionResponse","data":{"title":"YesNoUnsureSurveyQuestionResponse","required":["questionId","type"],"type":"object","properties":{"questionId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the survey question base"},"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.SurveyQuestionType"}],"description":"Gets the question type"},"response":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Responses.YesNoUnsureResponse"}],"description":"Gets the response, if applicable"}},"additionalProperties":false,"description":"Represents the patron's response to a yes no unsure survey question"}},"components/schemas/Ocapi.V1.Surveys.Survey":{"id":"components/schemas/Ocapi.V1.Surveys.Survey","kind":"json-schema","title":"Survey","data":{"title":"Survey","required":["expiresAt","isCompleted","pages","responses","title"],"type":"object","properties":{"expiresAt":{"type":"string","description":"Gets the date and time that the survey is set to expire","format":"date-time"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Surveys.SurveyPage"},"description":"Gets the list of survey page entities, sorted by survey page Number"},"title":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}],"description":"Gets the title text, and its translations"},"responses":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Responses.RatingScaleSurveyQuestionResponse"},{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Responses.TextSurveyQuestionResponse"},{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Responses.YesNoUnsureSurveyQuestionResponse"}],"description":"Represents the base properties of a response to a survey question base"},"description":"Gets the list of existing survey question response base entities"},"isCompleted":{"type":"boolean","description":"Gets a value indicating whether the survey is completed"}},"additionalProperties":false,"description":"Represents a survey which allows a patron to provide feedback about their experience"}},"components/schemas/Ocapi.V1.Surveys.SurveyDetails":{"id":"components/schemas/Ocapi.V1.Surveys.SurveyDetails","kind":"json-schema","title":"SurveyDetails","data":{"title":"SurveyDetails","required":["relatedData","survey"],"type":"object","properties":{"survey":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Survey"}],"description":"Gets the survey entity"},"relatedData":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.RelatedData.SurveyRelatedData"}],"description":"Gets the related data"}},"additionalProperties":false,"description":"Represents the details of a survey and its related data"}},"components/schemas/Ocapi.V1.Surveys.SurveyPage":{"id":"components/schemas/Ocapi.V1.Surveys.SurveyPage","kind":"json-schema","title":"SurveyPage","data":{"title":"SurveyPage","required":["number","questions"],"type":"object","properties":{"number":{"type":"integer","description":"Gets the number that can be used to uniquely identify the page within the survey","format":"int32"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.FilmRatingScaleSurveyQuestion"},{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.FilmSuggestionYesNoUnsureSurveyQuestion"},{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.RatingScaleSurveyQuestion"},{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.TextSurveyQuestion"},{"$ref":"#/components/schemas/Ocapi.V1.Surveys.Questions.YesNoUnsureSurveyQuestion"}],"description":"Represents the base properties of a question in a survey"},"description":"Gets the list of survey question base entities, sorted by survey question base Number"},"title":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.Translatable"}]}},"additionalProperties":false,"description":"Represents a page in a survey"}},"components/schemas/Ocapi.V1.TicketRedemptionCards.ThirdPartyMemberCardCredentials":{"id":"components/schemas/Ocapi.V1.TicketRedemptionCards.ThirdPartyMemberCardCredentials","kind":"json-schema","title":"ThirdPartyMemberCardCredentials","data":{"title":"ThirdPartyMemberCardCredentials","required":["cardNumber","thirdPartyMemberSchemeId"],"type":"object","properties":{"cardNumber":{"minLength":1,"type":"string","description":"Gets the card number"},"thirdPartyMemberSchemeId":{"minLength":1,"type":"string","description":"Gets the unique identifier of the third party member scheme"}},"additionalProperties":false,"description":"Represents the credentials required to identify and validate a third-party member card"}},"components/schemas/Ocapi.V1.TicketRedemptionCards.TicketRedemptionCardBase":{"id":"components/schemas/Ocapi.V1.TicketRedemptionCards.TicketRedemptionCardBase","kind":"json-schema","title":"TicketRedemptionCardBase","data":{"title":"TicketRedemptionCardBase","required":["maskedCardNumber","type"],"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.TicketRedemptionCards.TicketRedemptionCardType"}],"description":"Gets the type"},"maskedCardNumber":{"minLength":1,"type":"string","description":"Gets a masked representation of the card number","example":"12.......6789"},"memberName":{"allOf":[{"$ref":"#/components/schemas/Ocapi.V1.PersonName"}],"description":"Gets the name of the person that owns the card, if known"}},"additionalProperties":false,"description":"Represents the base properties of a card that can be redeemed to purchase tickets"}},"components/schemas/Ocapi.V1.TicketRedemptionCards.TicketRedemptionCardType":{"id":"components/schemas/Ocapi.V1.TicketRedemptionCards.TicketRedemptionCardType","kind":"json-schema","title":"TicketRedemptionCardType","data":{"title":"TicketRedemptionCardType","enum":["MemberSubscriptionCard","ThirdPartyMemberCard"],"type":"string","description":"Represents the type of a ticket redemption card base"}},"components/schemas/Ocapi.V1.Translatable":{"id":"components/schemas/Ocapi.V1.Translatable","kind":"json-schema","title":"Translatable","data":{"title":"Translatable","required":["text","translations"],"type":"object","properties":{"text":{"minLength":1,"type":"string","description":"Gets the text in the default language"},"translations":{"type":"array","items":{"$ref":"#/components/schemas/Ocapi.V1.Translation"},"description":"Gets the translations of the translatable Text in other languages"}},"additionalProperties":false,"description":"Represents some customer-visible translatable Text in the default language, and a list of translation entities"}},"components/schemas/Ocapi.V1.Translation":{"id":"components/schemas/Ocapi.V1.Translation","kind":"json-schema","title":"Translation","data":{"title":"Translation","required":["languageTag","text"],"type":"object","properties":{"languageTag":{"minLength":1,"type":"string","description":"Gets the IETF (RFC 4646) language tag that the translation Text has been translated for","example":"en-US"},"text":{"minLength":1,"type":"string","description":"Gets the translated text"}},"additionalProperties":false,"description":"Represents some translated customer-visible translation Text"}},"components/schemas/Ocapi.V1.Vouchers.VoucherCredentials":{"id":"components/schemas/Ocapi.V1.Vouchers.VoucherCredentials","kind":"json-schema","title":"VoucherCredentials","data":{"title":"VoucherCredentials","required":["barcode"],"type":"object","properties":{"barcode":{"minLength":1,"type":"string","description":"Gets the barcode"},"pin":{"type":"string","description":"Gets the PIN","nullable":true}},"additionalProperties":false,"description":"Represents the details required to validate a voucher"}},"components/schemas/Ocapi.V1.Vouchers.VoucherType":{"id":"components/schemas/Ocapi.V1.Vouchers.VoucherType","kind":"json-schema","title":"VoucherType","data":{"title":"VoucherType","enum":["Ticket","Subscription","Deal"],"type":"string","description":"Represents the type of a voucher"}},"components/schemas/System.DayOfWeek":{"id":"components/schemas/System.DayOfWeek","kind":"json-schema","title":"System.DayOfWeek","data":{"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"}},"components/schemas/Vista.Connect.OrderType":{"id":"components/schemas/Vista.Connect.OrderType","kind":"json-schema","title":"OrderType","data":{"title":"OrderType","enum":["Standard","GiftShop","Subscription","Tab"],"type":"string"}},"schema_33":{"kind":"json-schema","data":{"type":"string"},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"string","format":"byte"},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","default":0},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemCounterPickup"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemCustomLocationDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemDiningLocationDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemElectronicDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemInSeatDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemPostalDelivery"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Items.Deliveries.Completed.CompletedOrderItemServiceAreaPickup"}],"description":"Represents the base properties of an order item delivery base for a completed order base"},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Completions.OrderCompletion"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Completions.StandardOrderCompletion"}],"description":"Represents the completion of an in progress order base"},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.Vouchers.Requests.OrderDealVoucherRequest"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Vouchers.Requests.OrderSubscriptionVoucherRequest"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.Vouchers.Requests.OrderTicketVoucherRequest"}],"description":"Represents the information required to add an order voucher to an in progress order base"},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.Availability.DiscountAvailabilityListDetails"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.Availability.SiteDiscountAvailabilityListDetails"}],"description":"Represents a list of discount availability entities"},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeBusinessDayListDetails"},{"$ref":"#/components/schemas/Ocapi.V1.Browsing.MasterData.Showtimes.ShowtimeListDetails"}],"description":"Represents a list of showtime entities, and their related data"},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Sales.Availability.ItemAvailabilityListDetails"},{"$ref":"#/components/schemas/Ocapi.V1.Sales.Availability.SiteItemAvailabilityListDetails"}],"description":"Represents a list of item availability entities"},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"required":["grant_type"],"type":"object","properties":{"grant_type":{"type":"string"},"card_number":{"type":"string"},"phone_number":{"type":"string"},"pin":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"password":{"type":"string"},"club_id":{"type":"string"}}},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"required":["grant_type"],"type":"object","properties":{"grant_type":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"password":{"type":"string"},"refresh_token":{"type":"string"},"club_id":{"type":"string"},"remember":{"type":"boolean"},"external_issuer_id":{"type":"string"},"external_token":{"type":"string"}}},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Delete.ExternallyAuthenticatedMemberDelete"},{"$ref":"#/components/schemas/Ocapi.V1.Loyalty.Delete.LoyaltyAuthenticatedMemberDelete"}],"description":"Represents the values needed to securely delete a member"},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":50},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":0},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"type":"object","properties":{"ContentType":{"type":"string"},"ContentDisposition":{"type":"string"},"Headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Length":{"type":"integer","format":"int64"},"Name":{"type":"string"},"FileName":{"type":"string"}}},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":10},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Vista.Connect.OrderType"},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.Requests.OrderMemberTicketRedemptionCardRequest"},{"$ref":"#/components/schemas/Ocapi.V1.Orders.TicketRedemptionCards.Requests.OrderThirdPartyMemberCardRequest"}],"description":"Represents the information required to add an order ticket redemption card base to an in progress standard order"},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_58"}},"exampleStore":{},"securitySchemeStore":{},"servers":[{"url":"/_mock/openapi/digital-platform/openapi","isMockServer":true,"description":"Mock server"}],"specType":"openapi"},"options":{"hideReplay":true,"codeSamples":{"languages":[{"lang":"curl","label":"cURL"},{"lang":"JavaScript","label":"JavaScript"},{"lang":"Node.js","label":"Node.js"}]},"feedback":{"hide":true,"settings":{"label":""}},"mockServer":{"url":"/_mock/openapi/digital-platform/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/digital-platform/openapi.json?download"},{"url":"/_bundle/openapi/digital-platform/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Vista Digital Platform"}},"baseSlug":"/openapi/digital-platform/openapi","routesMapping":{}}