Product

A single product.

More info: see the get operation and the products endpoint.

Fields

FieldDescription
id
int 
(required)

Unique ID

Example value:123
typeid
int 
(required)

Type ID

Example value:26001
categoryid
int

Category for the product. Categories can be managed in account parameters and indicate the labels for a single and multiple product and also what labels to use for the holders of the product. If not set, the UI will fallback to default labels.

Example value:1
layoutid
int

Optional layout for the product. If not specified, there will be no ticket generated for the product

Example value:1
name
mlstring 
(required)

Name for the product

Example value:"T-shirt"
code
string

Unique 12-digit for the product

Example value:"123412341234"
description

Description for the product

Example value:"The new t-shirt is made of 100% cotton"
groupbycustomfield
int

The customfield that is used to group the option bundle in the UI (websales and backoffice)

Example value:10003
instancevalues

Instancevalues control the price for a product and for non simple products it also controls the content of the product. All products should have a default instancevalue and a set of exceptions (if there are any). If no specific exception is found for the selected product, the default instancevalue is used.

Example value:{ "default": { "price": 25.000000, "voucher": { "amount": 10.000000, "voucherid": 123 } }, "exceptions": [ { "properties": { "colour": [ "red" ], "size": [ "S" ] }, "value": { "price": 15.000000, "voucher": { "amount": 10.000000, "voucherid": 123 } } }, { "properties": { "colour": [ "red" ], "size": [ "M" ] }, "value": { "price": 17.000000, "voucher": { "amount": 30.000000, "voucherid": 124 } } } ] }
maxadditionaltickets
int

The amount of individual tickets per event that can be purchased alongside this bundle.

Example value:3
printtickets
bool

If true, tickets for items that belong to the product will be printed when printing the product.

Example value:true
properties
ProductProperty[] 
(required)

Definition of possible properties for the product. A product can have one or more properties. Properties can be used to introduce variants of a product (sizes of a t-shirt for example).

Example value:[ { "name": "Size", "description": "Size of the t-shirt", "key": "size", "values": [ { "key": "S", "value": "Small" }, { "key": "M", "value": "Medium" }, { "key": "L", "value": "Large" } ] }, { "name": "Colour", "description": "Colour of the t-shirt", "key": "colour", "values": [ { "key": "red", "value": "Red" }, { "key": "green", "value": "Green" } ] } ]
queuetoken
int

Queue ID

See rate limiting for more info.

Example value:421
saleendts
timestamp

End of sales

Example value:"2016-01-01 00:00:00"
saleschannels
int[]

Sales is active for these saleschannels

Example value:[ 1, 2, 3 ]
salestartts
timestamp

Start of sales

Example value:"2016-01-01 00:00:00"
translations
map<string, string>

Translations for the product properties

Example value:{ "properties:size:L:nl": "Groot", "properties:size:S:nl": "Klein" }
isarchived
bool 
(required)

Whether or not this item is archived

createdts
timestamp 
(required)

Created timestamp

Example value:"2014-09-26 15:24:36"
lastupdatets
timestamp 
(required)

Last updated timestamp

Example value:"2014-09-26 15:24:36"

This type can have custom fields

Example

  1{
  2    "id": 123,
  3    "typeid": 26001,
  4    "categoryid": 1,
  5    "layoutid": 1,
  6    "name": "T-shirt",
  7    "code": "123412341234",
  8    "description": "The new t-shirt is made of 100% cotton",
  9    "groupbycustomfield": 10003,
 10    "instancevalues": {
 11        "default": {
 12            "price": 25.000000,
 13            "voucher": {
 14                "amount": 10.000000,
 15                "voucherid": 123
 16            }
 17        },
 18        "exceptions": [
 19            {
 20                "properties": {
 21                    "colour": [
 22                        "red"
 23                    ],
 24                    "size": [
 25                        "S"
 26                    ]
 27                },
 28                "value": {
 29                    "price": 15.000000,
 30                    "voucher": {
 31                        "amount": 10.000000,
 32                        "voucherid": 123
 33                    }
 34                }
 35            },
 36            {
 37                "properties": {
 38                    "colour": [
 39                        "red"
 40                    ],
 41                    "size": [
 42                        "M"
 43                    ]
 44                },
 45                "value": {
 46                    "price": 17.000000,
 47                    "voucher": {
 48                        "amount": 30.000000,
 49                        "voucherid": 124
 50                    }
 51                }
 52            }
 53        ]
 54    },
 55    "maxadditionaltickets": 3,
 56    "printtickets": true,
 57    "properties": [
 58        {
 59            "name": "Size",
 60            "description": "Size of the t-shirt",
 61            "key": "size",
 62            "values": [
 63                {
 64                    "key": "S",
 65                    "value": "Small"
 66                },
 67                {
 68                    "key": "M",
 69                    "value": "Medium"
 70                },
 71                {
 72                    "key": "L",
 73                    "value": "Large"
 74                }
 75            ]
 76        },
 77        {
 78            "name": "Colour",
 79            "description": "Colour of the t-shirt",
 80            "key": "colour",
 81            "values": [
 82                {
 83                    "key": "red",
 84                    "value": "Red"
 85                },
 86                {
 87                    "key": "green",
 88                    "value": "Green"
 89                }
 90            ]
 91        }
 92    ],
 93    "queuetoken": 421,
 94    "saleendts": "2016-01-01 00:00:00",
 95    "saleschannels": [ 1, 2, 3 ],
 96    "salestartts": "2016-01-01 00:00:00",
 97    "translations": {
 98        "properties:size:L:nl": "Groot",
 99        "properties:size:S:nl": "Klein"
100    },
101    "isarchived": false,
102    "createdts": "2014-09-26 15:24:36",
103    "lastupdatets": "2014-09-26 15:24:36"
104}