Update OrderInfo
Purpose: Updates the custom merchant-specific data associated with the order.
Endpoint Details
- HTTP Verb: PATCH
- URL Segment: /v3/order/{orderId}/orderinfo
- OpenAPI Spec: View in Swagger UI
- Notes: The status must not be
Completed,Rejected, orCancelled.
Path Parameters
| Field Name | Description | Type | Additional Information |
|---|---|---|---|
orderId | The unique ID of the order to update. | string ($uuid) | Required. |
Request Body (UpdateOrderInfoRequest)
This method requires a JSON body containing the new orderInfo object.
| Field Name | Description | Type | Additional Information |
|---|---|---|---|
orderInfo | The new custom merchant-specific data. | Object | Required. See OrderInfo Schema |
Example Request
{
"orderInfo": {
"newKey": "New value added",
"salesPersonId": "52"
}
}
Successful Response (200 OK)
The API returns an OrderResponse object containing the updated Order.
For schema and examples, see the OrderResponse Schema page.
Error Responses
| Status Code | Description |
|---|---|
| 400 Bad Request | The request was invalid (e.g., order status does not allow updates or orderInfo has invalid content). |
| 401 Unauthorized | Authentication failure (e.g., missing or invalid API key/credentials). |
| 404 Not Found | The specified orderId does not exist. |