Legacy (v0)
Update an order
Update an order. Callers without internal order snapshot read access cannot write tax_and_shipping_settings; such requests return 422 without changing the order. tax_label remains readable but is set by the tax provider; setting, changing or removing it returns 422, while resending its stored value is allowed. Replacing metadata preserves an omitted stored tax_label and the hidden snapshot. A write of status or order_status that cancels an order that cannot be cancelled, such as one holding captured funds or a renewal whose charge the payment provider has not answered yet, returns 422. A paid order must be refunded in full first.
PATCH
/
api
/
orders
/
{id}
Update an order
curl --request PATCH \
--url https://api.fluid.app/api/orders/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"order": {
"note": "Leave the cases at the loading dock on Slough Avenue.",
"external_id": "NS-SO-77120",
"metadata": {
"sales_channel": "phone"
},
"metafields": [
{
"namespace": "custom",
"key": "purchase_order",
"value": "PO-2026-0917",
"value_type": "string"
}
]
}
}
'import requests
url = "https://api.fluid.app/api/orders/{id}"
payload = { "order": {
"note": "Leave the cases at the loading dock on Slough Avenue.",
"external_id": "NS-SO-77120",
"metadata": { "sales_channel": "phone" },
"metafields": [
{
"namespace": "custom",
"key": "purchase_order",
"value": "PO-2026-0917",
"value_type": "string"
}
]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
order: {
note: 'Leave the cases at the loading dock on Slough Avenue.',
external_id: 'NS-SO-77120',
metadata: {sales_channel: 'phone'},
metafields: [
{
namespace: 'custom',
key: 'purchase_order',
value: 'PO-2026-0917',
value_type: 'string'
}
]
}
})
};
fetch('https://api.fluid.app/api/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.fluid.app/api/orders/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'order' => [
'note' => 'Leave the cases at the loading dock on Slough Avenue.',
'external_id' => 'NS-SO-77120',
'metadata' => [
'sales_channel' => 'phone'
],
'metafields' => [
[
'namespace' => 'custom',
'key' => 'purchase_order',
'value' => 'PO-2026-0917',
'value_type' => 'string'
]
]
]
]),
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.fluid.app/api/orders/{id}"
payload := strings.NewReader("{\n \"order\": {\n \"note\": \"Leave the cases at the loading dock on Slough Avenue.\",\n \"external_id\": \"NS-SO-77120\",\n \"metadata\": {\n \"sales_channel\": \"phone\"\n },\n \"metafields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"purchase_order\",\n \"value\": \"PO-2026-0917\",\n \"value_type\": \"string\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.fluid.app/api/orders/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"order\": {\n \"note\": \"Leave the cases at the loading dock on Slough Avenue.\",\n \"external_id\": \"NS-SO-77120\",\n \"metadata\": {\n \"sales_channel\": \"phone\"\n },\n \"metafields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"purchase_order\",\n \"value\": \"PO-2026-0917\",\n \"value_type\": \"string\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fluid.app/api/orders/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"order\": {\n \"note\": \"Leave the cases at the loading dock on Slough Avenue.\",\n \"external_id\": \"NS-SO-77120\",\n \"metadata\": {\n \"sales_channel\": \"phone\"\n },\n \"metafields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"purchase_order\",\n \"value\": \"PO-2026-0917\",\n \"value_type\": \"string\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"order": {
"id": 48213,
"order_number": "DM-10482",
"token": "fo_7Kq2ZtW9xYbN4cRhJ3mLpV",
"enrollment_member_type": null,
"resulting_member_type": null,
"pricing_snapshot": null,
"external_id": "NS-SO-77120",
"email": "holly.flax@dundermifflin.com",
"first_name": "Holly",
"last_name": "Flax",
"status": "awaiting_shipment",
"order_status": "completed",
"financial_status": "paid",
"fulfillment_status": "unfulfilled",
"source": "admin",
"currency_code": "USD",
"currency_symbol": "$",
"amount": "63.41",
"subtotal": "54.99",
"tax": "4.42",
"shipping": "4.0",
"note": "Leave the cases at the loading dock on Slough Avenue.",
"warehouse_id": 311,
"items_count": 1,
"quantity_count": 1,
"company_subdomain": "dunder-mifflin",
"primary_domain_hostname": "shop.dundermifflin.com",
"created_at": "2026-09-14T15:40:52Z",
"updated_at": "2026-09-14T16:05:11Z"
},
"meta": {
"request_id": "5e2a8c14-7d3b-4f96-a0c1-9b6e3d2f8a47",
"timestamp": "2026-09-14T16:05:11Z",
"shop_url": "https://shop.dundermifflin.com"
}
}{
"message": "<string>"
}{
"message": "<string>",
"error": "<string>",
"error_message": "<string>",
"errors": "<string>",
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"code": "<string>",
"blocked_date": "2026-11-30",
"blocked_day": 30,
"allowed_date": "2026-11-28",
"scheduled_date": "2026-12-10",
"last_bill_date": "2026-11-10",
"requested_date": "2026-11-30",
"payment_uuid": "<string>",
"error_details": [
{
"code": "<string>",
"field": "<string>",
"payment": "not_attempted",
"message": "<string>"
}
],
"coded_recovery": true
}
}{
"error_message": "unprocessable entity",
"errors": {
"metadata": [
"tax_and_shipping_settings requires order read access"
]
}
}⌘I
Update an order
curl --request PATCH \
--url https://api.fluid.app/api/orders/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"order": {
"note": "Leave the cases at the loading dock on Slough Avenue.",
"external_id": "NS-SO-77120",
"metadata": {
"sales_channel": "phone"
},
"metafields": [
{
"namespace": "custom",
"key": "purchase_order",
"value": "PO-2026-0917",
"value_type": "string"
}
]
}
}
'import requests
url = "https://api.fluid.app/api/orders/{id}"
payload = { "order": {
"note": "Leave the cases at the loading dock on Slough Avenue.",
"external_id": "NS-SO-77120",
"metadata": { "sales_channel": "phone" },
"metafields": [
{
"namespace": "custom",
"key": "purchase_order",
"value": "PO-2026-0917",
"value_type": "string"
}
]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
order: {
note: 'Leave the cases at the loading dock on Slough Avenue.',
external_id: 'NS-SO-77120',
metadata: {sales_channel: 'phone'},
metafields: [
{
namespace: 'custom',
key: 'purchase_order',
value: 'PO-2026-0917',
value_type: 'string'
}
]
}
})
};
fetch('https://api.fluid.app/api/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.fluid.app/api/orders/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'order' => [
'note' => 'Leave the cases at the loading dock on Slough Avenue.',
'external_id' => 'NS-SO-77120',
'metadata' => [
'sales_channel' => 'phone'
],
'metafields' => [
[
'namespace' => 'custom',
'key' => 'purchase_order',
'value' => 'PO-2026-0917',
'value_type' => 'string'
]
]
]
]),
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.fluid.app/api/orders/{id}"
payload := strings.NewReader("{\n \"order\": {\n \"note\": \"Leave the cases at the loading dock on Slough Avenue.\",\n \"external_id\": \"NS-SO-77120\",\n \"metadata\": {\n \"sales_channel\": \"phone\"\n },\n \"metafields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"purchase_order\",\n \"value\": \"PO-2026-0917\",\n \"value_type\": \"string\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.fluid.app/api/orders/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"order\": {\n \"note\": \"Leave the cases at the loading dock on Slough Avenue.\",\n \"external_id\": \"NS-SO-77120\",\n \"metadata\": {\n \"sales_channel\": \"phone\"\n },\n \"metafields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"purchase_order\",\n \"value\": \"PO-2026-0917\",\n \"value_type\": \"string\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fluid.app/api/orders/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"order\": {\n \"note\": \"Leave the cases at the loading dock on Slough Avenue.\",\n \"external_id\": \"NS-SO-77120\",\n \"metadata\": {\n \"sales_channel\": \"phone\"\n },\n \"metafields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"purchase_order\",\n \"value\": \"PO-2026-0917\",\n \"value_type\": \"string\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"order": {
"id": 48213,
"order_number": "DM-10482",
"token": "fo_7Kq2ZtW9xYbN4cRhJ3mLpV",
"enrollment_member_type": null,
"resulting_member_type": null,
"pricing_snapshot": null,
"external_id": "NS-SO-77120",
"email": "holly.flax@dundermifflin.com",
"first_name": "Holly",
"last_name": "Flax",
"status": "awaiting_shipment",
"order_status": "completed",
"financial_status": "paid",
"fulfillment_status": "unfulfilled",
"source": "admin",
"currency_code": "USD",
"currency_symbol": "$",
"amount": "63.41",
"subtotal": "54.99",
"tax": "4.42",
"shipping": "4.0",
"note": "Leave the cases at the loading dock on Slough Avenue.",
"warehouse_id": 311,
"items_count": 1,
"quantity_count": 1,
"company_subdomain": "dunder-mifflin",
"primary_domain_hostname": "shop.dundermifflin.com",
"created_at": "2026-09-14T15:40:52Z",
"updated_at": "2026-09-14T16:05:11Z"
},
"meta": {
"request_id": "5e2a8c14-7d3b-4f96-a0c1-9b6e3d2f8a47",
"timestamp": "2026-09-14T16:05:11Z",
"shop_url": "https://shop.dundermifflin.com"
}
}{
"message": "<string>"
}{
"message": "<string>",
"error": "<string>",
"error_message": "<string>",
"errors": "<string>",
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"code": "<string>",
"blocked_date": "2026-11-30",
"blocked_day": 30,
"allowed_date": "2026-11-28",
"scheduled_date": "2026-12-10",
"last_bill_date": "2026-11-10",
"requested_date": "2026-11-30",
"payment_uuid": "<string>",
"error_details": [
{
"code": "<string>",
"field": "<string>",
"payment": "not_attempted",
"message": "<string>"
}
],
"coded_recovery": true
}
}{
"error_message": "unprocessable entity",
"errors": {
"metadata": [
"tax_and_shipping_settings requires order read access"
]
}
}