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": 95,
            "status": "COLLECTED",
            "valid": true,
            "order_nr": 46,
            "prices": {
                "price": {
                    "value": 3676,
                    "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": 3676,
                    "currency": "EUR"
                }
            },
            "payment_method": "pesopay_visa",
            "checkout": {
                "method": "takeout",
                "date": "2017-09-24",
                "time": "17:46"
            },
            "created_at": 1592307655,
            "shop": {
                "id": 243,
                "name": "Best Thing Since Sliced Bread",
                "address": {
                    "street": "Declercqhof",
                    "nr": "12",
                    "zipcode": "3665",
                    "city": "Sint-Truiden",
                    "country": "BE",
                    "position": {
                        "latitude": 51.05,
                        "longitude": 3.71667
                    }
                },
                "allow_comments": true,
                "currency": "EUR"
            },
            "payment_status": null,
            "joyn": null,
            "currency": "EUR"
        },
        {
            "id": 96,
            "status": "APPROVED",
            "valid": true,
            "order_nr": 47,
            "prices": {
                "price": {
                    "value": 9074,
                    "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": 9074,
                    "currency": "EUR"
                }
            },
            "payment_method": "creditcard",
            "checkout": {
                "method": "delivery",
                "date": "2023-06-25",
                "time": "09:42",
                "end_time": "09:57",
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Ghent",
                    "country": "BE"
                },
                "notes": null
            },
            "created_at": 1592307655,
            "shop": {
                "id": 244,
                "name": "Best Thing Since Sliced Bread",
                "address": {
                    "street": "Lauwersstraat",
                    "nr": "67",
                    "zipcode": "7331",
                    "city": "Blankenberge",
                    "country": "BE",
                    "position": {
                        "latitude": 51.260197,
                        "longitude": 4.402771
                    }
                },
                "allow_comments": true,
                "currency": "EUR"
            },
            "payment_status": null,
            "joyn": null,
            "currency": "EUR"
        },
        {
            "id": 97,
            "status": "DELETED_BY_SHOP",
            "valid": true,
            "order_nr": 48,
            "prices": {
                "price": {
                    "value": 7654,
                    "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": 7654,
                    "currency": "EUR"
                }
            },
            "payment_method": "pesopay_gcash",
            "checkout": {
                "method": "latch",
                "date": "2016-04-02",
                "time": "20:38",
                "latch_id": 25,
                "name": "Lana Heylen",
                "address": {
                    "street": "De Wintersteeg",
                    "nr": "37",
                    "zipcode": "5544",
                    "city": "Le Rœulx",
                    "country": "BE"
                }
            },
            "created_at": 1592307655,
            "shop": {
                "id": 245,
                "name": "Slow Dough",
                "address": {
                    "street": "Wuytsbaan",
                    "nr": "44",
                    "zipcode": "6997",
                    "city": "Deinze",
                    "country": "BE",
                    "position": {
                        "latitude": 51.260197,
                        "longitude": 4.402771
                    }
                },
                "allow_comments": true,
                "currency": "EUR"
            },
            "payment_status": null,
            "joyn": null,
            "currency": "EUR"
        }
    ],
    "next": {
        "status": "PENDING",
        "created_after": 1592307655,
        "created_before": 1592307655,
        "before_id": 12,
        "after_id": 12,
        "sort": "ascending",
        "company_id": 12
    },
    "future": {
        "status": "PENDING",
        "created_after": 1592307655,
        "created_before": 1592307655,
        "before_id": 12,
        "after_id": 12,
        "sort": "ascending",
        "company_id": 12
    }
}

Response

When returned in a response.

Example 1

{
    "results": [
        {
            "id": 98,
            "status": "DELETED_BY_SHOP",
            "valid": true,
            "order_nr": 49,
            "prices": {
                "price": {
                    "value": 11867,
                    "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": 11867,
                    "currency": "EUR"
                }
            },
            "payment_method": "stripe_google_pay",
            "checkout": {
                "method": "takeout",
                "date": "2023-09-05",
                "time": "14:30"
            },
            "created_at": 1592307655,
            "shop": {
                "id": 246,
                "name": "The Pastry Corner",
                "address": {
                    "street": "Adamstraat",
                    "nr": "49",
                    "zipcode": "4990",
                    "city": "Diksmuide",
                    "country": "BE",
                    "position": {
                        "latitude": 51.05,
                        "longitude": 3.71667
                    }
                },
                "allow_comments": true,
                "currency": "EUR"
            },
            "payment_status": null,
            "joyn": null,
            "currency": "EUR"
        },
        {
            "id": 99,
            "status": "PENDING",
            "valid": true,
            "order_nr": 50,
            "prices": {
                "price": {
                    "value": 3152,
                    "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": 3152,
                    "currency": "EUR"
                }
            },
            "payment_method": "monizze",
            "checkout": {
                "method": "delivery",
                "date": "2019-08-24",
                "time": "01:02",
                "end_time": "01:17",
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Ghent",
                    "country": "BE"
                },
                "notes": null
            },
            "created_at": 1592307656,
            "shop": {
                "id": 247,
                "name": "Born and Bread",
                "address": {
                    "street": "De Wildering",
                    "nr": "58",
                    "zipcode": "9880",
                    "city": "Fosses-la-Ville",
                    "country": "BE",
                    "position": {
                        "latitude": 51.260197,
                        "longitude": 4.402771
                    }
                },
                "allow_comments": true,
                "currency": "EUR"
            },
            "payment_status": null,
            "joyn": null,
            "currency": "EUR"
        },
        {
            "id": 100,
            "status": "APPROVED",
            "valid": true,
            "order_nr": 51,
            "prices": {
                "price": {
                    "value": 3412,
                    "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": 3412,
                    "currency": "EUR"
                }
            },
            "payment_method": "payu_sp_pbl",
            "checkout": {
                "method": "latch",
                "date": "2016-02-18",
                "time": "10:54",
                "latch_id": 26,
                "name": "Hajar Barry",
                "address": {
                    "street": "Boulangerring",
                    "nr": "19",
                    "zipcode": "6706",
                    "city": "Halen",
                    "country": "BE"
                }
            },
            "created_at": 1592307656,
            "shop": {
                "id": 248,
                "name": "Glazed and Glorious",
                "address": {
                    "street": "Timmermansboulevard",
                    "nr": "30",
                    "zipcode": "8580",
                    "city": "Doornik",
                    "country": "BE",
                    "position": {
                        "latitude": 51.260197,
                        "longitude": 4.402771
                    }
                },
                "allow_comments": true,
                "currency": "EUR"
            },
            "payment_status": null,
            "joyn": null,
            "currency": "EUR"
        }
    ],
    "next": {
        "status": "PENDING",
        "created_after": 1592307656,
        "created_before": 1592307656,
        "before_id": 12,
        "after_id": 12,
        "sort": "ascending",
        "company_id": 12
    },
    "future": {
        "status": "PENDING",
        "created_after": 1592307656,
        "created_before": 1592307656,
        "before_id": 12,
        "after_id": 12,
        "sort": "ascending",
        "company_id": 12
    }
}
1.5.0 stable