Partial Order Update by OrderId

This operation updates one or more fields of an existing order.This API is used to modify order data after creation, such as adding items or updating order-level information, without replacing the entire order record.

SecuritybearerAuth
Request
path Parameters
orderId
required
string

Unique identifier for the order

Request Body schema: application/json
orderNumber
string

The unique identifier for the order.

object

An optional message added to an order, such as a gift note or a short greeting.

object (Charges)

Financials and tender type information for the order.

object (ShippingReferences)

Contains additional reference fields that can be passed with the request.

object

End customer (buyer) profile for communication.

object

The address from where the order is generated.

object

The address where the order is destined to.

Array of objects (Item)

List of items in the order. To create an order, minimum one item is required.

object (ShippingPreferences)

Shipping-related preferences for an order.

Responses
200

Order updated successfully (partial)

400

Invalid request

401

The request could not be authorized

404

The requested resource was not found.

500

The request could not be completed due to an internal error

patch/api/v1/orders/{orderId}
Request samples
application/json
{
  • "orderNumber": "ORD12346",
  • "orderMessage": {
    },
  • "charges": {
    },
  • "shippingReference": {
    },
  • "customerInfo": {
    },
  • "fromAddress": {
    },
  • "toAddress": {
    },
  • "items": [
    ],
  • "shippingPreferences": {
    }
}
Response samples
application/json
{
  • "orderId": "PBNj9OB9zXvx",
  • "orderNumber": "ORD123456",
  • "status": "Updated",
  • "transactionCreateDate": "2025-07-02T18:27:48.172Z"
}