Get a list of orders

GET

/Order

Query orders submitted at the show

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/Order?sort&page=1&resultsPerPage=20&customerid&productid&vendorid&status&ordertype&datelastmodified&deliverydate&deliverydatetill&ponumber'

Response Example

[
    {
        "items": [
            {
                "modifiedDate": "2025-01-20T04:50:03.61",
                "orderLineID": "11",
                "customer": {
                    "id": "CUSTOMER2",
                    "name": "CUSTOMER2 - KEEP"
                },
                "product": {
                    "id": "FORAPI",
                    "description": "Product For API Do not Delete"
                },
                "orderUnit": "CS",
                "deliveryDate": "2024-07-22T00:00:00",
                "quantity": 2,
                "orderType": "REGULAR",
                "price": 150,
                "basePrice": 100,
                "vendor": {
                    "id": "FORAPI",
                    "name": "VENDOR FOR API Do not Delete"
                },
                "warehouse": {
                    "id": "DFLT",
                    "description": "Default warehouse"
                },
                "purchaseOrder": {
                    "id": "PO12345",
                    "notes": "This is a sample purchase order"
                },
                "allowances": [
                    {
                        "allowanceDescription": "REBATE PER UNIT",
                        "componentName": "C1",
                        "benefitType": "Rebate Per Unit"
                    },
                    {
                        "allowanceDescription": "REBATE PER UNIT",
                        "componentName": "C2",
                        "benefitType": "Rebate Per Unit"
                    }
                ]
            },
            {
                "modifiedDate": "2025-01-22T22:24:45.39",
                "orderLineID": "20",
                "customer": {
                    "id": "CUSTOMER2",
                    "name": "CUSTOMER2 - KEEP"
                },
                "product": {
                    "id": "FORAPI",
                    "description": "Product For API Do not Delete"
                },
                "orderUnit": "CS",
                "deliveryDate": "2024-07-02T00:00:00",
                "quantity": 1,
                "orderType": "REGULAR",
                "price": 150,
                "basePrice": 100,
                "vendor": {
                    "id": "FORAPI",
                    "name": "VENDOR FOR API Do not Delete"
                },
                "warehouse": {
                    "id": "DFLT",
                    "description": "Default warehouse"
                },
                "purchaseOrder": {
                    "id": "PO12345",
                    "notes": "This is a sample purchase order"
                },
                "allowances": [
                    {
                        "allowanceDescription": "REBATE PER UNIT",
                        "componentName": "C1",
                        "benefitType": "Rebate Per Unit"
                    },
                    {
                        "allowanceDescription": "REBATE PER UNIT",
                        "componentName": "C2",
                        "benefitType": "Rebate Per Unit"
                    }
                ]
            },
            {
                "modifiedDate": "2025-01-23T18:50:16.4",
                "orderLineID": "24",
                "customer": {
                    "id": "CUSTOMER2",
                    "name": "CUSTOMER2 - KEEP"
                },
                "product": {
                    "id": "FORAPI",
                    "description": "Product For API Do not Delete"
                },
                "orderUnit": "CS",
                "deliveryDate": "2024-07-04T00:00:00",
                "quantity": 1,
                "orderType": "REGULAR",
                "price": 150,
                "basePrice": 100,
                "vendor": {
                    "id": "FORAPI",
                    "name": "VENDOR FOR API Do not Delete"
                },
                "warehouse": {
                    "id": "DFLT",
                    "description": "Default warehouse"
                },
                "purchaseOrder": {
                    "id": "PO12345",
                    "notes": "This is a sample purchase order"
                },
                "allowances": [
                    {
                        "allowanceDescription": "REBATE PER UNIT",
                        "componentName": "C1",
                        "benefitType": "Rebate Per Unit"
                    },
                    {
                        "allowanceDescription": "REBATE PER UNIT",
                        "componentName": "C2",
                        "benefitType": "Rebate Per Unit"
                    }
                ]
            }
        ]
    }
]

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200Success

application/json

Body

Modified at 2025-05-13 17:32:51

Bulk update orders

Retrieve a specific order by ID