Product
A single product.
More info: see the get operation and the products endpoint.
Fields
| Field | Description |
|---|---|
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" |
asksubscribers bool | If true, subscriber info is requested for each bundle in websales. Example value:true |
code string | Unique 12-digit for the product Example value:"123412341234" |
description | Description for the product Example value:"Longer product description" |
groupbycustomfield int | The customfield that is used to group the option bundle in the UI (websales and backoffice) Example value:10003 |
image string | Reference to product image Example value:"/products/1282/image.5b3a145b576ab.jpg" |
instancevalues ProductInstancevalues (required) | 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 | 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" |
salestatusmessagesid int | Sale status messages in use for this product Example value:1 |
shortdescription | Short description for the product Example value:"The new t-shirt is made of 100% cotton" |
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 "asksubscribers": true,
8 "code": "123412341234",
9 "description": "Longer product description",
10 "groupbycustomfield": 10003,
11 "image": "/products/1282/image.5b3a145b576ab.jpg",
12 "instancevalues": {
13 "default": {
14 "price": 25.000000,
15 "voucher": {
16 "amount": 10.000000,
17 "voucherid": 123
18 }
19 },
20 "exceptions": [
21 {
22 "properties": {
23 "colour": [
24 "red"
25 ],
26 "size": [
27 "S"
28 ]
29 },
30 "value": {
31 "price": 15.000000,
32 "voucher": {
33 "amount": 10.000000,
34 "voucherid": 123
35 }
36 }
37 },
38 {
39 "properties": {
40 "colour": [
41 "red"
42 ],
43 "size": [
44 "M"
45 ]
46 },
47 "value": {
48 "price": 17.000000,
49 "voucher": {
50 "amount": 30.000000,
51 "voucherid": 124
52 }
53 }
54 }
55 ]
56 },
57 "maxadditionaltickets": 3,
58 "printtickets": true,
59 "properties": [
60 {
61 "name": "Size",
62 "description": "Size of the t-shirt",
63 "key": "size",
64 "values": [
65 {
66 "key": "S",
67 "value": "Small"
68 },
69 {
70 "key": "M",
71 "value": "Medium"
72 },
73 {
74 "key": "L",
75 "value": "Large"
76 }
77 ]
78 },
79 {
80 "name": "Colour",
81 "description": "Colour of the t-shirt",
82 "key": "colour",
83 "values": [
84 {
85 "key": "red",
86 "value": "Red"
87 },
88 {
89 "key": "green",
90 "value": "Green"
91 }
92 ]
93 }
94 ],
95 "queuetoken": 421,
96 "saleendts": "2016-01-01 00:00:00",
97 "saleschannels": [ 1, 2, 3 ],
98 "salestartts": "2016-01-01 00:00:00",
99 "salestatusmessagesid": 1,
100 "shortdescription": "The new t-shirt is made of 100% cotton",
101 "translations": {
102 "properties:size:L:nl": "Groot",
103 "properties:size:S:nl": "Klein"
104 },
105 "isarchived": false,
106 "createdts": "2014-09-26 15:24:36",
107 "lastupdatets": "2014-09-26 15:24:36"
108}