Skip to main content
PATCH
/
orders
/
{id}
curl --request PATCH \
  --url https://panel.sendcloud.sc/api/v3/orders/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "669",
  "order_id": "555413",
  "order_details": {
    "status": {
      "code": "fulfilled",
      "message": "Fulfilled"
    },
    "tags": [
      "october_campaign"
    ]
  }
}
'
{
  "data": {
    "id": 669,
    "order_id": "555413",
    "order_number": "OXSDFGHTD-12"
  }
}

Authorizations

​
Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Path Parameters

​
id
integer
required

Filtering on the Sendcloud order ID

Required range: x >= 1

Body

application/json

Only include the fields you would like to update. If you need to update any of the order_items, the name field is required so that the correct order_item is updated. If you need to add items to or remove items from an order, you should use the Create/Update orders in batch endpoint instead.

API v3 Order model without any required fields to be used in partial update.

​
order_id
string

External order ID assigned by shop system

Example:

"7bdd5bfd-76bc-4654-9d40-5d5d49f1cd6c"

​
order_number
string

Unique order number generated manualy or by shop system

Example:

"101170081"

​
order_details
object

Node for general order information

​
payment_details
object

Node for everything about payments and money

​
customs_details
Customs Details · object

Customs information required for international shipments.

​
customer_details
object

Node for an information about customer

​
billing_address
Address Object · object

Sendcloud Address object

​
shipping_address
Address Object · object

Sendcloud Address object

​
shipping_details
object

Shipping information

​
service_point_details
object

Node for service point information. The service point information can be retrieved using the Service points API.

Response

OK

​
data
object

Create/Update orders in batch response object