Update async orders

🚧
Closed Release:
This feature is available for a limited number of customers with specific use cases only.

This endpoint in the Tango API is designed to allow updates to asynchronous orders that have already been created.

Use the following endpoint to update async orders placed under your platform:

Endpoint	Purpose
`PATCH {URI}/asyncOrders/customers/{customerIdentifier}/ accounts/{accountIdentifier}/{externalRefID}`	Update an async order under a specific Account

Benefits

Ability to update or correct metadata like campaign names, purchase order numbers, or notes associated with the order, which is useful for tracking and reporting.
Ensures accurate records for compliance, auditing, and reconciliation.

Use case

Acme Health offers a wellness program, where patients who complete annual check-ups receive a $25 digital gift card. Orders are created asynchronously in batches at the end of each week. An order was made, but it had incorrect metadata.

The following path parameter indicates which specific async order the request is acting upon:

Path params	Data type	Requirement	Description
customerIdentifier	string	required	Specify the customer to be queried
accountIdentifier	string	required	Specify the account to be queried.
externalRefID	string	required	An idempotent field that can be used for your order cross-reference and to prevent accidental order duplication. This value is returned in the order response, order details, and order history. The string has a maximum of 100 alphanumeric characters.

The following body params can be modified using PATCH endpoint:

Body params	Data type	Requirement	Description
campaign	string	optional	The campaign field can be used to categorize a specific order administratively. Must be between 0 and 1024 characters in length.
purchaseOrderNumber	string	optional	The Purchase Order Number associated with this order.
notes	string	optional	Order notes up to 150 characters.

The following example shows the payload for when you use this endpoint with a successful response:

{
  "externalRefID": "string",
  "status": "string",
  "totalLineItems": 0,
  "createdAt": "2025-10-23T21:52:43.041Z",
  "failedLineItems": [
    {
      "lineItemId": "string",
      "externalRefLineItemID": "string",
      "utid": "string",
      "errors": [
        {
          "field": "string",
          "errorCodeValue": 0,
          "errorCodeName": "string",
          "message": "string"
        }
      ]
    }
  ],
  "duplicateLineItemRefIds": {
    "additionalProp": 0
  }
}

The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:

Response code	Meaning
200	The request was successful.
400	The server could not understand the request due to invalid syntax.
401	Authentication is required and has either not been provided or failed.
429	Exceeded the allowable TPS rate limit. It indicates that the user has sent too many requests in a given amount of time, and the server is rate-limiting further requests
500	Something went wrong on the server, but the server cannot be more specific about the exact problem.
503	The server is currently unable to handle the request due to temporary overload or maintenance.