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"
}
}{
"errors": [
{
"status": "400",
"code": "invalid",
"title": "Invalid",
"detail": "Could not find specified item.",
"source": {
"pointer": "order/order_details/order_items"
}
}
]
}{
"errors": [
{
"status": "404",
"code": "not_found",
"title": "Not found",
"detail": "Could not find specified item."
}
]
}Update an order
Partially update some fields of an order.
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"
}
}{
"errors": [
{
"status": "400",
"code": "invalid",
"title": "Invalid",
"detail": "Could not find specified item.",
"source": {
"pointer": "order/order_details/order_items"
}
}
]
}{
"errors": [
{
"status": "404",
"code": "not_found",
"title": "Not found",
"detail": "Could not find specified item."
}
]
}write:order. See Scopes for OAuth apps.Authorizations
Basic Authentication using API key and secrets is currently the main authentication mechanism.
Scopes
Import and process your orders
Path Parameters
Filtering on the Sendcloud order ID
x >= 1Body
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.
External order ID assigned by shop system
"7bdd5bfd-76bc-4654-9d40-5d5d49f1cd6c"
Unique order number generated manually or by shop system
"101170081"
Node for general order information
Show child attributes
Show child attributes
Node for everything about payments and money
Show child attributes
Show child attributes
Customs information required for international shipments.
Show child attributes
Show child attributes
Node for information about the customer
Show child attributes
Show child attributes
Sendcloud Address object
Show child attributes
Show child attributes
Sendcloud Address object
Show child attributes
Show child attributes
Shipping information
Show child attributes
Show child attributes
Node for service point information. The service point information can be retrieved using the Service points API.
You must provide either the Sendcloud id or the carrier_service_point_id to identify the service point.
Note:
service_point_detailsis intended for API usage only and will not be reflected in the Incoming Order View (IOV).
- Sendcloud ID
- Carrier Service Point ID
Show child attributes
Show child attributes
Response
OK
Create/Update orders in batch response object
Show child attributes
Show child attributes