Equipment Terminal Loader

The Equipment Terminal Loader API lets you search and retrieve equipment products to use in your equipment order flow (see Equipment Order API). You can perform a paged search over all products or fetch a single product by manufacturer and device type.

Base URLs

Environment	URL
Sandbox	https://boarding-sb.clearent.net/api/
Production	https://boarding.clearent.net/api/

Headers

Content-Type: application/json
Accept: application/json
AccessKey: Secret access key issued by Xplor Pay

Available Endpoints:

• Get Products List: GET /api/equipment/products

• Get Single Product: GET /api/equipment/products/{manufacturer}/{deviceType}

Path Parameters

Name	Data Type	Required?	Description
{manufacturer}	String	Required	Product manufacturer name
{deviceType}	String	Required	Device type identifier

Additional Information

Usage Workflow:

1. Retrieve multiple products Use the /api/equipment/products endpoint to retrieve multiple Equipment Boarding products with a configurable paged response. Supported query parameters include:

   • term – search for a specific product (leave blank to search all products)

   • size – number of products to be returned in the response

   • page – desired page of products to return in the response when returning a paged response.

   • sort – sort order for results (asc or desc)

   • isSoftware – true for software products, false for hardware

Note: By default, the page size is set to 25 records.

1. Retrieve a single product Use the /api/equipment/products/{manufacturer}/{deviceType} endpoint to search by manufacturer and device type. One matching product is returned.

2. Fetch the configuration survey After obtaining a product, call the Equipment Configuration Survey API to retrieve the survey for that product.