---
title: "Manual update order"
method: PUT
path: "/api/equipment/orders/resubmit"
---

# Manual update order

`PUT /api/equipment/orders/resubmit`

## Request body

- EquipmentOrderForm
  - `orderItems` OrderItem[] — List of items included in the order, such as equipment or software, or accessories.
    - `orderItemId` integer — Unique identifier of the order item.
    - `manufacturer` string — Name of the equipment manufacturer.
    - `productName` string — Name of the ordered product.
    - `survey` Survey — Equipment survey details linked with the order item.
      - `questionAnswerGroup` QuestionAnswerGroup — Contains the structure and data for survey questions and answers.
        - `questionAnswerSets` object — Holds sets of related questions and their possible answers.
        - `questionAreas` string[] — Lists the survey question categories or areas being addressed.
      - `metadata` Metadata — Contains metadata for the API response.
        - `exchangeId` unknown
        - `timestamp` unknown
    - `quantity` integer — Number of units ordered for the product.
    - `validFrontends` string[] — List of supported frontends for the order item.
    - `errors` ValidationError[] — Errors related to the specific order item.
      - `field` string
      - `message` string
    - `productType` 'Software' | 'Terminal' — Type of the product (Example: Software, Hardware).
    - `orderItemMetadata` OrderItemMetadata[] — Additional metadata about the order item (API key, model, serial number, tracking, etc.).
      - `orderStatus` string — Current status of the order item.
      - `terminalId` integer, required — Terminal ID associated with the product or order.
      - `storeNumber` integer, required — Serial number of the product.
      - `getvNumber` string — Version number or internal reference number for the order item.
      - `apiKey` string — API key associated with the order item.
      - `publicKey` string — Public key associated with the product or order item.
      - `trackingNumber` string — Tracking number for shipping the product.
      - `salesforceCaseNumber` string — Salesforce case number related to the order item.
      - `tcn` string — Transaction control number related to the item.
      - `serialNumber` string — Serial number of the product.
      - `productManufacturer` string — Name of the manufacturer for the product.
      - `productModel` string — Model of the product.
    - `trackingNumber` string — Tracking number for shipping the product.
    - `completionDate` string, date-time — Completion date of the order item. Format: MM/dd/yyyy HH:mm a
    - `surveyValid` boolean — Indicates whether the survey data is valid.
  - `merchantNumber` string — The unique identifier of the merchant.
  - `orderId` string — The unique identifier of the order.
  - `status` 'Active' | 'Submitted' | 'Signed' | 'Approved' | 'AddedSalesforce' | 'BoardedTSYS' | 'BoardedQuest' | 'Shipped' | 'BackOrdered' | 'Deleted' | 'Completed' | 'OffRamp' | 'WaitingForTracking' | 'BoardedDevice' — Current status of the order. Possible values: Active Submitted Signed Approved AddedSalesforce BoardedTSYS BoardedQuest Shipped BackOrdered Deleted Completed OffRamp WaitingForTracking BoardedDevice
  - `metadata` Metadata — Contains metadata for the API response.
    - `exchangeId` unknown
    - `timestamp` unknown
  - `errors` ValidationError[] — Contains validation errors with details about the field and message.
    - `field` string
    - `message` string
  - `orderCreateTime` string, date-time — Timestamp details when the order was created. Includes calendar, time zone, and week data.
  - `orderModifyTime` string, date-time — Details of when the order was last modified, including time zone, week data, and timestamp.
  - `resubmit` boolean — Indicates if the order is a resubmission.
  - `validFrontends` string[] — List of supported frontends for the order.

## Response `201`

Success

- EquipmentOrderForm
  - `orderItems` OrderItem[] — List of items included in the order, such as equipment or software, or accessories.
    - `orderItemId` integer — Unique identifier of the order item.
    - `manufacturer` string — Name of the equipment manufacturer.
    - `productName` string — Name of the ordered product.
    - `survey` Survey — Equipment survey details linked with the order item.
      - `questionAnswerGroup` QuestionAnswerGroup — Contains the structure and data for survey questions and answers.
        - `questionAnswerSets` object — Holds sets of related questions and their possible answers.
        - `questionAreas` string[] — Lists the survey question categories or areas being addressed.
      - `metadata` Metadata — Contains metadata for the API response.
        - `exchangeId` unknown
        - `timestamp` unknown
    - `quantity` integer — Number of units ordered for the product.
    - `validFrontends` string[] — List of supported frontends for the order item.
    - `errors` ValidationError[] — Errors related to the specific order item.
      - `field` string
      - `message` string
    - `productType` 'Software' | 'Terminal' — Type of the product (Example: Software, Hardware).
    - `orderItemMetadata` OrderItemMetadata[] — Additional metadata about the order item (API key, model, serial number, tracking, etc.).
      - `orderStatus` string — Current status of the order item.
      - `terminalId` integer, required — Terminal ID associated with the product or order.
      - `storeNumber` integer, required — Serial number of the product.
      - `getvNumber` string — Version number or internal reference number for the order item.
      - `apiKey` string — API key associated with the order item.
      - `publicKey` string — Public key associated with the product or order item.
      - `trackingNumber` string — Tracking number for shipping the product.
      - `salesforceCaseNumber` string — Salesforce case number related to the order item.
      - `tcn` string — Transaction control number related to the item.
      - `serialNumber` string — Serial number of the product.
      - `productManufacturer` string — Name of the manufacturer for the product.
      - `productModel` string — Model of the product.
    - `trackingNumber` string — Tracking number for shipping the product.
    - `completionDate` string, date-time — Completion date of the order item. Format: MM/dd/yyyy HH:mm a
    - `surveyValid` boolean — Indicates whether the survey data is valid.
  - `merchantNumber` string — The unique identifier of the merchant.
  - `orderId` string — The unique identifier of the order.
  - `status` 'Active' | 'Submitted' | 'Signed' | 'Approved' | 'AddedSalesforce' | 'BoardedTSYS' | 'BoardedQuest' | 'Shipped' | 'BackOrdered' | 'Deleted' | 'Completed' | 'OffRamp' | 'WaitingForTracking' | 'BoardedDevice' — Current status of the order. Possible values: Active Submitted Signed Approved AddedSalesforce BoardedTSYS BoardedQuest Shipped BackOrdered Deleted Completed OffRamp WaitingForTracking BoardedDevice
  - `metadata` Metadata — Contains metadata for the API response.
    - `exchangeId` unknown
    - `timestamp` unknown
  - `errors` ValidationError[] — Contains validation errors with details about the field and message.
    - `field` string
    - `message` string
  - `orderCreateTime` string, date-time — Timestamp details when the order was created. Includes calendar, time zone, and week data.
  - `orderModifyTime` string, date-time — Details of when the order was last modified, including time zone, week data, and timestamp.
  - `resubmit` boolean — Indicates if the order is a resubmission.
  - `validFrontends` string[] — List of supported frontends for the order.

## Other responses

- `400` — Validation failure
- `500` — Unknown exception

---

[API](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow.md) · [All operations](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xplorpay/external-us-onboarding-workflow/versions/f37077c24b66/schema)
