Equipment Order

Submit equipment order

post

Create a new equipment order for the specified merchant.

Body

application/json

merchantNumberstringOptional

The unique identifier of the merchant.

Example: text

orderIdstringOptional

The unique identifier of the order.

Example: text

statusstring · enumOptional

Current status of the order.

Possible values: Active Submitted Signed Approved AddedSalesforce BoardedTSYS BoardedQuest Shipped BackOrdered Deleted Completed OffRamp WaitingForTracking BoardedDevice

Possible values:

orderCreateTimestring · date-timeOptional

Timestamp details when the order was created. Includes calendar, time zone, and week data.

orderModifyTimestring · date-timeOptional

Details of when the order was last modified, including time zone, week data, and timestamp.

resubmitbooleanOptional

Indicates if the order is a resubmission.

Example: false

validFrontendsstring[]Optional

List of supported frontends for the order.

Responses

201

Success

application/jsonapplication/xml

merchantNumberstringOptional

The unique identifier of the merchant.

Example: text

orderIdstringOptional

The unique identifier of the order.

Example: text

statusstring · enumOptional

Current status of the order.

Possible values: Active Submitted Signed Approved AddedSalesforce BoardedTSYS BoardedQuest Shipped BackOrdered Deleted Completed OffRamp WaitingForTracking BoardedDevice

Possible values:

orderCreateTimestring · date-timeOptional

Timestamp details when the order was created. Includes calendar, time zone, and week data.

orderModifyTimestring · date-timeOptional

Details of when the order was last modified, including time zone, week data, and timestamp.

resubmitbooleanOptional

Indicates if the order is a resubmission.

Example: false

validFrontendsstring[]Optional

List of supported frontends for the order.

400

Validation failure

application/jsonapplication/xml

500

Unknown exception

application/jsonapplication/xml

post/api/equipment/orders

HTTPcURLJavaScriptPython

POST /api/equipment/orders HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 1055

{
  "orderItems": [
    {
      "orderItemId": 1,
      "manufacturer": "text",
      "productName": "text",
      "survey": {
        "questionAnswerGroup": {
          "questionAnswerSets": {
            "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
          },
          "questionAreas": [
            "text"
          ]
        },
        "metadata": {
          "exchangeId": "text",
          "timestamp": "2024-06-01T12:34:56.789"
        }
      },
      "quantity": 1,
      "validFrontends": [
        "text"
      ],
      "errors": [
        {
          "field": "text",
          "message": "text"
        }
      ],
      "productType": "Software",
      "orderItemMetadata": [
        {
          "orderStatus": "text",
          "terminalId": 1,
          "storeNumber": 1,
          "getvNumber": "text",
          "apiKey": "text",
          "publicKey": "text",
          "trackingNumber": "text",
          "salesforceCaseNumber": "text",
          "tcn": "text",
          "serialNumber": "text",
          "productManufacturer": "text",
          "productModel": "text"
        }
      ],
      "trackingNumber": "text",
      "completionDate": "2026-08-09T07:44:50.352Z",
      "surveyValid": true
    }
  ],
  "merchantNumber": "text",
  "orderId": "text",
  "status": "Active",
  "metadata": {
    "exchangeId": "text",
    "timestamp": "2024-06-01T12:34:56.789"
  },
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ],
  "orderCreateTime": "2026-08-09T07:44:50.352Z",
  "orderModifyTime": "2026-08-09T07:44:50.352Z",
  "resubmit": false,
  "validFrontends": [
    "text"
  ]
}

{
  "orderItems": [
    {
      "orderItemId": 1,
      "manufacturer": "text",
      "productName": "text",
      "survey": {
        "questionAnswerGroup": {
          "questionAnswerSets": {
            "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
          },
          "questionAreas": [
            "text"
          ]
        },
        "metadata": {
          "exchangeId": "text",
          "timestamp": "2024-06-01T12:34:56.789"
        }
      },
      "quantity": 1,
      "validFrontends": [
        "text"
      ],
      "errors": [
        {
          "field": "text",
          "message": "text"
        }
      ],
      "productType": "Software",
      "orderItemMetadata": [
        {
          "orderStatus": "text",
          "terminalId": 1,
          "storeNumber": 1,
          "getvNumber": "text",
          "apiKey": "text",
          "publicKey": "text",
          "trackingNumber": "text",
          "salesforceCaseNumber": "text",
          "tcn": "text",
          "serialNumber": "text",
          "productManufacturer": "text",
          "productModel": "text"
        }
      ],
      "trackingNumber": "text",
      "completionDate": "2026-08-09T07:44:50.352Z",
      "surveyValid": true
    }
  ],
  "merchantNumber": "text",
  "orderId": "text",
  "status": "Active",
  "metadata": {
    "exchangeId": "text",
    "timestamp": "2024-06-01T12:34:56.789"
  },
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ],
  "orderCreateTime": "2026-08-09T07:44:50.352Z",
  "orderModifyTime": "2026-08-09T07:44:50.352Z",
  "resubmit": false,
  "validFrontends": [
    "text"
  ]
}

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

orderTypestringOptional

Filter the results based on the type of equipment order.

merchAppFilterbooleanOptional

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

Default: false

Responses

200

Success

application/jsonapplication/xml

500

Unknown exception

application/jsonapplication/xml

get/api/equipment/orders/{merchant}

HTTPcURLJavaScriptPython

GET /api/equipment/orders/{merchant} HTTP/1.1
Accept: */*

{
  "orders": [
    {
      "orderItems": [
        {
          "orderItemId": 1,
          "manufacturer": "text",
          "productName": "text",
          "survey": {
            "questionAnswerGroup": "[Circular Reference]",
            "metadata": {
              "exchangeId": "text",
              "timestamp": "2024-06-01T12:34:56.789"
            }
          },
          "quantity": 1,
          "validFrontends": [
            "text"
          ],
          "errors": [
            {
              "field": "text",
              "message": "text"
            }
          ],
          "productType": "Software",
          "orderItemMetadata": [
            {
              "orderStatus": "text",
              "terminalId": 1,
              "storeNumber": 1,
              "getvNumber": "text",
              "apiKey": "text",
              "publicKey": "text",
              "trackingNumber": "text",
              "salesforceCaseNumber": "text",
              "tcn": "text",
              "serialNumber": "text",
              "productManufacturer": "text",
              "productModel": "text"
            }
          ],
          "trackingNumber": "text",
          "completionDate": "2026-08-09T07:44:50.352Z",
          "surveyValid": true
        }
      ],
      "merchantNumber": "text",
      "orderId": "text",
      "status": "Active",
      "metadata": {
        "exchangeId": "text",
        "timestamp": "2024-06-01T12:34:56.789"
      },
      "errors": [
        {
          "field": "text",
          "message": "text"
        }
      ],
      "orderCreateTime": "2026-08-09T07:44:50.352Z",
      "orderModifyTime": "2026-08-09T07:44:50.352Z",
      "resubmit": false,
      "validFrontends": [
        "text"
      ]
    }
  ],
  "metadata": {
    "exchangeId": "text",
    "timestamp": "2024-06-01T12:34:56.789"
  }
}

Get existing order by merchant and status

get

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

Path parameters

merchantstringRequired

The merchant's unique identification number

statusstringRequired

The orders status used to filter the results.

Query parameters

orderTypestringOptional

Filter the results based on the type of equipment order.

merchAppFilterbooleanOptional

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

Default: false

Responses

200

Success

application/jsonapplication/xml

500

Unknown exception

application/jsonapplication/xml

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

HTTPcURLJavaScriptPython

GET /api/equipment/orders/{merchant}/{status} HTTP/1.1
Accept: */*

{
  "orders": [
    {
      "orderItems": [
        {
          "orderItemId": 1,
          "manufacturer": "text",
          "productName": "text",
          "survey": {
            "questionAnswerGroup": "[Circular Reference]",
            "metadata": {
              "exchangeId": "text",
              "timestamp": "2024-06-01T12:34:56.789"
            }
          },
          "quantity": 1,
          "validFrontends": [
            "text"
          ],
          "errors": [
            {
              "field": "text",
              "message": "text"
            }
          ],
          "productType": "Software",
          "orderItemMetadata": [
            {
              "orderStatus": "text",
              "terminalId": 1,
              "storeNumber": 1,
              "getvNumber": "text",
              "apiKey": "text",
              "publicKey": "text",
              "trackingNumber": "text",
              "salesforceCaseNumber": "text",
              "tcn": "text",
              "serialNumber": "text",
              "productManufacturer": "text",
              "productModel": "text"
            }
          ],
          "trackingNumber": "text",
          "completionDate": "2026-08-09T07:44:50.352Z",
          "surveyValid": true
        }
      ],
      "merchantNumber": "text",
      "orderId": "text",
      "status": "Active",
      "metadata": {
        "exchangeId": "text",
        "timestamp": "2024-06-01T12:34:56.789"
      },
      "errors": [
        {
          "field": "text",
          "message": "text"
        }
      ],
      "orderCreateTime": "2026-08-09T07:44:50.352Z",
      "orderModifyTime": "2026-08-09T07:44:50.352Z",
      "resubmit": false,
      "validFrontends": [
        "text"
      ]
    }
  ],
  "metadata": {
    "exchangeId": "text",
    "timestamp": "2024-06-01T12:34:56.789"
  }
}

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

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

Default: false

Responses

200

Success

application/jsonapplication/xml

merchantNumberstringOptional

The unique identifier of the merchant.

Example: text

orderIdstringOptional

The unique identifier of the order.

Example: text

statusstring · enumOptional

Current status of the order.

Possible values: Active Submitted Signed Approved AddedSalesforce BoardedTSYS BoardedQuest Shipped BackOrdered Deleted Completed OffRamp WaitingForTracking BoardedDevice

Possible values:

orderCreateTimestring · date-timeOptional

Timestamp details when the order was created. Includes calendar, time zone, and week data.

orderModifyTimestring · date-timeOptional

Details of when the order was last modified, including time zone, week data, and timestamp.

resubmitbooleanOptional

Indicates if the order is a resubmission.

Example: false

validFrontendsstring[]Optional

List of supported frontends for the order.

500

Unknown exception

application/jsonapplication/xml

get/api/equipment/orders/{merchant}/order/{orderNumber}

HTTPcURLJavaScriptPython

GET /api/equipment/orders/{merchant}/order/{orderNumber} HTTP/1.1
Accept: */*

{
  "orderItems": [
    {
      "orderItemId": 1,
      "manufacturer": "text",
      "productName": "text",
      "survey": {
        "questionAnswerGroup": {
          "questionAnswerSets": {
            "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
          },
          "questionAreas": [
            "text"
          ]
        },
        "metadata": {
          "exchangeId": "text",
          "timestamp": "2024-06-01T12:34:56.789"
        }
      },
      "quantity": 1,
      "validFrontends": [
        "text"
      ],
      "errors": [
        {
          "field": "text",
          "message": "text"
        }
      ],
      "productType": "Software",
      "orderItemMetadata": [
        {
          "orderStatus": "text",
          "terminalId": 1,
          "storeNumber": 1,
          "getvNumber": "text",
          "apiKey": "text",
          "publicKey": "text",
          "trackingNumber": "text",
          "salesforceCaseNumber": "text",
          "tcn": "text",
          "serialNumber": "text",
          "productManufacturer": "text",
          "productModel": "text"
        }
      ],
      "trackingNumber": "text",
      "completionDate": "2026-08-09T07:44:50.352Z",
      "surveyValid": true
    }
  ],
  "merchantNumber": "text",
  "orderId": "text",
  "status": "Active",
  "metadata": {
    "exchangeId": "text",
    "timestamp": "2024-06-01T12:34:56.789"
  },
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ],
  "orderCreateTime": "2026-08-09T07:44:50.352Z",
  "orderModifyTime": "2026-08-09T07:44:50.352Z",
  "resubmit": false,
  "validFrontends": [
    "text"
  ]
}

Delete existing order

delete

Deletes the specified equipment order forthe given merchant using the unique order ID.

Path parameters

merchantstringRequired

The merchant's unique identification number

orderNumberstringRequired

The unique identifier assigned to each equipment order.

Responses

200

Success

No content

500

Unknown exception

application/jsonapplication/xml

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

HTTPcURLJavaScriptPython

DELETE /api/equipment/orders/{merchant}/order/{orderNumber} HTTP/1.1
Accept: */*

No content