Equipment Order

The Equipment Order API is a RESTful service that allows you to create, retrieve, and delete equipment orders for merchants once the survey is complete.

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
MerchantId: Id of the merchant

Available Endpoints:

• Create Order: POST /api/equipment/orders

• Get Orders by Merchant: GET /api/equipment/orders/{merchant}

• Get Order by Order ID: GET /api/equipment/orders/{merchant}/order/{orderNumber}

• Delete Existing Order: DELETE /api/equipment/orders/{merchant}/order/{orderNumber}

• Get Order by Merchant and Status: GET /api/equipment/orders/{merchant}/{status}

Note:

• Upon a successful POST, the API generates a unique Order ID.

• The status of the equipment order will change as the order progresses through our system.

• Valid statuses to delete equipment orders: Active, Submitted.

Path Parameters

Name	Data Type	Required?	Description
merchant	String	Required	Merchant ID
orderNumber	String	Required	Unique order identifier
status	String	Required	Order status