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": 15,
    "status": "PENDING",
    "valid": false,
    "order_nr": 16,
    "prices": {
        "price": {
            "value": 15,
            "currency": "EUR"
        },
        "discount": {
            "value": 14,
            "currency": "EUR"
        },
        "warranty": {
            "value": 10,
            "currency": "EUR"
        },
        "delivery_cost": {
            "value": 13,
            "currency": "EUR"
        },
        "invoice_cost": {
            "value": 16,
            "currency": "EUR"
        },
        "sms_cost": {
            "value": 13,
            "currency": "EUR"
        },
        "transaction_cost": {
            "value": 16,
            "currency": "EUR"
        },
        "price_to_pay": {
            "value": 17,
            "currency": "EUR"
        },
        "price_with_discount": {
            "value": 11,
            "currency": "EUR"
        }
    },
    "payment_method": "point_of_sale",
    "checkout": {
        "method": "delivery",
        "date": "2019-01-31",
        "time": "12:00",
        "end_time": "12:00",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Gent",
            "country": "BE"
        },
        "notes": "...",
        "name": "...",
        "latch_id": 10
    },
    "shop": {
        "id": 10,
        "name": "Candice Davis",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Gent",
            "country": "BE"
        },
        "allow_comments": true,
        "currency": "EUR"
    },
    "created_at": 1629198229,
    "joyn": {
        "points": 13,
        "collect_url": "https://example.com",
        "qr_code_url": "https://example.com"
    },
    "payment_status": "pending",
    "currency": "EUR"
}

Response

When returned in a response.

Example 1

{
    "id": 14,
    "status": "PENDING",
    "valid": false,
    "order_nr": 12,
    "prices": {
        "price": {
            "value": 15,
            "currency": "EUR"
        },
        "discount": {
            "value": 11,
            "currency": "EUR"
        },
        "warranty": {
            "value": 11,
            "currency": "EUR"
        },
        "delivery_cost": {
            "value": 11,
            "currency": "EUR"
        },
        "invoice_cost": {
            "value": 11,
            "currency": "EUR"
        },
        "sms_cost": {
            "value": 11,
            "currency": "EUR"
        },
        "transaction_cost": {
            "value": 18,
            "currency": "EUR"
        },
        "price_to_pay": {
            "value": 13,
            "currency": "EUR"
        },
        "price_with_discount": {
            "value": 15,
            "currency": "EUR"
        }
    },
    "payment_method": "point_of_sale",
    "checkout": {
        "method": "delivery",
        "date": "2019-01-31",
        "time": "12:00",
        "end_time": "12:00",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Gent",
            "country": "BE"
        },
        "notes": "...",
        "name": "...",
        "latch_id": 18
    },
    "shop": {
        "id": 16,
        "name": "Karelle Kiehn Jr.",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Gent",
            "country": "BE",
            "position": {
                "latitude": 1.54361,
                "longitude": 0.45645
            }
        },
        "allow_comments": true,
        "currency": "EUR"
    },
    "created_at": 1629198229,
    "joyn": {
        "points": 17,
        "collect_url": "https://example.com",
        "qr_code_url": "https://example.com"
    },
    "payment_status": "pending",
    "currency": "EUR"
}
Version update available Please adjust your integration to the latest stable version (1.6.0)
1.5.0 stable