Update an order
curl --request PUT \
--url https://api.salesive.com/api/v1/orders/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "processing",
"notes": "Packed and awaiting pickup",
"shippingCost": 1500,
"discount": 500,
"additionalInfo": [
{
"label": "Gift message",
"value": "Happy birthday!"
}
]
}
'import requests
url = "https://api.salesive.com/api/v1/orders/{id}"
payload = {
"status": "processing",
"notes": "Packed and awaiting pickup",
"shippingCost": 1500,
"discount": 500,
"additionalInfo": [
{
"label": "Gift message",
"value": "Happy birthday!"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 'processing',
notes: 'Packed and awaiting pickup',
shippingCost: 1500,
discount: 500,
additionalInfo: [{label: 'Gift message', value: 'Happy birthday!'}]
})
};
fetch('https://api.salesive.com/api/v1/orders/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.salesive.com/api/v1/orders/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'processing',
'notes' => 'Packed and awaiting pickup',
'shippingCost' => 1500,
'discount' => 500,
'additionalInfo' => [
[
'label' => 'Gift message',
'value' => 'Happy birthday!'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.salesive.com/api/v1/orders/{id}"
payload := strings.NewReader("{\n \"status\": \"processing\",\n \"notes\": \"Packed and awaiting pickup\",\n \"shippingCost\": 1500,\n \"discount\": 500,\n \"additionalInfo\": [\n {\n \"label\": \"Gift message\",\n \"value\": \"Happy birthday!\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.salesive.com/api/v1/orders/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"processing\",\n \"notes\": \"Packed and awaiting pickup\",\n \"shippingCost\": 1500,\n \"discount\": 500,\n \"additionalInfo\": [\n {\n \"label\": \"Gift message\",\n \"value\": \"Happy birthday!\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesive.com/api/v1/orders/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"processing\",\n \"notes\": \"Packed and awaiting pickup\",\n \"shippingCost\": 1500,\n \"discount\": 500,\n \"additionalInfo\": [\n {\n \"label\": \"Gift message\",\n \"value\": \"Happy birthday!\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": 200,
"success": true,
"message": "Order updated",
"data": {
"_id": "66b1f0a3c2d4e5f6a7b8c9d0",
"orderId": 1042,
"user": {
"_id": "66a0c1d2e3f4a5b6c7d8e9f0",
"name": "Ada Lovelace",
"email": "ada@example.com",
"phone": "+2348012345678",
"customerId": "66a0d0e1f2a3b4c5d6e7f8a9"
},
"items": [
{
"_id": "66b1f0a3c2d4e5f6a7b8c9d1",
"product": {
"_id": "6699aabbccddeeff00112233",
"name": "Wireless Earbuds",
"images": [
"https://cdn.salesive.com/p/earbuds.jpg"
]
},
"name": "Wireless Earbuds",
"sku": "WE-BLK-01",
"price": 24990,
"quantity": 2,
"variantAttributes": {},
"imageUrl": "https://cdn.salesive.com/p/earbuds.jpg"
}
],
"status": "processing",
"notes": "Packed and awaiting pickup",
"additionalInfo": [
{
"label": "Gift message",
"value": "Happy birthday!"
}
],
"payment": {
"_id": "66b1f0a3c2d4e5f6a7b8c9e0",
"status": "completed",
"amount": 49980,
"method": "card",
"transactionId": "txn_9f8e7d6c"
},
"coupon": null,
"shipment": null,
"discount": 500,
"subtotal": 49980,
"shippingCost": 1500,
"tax": 0,
"source": "online",
"paymentMethod": "card",
"total": 50980,
"createdAt": "2026-06-21T10:30:00.000Z",
"updatedAt": "2026-06-21T11:20:00.000Z"
}
}{
"status": 401,
"success": false,
"message": "Authentication required",
"data": null
}{
"status": 403,
"success": false,
"message": "Insufficient scope",
"data": null
}{
"status": 404,
"success": false,
"message": "Order not found",
"data": null
}Orders
Update an order
Update an existing order’s status, notes, shipping cost or discount. Requires the WRITE_ORDERS scope.
PUT
/
orders
/
{id}
Update an order
curl --request PUT \
--url https://api.salesive.com/api/v1/orders/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "processing",
"notes": "Packed and awaiting pickup",
"shippingCost": 1500,
"discount": 500,
"additionalInfo": [
{
"label": "Gift message",
"value": "Happy birthday!"
}
]
}
'import requests
url = "https://api.salesive.com/api/v1/orders/{id}"
payload = {
"status": "processing",
"notes": "Packed and awaiting pickup",
"shippingCost": 1500,
"discount": 500,
"additionalInfo": [
{
"label": "Gift message",
"value": "Happy birthday!"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 'processing',
notes: 'Packed and awaiting pickup',
shippingCost: 1500,
discount: 500,
additionalInfo: [{label: 'Gift message', value: 'Happy birthday!'}]
})
};
fetch('https://api.salesive.com/api/v1/orders/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.salesive.com/api/v1/orders/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'processing',
'notes' => 'Packed and awaiting pickup',
'shippingCost' => 1500,
'discount' => 500,
'additionalInfo' => [
[
'label' => 'Gift message',
'value' => 'Happy birthday!'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.salesive.com/api/v1/orders/{id}"
payload := strings.NewReader("{\n \"status\": \"processing\",\n \"notes\": \"Packed and awaiting pickup\",\n \"shippingCost\": 1500,\n \"discount\": 500,\n \"additionalInfo\": [\n {\n \"label\": \"Gift message\",\n \"value\": \"Happy birthday!\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.salesive.com/api/v1/orders/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"processing\",\n \"notes\": \"Packed and awaiting pickup\",\n \"shippingCost\": 1500,\n \"discount\": 500,\n \"additionalInfo\": [\n {\n \"label\": \"Gift message\",\n \"value\": \"Happy birthday!\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesive.com/api/v1/orders/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"processing\",\n \"notes\": \"Packed and awaiting pickup\",\n \"shippingCost\": 1500,\n \"discount\": 500,\n \"additionalInfo\": [\n {\n \"label\": \"Gift message\",\n \"value\": \"Happy birthday!\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": 200,
"success": true,
"message": "Order updated",
"data": {
"_id": "66b1f0a3c2d4e5f6a7b8c9d0",
"orderId": 1042,
"user": {
"_id": "66a0c1d2e3f4a5b6c7d8e9f0",
"name": "Ada Lovelace",
"email": "ada@example.com",
"phone": "+2348012345678",
"customerId": "66a0d0e1f2a3b4c5d6e7f8a9"
},
"items": [
{
"_id": "66b1f0a3c2d4e5f6a7b8c9d1",
"product": {
"_id": "6699aabbccddeeff00112233",
"name": "Wireless Earbuds",
"images": [
"https://cdn.salesive.com/p/earbuds.jpg"
]
},
"name": "Wireless Earbuds",
"sku": "WE-BLK-01",
"price": 24990,
"quantity": 2,
"variantAttributes": {},
"imageUrl": "https://cdn.salesive.com/p/earbuds.jpg"
}
],
"status": "processing",
"notes": "Packed and awaiting pickup",
"additionalInfo": [
{
"label": "Gift message",
"value": "Happy birthday!"
}
],
"payment": {
"_id": "66b1f0a3c2d4e5f6a7b8c9e0",
"status": "completed",
"amount": 49980,
"method": "card",
"transactionId": "txn_9f8e7d6c"
},
"coupon": null,
"shipment": null,
"discount": 500,
"subtotal": 49980,
"shippingCost": 1500,
"tax": 0,
"source": "online",
"paymentMethod": "card",
"total": 50980,
"createdAt": "2026-06-21T10:30:00.000Z",
"updatedAt": "2026-06-21T11:20:00.000Z"
}
}{
"status": 401,
"success": false,
"message": "Authentication required",
"data": null
}{
"status": 403,
"success": false,
"message": "Insufficient scope",
"data": null
}{
"status": 404,
"success": false,
"message": "Order not found",
"data": null
}Applies the whitelisted fields (
status, notes, shippingCost, discount, additionalInfo) and returns the re-fetched, fully populated order. Status changes notify the customer. The store is bound to your app token server-side — never send a shop id.
additionalInfo is a list of custom labelled { label, value } entries attached to the order (e.g. a gift message or delivery instructions). It is replaced wholesale — send the full list you want the order to end up with. Entries without a label are dropped and the list is capped at 50 entries.Authorizations
Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.
Path Parameters
The order's id (Mongo ObjectId).
Body
application/json
New order status.
Available options:
pending, processing, paid, cancelled, refunded, completed Internal order notes.
Shipping cost for the order.
Order-level discount amount.
Replaces the order's additional info with this list of labelled key/value entries (max 50).
Maximum array length:
50Show child attributes
Show child attributes
Response
The updated, fully populated order.
Standard Salesive response envelope. The operation-specific payload is carried in data.
Was this page helpful?
⌘I

