Trade Show
  1. Customers
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
    • Update a Delivery Drop
    • Get a list of Delivery Drops
    • Retrieve a specific Delivery Drop by ID
    • Delete a Delivery Drop
  • 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
      POST
    • Get a list of Customer Classes
      GET
    • Retrieve a specific Customer Class by ID
      GET
    • Update a Customer Class
      PUT
    • Delete a Customer Class
      DELETE
    • Create a new Customer
      POST
    • Get a list of Customers
      GET
    • Retrieve a specific Customer by ID
      GET
    • Update a Customer
      PUT
    • Delete a Customer
      DELETE
  • 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. Customers

Create a new Customer

POST
/Customer
Customers
Import a customer into the show. Customers are a person or store that buys goods and services from distributors. Also called an account.
The following must be imported or configured before assigning:
AllowanceGroup
CustomerClass
DeliveryGroup
Only assign if "Customers can have different delivery groups" option is configured
OrderPermission
OrderingGroup
By default, createMissingOrderingGroups = true will auto-create ordering groups as needed
SalesRep
Warehouse
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/Customer?createMissingOrderingGroups' \
--header 'Content-Type: application/json' \
--data-raw '{
    "modifiedDate": "2025-07-28",
    "customerID": "5041",
    "customerName": "Pfeffer Group",
    "email": "Merritt.Monahan54@yahoo.com",
    "phone": "(879) 746-5156",
    "fax": "305-476-4677 x559",
    "priceZone": 702,
    "test": false,
    "placeholder": false,
    "street1": "2519 Kshlerin Track",
    "street2": "992 W Jefferson Street",
    "city": "Rebecaland",
    "state": "North Dakota",
    "zipCode": "27667-9860",
    "allowanceGroup": "AG88",
    "deliveryGroup": "0940",
    "warehouseID": "WH7558",
    "customerClassID": "H",
    "orderPermissionKey": 3,
    "primarySalesRep": "USER2791",
    "salesReps": [
        "USER2960",
        "USER1243"
    ],
    "orderingGroups": [
        {
            "orderingGroupID": "OG0849",
            "orderingGroupName": "Franchise Networks",
            "orderingSubGroupID": "6287",
            "orderingSubGroupName": "Erma Sporer",
            "customers": [
                "CUST2113",
                "CUST9761",
                "CUST7217"
            ]
        }
    ],
    "extra1": "472",
    "extra2": "7mwek4",
    "extra3": "throughput",
    "extra4": "e-mail",
    "extra5": "imaginative"
}'
Response Response Example
200 - Customer
{
    "id": "jggkh3",
    "modifiedDate": "2025-07-28",
    "customerID": "5041",
    "customerName": "Pfeffer Group",
    "email": "Merritt.Monahan54@yahoo.com",
    "phone": "(879) 746-5156",
    "fax": "305-476-4677 x559",
    "priceZone": 702,
    "test": false,
    "placeholder": false,
    "street1": "2519 Kshlerin Track",
    "street2": "992 W Jefferson Street",
    "city": "Rebecaland",
    "state": "North Dakota",
    "zipCode": "27667-9860",
    "allowanceGroup": "AG88",
    "deliveryGroup": "0940",
    "warehouseID": "WH7558",
    "customerClassID": "H",
    "orderPermissionKey": 3,
    "primarySalesRep": "USER2791",
    "salesReps": [
        "USER2960",
        "USER1243"
    ],
    "orderingGroups": [
        {
            "id": "6dga8j",
            "orderingGroupID": "OG0849",
            "orderingGroupName": "Franchise Networks",
            "orderingSubGroupID": "6287",
            "orderingSubGroupName": "Erma Sporer",
            "customers": [
                "CUST2113",
                "CUST9761",
                "CUST7217"
            ]
        }
    ],
    "extra1": "472",
    "extra2": "7mwek4",
    "extra3": "throughput",
    "extra4": "e-mail",
    "extra5": "imaginative"
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
createMissingOrderingGroups
boolean 
optional
if configured, create ordering groups that don't already exist
Body Params application/json
customerID
string 
required
Unique ID provided to reference the customer
>= 1 characters
customerName
string 
required
The name of the customer
>= 1 characters
email
string 
optional
Email where notifications will be sent
phone
string 
optional
Phone number used to contact the customer
fax
string 
optional
Fax number used to send documents
priceZone
integer <int32>
optional
Number used to define different pricing zones based on location
test
boolean 
optional
This is a test customer. It should not be included in reports
placeholder
boolean 
optional
This customer is used as a placeholder for allocation mode
street1
string 
optional
Street Address Line 1
<= 100 characters
street2
string 
optional
Street Address Line 2
<= 100 characters
city
string 
optional
City where the address is located
<= 50 characters
state
string 
optional
State name (full name)
<= 50 characters
zipCode
string 
optional
Zip Code for the address
<= 20 characters
allowanceGroup
string 
optional
ID used to define which allowances apply to the customer
deliveryGroup
string 
optional
ID used to define the dates available for product delivery
warehouseID
string 
optional
ID used to define which warehouse will deliver the product
customerClassID
string 
optional
ID used to group the customer by class
orderPermissionKey
integer <int32>
optional
Defines whether the customer can order during pre-show, at-show, or post-show
primarySalesRep
string 
optional
User ID of the primary sales rep assigned to the customer
salesReps
array[string]
optional
Additional user IDs that have access to the customer
orderingGroups
array[object (OrderingGroup V1) {5}] 
optional
Ordering Group affiliations. Will be created by default if the group doesn't already exist
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
extra1
string 
optional
Customizable field to capture additional information about the customer
extra2
string 
optional
Customizable field to capture additional information about the customer
extra3
string 
optional
Customizable field to capture additional information about the customer
extra4
string 
optional
Customizable field to capture additional information about the customer
extra5
string 
optional
Customizable field to capture additional information about the customer
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
customerID
string 
required
Unique ID provided to reference the customer
>= 1 characters
customerName
string 
required
The name of the customer
>= 1 characters
email
string 
optional
Email where notifications will be sent
phone
string 
optional
Phone number used to contact the customer
fax
string 
optional
Fax number used to send documents
priceZone
integer <int32>
optional
Number used to define different pricing zones based on location
test
boolean 
optional
This is a test customer. It should not be included in reports
placeholder
boolean 
optional
This customer is used as a placeholder for allocation mode
street1
string 
optional
Street Address Line 1
<= 100 characters
street2
string 
optional
Street Address Line 2
<= 100 characters
city
string 
optional
City where the address is located
<= 50 characters
state
string 
optional
State name (full name)
<= 50 characters
zipCode
string 
optional
Zip Code for the address
<= 20 characters
allowanceGroup
string 
optional
ID used to define which allowances apply to the customer
deliveryGroup
string 
optional
ID used to define the dates available for product delivery
warehouseID
string 
optional
ID used to define which warehouse will deliver the product
customerClassID
string 
optional
ID used to group the customer by class
orderPermissionKey
integer <int32>
optional
Defines whether the customer can order during pre-show, at-show, or post-show
primarySalesRep
string 
optional
User ID of the primary sales rep assigned to the customer
salesReps
array[string]
optional
Additional user IDs that have access to the customer
orderingGroups
array[object (OrderingGroup V1) {6}] 
optional
Ordering Group affiliations. Will be created by default if the group doesn't already exist
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
extra1
string 
optional
Customizable field to capture additional information about the customer
extra2
string 
optional
Customizable field to capture additional information about the customer
extra3
string 
optional
Customizable field to capture additional information about the customer
extra4
string 
optional
Customizable field to capture additional information about the customer
extra5
string 
optional
Customizable field to capture additional information about the customer
🟢201Created
🟠400Bad Request
Modified at 2025-05-20 19:25:16
Previous
Delete a Customer Class
Next
Get a list of Customers
Built with