Trade Show
  1. Ordering Groups
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
      POST
    • Update a Ordering Group
      PUT
    • Get a list of Ordering Groups
      GET
    • Retrieve a specific Ordering Group by ID
      GET
    • Delete a Ordering Group
      DELETE
  • 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
    • Bulk update orders
    • Get a list of orders
    • Retrieve a specific order by ID
    • Delete an order line
    • Get a list of order history buckets
    • Bulk create order history items
    • Get a list of order history items
  • 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. Ordering Groups

Get a list of Ordering Groups

GET
/OrderingGroup
Ordering Groups
Query existing ordering groups and filter groups from the associated show
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/OrderingGroup?sort&page=1&resultsPerPage=20&showLinkedCustomers'
Response Response Example
200 - Ordering Groups
[
    {
        "id": "j47249",
        "orderingGroupID": "OG5619",
        "orderingGroupName": "Supply Chain Partners",
        "orderingSubGroupID": "4792",
        "orderingSubGroupName": "Default group",
        "customers": [
            "CUST2614"
        ]
    },
    {
        "id": "gdpgdh",
        "orderingGroupID": "OG9749",
        "orderingGroupName": "Franchise Networks",
        "orderingSubGroupID": "4013",
        "orderingSubGroupName": "Default group",
        "customers": [
            "CUST0872"
        ]
    }
]

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}
Default:
page
integer <int32>
optional
Page index to return, starts at Page 1
Default:
1
Example:
1
resultsPerPage
integer <int32>
optional
Number of items to return per page
Default:
20
Example:
20
showLinkedCustomers
boolean 
optional
Include the customers that are affiliated with each ordering group in the response
Default:
false

Responses

🟢200OK
application/json
OK
Body
array of:
id
string 
read-onlyoptional
Unique ID specific to this API
orderingGroupID
string 
optional
Unique ID provided to reference the Ordering Group. Will be autogenerated if not defined
orderingGroupName
string 
required
The name of the ordering group
>= 1 characters
orderingSubGroupID
string 
optional
Unique ID provided to reference the Filter Group. Not required.
orderingSubGroupName
string 
optional
The name of the filter group. Defaults to "Default group" if not specified
customers
array[string]
required
Customer IDs assigned to the filter group
🟠400Bad Request
Modified at 2025-05-13 17:12:44
Previous
Update a Ordering Group
Next
Retrieve a specific Ordering Group by ID
Built with