Order.detailed

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', 'carte_bleue', 'paypal', 'eps_uberweisung', 'apple_pay', 'google_pay', 'payconiq', 'monizze', 'edenred', 'webpay', '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', 'redsys_bizum', 'sibs_id'
checkout OrderCheckout
shop Shop.simple
created_at DateTime Datetime string in Europe/Brussels for when the order was created.
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'
products [CartItem.order] Array of CartItem.order

Examples

Request

When used inside a request.

Example 1

{
    "id": 19,
    "status": "PENDING",
    "valid": true,
    "order_nr": 15,
    "prices": {
        "price": 17,
        "discount": 12,
        "warranty": 19,
        "delivery_cost": 10,
        "invoice_cost": 12,
        "sms_cost": 10,
        "transaction_cost": 19,
        "price_to_pay": 14,
        "price_with_discount": 16
    },
    "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": "..."
    },
    "shop": {
        "id": 19,
        "name": "Onie Kuhic",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Gent",
            "country": "BE"
        }
    },
    "created_at": "2019-01-31 12:00:00",
    "joyn": {
        "points": 10,
        "collect_url": "https://example.com",
        "qr_code_url": "https://example.com"
    },
    "payment_status": "pending",
    "products": [
        [],
        [],
        []
    ]
}

Response

When returned in a response.

Example 1

{
    "id": 19,
    "status": "PENDING",
    "valid": false,
    "order_nr": 11,
    "prices": {
        "price": 17,
        "discount": 17,
        "warranty": 18,
        "delivery_cost": 18,
        "invoice_cost": 19,
        "sms_cost": 10,
        "transaction_cost": 14,
        "price_to_pay": 17,
        "price_with_discount": 15
    },
    "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": "..."
    },
    "shop": {
        "id": 10,
        "name": "Ashley Miller",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Gent",
            "country": "BE",
            "position": {
                "latitude": 1.54361,
                "longitude": 0.45645
            }
        }
    },
    "created_at": "2019-01-31 12:00:00",
    "joyn": {
        "points": 15,
        "collect_url": "https://example.com",
        "qr_code_url": "https://example.com"
    },
    "payment_status": "pending",
    "products": [
        {
            "amount": 18,
            "persons": 18,
            "gram": 13,
            "comment": "...",
            "product": {
                "id": 10,
                "name": "...",
                "images": [
                    {
                        "resolutions": [
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            },
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            },
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            }
                        ],
                        "white_background": false
                    },
                    {
                        "resolutions": [
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            },
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            },
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            }
                        ],
                        "white_background": true
                    },
                    {
                        "resolutions": [
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            },
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            },
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            }
                        ],
                        "white_background": false
                    }
                ],
                "price_type": "PER_UNIT",
                "target_price": true,
                "price": 16
            },
            "product_price": {
                "id": 13,
                "name": "...",
                "price": 11
            },
            "calculated_prices": {
                "unit_price": 15,
                "price": 14
            },
            "discount_prices": {
                "unit_price": 17,
                "price": 18
            },
            "options": [
                {
                    "id": 14,
                    "name": "...",
                    "price_change": 18,
                    "optionset": {
                        "id": 10,
                        "name": "...",
                        "allow_attachment": false
                    }
                },
                {
                    "id": 10,
                    "name": "...",
                    "price_change": 13,
                    "optionset": {
                        "id": 18,
                        "name": "...",
                        "allow_attachment": false
                    }
                },
                {
                    "id": 14,
                    "name": "...",
                    "price_change": 12,
                    "optionset": {
                        "id": 11,
                        "name": "...",
                        "allow_attachment": false
                    }
                }
            ],
            "uploads": [
                {
                    "upload": {
                        "id": 12,
                        "url": "https://example.com"
                    },
                    "optionset_id": 11
                },
                {
                    "upload": {
                        "id": 10,
                        "url": "https://example.com"
                    },
                    "optionset_id": 19
                },
                {
                    "upload": {
                        "id": 13,
                        "url": "https://example.com"
                    },
                    "optionset_id": 16
                }
            ],
            "code": "..."
        },
        {
            "amount": 17,
            "persons": 16,
            "gram": 11,
            "comment": "...",
            "product": {
                "id": 19,
                "name": "...",
                "images": [
                    {
                        "resolutions": [
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            },
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            },
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            }
                        ],
                        "white_background": true
                    },
                    {
                        "resolutions": [
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            },
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            },
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            }
                        ],
                        "white_background": false
                    },
                    {
                        "resolutions": [
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            },
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            },
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            }
                        ],
                        "white_background": false
                    }
                ],
                "price_type": "PER_UNIT",
                "target_price": true,
                "price": 16
            },
            "product_price": {
                "id": 12,
                "name": "...",
                "price": 17
            },
            "calculated_prices": {
                "unit_price": 12,
                "price": 12
            },
            "discount_prices": {
                "unit_price": 15,
                "price": 17
            },
            "options": [
                {
                    "id": 18,
                    "name": "...",
                    "price_change": 10,
                    "optionset": {
                        "id": 13,
                        "name": "...",
                        "allow_attachment": true
                    }
                },
                {
                    "id": 14,
                    "name": "...",
                    "price_change": 13,
                    "optionset": {
                        "id": 14,
                        "name": "...",
                        "allow_attachment": true
                    }
                },
                {
                    "id": 19,
                    "name": "...",
                    "price_change": 10,
                    "optionset": {
                        "id": 17,
                        "name": "...",
                        "allow_attachment": false
                    }
                }
            ],
            "uploads": [
                {
                    "upload": {
                        "id": 19,
                        "url": "https://example.com"
                    },
                    "optionset_id": 12
                },
                {
                    "upload": {
                        "id": 13,
                        "url": "https://example.com"
                    },
                    "optionset_id": 14
                },
                {
                    "upload": {
                        "id": 11,
                        "url": "https://example.com"
                    },
                    "optionset_id": 11
                }
            ],
            "code": "..."
        },
        {
            "amount": 16,
            "persons": 14,
            "gram": 18,
            "comment": "...",
            "product": {
                "id": 16,
                "name": "...",
                "images": [
                    {
                        "resolutions": [
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            },
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            },
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            }
                        ],
                        "white_background": true
                    },
                    {
                        "resolutions": [
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            },
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            },
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            }
                        ],
                        "white_background": true
                    },
                    {
                        "resolutions": [
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            },
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            },
                            {
                                "src": "https://example.com",
                                "width": 600,
                                "height": 350
                            }
                        ],
                        "white_background": true
                    }
                ],
                "price_type": "PER_UNIT",
                "target_price": false,
                "price": 11
            },
            "product_price": {
                "id": 19,
                "name": "...",
                "price": 18
            },
            "calculated_prices": {
                "unit_price": 15,
                "price": 19
            },
            "discount_prices": {
                "unit_price": 17,
                "price": 14
            },
            "options": [
                {
                    "id": 11,
                    "name": "...",
                    "price_change": 13,
                    "optionset": {
                        "id": 16,
                        "name": "...",
                        "allow_attachment": true
                    }
                },
                {
                    "id": 10,
                    "name": "...",
                    "price_change": 18,
                    "optionset": {
                        "id": 17,
                        "name": "...",
                        "allow_attachment": true
                    }
                },
                {
                    "id": 15,
                    "name": "...",
                    "price_change": 11,
                    "optionset": {
                        "id": 11,
                        "name": "...",
                        "allow_attachment": true
                    }
                }
            ],
            "uploads": [
                {
                    "upload": {
                        "id": 10,
                        "url": "https://example.com"
                    },
                    "optionset_id": 11
                },
                {
                    "upload": {
                        "id": 16,
                        "url": "https://example.com"
                    },
                    "optionset_id": 18
                },
                {
                    "upload": {
                        "id": 19,
                        "url": "https://example.com"
                    },
                    "optionset_id": 14
                }
            ],
            "code": "..."
        }
    ]
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
0.2.1 stable