Skip to main content

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, or Cancelled.

Path Parameters

Field NameDescriptionTypeAdditional Information
orderIdThe 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 NameDescriptionTypeAdditional Information
orderInfoThe new custom merchant-specific data.ObjectRequired. 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 CodeDescription
400 Bad RequestThe request was invalid (e.g., order status does not allow updates or orderInfo has invalid content).
401 UnauthorizedAuthentication failure (e.g., missing or invalid API key/credentials).
404 Not FoundThe specified orderId does not exist.