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

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 the start time of the earliest showtime of the parent order.

Licenses Required

  • Vista.Ocapi
Request
path Parameters
orderId
required
string

The unique identifier of the in progress standard order or in progress gift shop order being modified

header Parameters
Connect-Region-Code
string

Region Code

Request Body schema:
required

The requested items

required
Array of objects (OrderItemRequest)

Gets the list of order item request base entities

Array of OrderItemCustomLocationDeliveryCreate (object) or OrderItemInSeatDeliveryCreate (object) or OrderItemServiceAreaPickupCreate (object) or null

Gets the list of order item delivery create base entities, if applicable

itemDeliveriesComment
string or null

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

OrderItemDeliveryScheduleImmediate (object) or OrderItemDeliveryScheduleOnRequest (object) or OrderItemDeliveryScheduleShowtimeDeliveryWindow (object)

Represents the base properties of a schedule that determines when an order item delivery base should be delivered or ready for pickup

Responses
200

Order items

400

Request property is invalid or missing, or invalid order type.

404

Order does not exist.

put/ocapi/v1/orders/{orderId}/items
Request samples
{
  • "items": [
    ],
  • "itemDeliveries": [
    ],
  • "itemDeliveriesComment": "string",
  • "serviceAreaPickupSchedule": {
    }
}
Response samples
application/json
{
  • "order": {
    },
  • "relatedData": {
    }
}