Item deliveries

When ordering items, the client may also indicate when and where the items should be delivered. This is done by providing one or more itemDeliveries and assigning them to individual items.

The following item delivery methods are supported:

In-seat delivery - items are delivered to a seat during a showtime.
Custom location delivery - items are immediately delivered to a custom location (e.g., a table).
Electronic delivery - items are delivered electronically (e.g., a digital voucher or gift card).
Service area pickup - items are delivered to a service area for pickup by the patron.
Counter pickup - items are picked up from POS by the patron.

Clients must inspect the allowedDeliveryMethods property of an item to determine which delivery methods are available.

NOTE

Available delivery methods are limited based on whether an item requires preparation.

In-seat deliveries

When creating an in-seat item delivery, the showtimeId and seats properties must be provided. These details are typically sourced from:

Showtimes within in-progress ticket orders .
Completed orders that contains tickets or in-seat deliveries.
QR codes displayed at physical seats.

In-seat deliveries can be prepared immediately via the Immediate schedule or at a specific time via the ShowtimeDeliveryWindow schedule.

Showtime delivery windows

When specifying an ShowtimeDeliveryWindow preparation schedule, the showtimeDeliveryWindowId must be provided.

Use the GetItemProfileForSite endpoint to get the available showtime delivery windows for a site.

Copy

Copied

{
  "itemProfile": {
    "siteId": "0000000003",
    "itemShowtimeDeliveryWindows": [
      {
        "minutes": 10,
        "type": "MinutesFromStart",
        "id": "0000000003-FirstService",
        "name": {
          "text": "First Service - 10 mins"
        }
      },
      {
        "minutes": 45,
        "type": "MinutesFromStart",
        "id": "0000000003-SecondService",
        "name": {
          "text": "Second Service - 45 mins"
        }
      }
    ]
  }
}

NOTE

Some properties have been omitted from the code snippet above for brevity.

Service area pickups

When creating a service area pickup, no additional information is required as the service areas are back-end configuration and cannot be defined by the client.

The schedule of a service area pickup can be set to Immediate or OnRequest.

NOTE

Items that require preparation and have no delivery assigned by the client will be assigned a ServiceAreaPickup delivery with the OnRequest schedule.

For convenience, the serviceAreaPickupSchedule request property on the SetItems endpoint can be used to control which type of schedule will be applied to default service area pick up deliveries.

Copy

Copied

{
  "items": [
    { 
      "itemId": "0002-001"
    },
    { 
      "itemId": "0002-002"
    }
  ],
  "serviceAreaPickupSchedule": {
    "type": "Immediate"
  }
}

IMPORTANT

Note that the serviceAreaPickupSchedule request property is only applicable for Standard Orders.

Delivery comments

Item deliveries that require preparation allow for comments to be provided. Delivery comments can be used to offer free-text additional requests that go beyond system-defined item modifiers and options.

Requesting preparation

Item deliveries with an OnRequest schedule require the patron to request preparation after the order has been completed.

See item delivery preparation for more info.