Trade Show
  1. Delivery Ranges
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
      PUT
    • Create Sales Rep Group
      POST
    • Update Sales Rep Group
      PUT
    • Move Sales Rep Group
      PUT
    • Reorder Sales Rep Groups
      PUT
    • Get a list of Sales Rep Groups
      GET
    • Get Sales Rep Group
      GET
    • Delete Sales Rep Group
      DELETE
  • 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
    • 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. Delivery Ranges

Create a new Delivery Range

POST
/DeliveryRange
Delivery Ranges
Delivery ranges define which dates are available for delivery in a delivery group.

Flexible Dates#

A delivery range configured with flexible dates allows a customer to arrange delivery for any date within the range.
If it is not configured with flexible dates, you must define delivery drops for the specific dates available for delivery.

Rules#

The end date must come after the start date
You cannot have overlapping delivery ranges
If the delivery group doesn't exist, it will be created
If the delivery group does exist, all of its properties must match the existing delivery group
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/DeliveryRange' \
--header 'Content-Type: application/json' \
--data-raw '{
    "deliveryGroupID": "string",
    "deliveryGroupDescription": "string",
    "deliveryGroupDisplayOrder": 0,
    "flexibleDates": true,
    "deliveryRangeStartDate": "2019-08-24",
    "deliveryRangeEndDate": "2019-08-24",
    "canEditOrderLines": true
}'
Response Response Example
200 - Success
{
    "id": "g9jkdj",
    "deliveryGroupID": "4736",
    "deliveryGroupDescription": "06/14/2025 - 07/11/2025",
    "flexibleDates": true,
    "deliveryRangeStartDate": "2025-06-14T00:00:00",
    "deliveryRangeEndDate": "2025-07-11T00:00:00",
    "canEditOrderLines": true
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
deliveryGroupID
string 
required
Unique ID provided to reference the delivery group
deliveryGroupDescription
string 
optional
Description of the delivery group
deliveryGroupDisplayOrder
integer <int32>
optional
Index used to set a specific ordering of delivery groups
flexibleDates
boolean 
optional
Allows a customer to order products for any date within the delivery range
deliveryRangeStartDate
string <date>
optional
Start of the delivery range
deliveryRangeEndDate
string <date>
optional
End of the delivery range
canEditOrderLines
boolean 
optional
Used to disable ordering for the delivery range
Examples

Responses

🟢200OK
application/json
Already Exists
Body
id
string 
read-onlyoptional
Unique ID specific to this API
modifiedDate
string <date-time>
read-onlyoptional
Last time this item was updated, only displayed when supplying the modifiedAfter parameter in a query
deliveryGroupID
string 
required
Unique ID provided to reference the delivery group
deliveryGroupDescription
string 
optional
Description of the delivery group
deliveryGroupDisplayOrder
integer <int32>
optional
Index used to set a specific ordering of delivery groups
flexibleDates
boolean 
optional
Allows a customer to order products for any date within the delivery range
deliveryRangeStartDate
string <date>
optional
Start of the delivery range
deliveryRangeEndDate
string <date>
optional
End of the delivery range
canEditOrderLines
boolean 
optional
Used to disable ordering for the delivery range
🟢201Created
🟠400Bad Request
Modified at 2025-05-12 15:21:10
Previous
Delete a Delivery Group
Next
Update a Delivery Range
Built with