Equipment Order Controller

Service to post an order

Submit Equipment Order

post

Create a new equipment order for the specified merchant.

Body
merchantNumberstringOptional

The unique identifier of the merchant.

Example: text
orderIdstringOptional

Unique identifier for the order.

Example: text
resubmitbooleanOptional

Indicates if the order is a resubmission.

Example: true
statusstring · enumOptional

Current status of the order. Possible values: Active Submitted Signed Approved AddedSalesforce BoardedTSYS BoardedQuest Shipped BackOrdered Deleted Completed OffRamp WaitingForTracking BoardedDevice

Example: ActivePossible values:
validFrontendsstring[]Optional

List of supported frontends for the order.

Example: ["text"]
Responses
post
/api/equipment/orders

Get Existing Order

get

Retrieves the existing equipment order associated with the specified merchant.

Path parameters
merchantstringRequired

The merchant's unique identification number.

Query parameters
merchAppFilterbooleanOptional

Filter criteria applied at the merchant application level.

Default: false
orderTypestringOptional

Specifies the type of equipment order to retrieve.

Responses
get
/api/equipment/orders/{merchant}

Delete Existing Order

delete

Delete the specified equipment order for the given merchant using the unique order ID.

Path parameters
merchantstringRequired

The merchant's unique identification number.

orderIdstringRequired

A unique identifier assigned to each equipment order.

Responses
204

No Content

No content

delete
/api/equipment/orders/{merchant}/order/{orderId}

No content

Get Existing Order by Order ID

get

Retrieve the details of a specific equipment order of specified merchant using the unique order ID.

Path parameters
merchantstringRequired

The merchant's unique identification number.

orderNumberstringRequired

The unique order ID assigned to the merchant’s equipment order.

Query parameters
merchAppFilterbooleanOptional

Filters the response to include order details specific to the merchant application or a defined subset of orders.

Default: false
Responses
get
/api/equipment/orders/{merchant}/order/{orderNumber}

Get Existing Order by Merchant and Status

get

Retrieve the existing equipment orders for the specified merchant filtered by order status.

Path parameters
merchantstringRequired

The merchant's unique identification number.

statusstringRequired

The order status used to filter the results.

Query parameters
merchAppFilterbooleanOptional

Filter the results to return orders associated with a specific merchant application.

Default: false
orderTypestringOptional

Filter the results based on the type of equipment order.

Responses
get
/api/equipment/orders/{merchant}/{status}

Last updated

Was this helpful?