Order.simple

Field Type Description
id Int Id of the product
status String String enumarion of 'PENDING', 'HAS_READ', 'APPROVED', 'DECLINED', 'REMOVED', 'DELETED_BY_SHOP', 'COLLECTED'
valid Bool Is true when the order is completed or paid and visible for the shop.
order_nr Int Unique number on a yearly basis and per shop. Visible for the shop and users. Only available for valid orders.
prices CartPrices Prices
payment_method String String enumarion of 'point_of_sale', 'paid_in_shop', 'bank_transfer', 'ideal', 'bancontact', 'sofort', 'giropay', 'creditcard', 'cartes_bancaires', 'paypal', 'eps_uberweisung', 'payconiq', 'monizze', 'edenred', 'webpay', 'credomatic', 'satispay', 'stripe_card_visa_mc', 'stripe_card_amex', 'stripe_apple_pay', 'stripe_google_pay', 'payu_romania_visa', 'payu_romania_mc', 'payu_romania_visa_electron', 'payu_romania_maestro', 'payu_brazil_amex', 'payu_brazil_boleto_bancario', 'payu_brazil_diners', 'payu_brazil_elo', 'payu_brazil_hipercard', 'payu_brazil_mc', 'payu_brazil_visa', 'payu_sp_maestro', 'payu_sp_mc', 'payu_sp_pbl', 'payu_sp_visa', 'payu_sp_blik', 'payu_iyzico_amex', 'payu_iyzico_mc', 'payu_iyzico_troy', 'payu_iyzico_visa', 'pesopay_gcash', 'pesopay_visa', 'pesopay_mc'
checkout OrderCheckout
shop Shop.simple
created_at Timestamp Time when the order was created, measured in the number of seconds since the Unix Epoch (January 1 1970 00:00:00 GMT).
joyn Joyn? Nullable. Contains the amount of points that can get saved with Joyn + a link to collect the points.
payment_status String? Nullable. String enumarion of 'pending', 'canceled', 'timeout', 'declined', 'refunded', 'paid'
currency Currency 3 letter ISO 4217 currency name (string)

Examples

Request

When used inside a request.

Example 1

{
    "id": 1371,
    "status": "PENDING",
    "valid": true,
    "order_nr": 58,
    "prices": {
        "price": {
            "value": 1596,
            "currency": "EUR"
        },
        "discount": {
            "value": 0,
            "currency": "EUR"
        },
        "warranty": {
            "value": 0,
            "currency": "EUR"
        },
        "delivery_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "invoice_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "sms_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "transaction_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "price_to_pay": {
            "value": 1596,
            "currency": "EUR"
        }
    },
    "payment_method": "payu_brazil_mc",
    "checkout": {
        "method": "takeout",
        "date": "2018-05-16",
        "time": "07:28"
    },
    "created_at": 1618995868,
    "shop": {
        "id": 3338,
        "name": "Breadline",
        "address": {
            "street": "Heylenlaan",
            "nr": "41",
            "zipcode": "5370",
            "city": "Aarlen",
            "country": "BE",
            "position": {
                "latitude": 50.8503396,
                "longitude": 4.3517103
            }
        },
        "allow_comments": false,
        "currency": "EUR"
    },
    "payment_status": null,
    "joyn": null,
    "currency": "EUR"
}

Example 2

{
    "id": 1376,
    "status": "DELETED_BY_SHOP",
    "valid": true,
    "order_nr": 59,
    "prices": {
        "price": {
            "value": 2180,
            "currency": "EUR"
        },
        "discount": {
            "value": 0,
            "currency": "EUR"
        },
        "warranty": {
            "value": 0,
            "currency": "EUR"
        },
        "delivery_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "invoice_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "sms_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "transaction_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "price_to_pay": {
            "value": 2180,
            "currency": "EUR"
        }
    },
    "payment_method": "payu_iyzico_mc",
    "checkout": {
        "method": "delivery",
        "date": "2017-02-07",
        "time": "11:10",
        "end_time": "11:25",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Ghent",
            "country": "BE"
        },
        "notes": null
    },
    "created_at": 1618995869,
    "shop": {
        "id": 3342,
        "name": "Top of the Flour",
        "address": {
            "street": "Libertsingel",
            "nr": "67",
            "zipcode": "5070",
            "city": "Zoutleeuw",
            "country": "BE",
            "position": {
                "latitude": 51.260197,
                "longitude": 4.402771
            }
        },
        "allow_comments": false,
        "currency": "EUR"
    },
    "payment_status": null,
    "joyn": null,
    "currency": "EUR"
}

Example 3

{
    "id": 1380,
    "status": "APPROVED",
    "valid": true,
    "order_nr": 60,
    "prices": {
        "price": {
            "value": 6722,
            "currency": "EUR"
        },
        "discount": {
            "value": 0,
            "currency": "EUR"
        },
        "warranty": {
            "value": 0,
            "currency": "EUR"
        },
        "delivery_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "invoice_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "sms_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "transaction_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "price_to_pay": {
            "value": 6722,
            "currency": "EUR"
        }
    },
    "payment_method": "payu_iyzico_troy",
    "checkout": {
        "method": "latch",
        "date": "2017-08-13",
        "time": "20:03",
        "latch_id": 410,
        "name": "Nicolas Libert",
        "address": {
            "street": "Léonardsingel",
            "nr": "98",
            "zipcode": "6997",
            "city": "Houffalize",
            "country": "BE"
        }
    },
    "created_at": 1618995872,
    "shop": {
        "id": 3346,
        "name": "Top of the Muffin",
        "address": {
            "street": "Pauwelsweg",
            "nr": "55",
            "zipcode": "9310",
            "city": "Beringen",
            "country": "BE",
            "position": {
                "latitude": 51.05,
                "longitude": 3.71667
            }
        },
        "allow_comments": false,
        "currency": "EUR"
    },
    "payment_status": null,
    "joyn": null,
    "currency": "EUR"
}

Response

When returned in a response.

Example 1

{
    "id": 1384,
    "status": "REMOVED",
    "valid": true,
    "order_nr": 61,
    "prices": {
        "price": {
            "value": 14859,
            "currency": "EUR"
        },
        "discount": {
            "value": 0,
            "currency": "EUR"
        },
        "warranty": {
            "value": 0,
            "currency": "EUR"
        },
        "delivery_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "invoice_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "sms_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "transaction_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "price_to_pay": {
            "value": 14859,
            "currency": "EUR"
        }
    },
    "payment_method": "payu_sp_pbl",
    "checkout": {
        "method": "takeout",
        "date": "2023-06-01",
        "time": "14:35"
    },
    "created_at": 1618995874,
    "shop": {
        "id": 3350,
        "name": "Rise of the Buns",
        "address": {
            "street": "Verhaegendreef",
            "nr": "94",
            "zipcode": "7532",
            "city": "Borgworm",
            "country": "BE",
            "position": {
                "latitude": 50.8503396,
                "longitude": 4.3517103
            }
        },
        "allow_comments": false,
        "currency": "EUR"
    },
    "payment_status": null,
    "joyn": null,
    "currency": "EUR"
}

Example 2

{
    "id": 1388,
    "status": "DELETED_BY_SHOP",
    "valid": true,
    "order_nr": 62,
    "prices": {
        "price": {
            "value": 9951,
            "currency": "EUR"
        },
        "discount": {
            "value": 0,
            "currency": "EUR"
        },
        "warranty": {
            "value": 0,
            "currency": "EUR"
        },
        "delivery_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "invoice_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "sms_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "transaction_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "price_to_pay": {
            "value": 9951,
            "currency": "EUR"
        }
    },
    "payment_method": "payu_sp_maestro",
    "checkout": {
        "method": "delivery",
        "date": "2024-07-18",
        "time": "18:53",
        "end_time": "19:08",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Ghent",
            "country": "BE"
        },
        "notes": null
    },
    "created_at": 1618995876,
    "shop": {
        "id": 3354,
        "name": "Flours for Hours",
        "address": {
            "street": "Pirottering",
            "nr": "25",
            "zipcode": "3200",
            "city": "La Louvière",
            "country": "BE",
            "position": {
                "latitude": 51.260197,
                "longitude": 4.402771
            }
        },
        "allow_comments": false,
        "currency": "EUR"
    },
    "payment_status": null,
    "joyn": null,
    "currency": "EUR"
}

Example 3

{
    "id": 1392,
    "status": "HAS_READ",
    "valid": true,
    "order_nr": 63,
    "prices": {
        "price": {
            "value": 7962,
            "currency": "EUR"
        },
        "discount": {
            "value": 0,
            "currency": "EUR"
        },
        "warranty": {
            "value": 0,
            "currency": "EUR"
        },
        "delivery_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "invoice_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "sms_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "transaction_cost": {
            "value": 0,
            "currency": "EUR"
        },
        "price_to_pay": {
            "value": 7962,
            "currency": "EUR"
        }
    },
    "payment_method": "stripe_card_amex",
    "checkout": {
        "method": "latch",
        "date": "2018-09-10",
        "time": "14:11",
        "latch_id": 414,
        "name": "Lana Janssens",
        "address": {
            "street": "Claeysdreef",
            "nr": "78",
            "zipcode": "4432",
            "city": "Stavelot",
            "country": "BE"
        }
    },
    "created_at": 1618995878,
    "shop": {
        "id": 3358,
        "name": "Cut the Cake",
        "address": {
            "street": "Goethalsring",
            "nr": "83",
            "zipcode": "5170",
            "city": "Dilsen-Stokkem",
            "country": "BE",
            "position": {
                "latitude": 50.8503396,
                "longitude": 4.3517103
            }
        },
        "allow_comments": false,
        "currency": "EUR"
    },
    "payment_status": null,
    "joyn": null,
    "currency": "EUR"
}
Version update available Please adjust your integration to the latest stable version (1.5.2)
1.5.0 stable