Trade Show

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

sort

string

optional

Sort the items using {SortField:SortDirection}

page

string

optional

Page index to return, starts at Page 1

Example:

resultsPerPage

string

optional

Number of items to return per page

Example:

customerid

string

optional

Unique ID provided to filter by customer

productid

string

optional

Unique ID provided to filter by product

vendorid

string

optional

Unique ID provided to filter by vendor

status

string

deprecated

Current state of the order

ordertype

enum<string>

optional

Classification of the order type. Typically, the order type is Regular, but it can also be Pre Order -- an order made before the show, or Tentative -- an order made against a product that doesn't yet have a price.

Allowed values:

RegularPre OrderTentative

datelastmodified

string <date-time>

optional

Filter by the last time the order was modified

deliverydate

string <date-time>

optional

Filter by delivery date or used with deliverydatetill to filter by a range of delivery dates

deliverydatetill

string <date-time>

optional

Used with deliverydate to filter by a range of delivery dates

ponumber

string

optional

Filter by purchase order

Responses

🟢200Success

application/json

Body

array of:

items

array[object (OrderLine) {17}]

required

orderLineID

string

optional

Unique ID specific to the API

customer

object

optional

Customer who placed the order. Referenced by ID.

product

object

optional

Product that was ordered. Referenced by ID.

orderUnit

string

optional

Abbreviation or code representing the selling unit of the product

deliveryDropDate

string <date-time>

optional

An eligible delivery date for an order

quantity

integer

optional

Amount of product ordered

orderType

enum<string>

optional

Allowed values:

REGULARPRE_ORDERTENTATIVE

unitQty

integer

optional

Quantity per unit

price

number <double>

optional

Current price of the product

basePrice

number <double>

optional

Original price before discounts or allowances

vendor

object

optional

Supplier of the product. Referenced by ID.

warehouse

object

optional

Warehouse where the product is stored. Referenced by ID.

salesRep

object

optional

Sales representative associated with the order. Referenced by User ID

notes

string

optional

Additional information about the order

purchaseOrder

optional

Purchase order associated with the transaction

allowances

array[object (OrderAllowance) {6}]

optional

Discounts given to the order

status

string

deprecated

Current state of the order

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

Bulk update orders

Retrieve a specific order by ID