Trade Show
  1. Orders
Trade Show
  • Introduction
  • Warehouses
    • Create a new Warehouse
      POST
    • Update a Warehouse
      PUT
    • Get a list of Warehouses
      GET
    • Retrieve a specific Warehouse by ID
      GET
    • Delete a Warehouse
      DELETE
  • Delivery Groups
    • Create a new Delivery Group
      POST
    • Update a Delivery Group
      PUT
    • Get a list of Delivery Groups
      GET
    • Retrieve a specific Delivery Group by ID
      GET
    • Delete a Delivery Group
      DELETE
  • Delivery Ranges
    • Create a new Delivery Range
      POST
    • Update a Delivery Range
      PUT
    • Get a list of Delivery Ranges
      GET
    • Retrieve a specific Delivery Range by ID
      GET
    • Delete a Delivery Range
      DELETE
  • Delivery Drops
    • Create a new Delivery Drop
      POST
    • Update a Delivery Drop
      PUT
    • Get a list of Delivery Drops
      GET
    • Retrieve a specific Delivery Drop by ID
      GET
    • Delete a Delivery Drop
      DELETE
  • Sales Rep Hierarchies
    • Define Hierarchy Levels
    • Create Sales Rep Group
    • Update Sales Rep Group
    • Move Sales Rep Group
    • Reorder Sales Rep Groups
    • Get a list of Sales Rep Groups
    • Get Sales Rep Group
    • Delete Sales Rep Group
  • Sales Reps
    • Create a new sales rep
    • Update a sales rep
    • Get a list of sales reps
    • Retrieve a specific sales rep by ID
    • Delete a sales rep
  • Sales Rep Managers
    • Create a new sales rep manager
    • Update a sales rep manager
    • Get a list of sales rep managers
    • Retrieve a specific sales rep manager by ID
    • Delete a sales rep manager
  • Ordering Groups
    • Create a new Ordering Group
    • Update a Ordering Group
    • Get a list of Ordering Groups
    • Retrieve a specific Ordering Group by ID
    • Delete a Ordering Group
  • Customers
    • Create a new Customer Class
    • Get a list of Customer Classes
    • Retrieve a specific Customer Class by ID
    • Update a Customer Class
    • Delete a Customer Class
    • Create a new Customer
    • Get a list of Customers
    • Retrieve a specific Customer by ID
    • Update a Customer
    • Delete a Customer
  • Attendees
    • Create a new Attendee
    • Update a Attendee
    • Get a list of Attendees
    • Retrieve a specific Attendee by ID
    • Delete a Attendee
  • Vendors
    • Create a new Vendor
    • Update a Vendor
    • Get a list of Vendors
    • Retrieve a specific Vendor by ID
    • Delete a Vendor
    • Create a new vendor user
    • Update a vendor user
    • Get a list of vendor users
    • Retrieve a specific vendor user by ID
    • Delete a vendor user
  • Brokers
    • Create a new Broker
    • Update a Broker
    • Get a list of Brokers
    • Retrieve a specific Broker by ID
    • Delete a Broker
    • Create a new broker user
    • Update a broker user
    • Get a list of broker users
    • Retrieve a specific broker user by ID
    • Delete a broker user
  • Booths
    • Create a new Booth
    • Update a Booth
    • Get a list of Booths
    • Retrieve a specific Booth by ID
    • Delete a Booth
    • Associate a product to a booth
    • Get a list of products associated with a booth
    • Associate multiple products to a booth
    • Remove a product from a booth
    • Associate a vendor to a booth
    • Associate multiple vendors to a booth
    • Get a list of vendors associated with a booth
    • Remove a vendor from a booth
  • Facilitators
    • Create a new Facilitator
    • Update a Facilitator
    • Get a list of Facilitators
    • Retrieve a specific Facilitator by ID
    • Delete a Facilitator
  • Brands
    • Create a new Brand
    • Update a Brand
    • Get a list of Brands
    • Retrieve a specific Brand by ID
    • Delete a Brand
  • Categories
    • Create a new Category
    • Update a Category
    • Get a list of Categories
    • Retrieve a specific Category by ID
    • Delete a Category
  • Products
    • Create new pricing for a product
    • Update product pricing by price ID
    • Get a collection of price lists for products
    • Retrieve pricing by price ID
    • Delete a price list by ID
    • Create a new Product
    • Update a Product
    • Get a list of Products
    • Retrieve a specific Product by ID
    • Delete a Product
    • Get a list of Product Inventory
    • Bulk update product inventory
  • Orders
    • Bulk create orders
      POST
    • Bulk update orders
      PUT
    • Get a list of orders
      GET
    • Retrieve a specific order by ID
      GET
    • Delete an order line
      DELETE
    • Get a list of order history buckets
      GET
    • Bulk create order history items
      POST
    • Get a list of order history items
      GET
  • Delivery Dates
    • Get a list of delivery dates
    • Retrieve delivery dates by product using ID
  • VIP Users
    • Create a new VIP user
    • Update a VIP user
    • Get a list of VIP users
    • Retrieve a specific VIP user by ID
    • Delete a VIP user
  • Show Admins
    • Create a new Show Admin
    • Update a Show Admin
    • Get a list of Show Admins
    • Retrieve a specific Show Admin by ID
    • Delete a Show Admin
  • Exports
    • Get available exports
    • Get parameter options
    • Run Custom Export
  1. Orders

Retrieve a specific order by ID

GET
/Order/{id}
Access a specific order by using its id in the endpoint path
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/Order/'
Response Response Example
{
    "items": [
        {
            "modifiedDate": "2025-01-22T04:01:03.97",
            "orderLineID": "1",
            "customer": {
                "id": "CUSTOMER1",
                "name": "CUSTOMER1 FOR API (DO NOT DELETE)"
            },
            "product": {
                "id": "FORAPI",
                "description": "Product For API Do not Delete"
            },
            "orderUnit": "CS",
            "deliveryDate": "2024-07-01T00:00:00",
            "quantity": 5,
            "orderType": "REGULAR",
            "price": 150,
            "basePrice": 100,
            "vendor": {
                "id": "FORAPI",
                "name": "VENDOR FOR API Do not Delete"
            },
            "warehouse": {
                "id": "DFLT",
                "description": "Default warehouse"
            },
            "purchaseOrder": null,
            "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 ********************
Path Params
id
string 
required
Unique ID specific to this API

Responses

🟢200Success
application/json
Body
orderLineID
string 
optional
Unique ID specific to the API
customer
object 
optional
Customer who placed the order. Referenced by ID.
id
string 
optional
Customer ID
name
string 
optional
Customer Name
product
object 
optional
Product that was ordered. Referenced by ID.
id
string 
optional
Product ID
description
string 
optional
Product Description
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
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
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.
id
string 
optional
Vendor ID
name
string 
optional
Vendor Name
warehouse
object 
optional
Warehouse where the product is stored. Referenced by ID.
id
string 
optional
Warehouse ID
name
string 
optional
Warehouse Name
salesRep
object 
optional
Sales representative associated with the order. Referenced by User ID
id
string 
optional
Sales Rep User ID
name
string 
optional
Sales Rep Name
notes
string 
optional
Additional information about the order
purchaseOrder
optional
Purchase order associated with the transaction
Any of
purchaseOrderID
string 
optional
The purchase order name
notes
string 
optional
Additional notes regarding the purchase order
allowances
array[object (OrderAllowance) {6}] 
optional
Discounts given to the order
allowanceDescription
string 
optional
Description of the discount or allowance
componentID
string 
optional
Unique ID of a component of the allowance
componentName
string 
optional
Name of the allowance component
benefitType
enum<string> 
optional
Type of benefit provided by an allowance
Allowed values:
% off Show PriceRebate Per UnitRebate Per WeightProduct Points
isAdjustment
boolean 
optional
Indicates whether the entry is an allowance adjustment
allowanceValue
number <double>
optional
Amount or percentage of the allowance
status
string 
deprecated
Current state of the order
Modified at 2025-05-15 21:18:11
Previous
Get a list of orders
Next
Delete an order line
Built with