v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB
Completed Orders

Starts preparation of items in a completed standard order

Calling this endpoint will also set the CollectionStatus of the items to Collected.

It is not necessary to call this endpoint if SetOrderAsCollected had been called prior as the concession items that require preparing will have already been sent to the kitchen.

Licenses Required

  • Vista.Ocapi
post/ocapi/v1/orders/completed/{orderId}/preparation

Path parameters

orderIdstring required

The unique identifier of the completed standard order that is to be prepared for collection

Headers

Connect-Region-Codestring

Region Code

Response

Success

collectionNumberinteger nullable

Gets the number generated by the site that can be used to collect the completed standard order when the order preparation Status equals order preparation status Completed

status'NotStarted' | 'Started' | 'Completed' | 'Collected' | 'Cancelled' required

Represents the status of an order preparation