Equipment Order

Submit equipment order

post

Create a new equipment order for the specified merchant.

Body

application/json

merchantNumberstringOptional

orderIdstringOptional

statusstring · enumOptionalPossible values:

orderCreateTimestring · date-timeOptional

orderModifyTimestring · date-timeOptional

resubmitbooleanOptional

validFrontendsstring[]Optional

Responses

201

Success

*/*

400

Validation failure

*/*

500

Unknown exception

*/*

post

/api/equipment/orders

HTTPcURLJavaScriptPython

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

{
  "orderItems": [
    {
      "orderItemId": 1,
      "manufacturer": "text",
      "productName": "text",
      "survey": {
        "questionAnswerGroup": {
          "questionAnswerSets": {
            "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
          },
          "questionAreas": [
            "text"
          ]
        },
        "metadata": {
          "exchangeId": "text",
          "timestamp": "text"
        }
      },
      "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-06-04T10:49:09.174Z",
      "surveyValid": true
    }
  ],
  "merchantNumber": "text",
  "orderId": "text",
  "status": "Active",
  "metadata": {
    "exchangeId": "text",
    "timestamp": "text"
  },
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ],
  "orderCreateTime": "2026-06-04T10:49:09.174Z",
  "orderModifyTime": "2026-06-04T10:49:09.174Z",
  "resubmit": true,
  "validFrontends": [
    "text"
  ]
}

{}

Update the status of an order

put

Header parameters

AccessKeystringRequired

Body

application/json

merchantNumberstringOptional

orderIdstringOptional

statusstring · enumOptionalPossible values:

resubmitbooleanOptional

Responses

200

Success

*/*

merchantNumberstringOptional

orderIdstringOptional

500

Unknown exception

*/*

put

/api/equipment/orders

HTTPcURLJavaScriptPython

PUT /api/equipment/orders HTTP/1.1
AccessKey: text
Content-Type: application/json
Accept: */*
Content-Length: 366

{
  "merchantNumber": "text",
  "orderId": "text",
  "status": "Active",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "orderStatus": "text",
        "terminalId": 1,
        "storeNumber": 1,
        "getvNumber": "text",
        "apiKey": "text",
        "publicKey": "text",
        "trackingNumber": "text",
        "salesforceCaseNumber": "text",
        "tcn": "text",
        "serialNumber": "text",
        "productManufacturer": "text",
        "productModel": "text"
      }
    ]
  },
  "resubmit": true
}

{
  "orderForm": {
    "orderItems": [
      {
        "orderItemId": 1,
        "manufacturer": "text",
        "productName": "text",
        "survey": {
          "questionAnswerGroup": {
            "questionAnswerSets": "[Circular Reference]",
            "questionAreas": [
              "text"
            ]
          },
          "metadata": {
            "exchangeId": "text",
            "timestamp": "text"
          }
        },
        "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-06-04T10:49:09.174Z",
        "surveyValid": true
      }
    ],
    "merchantNumber": "text",
    "orderId": "text",
    "status": "Active",
    "metadata": {
      "exchangeId": "text",
      "timestamp": "text"
    },
    "errors": [
      {
        "field": "text",
        "message": "text"
      }
    ],
    "orderCreateTime": "2026-06-04T10:49:09.174Z",
    "orderModifyTime": "2026-06-04T10:49:09.174Z",
    "resubmit": true,
    "validFrontends": [
      "text"
    ]
  },
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ],
  "merchantNumber": "text",
  "orderId": "text"
}

Process UI order by signing and approving it

put

Path parameters

merchantNumberstringRequired

orderIdstringRequired

Header parameters

AccessKeystringOptional

Responses

200

Success

*/*

merchantNumberstringOptional

orderIdstringOptional

500

Unknown exception

*/*

put

/api/equipment/orders/process/{merchantNumber}/{orderId}

HTTPcURLJavaScriptPython

PUT /api/equipment/orders/process/{merchantNumber}/{orderId} HTTP/1.1
Accept: */*

{
  "orderForm": {
    "orderItems": [
      {
        "orderItemId": 1,
        "manufacturer": "text",
        "productName": "text",
        "survey": {
          "questionAnswerGroup": {
            "questionAnswerSets": "[Circular Reference]",
            "questionAreas": [
              "text"
            ]
          },
          "metadata": {
            "exchangeId": "text",
            "timestamp": "text"
          }
        },
        "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-06-04T10:49:09.174Z",
        "surveyValid": true
      }
    ],
    "merchantNumber": "text",
    "orderId": "text",
    "status": "Active",
    "metadata": {
      "exchangeId": "text",
      "timestamp": "text"
    },
    "errors": [
      {
        "field": "text",
        "message": "text"
      }
    ],
    "orderCreateTime": "2026-06-04T10:49:09.174Z",
    "orderModifyTime": "2026-06-04T10:49:09.174Z",
    "resubmit": true,
    "validFrontends": [
      "text"
    ]
  },
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ],
  "merchantNumber": "text",
  "orderId": "text"
}

Get equipment 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

*/*

500

Unknown exception

*/*

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": "text"
            }
          },
          "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-06-04T10:49:09.174Z",
          "surveyValid": true
        }
      ],
      "merchantNumber": "text",
      "orderId": "text",
      "status": "Active",
      "metadata": {
        "exchangeId": "text",
        "timestamp": "text"
      },
      "errors": [
        {
          "field": "text",
          "message": "text"
        }
      ],
      "orderCreateTime": "2026-06-04T10:49:09.174Z",
      "orderModifyTime": "2026-06-04T10:49:09.174Z",
      "resubmit": true,
      "validFrontends": [
        "text"
      ]
    }
  ],
  "metadata": {
    "exchangeId": "text",
    "timestamp": "text"
  }
}

Get equipment 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

*/*

500

Unknown exception

*/*

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": "text"
            }
          },
          "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-06-04T10:49:09.174Z",
          "surveyValid": true
        }
      ],
      "merchantNumber": "text",
      "orderId": "text",
      "status": "Active",
      "metadata": {
        "exchangeId": "text",
        "timestamp": "text"
      },
      "errors": [
        {
          "field": "text",
          "message": "text"
        }
      ],
      "orderCreateTime": "2026-06-04T10:49:09.174Z",
      "orderModifyTime": "2026-06-04T10:49:09.174Z",
      "resubmit": true,
      "validFrontends": [
        "text"
      ]
    }
  ],
  "metadata": {
    "exchangeId": "text",
    "timestamp": "text"
  }
}

Get equipment order by 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

*/*

merchantNumberstringOptional

orderIdstringOptional

statusstring · enumOptionalPossible values:

orderCreateTimestring · date-timeOptional

orderModifyTimestring · date-timeOptional

resubmitbooleanOptional

validFrontendsstring[]Optional

500

Unknown exception

*/*

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": "text"
        }
      },
      "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-06-04T10:49:09.174Z",
      "surveyValid": true
    }
  ],
  "merchantNumber": "text",
  "orderId": "text",
  "status": "Active",
  "metadata": {
    "exchangeId": "text",
    "timestamp": "text"
  },
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ],
  "orderCreateTime": "2026-06-04T10:49:09.174Z",
  "orderModifyTime": "2026-06-04T10:49:09.174Z",
  "resubmit": true,
  "validFrontends": [
    "text"
  ]
}

Delete equipment order by Id

delete

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

Path parameters

merchantstringRequired

The merchant's unique identification number

orderIdstringRequired

The unique identifier assigned to each equipment order.

Responses

200

Success

No content

500

Unknown exception

delete

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

HTTPcURLJavaScriptPython

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

No content