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": 13,
            "status": "PENDING",
            "valid": false,
            "order_nr": 14,
            "prices": {
                "price": {
                    "value": 11,
                    "currency": "EUR"
                },
                "discount": {
                    "value": 19,
                    "currency": "EUR"
                },
                "warranty": {
                    "value": 19,
                    "currency": "EUR"
                },
                "delivery_cost": {
                    "value": 11,
                    "currency": "EUR"
                },
                "invoice_cost": {
                    "value": 10,
                    "currency": "EUR"
                },
                "sms_cost": {
                    "value": 15,
                    "currency": "EUR"
                },
                "transaction_cost": {
                    "value": 11,
                    "currency": "EUR"
                },
                "price_to_pay": {
                    "value": 15,
                    "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": 17,
                "name": "Shaylee Koss",
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE"
                },
                "allow_comments": false,
                "currency": "EUR"
            },
            "created_at": 1629198228,
            "joyn": {
                "points": 15,
                "collect_url": "https://example.com",
                "qr_code_url": "https://example.com"
            },
            "payment_status": "pending",
            "currency": "EUR"
        },
        {
            "id": 18,
            "status": "PENDING",
            "valid": false,
            "order_nr": 19,
            "prices": {
                "price": {
                    "value": 11,
                    "currency": "EUR"
                },
                "discount": {
                    "value": 13,
                    "currency": "EUR"
                },
                "warranty": {
                    "value": 12,
                    "currency": "EUR"
                },
                "delivery_cost": {
                    "value": 18,
                    "currency": "EUR"
                },
                "invoice_cost": {
                    "value": 19,
                    "currency": "EUR"
                },
                "sms_cost": {
                    "value": 18,
                    "currency": "EUR"
                },
                "transaction_cost": {
                    "value": 17,
                    "currency": "EUR"
                },
                "price_to_pay": {
                    "value": 18,
                    "currency": "EUR"
                },
                "price_with_discount": {
                    "value": 16,
                    "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": 11
            },
            "shop": {
                "id": 12,
                "name": "Timmy Moore",
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE"
                },
                "allow_comments": true,
                "currency": "EUR"
            },
            "created_at": 1629198228,
            "joyn": {
                "points": 15,
                "collect_url": "https://example.com",
                "qr_code_url": "https://example.com"
            },
            "payment_status": "pending",
            "currency": "EUR"
        },
        {
            "id": 19,
            "status": "PENDING",
            "valid": true,
            "order_nr": 12,
            "prices": {
                "price": {
                    "value": 17,
                    "currency": "EUR"
                },
                "discount": {
                    "value": 16,
                    "currency": "EUR"
                },
                "warranty": {
                    "value": 14,
                    "currency": "EUR"
                },
                "delivery_cost": {
                    "value": 14,
                    "currency": "EUR"
                },
                "invoice_cost": {
                    "value": 10,
                    "currency": "EUR"
                },
                "sms_cost": {
                    "value": 17,
                    "currency": "EUR"
                },
                "transaction_cost": {
                    "value": 18,
                    "currency": "EUR"
                },
                "price_to_pay": {
                    "value": 18,
                    "currency": "EUR"
                },
                "price_with_discount": {
                    "value": 19,
                    "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": 14
            },
            "shop": {
                "id": 12,
                "name": "Randal Grant",
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE"
                },
                "allow_comments": true,
                "currency": "EUR"
            },
            "created_at": 1629198228,
            "joyn": {
                "points": 16,
                "collect_url": "https://example.com",
                "qr_code_url": "https://example.com"
            },
            "payment_status": "pending",
            "currency": "EUR"
        }
    ],
    "next": {
        "status": "PENDING",
        "created_after": 1629198228,
        "created_before": 1629198228,
        "before_id": 10,
        "after_id": 17,
        "sort": "ascending",
        "company_id": 17
    },
    "future": {
        "status": "PENDING",
        "created_after": 1629198228,
        "created_before": 1629198228,
        "before_id": 18,
        "after_id": 19,
        "sort": "ascending",
        "company_id": 11
    }
}

Response

When returned in a response.

Example 1

{
    "results": [
        {
            "id": 14,
            "status": "PENDING",
            "valid": true,
            "order_nr": 11,
            "prices": {
                "price": {
                    "value": 19,
                    "currency": "EUR"
                },
                "discount": {
                    "value": 12,
                    "currency": "EUR"
                },
                "warranty": {
                    "value": 14,
                    "currency": "EUR"
                },
                "delivery_cost": {
                    "value": 15,
                    "currency": "EUR"
                },
                "invoice_cost": {
                    "value": 19,
                    "currency": "EUR"
                },
                "sms_cost": {
                    "value": 17,
                    "currency": "EUR"
                },
                "transaction_cost": {
                    "value": 15,
                    "currency": "EUR"
                },
                "price_to_pay": {
                    "value": 15,
                    "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": 13
            },
            "shop": {
                "id": 16,
                "name": "Wyman O'Keefe",
                "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": 1629198228,
            "joyn": {
                "points": 10,
                "collect_url": "https://example.com",
                "qr_code_url": "https://example.com"
            },
            "payment_status": "pending",
            "currency": "EUR"
        },
        {
            "id": 17,
            "status": "PENDING",
            "valid": true,
            "order_nr": 17,
            "prices": {
                "price": {
                    "value": 19,
                    "currency": "EUR"
                },
                "discount": {
                    "value": 15,
                    "currency": "EUR"
                },
                "warranty": {
                    "value": 13,
                    "currency": "EUR"
                },
                "delivery_cost": {
                    "value": 11,
                    "currency": "EUR"
                },
                "invoice_cost": {
                    "value": 13,
                    "currency": "EUR"
                },
                "sms_cost": {
                    "value": 18,
                    "currency": "EUR"
                },
                "transaction_cost": {
                    "value": 17,
                    "currency": "EUR"
                },
                "price_to_pay": {
                    "value": 10,
                    "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": 14
            },
            "shop": {
                "id": 13,
                "name": "Carli Kuphal",
                "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": 1629198228,
            "joyn": {
                "points": 10,
                "collect_url": "https://example.com",
                "qr_code_url": "https://example.com"
            },
            "payment_status": "pending",
            "currency": "EUR"
        },
        {
            "id": 17,
            "status": "PENDING",
            "valid": false,
            "order_nr": 11,
            "prices": {
                "price": {
                    "value": 16,
                    "currency": "EUR"
                },
                "discount": {
                    "value": 13,
                    "currency": "EUR"
                },
                "warranty": {
                    "value": 12,
                    "currency": "EUR"
                },
                "delivery_cost": {
                    "value": 15,
                    "currency": "EUR"
                },
                "invoice_cost": {
                    "value": 15,
                    "currency": "EUR"
                },
                "sms_cost": {
                    "value": 12,
                    "currency": "EUR"
                },
                "transaction_cost": {
                    "value": 13,
                    "currency": "EUR"
                },
                "price_to_pay": {
                    "value": 14,
                    "currency": "EUR"
                },
                "price_with_discount": {
                    "value": 16,
                    "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": 14
            },
            "shop": {
                "id": 17,
                "name": "Darron Rath",
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE",
                    "position": {
                        "latitude": 1.54361,
                        "longitude": 0.45645
                    }
                },
                "allow_comments": false,
                "currency": "EUR"
            },
            "created_at": 1629198228,
            "joyn": {
                "points": 11,
                "collect_url": "https://example.com",
                "qr_code_url": "https://example.com"
            },
            "payment_status": "pending",
            "currency": "EUR"
        }
    ],
    "next": {
        "status": "PENDING",
        "created_after": 1629198228,
        "created_before": 1629198228,
        "before_id": 19,
        "after_id": 11,
        "sort": "ascending",
        "company_id": 17
    },
    "future": {
        "status": "PENDING",
        "created_after": 1629198228,
        "created_before": 1629198228,
        "before_id": 17,
        "after_id": 14,
        "sort": "ascending",
        "company_id": 19
    }
}
Version update available Please adjust your integration to the latest stable version (1.6.0)
1.5.0 stable