DeliveryScenario

A single delivery scenario.

More info: see the get operation and the delivery scenarios endpoint.

Fields

FieldDescription
id
int 
(required)

Unique ID

Example value:123
typeid
int 
(required)

The type of this delivery scenario, defines when this delivery scenario is triggered. The available values for this field can be found on the delivery scenario overview page.

Example value:2501
name
mlstring 
(required)

Name of the delivery scenario

Example value:"Print at home"
allowetickets
int 
(required)

Are e-tickets allowed with this delivery scenario?

Example value:1
availability
DeliveryscenarioAvailability 
(required)

The rules that define when this scenario is available. See the delivery scenario overview page for a description of this field

Example value:{ "saleschannels": [ 1, 2 ] }
deliverystatusaftertrigger
int 
(required)

The delivery status the order will transition to when the trigger occurs.

Example value:2602
feedescription
mlstring 
(required)

A very short description of the fee that is applicable.

Example value:"+ 1€"
internalremark
string

An internal description field. Will not be shown to customers.

Example value:"Don't use this scenario for partner events."
logo
string 
(required)

Logo url

Example value:"logos/printathome.svg"
mailorganization
bool 
(required)

Send mail to organization if known

Example value:true
needsaddress
bool 
(required)

A physical address is required

Example value:true
ordermailtemplateid_delivery
int 
(required)

The ID of the order mail template that will be used for sending out when changing to delivery state ‘delivered’. Can be 0 to indicate that no mail should be sent

ordermailtemplateid_deliverystarted
int 
(required)

The ID of the order mail template that will be used for sending out when changing to delivery state ‘delivery started’. Can be 0 to indicate that no mail should be sent

shortdescription
mlstring 
(required)

A short description of the deilvery scenario. Will be shown to customers.

Example value:"Print your own tickets. Do not forget to bring your copy to the event!"
visibility
string 
(required)

Parameter that sets the visibility of this scenario, can be either ‘FULL’ or ‘API’.

Example value:"FULL"
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": 2501,
 4    "name": "Print at home",
 5    "allowetickets": 1,
 6    "availability": {
 7        "saleschannels": [ 1, 2 ]
 8    },
 9    "deliverystatusaftertrigger": 2602,
10    "feedescription": "+ 1€",
11    "internalremark": "Don't use this scenario for partner events.",
12    "logo": "logos/printathome.svg",
13    "mailorganization": true,
14    "needsaddress": true,
15    "ordermailtemplateid_delivery": 0,
16    "ordermailtemplateid_deliverystarted": 0,
17    "shortdescription": "Print your own tickets. Do not forget to bring your copy to the event!",
18    "visibility": "FULL",
19    "isarchived": false,
20    "createdts": "2014-09-26 15:24:36",
21    "lastupdatets": "2014-09-26 15:24:36"
22}