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_payment_wall', 'payu_sp_pbl', 'payu_sp_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": 107,
    "status": "DECLINED",
    "valid": true,
    "order_nr": 58,
    "prices": {
        "price": {
            "value": 4158,
            "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": 4158,
            "currency": "EUR"
        }
    },
    "payment_method": "payu_brazil_hipercard",
    "checkout": {
        "method": "takeout",
        "date": "2016-10-17",
        "time": "13:45"
    },
    "created_at": 1592307659,
    "shop": {
        "id": 255,
        "name": "Makes Scents",
        "address": {
            "street": "Bertrandweg",
            "nr": "94",
            "zipcode": "6706",
            "city": "Limburg",
            "country": "BE",
            "position": {
                "latitude": 50.8503396,
                "longitude": 4.3517103
            }
        },
        "allow_comments": true,
        "currency": "EUR"
    },
    "payment_status": null,
    "joyn": null,
    "currency": "EUR"
}

Example 2

{
    "id": 108,
    "status": "REMOVED",
    "valid": true,
    "order_nr": 59,
    "prices": {
        "price": {
            "value": 10681,
            "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": 10681,
            "currency": "EUR"
        }
    },
    "payment_method": "payu_sp_visa",
    "checkout": {
        "method": "delivery",
        "date": "2024-05-28",
        "time": "17:58",
        "end_time": "18:13",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Ghent",
            "country": "BE"
        },
        "notes": null
    },
    "created_at": 1592307659,
    "shop": {
        "id": 256,
        "name": "Mad Batters",
        "address": {
            "street": "Coppenspad",
            "nr": "57",
            "zipcode": "6250",
            "city": "Geel",
            "country": "BE",
            "position": {
                "latitude": 51.260197,
                "longitude": 4.402771
            }
        },
        "allow_comments": true,
        "currency": "EUR"
    },
    "payment_status": null,
    "joyn": null,
    "currency": "EUR"
}

Example 3

{
    "id": 109,
    "status": "REMOVED",
    "valid": true,
    "order_nr": 60,
    "prices": {
        "price": {
            "value": 10350,
            "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": 10350,
            "currency": "EUR"
        }
    },
    "payment_method": "payu_romania_maestro",
    "checkout": {
        "method": "latch",
        "date": "2019-02-19",
        "time": "17:16",
        "latch_id": 29,
        "name": "Aya Bastin",
        "address": {
            "street": "Claessensring",
            "nr": "72",
            "zipcode": "9991",
            "city": "Chimay",
            "country": "BE"
        }
    },
    "created_at": 1592307660,
    "shop": {
        "id": 257,
        "name": "Tiers of Joy",
        "address": {
            "street": "Van Heckepad",
            "nr": "99",
            "zipcode": "8310",
            "city": "Tielt",
            "country": "BE",
            "position": {
                "latitude": 50.8503396,
                "longitude": 4.3517103
            }
        },
        "allow_comments": true,
        "currency": "EUR"
    },
    "payment_status": null,
    "joyn": null,
    "currency": "EUR"
}

Response

When returned in a response.

Example 1

{
    "id": 110,
    "status": "REMOVED",
    "valid": true,
    "order_nr": 61,
    "prices": {
        "price": {
            "value": 4396,
            "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": 4396,
            "currency": "EUR"
        }
    },
    "payment_method": "payu_brazil_elo",
    "checkout": {
        "method": "takeout",
        "date": "2015-11-26",
        "time": "13:59"
    },
    "created_at": 1592307660,
    "shop": {
        "id": 258,
        "name": "Piece of the Pie",
        "address": {
            "street": "Lejeuneboulevard",
            "nr": "79",
            "zipcode": "9300",
            "city": "Oudenburg",
            "country": "BE",
            "position": {
                "latitude": 51.05,
                "longitude": 3.71667
            }
        },
        "allow_comments": true,
        "currency": "EUR"
    },
    "payment_status": null,
    "joyn": null,
    "currency": "EUR"
}

Example 2

{
    "id": 111,
    "status": "APPROVED",
    "valid": true,
    "order_nr": 62,
    "prices": {
        "price": {
            "value": 20544,
            "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": 20544,
            "currency": "EUR"
        }
    },
    "payment_method": "stripe_apple_pay",
    "checkout": {
        "method": "delivery",
        "date": "2024-05-28",
        "time": "10:57",
        "end_time": "11:12",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Ghent",
            "country": "BE"
        },
        "notes": null
    },
    "created_at": 1592307660,
    "shop": {
        "id": 259,
        "name": "Slow Dough",
        "address": {
            "street": "Desmetsingel",
            "nr": "57",
            "zipcode": "4920",
            "city": "Doornik",
            "country": "BE",
            "position": {
                "latitude": 51.05,
                "longitude": 3.71667
            }
        },
        "allow_comments": true,
        "currency": "EUR"
    },
    "payment_status": null,
    "joyn": null,
    "currency": "EUR"
}

Example 3

{
    "id": 112,
    "status": "PENDING",
    "valid": true,
    "order_nr": 63,
    "prices": {
        "price": {
            "value": 14562,
            "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": 14562,
            "currency": "EUR"
        }
    },
    "payment_method": "webpay",
    "checkout": {
        "method": "latch",
        "date": "2020-05-19",
        "time": "06:21",
        "latch_id": 30,
        "name": "Lise Martens",
        "address": {
            "street": "Goethalssingel",
            "nr": "19",
            "zipcode": "8660",
            "city": "La Roche-en-Ardenne",
            "country": "BE"
        }
    },
    "created_at": 1592307660,
    "shop": {
        "id": 260,
        "name": "Best Thing Since Sliced Bread",
        "address": {
            "street": "Descampslaan",
            "nr": "79",
            "zipcode": "5060",
            "city": "Dinant",
            "country": "BE",
            "position": {
                "latitude": 51.260197,
                "longitude": 4.402771
            }
        },
        "allow_comments": true,
        "currency": "EUR"
    },
    "payment_status": null,
    "joyn": null,
    "currency": "EUR"
}
1.5.0 stable