FuturePagedResult

Field Type Description
results [Order.simple] Array of Order.simple
next Dictionary? Nullable. Set when we have more results at this moment. It contains the query parameters you need to request the following results. Is null when there are no results left
future Dictionary? Nullable. When all the results have been returned (no next set), but there might be more results in the future, future contains the query parameters you should use to request new results in the future (e.g. in 15 minutes) to know if you have extra results without returning the same results again.

Examples

Request

When used inside a request.

Example 1

{
    "results": [
        {
            "id": 1330,
            "status": "DELETED_BY_SHOP",
            "valid": true,
            "order_nr": 46,
            "prices": {
                "price": {
                    "value": 7053,
                    "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": 7053,
                    "currency": "EUR"
                }
            },
            "payment_method": "payu_sp_mc",
            "checkout": {
                "method": "takeout",
                "date": "2025-01-16",
                "time": "19:42"
            },
            "created_at": 1618995842,
            "shop": {
                "id": 3287,
                "name": "The Grateful Bread",
                "address": {
                    "street": "Celikstraat",
                    "nr": "40",
                    "zipcode": "4837",
                    "city": "Oostende",
                    "country": "BE",
                    "position": {
                        "latitude": 51.260197,
                        "longitude": 4.402771
                    }
                },
                "allow_comments": false,
                "currency": "EUR"
            },
            "payment_status": null,
            "joyn": null,
            "currency": "EUR"
        },
        {
            "id": 1334,
            "status": "REMOVED",
            "valid": true,
            "order_nr": 47,
            "prices": {
                "price": {
                    "value": 5267,
                    "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": 5267,
                    "currency": "EUR"
                }
            },
            "payment_method": "cartes_bancaires",
            "checkout": {
                "method": "delivery",
                "date": "2021-08-10",
                "time": "10:53",
                "end_time": "11:08",
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Ghent",
                    "country": "BE"
                },
                "notes": null
            },
            "created_at": 1618995845,
            "shop": {
                "id": 3291,
                "name": "Common Scents",
                "address": {
                    "street": "Vercammenhof",
                    "nr": "59",
                    "zipcode": "9150",
                    "city": "Ciney",
                    "country": "BE",
                    "position": {
                        "latitude": 51.05,
                        "longitude": 3.71667
                    }
                },
                "allow_comments": false,
                "currency": "EUR"
            },
            "payment_status": null,
            "joyn": null,
            "currency": "EUR"
        },
        {
            "id": 1337,
            "status": "DECLINED",
            "valid": true,
            "order_nr": 48,
            "prices": {
                "price": {
                    "value": 19274,
                    "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": 19274,
                    "currency": "EUR"
                }
            },
            "payment_method": "webpay",
            "checkout": {
                "method": "latch",
                "date": "2024-12-26",
                "time": "01:24",
                "latch_id": 397,
                "name": "Lowie Schmitz",
                "address": {
                    "street": "Dierckxlaan",
                    "nr": "32",
                    "zipcode": "5500",
                    "city": "Kortrijk",
                    "country": "BE"
                }
            },
            "created_at": 1618995847,
            "shop": {
                "id": 3295,
                "name": "Sprinkles of Joy",
                "address": {
                    "street": "Lejeunebaan",
                    "nr": "68",
                    "zipcode": "1790",
                    "city": "Izegem",
                    "country": "BE",
                    "position": {
                        "latitude": 50.8503396,
                        "longitude": 4.3517103
                    }
                },
                "allow_comments": false,
                "currency": "EUR"
            },
            "payment_status": null,
            "joyn": null,
            "currency": "EUR"
        }
    ],
    "next": {
        "status": "PENDING",
        "created_after": 1618995847,
        "created_before": 1618995847,
        "before_id": 12,
        "after_id": 12,
        "sort": "ascending",
        "company_id": 12
    },
    "future": {
        "status": "PENDING",
        "created_after": 1618995847,
        "created_before": 1618995847,
        "before_id": 12,
        "after_id": 12,
        "sort": "ascending",
        "company_id": 12
    }
}

Response

When returned in a response.

Example 1

{
    "results": [
        {
            "id": 1340,
            "status": "PENDING",
            "valid": true,
            "order_nr": 49,
            "prices": {
                "price": {
                    "value": 7293,
                    "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": 7293,
                    "currency": "EUR"
                }
            },
            "payment_method": "stripe_apple_pay",
            "checkout": {
                "method": "takeout",
                "date": "2017-11-03",
                "time": "21:40"
            },
            "created_at": 1618995849,
            "shop": {
                "id": 3300,
                "name": "Mad Batters",
                "address": {
                    "street": "De Conincksingel",
                    "nr": "97",
                    "zipcode": "3128",
                    "city": "Mechelen",
                    "country": "BE",
                    "position": {
                        "latitude": 50.8503396,
                        "longitude": 4.3517103
                    }
                },
                "allow_comments": false,
                "currency": "EUR"
            },
            "payment_status": null,
            "joyn": null,
            "currency": "EUR"
        },
        {
            "id": 1343,
            "status": "APPROVED",
            "valid": true,
            "order_nr": 50,
            "prices": {
                "price": {
                    "value": 3178,
                    "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": 3178,
                    "currency": "EUR"
                }
            },
            "payment_method": "pesopay_mc",
            "checkout": {
                "method": "delivery",
                "date": "2024-04-28",
                "time": "02:38",
                "end_time": "02:53",
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Ghent",
                    "country": "BE"
                },
                "notes": null
            },
            "created_at": 1618995852,
            "shop": {
                "id": 3307,
                "name": "Sprinkles of Joy",
                "address": {
                    "street": "De Smedtlaan",
                    "nr": "81",
                    "zipcode": "4983",
                    "city": "Sankt Vith",
                    "country": "BE",
                    "position": {
                        "latitude": 51.05,
                        "longitude": 3.71667
                    }
                },
                "allow_comments": false,
                "currency": "EUR"
            },
            "payment_status": null,
            "joyn": null,
            "currency": "EUR"
        },
        {
            "id": 1346,
            "status": "APPROVED",
            "valid": true,
            "order_nr": 51,
            "prices": {
                "price": {
                    "value": 23691,
                    "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": 23691,
                    "currency": "EUR"
                }
            },
            "payment_method": "payu_brazil_diners",
            "checkout": {
                "method": "latch",
                "date": "2018-10-04",
                "time": "13:16",
                "latch_id": 400,
                "name": "Axel Georges",
                "address": {
                    "street": "Mathieustraat",
                    "nr": "49",
                    "zipcode": "6953",
                    "city": "Virton",
                    "country": "BE"
                }
            },
            "created_at": 1618995854,
            "shop": {
                "id": 3312,
                "name": "One-Man Dough",
                "address": {
                    "street": "Maréchalstraat",
                    "nr": "35",
                    "zipcode": "4837",
                    "city": "Stavelot",
                    "country": "BE",
                    "position": {
                        "latitude": 51.260197,
                        "longitude": 4.402771
                    }
                },
                "allow_comments": false,
                "currency": "EUR"
            },
            "payment_status": null,
            "joyn": null,
            "currency": "EUR"
        }
    ],
    "next": {
        "status": "PENDING",
        "created_after": 1618995854,
        "created_before": 1618995854,
        "before_id": 12,
        "after_id": 12,
        "sort": "ascending",
        "company_id": 12
    },
    "future": {
        "status": "PENDING",
        "created_after": 1618995854,
        "created_before": 1618995854,
        "before_id": 12,
        "after_id": 12,
        "sort": "ascending",
        "company_id": 12
    }
}
Version update available Please adjust your integration to the latest stable version (1.5.2)
1.5.0 stable