Get list of orders that can be delivered

Provides a list of all orders that can be delivered.

Request

Authorization

Add parameter in header

api-key

Example:

api-key: ********************

Query Params

pageSize

integer

optional

This specifies the number of objects to returned, ranging between 10 and 100.

Example:

100

pageNumber

integer

optional

The parameter pageNumber indicates which page of the result should be requested.

Example:

inStock

string

optional

Search for all orders based on the provided InStock parameter. Values: yes, no, partially

Example:

yes

deliveryType

string

optional

Search for all orders based on the provided delivery type.

modifiedAfter

string <date-time>

optional

Search for all results that have been modified after the specified timestamp.

Example:

2024-04-12T13:49:51.141Z

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

pagination

object

optional

totalResults

integer

optional

The total number of records.

pageNumber

integer

optional

The current page number.

pageSize

integer

optional

The number of records returned per page.

totalPages

integer

optional

The total number of pages.

results

array [object {11}]

required

integer

required

The unique identifier of the order.

number

string

optional

The unique number with which the order can be found.

status

string

optional

The status of the order.

confirmedDeliveryDate

string <date-time>

optional

The confirmed delivery date of the delivery.

expectedDate

string <date-time>

optional

The desired delivery date of the delivery.

inStock

string

optional

This indicates whether the order is in stock or partially in stock. yes, no and partially

comment

object

optional

Comments related to the order.

delivery

object

optional

Delivery information relevant to the order.

lines

array [object {12}]

optional

The order lines.

totalPrice

number <double>

optional

The total amount of the order (calculated field).

paidAmount

number <double>

optional

The amount already paid on the order (calculated field).

Example

{
    "pagination": {
        "totalResults": 2,
        "pageNumber": 2,
        "pageSize": 100,
        "totalPages": 1
    },
    "results": [
        {
            "id": 1,
            "number": "nostrud sint proident occaecat",
            "status": "proident",
            "confirmedDeliveryDate": "",
            "desiredDeliveryDate": "2024-04-10T04:55:34.891Z",
            "comment": {
                "intern": "exercitation culpa in ipsum tempor",
                "extern": "dolore dolor laboris"
            },
            "delivery": {
                "type": "cillum dolore",
                "condition": "Excepteur aliquip deserunt cillum",
                "address": {
                    "street": "Maasdijk 522b",
                    "houseNumber": "voluptate incididunt nulla",
                    "zipCode": "1913 MM",
                    "city": "Ogden",
                    "country": "Qatar"
                }
            },
            "lines": [
                {
                    "id": -951493,
                    "lineNumber": 88908182,
                    "code": "qui aliqua sed dolore",
                    "barcode": "ullamco elit dolor ut",
                    "description": "Modi molestias at quod dolorem nesciunt. Fugiat molestiae exercitationem laudantium nulla laboriosam. Provident ad asperiores explicabo officia voluptate. Amet sit assumenda voluptatibus eum magni.",
                    "quantity": -88183751.47046757,
                    "quantityToDeliver": 18148121.86844042,
                    "comment": {
                        "intern": "quis pariatur nisi magna mollit",
                        "extern": "ad aute"
                    },
                    "configuration": {
                        "id": 41852588,
                        "items": [
                            {
                                "key": "in",
                                "value": "exercitation mollit"
                            }
                        ]
                    },
                    "volume": -45048160.4723004,
                    "warehouses": [
                        {
                            "warehouse": "esse nisi aliquip mollit nulla",
                            "quantity": 94006544.13411087
                        }
                    ]
                }
            ],
            "totalPrice": 33014038.80557485,
            "paidAmount": 53867306.45734334
        }
    ]
}

🟢204No Content

🟠403Forbidden

🟠422Parameter Error