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": 17,
            "status": "PENDING",
            "valid": true,
            "order_nr": 16,
            "prices": {
                "price": {
                    "value": 19,
                    "currency": "EUR"
                },
                "discount": {
                    "value": 14,
                    "currency": "EUR"
                },
                "warranty": {
                    "value": 16,
                    "currency": "EUR"
                },
                "delivery_cost": {
                    "value": 10,
                    "currency": "EUR"
                },
                "invoice_cost": {
                    "value": 16,
                    "currency": "EUR"
                },
                "sms_cost": {
                    "value": 15,
                    "currency": "EUR"
                },
                "transaction_cost": {
                    "value": 15,
                    "currency": "EUR"
                },
                "price_to_pay": {
                    "value": 14,
                    "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": 11,
                "comment": "..."
            },
            "shop": {
                "id": 14,
                "name": "Ms. Sally Anderson",
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE"
                },
                "allow_comments": true,
                "url": "...",
                "allow_order_comments": true,
                "allow_product_comments": false,
                "allow_orders": true,
                "currency": "EUR"
            },
            "created_at": 1657086003,
            "joyn": {
                "points": 16,
                "collect_url": "https://example.com",
                "qr_code_url": "https://example.com"
            },
            "payment_status": "pending",
            "currency": "EUR",
            "bank_transfer": {
                "reference": "...",
                "bank_accounts": [
                    {
                        "bank": "ING. Bank",
                        "number": "BE283578529348"
                    },
                    {
                        "bank": "ING. Bank",
                        "number": "BE283578529348"
                    },
                    {
                        "bank": "ING. Bank",
                        "number": "BE283578529348"
                    }
                ]
            }
        },
        {
            "id": 11,
            "status": "PENDING",
            "valid": true,
            "order_nr": 10,
            "prices": {
                "price": {
                    "value": 18,
                    "currency": "EUR"
                },
                "discount": {
                    "value": 15,
                    "currency": "EUR"
                },
                "warranty": {
                    "value": 19,
                    "currency": "EUR"
                },
                "delivery_cost": {
                    "value": 17,
                    "currency": "EUR"
                },
                "invoice_cost": {
                    "value": 14,
                    "currency": "EUR"
                },
                "sms_cost": {
                    "value": 16,
                    "currency": "EUR"
                },
                "transaction_cost": {
                    "value": 14,
                    "currency": "EUR"
                },
                "price_to_pay": {
                    "value": 11,
                    "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": 17,
                "comment": "..."
            },
            "shop": {
                "id": 17,
                "name": "Mrs. Paula Skiles PhD",
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE"
                },
                "allow_comments": true,
                "url": "...",
                "allow_order_comments": true,
                "allow_product_comments": false,
                "allow_orders": false,
                "currency": "EUR"
            },
            "created_at": 1657086003,
            "joyn": {
                "points": 14,
                "collect_url": "https://example.com",
                "qr_code_url": "https://example.com"
            },
            "payment_status": "pending",
            "currency": "EUR",
            "bank_transfer": {
                "reference": "...",
                "bank_accounts": [
                    {
                        "bank": "ING. Bank",
                        "number": "BE283578529348"
                    },
                    {
                        "bank": "ING. Bank",
                        "number": "BE283578529348"
                    },
                    {
                        "bank": "ING. Bank",
                        "number": "BE283578529348"
                    }
                ]
            }
        },
        {
            "id": 16,
            "status": "PENDING",
            "valid": false,
            "order_nr": 14,
            "prices": {
                "price": {
                    "value": 16,
                    "currency": "EUR"
                },
                "discount": {
                    "value": 17,
                    "currency": "EUR"
                },
                "warranty": {
                    "value": 13,
                    "currency": "EUR"
                },
                "delivery_cost": {
                    "value": 18,
                    "currency": "EUR"
                },
                "invoice_cost": {
                    "value": 16,
                    "currency": "EUR"
                },
                "sms_cost": {
                    "value": 13,
                    "currency": "EUR"
                },
                "transaction_cost": {
                    "value": 13,
                    "currency": "EUR"
                },
                "price_to_pay": {
                    "value": 19,
                    "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": 11,
                "comment": "..."
            },
            "shop": {
                "id": 13,
                "name": "Katelin Fadel DVM",
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE"
                },
                "allow_comments": false,
                "url": "...",
                "allow_order_comments": false,
                "allow_product_comments": false,
                "allow_orders": false,
                "currency": "EUR"
            },
            "created_at": 1657086003,
            "joyn": {
                "points": 18,
                "collect_url": "https://example.com",
                "qr_code_url": "https://example.com"
            },
            "payment_status": "pending",
            "currency": "EUR",
            "bank_transfer": {
                "reference": "...",
                "bank_accounts": [
                    {
                        "bank": "ING. Bank",
                        "number": "BE283578529348"
                    },
                    {
                        "bank": "ING. Bank",
                        "number": "BE283578529348"
                    },
                    {
                        "bank": "ING. Bank",
                        "number": "BE283578529348"
                    }
                ]
            }
        }
    ],
    "next": {
        "status": "PENDING",
        "created_after": 1657086003,
        "created_before": 1657086003,
        "before_id": 17,
        "after_id": 13,
        "sort": "ascending",
        "company_id": 15
    },
    "future": {
        "status": "PENDING",
        "created_after": 1657086003,
        "created_before": 1657086003,
        "before_id": 11,
        "after_id": 11,
        "sort": "ascending",
        "company_id": 13
    }
}

Response

When returned in a response.

Example 1

{
    "results": [
        {
            "id": 15,
            "status": "PENDING",
            "valid": false,
            "order_nr": 12,
            "prices": {
                "price": {
                    "value": 13,
                    "currency": "EUR"
                },
                "discount": {
                    "value": 14,
                    "currency": "EUR"
                },
                "warranty": {
                    "value": 14,
                    "currency": "EUR"
                },
                "delivery_cost": {
                    "value": 18,
                    "currency": "EUR"
                },
                "invoice_cost": {
                    "value": 18,
                    "currency": "EUR"
                },
                "sms_cost": {
                    "value": 10,
                    "currency": "EUR"
                },
                "transaction_cost": {
                    "value": 11,
                    "currency": "EUR"
                },
                "price_to_pay": {
                    "value": 14,
                    "currency": "EUR"
                },
                "price_with_discount": {
                    "value": 12,
                    "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": 17,
                "comment": "..."
            },
            "shop": {
                "id": 12,
                "name": "Mrs. Aleen Gleichner",
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE",
                    "position": {
                        "latitude": 1.54361,
                        "longitude": 0.45645
                    }
                },
                "allow_comments": false,
                "url": "...",
                "allow_order_comments": true,
                "allow_product_comments": true,
                "allow_orders": true,
                "currency": "EUR"
            },
            "created_at": 1657086003,
            "joyn": {
                "points": 19,
                "collect_url": "https://example.com",
                "qr_code_url": "https://example.com"
            },
            "payment_status": "pending",
            "currency": "EUR",
            "bank_transfer": {
                "reference": "...",
                "bank_accounts": [
                    {
                        "bank": "ING. Bank",
                        "number": "BE283578529348"
                    },
                    {
                        "bank": "ING. Bank",
                        "number": "BE283578529348"
                    },
                    {
                        "bank": "ING. Bank",
                        "number": "BE283578529348"
                    }
                ]
            }
        },
        {
            "id": 16,
            "status": "PENDING",
            "valid": false,
            "order_nr": 16,
            "prices": {
                "price": {
                    "value": 16,
                    "currency": "EUR"
                },
                "discount": {
                    "value": 13,
                    "currency": "EUR"
                },
                "warranty": {
                    "value": 14,
                    "currency": "EUR"
                },
                "delivery_cost": {
                    "value": 17,
                    "currency": "EUR"
                },
                "invoice_cost": {
                    "value": 15,
                    "currency": "EUR"
                },
                "sms_cost": {
                    "value": 17,
                    "currency": "EUR"
                },
                "transaction_cost": {
                    "value": 18,
                    "currency": "EUR"
                },
                "price_to_pay": {
                    "value": 11,
                    "currency": "EUR"
                },
                "price_with_discount": {
                    "value": 13,
                    "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,
                "comment": "..."
            },
            "shop": {
                "id": 10,
                "name": "Cloyd Bogan",
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE",
                    "position": {
                        "latitude": 1.54361,
                        "longitude": 0.45645
                    }
                },
                "allow_comments": false,
                "url": "...",
                "allow_order_comments": false,
                "allow_product_comments": true,
                "allow_orders": true,
                "currency": "EUR"
            },
            "created_at": 1657086003,
            "joyn": {
                "points": 18,
                "collect_url": "https://example.com",
                "qr_code_url": "https://example.com"
            },
            "payment_status": "pending",
            "currency": "EUR",
            "bank_transfer": {
                "reference": "...",
                "bank_accounts": [
                    {
                        "bank": "ING. Bank",
                        "number": "BE283578529348"
                    },
                    {
                        "bank": "ING. Bank",
                        "number": "BE283578529348"
                    },
                    {
                        "bank": "ING. Bank",
                        "number": "BE283578529348"
                    }
                ]
            }
        },
        {
            "id": 18,
            "status": "PENDING",
            "valid": false,
            "order_nr": 15,
            "prices": {
                "price": {
                    "value": 17,
                    "currency": "EUR"
                },
                "discount": {
                    "value": 12,
                    "currency": "EUR"
                },
                "warranty": {
                    "value": 17,
                    "currency": "EUR"
                },
                "delivery_cost": {
                    "value": 14,
                    "currency": "EUR"
                },
                "invoice_cost": {
                    "value": 15,
                    "currency": "EUR"
                },
                "sms_cost": {
                    "value": 13,
                    "currency": "EUR"
                },
                "transaction_cost": {
                    "value": 12,
                    "currency": "EUR"
                },
                "price_to_pay": {
                    "value": 17,
                    "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": 10,
                "comment": "..."
            },
            "shop": {
                "id": 18,
                "name": "Maritza Jacobi",
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE",
                    "position": {
                        "latitude": 1.54361,
                        "longitude": 0.45645
                    }
                },
                "allow_comments": true,
                "url": "...",
                "allow_order_comments": false,
                "allow_product_comments": false,
                "allow_orders": false,
                "currency": "EUR"
            },
            "created_at": 1657086003,
            "joyn": {
                "points": 12,
                "collect_url": "https://example.com",
                "qr_code_url": "https://example.com"
            },
            "payment_status": "pending",
            "currency": "EUR",
            "bank_transfer": {
                "reference": "...",
                "bank_accounts": [
                    {
                        "bank": "ING. Bank",
                        "number": "BE283578529348"
                    },
                    {
                        "bank": "ING. Bank",
                        "number": "BE283578529348"
                    },
                    {
                        "bank": "ING. Bank",
                        "number": "BE283578529348"
                    }
                ]
            }
        }
    ],
    "next": {
        "status": "PENDING",
        "created_after": 1657086003,
        "created_before": 1657086003,
        "before_id": 13,
        "after_id": 15,
        "sort": "ascending",
        "company_id": 16
    },
    "future": {
        "status": "PENDING",
        "created_after": 1657086003,
        "created_before": 1657086003,
        "before_id": 17,
        "after_id": 16,
        "sort": "ascending",
        "company_id": 17
    }
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.5.2 stable