Items

An item is a product that can be sold to a member. It can be a food item, or a drink or something else.

Please note: Items and tickets are two different entities. Items are products that can be sold to a member, while tickets are the type of ticket that a member can purchase at the box office.

Item

An item is a product that can be sold in a cinema.

item_id
required
string (Item_id)

The item_id is a unique identifier for an item.

name
required
string

The name of the item. This is how the item will be displayed within Movio EQ.

type
required
string
Default: "CONCESSION"

The type of the item. This is how the item will be categorized within Movio EQ.

A CONCESSION could be a food or beverage item that is sold at the cinema kiosks. The type OTHER could be a non-food or beverage item such as a subscription fee. OTHER is usually used for items that are bought at the box office together with a session.

Enum: "CONCESSION" "OTHER"
tags
Array of strings (Tags) <= 10 items

A list of tags that are used to group items together.

{
  • "item_id": "concession_popcorn_lrg_unbuttered",
  • "name": "Large Unbuttered Popcorn",
  • "type": "CONCESSION",
  • "tags": [
    ]
}

Create / Update Items

Creates or updates an item in the system. This will create the item in Movio if the item does not exist. If the item exists, then the item with the same item_id will be one to one replaced with the new item.

SecurityOAuth2
Request
Request Body schema: application/json
required

The items to be created.

Array ([ 1 .. 5000 ] items)
item_id
required
string (Item_id)

The item_id is a unique identifier for an item.

name
required
string

The name of the item. This is how the item will be displayed within Movio EQ.

type
required
string
Default: "CONCESSION"

The type of the item. This is how the item will be categorized within Movio EQ.

A CONCESSION could be a food or beverage item that is sold at the cinema kiosks. The type OTHER could be a non-food or beverage item such as a subscription fee. OTHER is usually used for items that are bought at the box office together with a session.

Enum: "CONCESSION" "OTHER"
tags
Array of strings (Tags) <= 10 items

A list of tags that are used to group items together.

Responses
202

The response to a bulk request that succeeded.

400

The response to a bulk request that failed.

401

The request has not been applied because it lacks valid authentication credentials for the target resource.

422

The request was well-formed but was unable to be followed due to semantic errors.

put/items
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "total": 3,
  • "created_count": 2,
  • "updated_count": 1
}

Delete Item

Deletes an item from the system. This effectively remove the item from Movio. Useful when an item is no longer available for purchase. Movio will keep the item in the system for historical purposes.

SecurityOAuth2
Request
path Parameters
item_id
required
string (Item_id)

The unique identifier for an item.

Example: concession_popcorn_lrg_unbuttered
Responses
204

The item was deleted successfully.

400

The request could not be understood by the server due to malformed syntax.

401

The request has not been applied because it lacks valid authentication credentials for the target resource.

422

The request was well-formed but was unable to be followed due to semantic errors.

delete/items/{item_id}
Response samples
plain/text
The request could not be understood by the server due to
malformed syntax. The client should not repeat the request without
modifications.