Order
A single Order.
Fields
| Field | Description |
|---|---|
orderid int | Order ID Example value:1269434 |
amountpaid decimal (required) | Total amount paid Example value:15.000000 |
calculate_ordercosts bool (required) | Whether or not auto / script order fees should be calculated Example value:true |
code string | Order code Used as a unique identifier in web sales. Example value:"864056970700" |
customerid int (required) | Customer ID Example value:1256 |
deferredpaymentproperties map<string, mixed> (required) | Information on the deferred payment scenario. Structure depends on payment method Example value:{ "bankAccount": "BE54719400092697", "bankBic": "FTSBBE22", "bankName": "Stichting Mollie Payments", "transferReference": "+++695/7317/77752+++" } |
deliveryaddress | Address used when delivering physically Example value:{ "city": "Leuven", "street1": "Main street" } |
deliveryscenarioid int | Delivery scenario ID See delivery scenarios for more info. Example value:1 |
deliverystatus int (required) | Delivery status Possible values:
2602 |
expiryhandled bool (required) | Whether the expired order has been handled (and optionally expiry mail has been sent) |
expiryts timestamp (required) | When the order will expire Example value:"2014-09-26 15:24:36" |
firstname string | First name (only with minimal output) Example value:"John" |
hasopenpaymentrequest bool | Indicates of the order has an open payment request with a PSP. Example value:true |
isauthenticatedcustomer bool (required) | Has customer authenticated? |
lastname string | Last name (only with minimal output) Example value:"Doe" |
lookup map<string, mixed> (required) | Related objects See the lookup fields on the getlist operation for a full description. Example value:{ "events": [] } |
nbroftickets int (required) | Number of tickets in the order. Read-only |
ordercosts | Order fees for the order Example value:[ { "orderid": 123, "amount": 5.500000, "servicechargedefinitionid": 12 }, { "orderid": 123, "amount": 2.000000, "servicechargedefinitionid": 13 } ] |
payments | Payments for the order Example value:[ { "id": 125, "orderid": 412, "amount": 50.000000, "paidts": "2015-04-07 07:00:00", "paymentmethodid": 2, "properties": null, "refundpaymentid": null } ] |
paymentscenarioid int | Payment scenario ID See payment scenarios for more info. Example value:1 |
paymentstatus int (required) | Payment status Possible values:
|
products | Products in the order Example value:[ { "id": 35539, "orderid": 368, "code": "123412341234", "contactid": null, "price": 15.000000, "productid": 234, "properties": null } ] |
promocodes string[] (required) | Promocodes active for the Order Example value:[ "PROMO2015", "COOLPROMO" ] |
queuetokens int[] (required) | Queue tokens for rate limiting Example value:[ 0, 24 ] |
rappelhandled bool (required) | Whether the overdue order has been handled (and optionally reminder mail has been sent) |
rappelts timestamp (required) | When the reminder mail will be sent Example value:"2014-09-26 15:24:36" |
saleschannelid int (required) | Sales channel ID See sales channels for more info. Example value:1 |
status int (required) | Order status Possible values:
1 |
tickets | Tickets in the order Example value:[ { "id": 35539, "orderid": 368, "price": 15.000000, "servicecharge": 1.000000, "ticketholderid": null, "ticketname": null, "tickettypeid": 111, "tickettypepriceid": 632 }, { "id": 35540, "orderid": 368, "price": 15.000000, "servicecharge": 1.000000, "ticketholderid": null, "ticketname": null, "tickettypeid": 111, "tickettypepriceid": 632 } ] |
totalamount decimal (required) | Total order amount Includes all costs and fees. Example value:25.500000 |
webskinid int (required) | Reference to the webskin that is used for showing the orderdetail page. Example value:1 |
createdts timestamp | Created timestamp Example value:"2014-09-26 15:24:36" |
lastupdatets timestamp | Last updated timestamp Example value:"2014-09-26 15:24:36" |
This type can have custom fields
Example
1{
2 "orderid": 1269434,
3 "amountpaid": 15.000000,
4 "calculate_ordercosts": true,
5 "code": "864056970700",
6 "customerid": 1256,
7 "deferredpaymentproperties": {
8 "bankAccount": "BE54719400092697",
9 "bankBic": "FTSBBE22",
10 "bankName": "Stichting Mollie Payments",
11 "transferReference": "+++695/7317/77752+++"
12 },
13 "deliveryaddress": {
14 "city": "Leuven",
15 "street1": "Main street"
16 },
17 "deliveryscenarioid": 1,
18 "deliverystatus": 2602,
19 "expiryhandled": false,
20 "expiryts": "2014-09-26 15:24:36",
21 "firstname": "John",
22 "hasopenpaymentrequest": true,
23 "isauthenticatedcustomer": false,
24 "lastname": "Doe",
25 "lookup": {
26 "events": []
27 },
28 "nbroftickets": 0,
29 "ordercosts": [
30 {
31 "orderid": 123,
32 "amount": 5.500000,
33 "servicechargedefinitionid": 12
34 },
35 {
36 "orderid": 123,
37 "amount": 2.000000,
38 "servicechargedefinitionid": 13
39 }
40 ],
41 "payments": [
42 {
43 "id": 125,
44 "orderid": 412,
45 "amount": 50.000000,
46 "paidts": "2015-04-07 07:00:00",
47 "paymentmethodid": 2,
48 "properties": null,
49 "refundpaymentid": null
50 }
51 ],
52 "paymentscenarioid": 1,
53 "paymentstatus": 0,
54 "products": [
55 {
56 "id": 35539,
57 "orderid": 368,
58 "code": "123412341234",
59 "contactid": null,
60 "price": 15.000000,
61 "productid": 234,
62 "properties": null
63 }
64 ],
65 "promocodes": [
66 "PROMO2015",
67 "COOLPROMO"
68 ],
69 "queuetokens": [ 0, 24 ],
70 "rappelhandled": false,
71 "rappelts": "2014-09-26 15:24:36",
72 "saleschannelid": 1,
73 "status": 1,
74 "tickets": [
75 {
76 "id": 35539,
77 "orderid": 368,
78 "price": 15.000000,
79 "servicecharge": 1.000000,
80 "ticketholderid": null,
81 "ticketname": null,
82 "tickettypeid": 111,
83 "tickettypepriceid": 632
84 },
85 {
86 "id": 35540,
87 "orderid": 368,
88 "price": 15.000000,
89 "servicecharge": 1.000000,
90 "ticketholderid": null,
91 "ticketname": null,
92 "tickettypeid": 111,
93 "tickettypepriceid": 632
94 }
95 ],
96 "totalamount": 25.500000,
97 "webskinid": 1,
98 "createdts": "2014-09-26 15:24:36",
99 "lastupdatets": "2014-09-26 15:24:36"
100}