> For the complete documentation index, see [llms.txt](https://docs.xplorpay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-order/equipment-order-service-api.md).

# Equipment Order Service API

## PUT /api/equipment/orders/resubmit

> Manual update order

```json
{"openapi":"3.0.1","info":{"title":"Equipment Order Service API","version":"2.0"},"paths":{"/api/equipment/orders/resubmit":{"put":{"summary":"Manual update order","operationId":"manualUpdateEquipmentOrder","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EquipmentOrderForm"}}},"required":true},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EquipmentOrderForm"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EquipmentOrderForm"}}}},"400":{"description":"Validation failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Unknown exception","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}}},"components":{"schemas":{"EquipmentOrderForm":{"type":"object","properties":{"orderItems":{"type":"array","description":"List of items included in the order, such as equipment or software, or accessories.","items":{"$ref":"#/components/schemas/OrderItem"}},"merchantNumber":{"type":"string","description":"The unique identifier of the merchant."},"orderId":{"type":"string","description":"The unique identifier of the order."},"status":{"type":"string","description":"Current status of the order.\r\n\r\nPossible values: Active Submitted Signed Approved AddedSalesforce BoardedTSYS BoardedQuest Shipped BackOrdered Deleted Completed OffRamp WaitingForTracking BoardedDevice","enum":["Active","Submitted","Signed","Approved","AddedSalesforce","BoardedTSYS","BoardedQuest","Shipped","BackOrdered","Deleted","Completed","OffRamp","WaitingForTracking","BoardedDevice"]},"metadata":{"$ref":"#/components/schemas/Metadata"},"errors":{"type":"array","description":"Contains validation errors with details about the field and message.","items":{"$ref":"#/components/schemas/ValidationError"}},"orderCreateTime":{"type":"string","description":"Timestamp details when the order was created. Includes calendar, time zone, and week data.","format":"date-time"},"orderModifyTime":{"type":"string","description":"Details of when the order was last modified, including time zone, week data, and timestamp.","format":"date-time"},"resubmit":{"type":"boolean","description":"Indicates if the order is a resubmission."},"validFrontends":{"type":"array","description":"List of supported frontends for the order.","items":{"type":"string","description":"List of supported frontends for the order."}}}},"OrderItem":{"type":"object","properties":{"orderItemId":{"type":"integer","description":"Unique identifier of the order item.","format":"int32"},"manufacturer":{"type":"string","description":"Name of the equipment manufacturer."},"productName":{"type":"string","description":"Name of the ordered product."},"survey":{"$ref":"#/components/schemas/Survey"},"quantity":{"type":"integer","description":"Number of units ordered for the product.","format":"int32"},"validFrontends":{"type":"array","description":"List of supported frontends for the order item.","items":{"type":"string","description":"List of supported frontends for the order item."}},"errors":{"type":"array","description":"Errors related to the specific order item.","items":{"$ref":"#/components/schemas/ValidationError"}},"productType":{"type":"string","description":"Type of the product (Example: Software, Hardware).","enum":["Software","Terminal"]},"orderItemMetadata":{"type":"array","description":"Additional metadata about the order item (API key, model, serial number, tracking, etc.).","items":{"$ref":"#/components/schemas/OrderItemMetadata"}},"trackingNumber":{"type":"string","description":"Tracking number for shipping the product."},"completionDate":{"type":"string","description":"Completion date of the order item. Format: MM/dd/yyyy HH:mm a","format":"date-time"},"surveyValid":{"type":"boolean","description":"Indicates whether the survey data is valid."}},"description":"List of items included in the order, such as equipment or software, or accessories."},"Survey":{"type":"object","properties":{"questionAnswerGroup":{"$ref":"#/components/schemas/QuestionAnswerGroup"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"description":"Equipment survey details linked with the order item."},"QuestionAnswerGroup":{"type":"object","properties":{"questionAnswerSets":{"type":"object","additionalProperties":{"type":"array","description":"Holds sets of related questions and their possible answers.","items":{"$ref":"#/components/schemas/QuestionAnswerSet"}},"description":"Holds sets of related questions and their possible answers."},"questionAreas":{"type":"array","description":"Lists the survey question categories or areas being addressed.","items":{"type":"string","description":"Lists the survey question categories or areas being addressed."}}},"description":"Contains the structure and data for survey questions and answers."},"QuestionAnswerSet":{"type":"object","properties":{"required":{"type":"boolean"},"type":{"type":"string"},"answers":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswer"}},"children":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswerSet"}},"sendToMerchantApp":{"type":"boolean"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}},"isHidden":{"type":"boolean"},"selectedAnswer":{"type":"integer","format":"int32"},"valid":{"type":"boolean"},"question":{"type":"string"},"conditionalOnAnswer":{"type":"integer","format":"int32"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/BoardingTag"}}},"description":"Holds sets of related questions and their possible answers."},"QuestionAnswer":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"selected":{"type":"boolean"},"answer":{"type":"string"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}},"description":"Contains validation errors with details about the field and message."},"BoardingTag":{"type":"object","properties":{"group":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}},"Metadata":{"type":"object","properties":{"exchangeId":{"type":"string","description":"Unique correlation ID for the order request."},"timestamp":{"type":"string","description":"Timestamp of when the order request was generated. Format: yyyy-MM-dd'T'hh:mm:ss.SSS"}},"description":"Contains metadata about the order request."},"OrderItemMetadata":{"required":["storeNumber","terminalId"],"type":"object","properties":{"orderStatus":{"type":"string","description":"Current status of the order item."},"terminalId":{"maximum":9999,"minimum":1000,"type":"integer","description":"Terminal ID associated with the product or order.","format":"int32"},"storeNumber":{"maximum":9999,"minimum":1000,"type":"integer","description":"Serial number of the product.","format":"int32"},"getvNumber":{"pattern":"^[a-zA-Z0-9]{8}$","type":"string","description":"Version number or internal reference number for the order item."},"apiKey":{"maxLength":512,"minLength":0,"type":"string","description":"API key associated with the order item."},"publicKey":{"maxLength":512,"minLength":0,"type":"string","description":"Public key associated with the product or order item."},"trackingNumber":{"maxLength":256,"minLength":0,"type":"string","description":"Tracking number for shipping the product."},"salesforceCaseNumber":{"maxLength":255,"minLength":0,"type":"string","description":"Salesforce case number related to the order item."},"tcn":{"maxLength":16,"minLength":0,"type":"string","description":"Transaction control number related to the item."},"serialNumber":{"maxLength":16,"minLength":8,"type":"string","description":"Serial number of the product."},"productManufacturer":{"maxLength":20,"minLength":0,"type":"string","description":"Name of the manufacturer for the product."},"productModel":{"maxLength":15,"minLength":0,"type":"string","description":"Model of the product."}},"description":"Additional metadata about the order item (API key, model, serial number, tracking, etc.)."},"ApiError":{"type":"object","properties":{"status":{"type":"string","description":"HTTP status code","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"timestamp":{"pattern":"dd-MM-yyyy hh:mm:ss","type":"string","description":"Timestamp when the error occurred","format":"date-time"},"message":{"type":"string","description":"Detailed error message describing what went wrong"}},"description":"Standard error response returned by the API when an error occurs"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-order/equipment-order-service-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
