Skip to main content
PATCH
/
orders
/
{orderId}
Update resource
curl --request PATCH \
  --url https://api.quivo.co/orders/{orderId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": {
    "name": "<string>",
    "company": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "street": "<string>",
    "street2": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "state": "<string>",
    "countryIso2": "<string>",
    "latitude": 123,
    "longitude": 123
  },
  "comment": "<string>",
  "trackingEnabled": true,
  "customAttributes": "{\"attr1\":\"val1\"}"
}
'
This response has no body data.

Path Parameters

​
orderId
integer<int64>
required

The unique identifier for an order.

Body

application/json

Partial resource data to update at /orders/{orderId}

Request payload for partially updating an existing order. Contains only the fields to be modified, such as delivery dates, shipping preferences, or order metadata.

​
address
object

Request payload for updating the delivery address of an existing order. Contains the new address information and optional address type specification.

​
comment
string

Optional text which contains instructions for the fulfillment and is sent to the warehouse.

Maximum string length: 250
​
trackingEnabled
boolean

Optional value setting whether to turn on/off tracking functionality for an order. Additional charges will apply when set to true.

​
customAttributes
object

Optional value for custom attributes of order.

Example:

"{\"attr1\":\"val1\"}"

Response

Bad request - the request payload is invalid, missing required fields, or contains invalid data.