Items

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

Changed on Oct 22, 2026

Existing items on the order will be replaced with the specified selections.

Note: Items with attached scarcity such as items with selling limits currently may fail on repeated PUT as this API is currently not fully atomic.

If the order contains showtimes (see standard order Showtimes), item availability will be based on the earliest showtime.

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.

For in progress tab order entities, use AddItems instead.

Licenses Required

Vista.Ocapi

put/ocapi/v1/orders/{orderId}/items

Request

Base URL
https://developer.vista.co (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/vista/apis/vista-digital-platform/docs/ocapi/v1/orders/:orderId/items/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

orderIdstring required

The unique identifier of the in progress order base being modified

Headers

Connect-Region-Codestring

Region Code

Request body

itemDeliveriesCommentstring nullable

Gets the comment that applies to all order item delivery with comment entities (including any default deliveries)

Response

Order items

Changes

Oct 22, 2026c46f30854000 Revision changes
- info
  added the optional property // to the response with the status
- info
  added the optional property //// to the response with the status
Oct 9, 202641415d239083 Revision changes
- breaking
  added to the response property oneOf list for the response status
- breaking
  added to the /// response property oneOf list for the response status
- breaking
  added to the /// response property oneOf list for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the /////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the /////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the /////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the /////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the /////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the /////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the /////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the /////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the /////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the /////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the /////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the /////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new DiningLocationDelivery enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new PaymentCard enum value to the ////// response property for the response status
- warning
  added the new Tab enum value to the /// response property for the response status
- warning
  added the new Tab enum value to the /// response property for the response status
- warning
  added the new Tab enum value to the /// response property for the response status
- info
  added the new optional request property /// (media type: application/json)
- info
  added the new optional request property /// (media type: text/json)
- info
  added the new optional request property /// (media type: application/*+json)
- info
  added the new optional request property /// (media type: application/json-patch+json)
- info
  added the new optional request property ///// (media type: application/json)
- info
  added the new optional request property ///// (media type: text/json)
- info
  added the new optional request property ///// (media type: application/*+json)
- info
  added the new optional request property ///// (media type: application/json-patch+json)
- info
  added the new optional request property /// (media type: application/json)
- info
  added the new optional request property /// (media type: text/json)
- info
  added the new optional request property /// (media type: application/*+json)
- info
  added the new optional request property /// (media type: application/json-patch+json)
- info
  added the new DiningLocationDelivery enum value to the request property ///// (media type: application/json)
- info
  added the new DiningLocationDelivery enum value to the request property ///// (media type: text/json)
- info
  added the new DiningLocationDelivery enum value to the request property ///// (media type: application/*+json)
- info
  added the new DiningLocationDelivery enum value to the request property ///// (media type: application/json-patch+json)
- info
  added the new DiningLocationDelivery enum value to the request property ///// (media type: application/json)
- info
  added the new DiningLocationDelivery enum value to the request property ///// (media type: text/json)
- info
  added the new DiningLocationDelivery enum value to the request property ///// (media type: application/*+json)
- info
  added the new DiningLocationDelivery enum value to the request property ///// (media type: application/json-patch+json)
- info
  added the new DiningLocationDelivery enum value to the request property ///// (media type: application/json)
- info
  added the new DiningLocationDelivery enum value to the request property ///// (media type: text/json)
- info
  added the new DiningLocationDelivery enum value to the request property ///// (media type: application/*+json)
- info
  added the new DiningLocationDelivery enum value to the request property ///// (media type: application/json-patch+json)
- info
  added the new DiningLocationDelivery enum value to the request property ///// (media type: application/json)
- info
  added the new DiningLocationDelivery enum value to the request property ///// (media type: text/json)
- info
  added the new DiningLocationDelivery enum value to the request property ///// (media type: application/*+json)
- info
  added the new DiningLocationDelivery enum value to the request property ///// (media type: application/json-patch+json)
- info
  added to the / request property oneOf list (media type: application/json)
- info
  added to the / request property oneOf list (media type: text/json)
- info
  added to the / request property oneOf list (media type: application/*+json)
- info
  added to the / request property oneOf list (media type: application/json-patch+json)
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  added the required property ///// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property ///// to the response with the status
- info
  added the required property ///// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property ///// to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status

Operation history (3 revisions)