Trade Show
    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

    Introduction

    Welcome to the Perenso TradeShow API documentation. This guide provides comprehensive information on how to interact with our REST API, authentication methods, and best practices for implementation.

    Authentication#

    Access to the REST API is granted to applications that can successfully retrieve an OAuth 2.0 Access token and Refresh token from our authentication server.
    Authentication Server URL: https://tradeshow.perenso.net/auth/oauth/token

    OAuth 2.0 Client Credentials#

    Use the OAuth 2.0 Client Credentials grant type to authenticate with the REST API. As described in Client Credentials - OAuth 2.0 Simplified, send an HTTP POST message to our Authentication URL.
    You will need to specify the following information in the POST request:
    1.
    grant_type – The grant type specifies the authentication flow you will use, and it should go in the body of the POST message with the following format:
       grant_type=client_credentials
    1.
    scope – The scope indicates the type of resource you are requesting access to. The value 100214 means you are requesting access to the REST API. It goes in the body and is combined with other data using an ampersand (&):
       scope=100214
    1.
    client_id – The client ID is the show ID for the show you are hosting. It will be provided to you by Perenso Show Support. This data can be specified in either the body of the request or base64-encoded into the authorization header with the client_secret. If included in the body, combine it with the other data using an ampersand (&):
       client_id=SHOW_ID
    1.
    client_secret – The client secret is an encoded value that acts as a password to authenticate access to the show's API. It is generated by our systems and provided by Perenso Show Support. This data can be specified in either the body of the request or base64-encoded into the authorization header with the client_id. If included in the body, combine it with the other data using an ampersand(&):
       client_secret=API_SECRET

    Example Authentication Request#

    Upon successful authentication, you'll receive an access token and refresh token that you'll use in subsequent API requests.

    Working with API Resources#

    Accessing Specific Records#

    When retrieving data from the API, each record will contain a unique identifier in the id field. This identifier can be used to access specific resources directly.
    For example, if you receive a list of attendees with the following structure:
    [
        {
          "id": "a123456",
          "firstName": "John",
          "lastName": "Doe",
          "email": "john.doe@example.com"
        },
        {
          "id": "b789012",
          "firstName": "Jane",
          "lastName": "Smith",
          "email": "jane.smith@example.com"
        }
      ]
    You can access a specific attendee by using their unique id in the endpoint path:
    GET /attendee/a123456

    Retrieving recently modified items#

    When querying collections, you can supply a modifiedAfter parameter to only retrieve items that have changed since the specified date:
    GET /attendee?modifiedAfter=2025-01-31
    The modifiedDate field will be included in the response and items will be sorted from most recently modified to least recently modified:
    [
        {
          "id": "a123456",
          "modifiedDate": "2025-05-07T12:25:00",
          "firstName": "John",
          "lastName": "Doe",
          "email": "john.doe@example.com"
        },
        {
          "id": "b789012",
          "modifiedDate": "2025-05-07T12:30:00",
          "firstName": "Jane",
          "lastName": "Smith",
          "email": "jane.smith@example.com"
        }
      ]

    Sorting#

    When querying collections, you can use any field except modifiedDate to sort the data:
    GET /attendee?sort=attendeeID:asc

    Support#

    If you encounter any issues with authentication or API usage, please contact Perenso Show Support for assistance.
    Modified at 2025-05-07 18:03:10
    Next
    Create a new Warehouse
    Built with