Trade Show
  1. Brokers
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
    • 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
      POST
    • Update a Broker
      PUT
    • Get a list of Brokers
      GET
    • Retrieve a specific Broker by ID
      GET
    • Delete a Broker
      DELETE
    • Create a new broker user
      POST
    • Update a broker user
      PUT
    • Get a list of broker users
      GET
    • Retrieve a specific broker user by ID
      GET
    • Delete a broker user
      DELETE
  • 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. Brokers

Create a new Broker

POST
/Broker
Brokers
Create a new broker and optionally assign vendors to it. Brokers are firms that charge a fee for executing the buying and selling of goods for vendors.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/Broker' \
--header 'Content-Type: application/json' \
--data-raw '{
    "street1": "3208 Wintheiser Canyon",
    "street2": "9550 Ova Walk",
    "city": "West Domenick",
    "state": "Idaho",
    "zipCode": "68505-1063",
    "brokerID": "9440",
    "brokerName": "Michelle Schaefer",
    "phone": "(225) 399-0570",
    "fax": "(608) 869-8133 x5582",
    "emailAddress": "Jarred24@yahoo.com",
    "vendors": [
        "VEND1962",
        "VEND9746",
        "VEND9972"
    ]
}'
Response Response Example
200 - Broker
{
    "id": "a7gfjg",
    "street1": "3208 Wintheiser Canyon",
    "street2": "9550 Ova Walk",
    "city": "West Domenick",
    "state": "Idaho",
    "zipCode": "68505-1063",
    "brokerID": "9440",
    "brokerName": "Michelle Schaefer",
    "phone": "(225) 399-0570",
    "fax": "(608) 869-8133 x5582",
    "emailAddress": "Jarred24@yahoo.com",
    "vendors": [
        "VEND1962",
        "VEND9746",
        "VEND9972"
    ]
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
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) where the address is located
<= 50 characters
zipCode
string 
optional
Zip Code for the address
<= 20 characters
brokerID
string 
required
Unique ID provided to reference the broker
>= 1 characters<= 100 characters
brokerName
string 
required
The name of the broker
>= 1 characters<= 50 characters
phone
string 
optional
Phone number used to contact the person
<= 30 characters
fax
string 
optional
Fax number used to send documents
<= 30 characters
emailAddress
string 
optional
Email address that will receive notifications
<= 100 characters
vendors
array[string]
optional
a list of Vendor IDs that will be associated with the Broker
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
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) where the address is located
<= 50 characters
zipCode
string 
optional
Zip Code for the address
<= 20 characters
brokerID
string 
required
Unique ID provided to reference the broker
>= 1 characters<= 100 characters
brokerName
string 
required
The name of the broker
>= 1 characters<= 50 characters
phone
string 
optional
Phone number used to contact the person
<= 30 characters
fax
string 
optional
Fax number used to send documents
<= 30 characters
emailAddress
string 
optional
Email address that will receive notifications
<= 100 characters
vendors
array[string]
optional
a list of Vendor IDs that will be associated with the Broker
🟢201Created
🟠400Bad Request
Modified at 2025-05-15 20:44:21
Previous
Delete a vendor user
Next
Update a Broker
Built with