Update orders (PUT)
The PUT form of PATCH /api/company/orders/{id}. Both methods reach one
update action, take the same body and return the same responses. Read
that operation for the details.
curl --request PUT \
--url https://api.fluid.app/api/company/orders/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"order": {
"status": "shipped",
"shipped_on": "2026-09-15",
"tracking_informations_attributes": [
{
"tracking_number": "1Z999AA10123456784",
"shipping_carrier": "UPS"
}
]
}
}
'import requests
url = "https://api.fluid.app/api/company/orders/{id}"
payload = { "order": {
"status": "shipped",
"shipped_on": "2026-09-15",
"tracking_informations_attributes": [
{
"tracking_number": "1Z999AA10123456784",
"shipping_carrier": "UPS"
}
]
} }
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({
order: {
status: 'shipped',
shipped_on: '2026-09-15',
tracking_informations_attributes: [{tracking_number: '1Z999AA10123456784', shipping_carrier: 'UPS'}]
}
})
};
fetch('https://api.fluid.app/api/company/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/company/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([
'order' => [
'status' => 'shipped',
'shipped_on' => '2026-09-15',
'tracking_informations_attributes' => [
[
'tracking_number' => '1Z999AA10123456784',
'shipping_carrier' => 'UPS'
]
]
]
]),
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/company/orders/{id}"
payload := strings.NewReader("{\n \"order\": {\n \"status\": \"shipped\",\n \"shipped_on\": \"2026-09-15\",\n \"tracking_informations_attributes\": [\n {\n \"tracking_number\": \"1Z999AA10123456784\",\n \"shipping_carrier\": \"UPS\"\n }\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.fluid.app/api/company/orders/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"order\": {\n \"status\": \"shipped\",\n \"shipped_on\": \"2026-09-15\",\n \"tracking_informations_attributes\": [\n {\n \"tracking_number\": \"1Z999AA10123456784\",\n \"shipping_carrier\": \"UPS\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fluid.app/api/company/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 \"order\": {\n \"status\": \"shipped\",\n \"shipped_on\": \"2026-09-15\",\n \"tracking_informations_attributes\": [\n {\n \"tracking_number\": \"1Z999AA10123456784\",\n \"shipping_carrier\": \"UPS\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 48213,
"order_number": "DM-10482",
"external_id": "NS-SO-77120",
"status": "shipped",
"currency_code": "USD",
"first_name": "Holly",
"last_name": "Flax",
"email": "holly.flax@dundermifflin.com",
"amount": "123.57",
"subtotal": "109.98",
"discount": "0.0",
"transaction_fee": "0.0",
"enrollment_fee": "0.0",
"total_display_amount": "$123.57",
"sub_total_in_currency": "$109.98",
"tax_in_currency": "$6.60",
"discount_in_currency": "$0.00",
"total_cv": "80.0",
"total_qv": "80.0",
"order_on_behalf_of": false,
"item_refunds_allowed": true,
"company_country_tax_inclusive_pricing": null,
"warehouse_name": "Scranton Warehouse",
"created_at": "2026-09-14T15:32:08Z",
"updated_at": "2026-09-15T13:05:44Z",
"items": [
{
"id": 90417,
"title": "Dunder Mifflin 20lb Copy Paper",
"quantity": 2,
"price": "54.99",
"paid_amount": 109.98,
"refundable_quantity": 2,
"cv_total": "80.0",
"qv_total": "80.0",
"source_subscription": null
}
],
"price_inclusive_of_tax": false,
"price_inclusive_tax_name": null,
"totals": {
"gross_subtotal": "109.98",
"gross_subtotal_in_currency": "$109.98",
"net_subtotal": "109.98",
"net_subtotal_in_currency": "$109.98",
"item_tax": "6.6",
"item_tax_in_currency": "$6.60",
"shipping_net": "6.99",
"shipping_net_in_currency": "$6.99",
"shipping_tax": "0.0",
"shipping_tax_in_currency": "$0.00",
"total_tax": "6.6",
"total_tax_in_currency": "$6.60",
"price_inclusive_of_tax": false,
"tax_label": "Sales Tax"
}
}{
"status": "fail",
"data": {
"error": "<string>"
}
}{
"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",
"payment_uuid": "<string>",
"error_details": [
{
"code": "<string>",
"field": "<string>",
"payment": "not_attempted",
"message": "<string>"
}
],
"coded_recovery": true
}
}{
"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",
"payment_uuid": "<string>",
"error_details": [
{
"code": "<string>",
"field": "<string>",
"payment": "not_attempted",
"message": "<string>"
}
],
"coded_recovery": true
}
}Authorizations
Bearer token authentication
Path Parameters
Body
The attributes to change. Send at least one of them. A body without the order key is also accepted through Rails' JSON parameter wrapping, but the wrapped form is the contract.
Show child attributes
Show child attributes
Response
Success
A single order as returned by the company order detail, update and find-by-external-id operations.
Whether the prices are inclusive of tax (deprecated, use totals.price_inclusive_of_tax — this field is not gated on the tax strategy and can disagree with the served totals)
The tax name shown beside an inclusive price (deprecated, use totals.tax_label)
Display-ready totals breakdown.
Decomposes the inclusive-tax figures so clients
render the net subtotal, item tax, shipping net and shipping VAT without re-deriving them. Each money component carries a raw boundary-rounded decimal string plus its currency-formatted _in_currency sibling. Deliberately omits a grand total — the authoritative charge stays on the sibling total/amount fields.
Show child attributes
Show child attributes
The order's human-readable number. Null only on legacy orders stored without one.
Decimal string.
Decimal string.
The order's ISO currency code. Null only on legacy orders stored without one.
Points applied to this order as a four-decimal string
^-?\d+\.\d{4}$"120.0000"
Points credited from this order as a four-decimal string
^-?\d+\.\d{4}$"120.0000"
Decimal string.
Decimal string.
Decimal string.
Decimal string.
Decimal string.
Raw tax_inclusive_pricing override on the company's country record for this order's country, or null when there is none. Not gated on the tax strategy and not a historical record, so it can disagree with the served amounts; read totals.price_inclusive_of_tax for the flag that matches them.
Null when the order has no payment method and no recorded cash payment. Cash an admin recorded serves payment_type "cash", payment_title and details with the transaction_id and receipt_number. A stored card serves the flat card keys, id through logo_url. Every other integration (PayPal, Affirm, Bread, Klarna, wallets and the rest) serves payment_type, payment_title and details instead; Apple Pay, Google Pay and a card without a stored card also serve source.
Show child attributes
Show child attributes
Which warning to show before offering to cancel the order, or null for none. inflight_capture means a capture is in flight, so the order cannot be cancelled until it settles. Null when the order is cancelled or archived, or cannot be cancelled for any other reason.
inflight_capture, no_payment, pending_hold, void_authorization, null Whether the buyer was tax-exempt when the order was placed. Read from the order-time snapshot, so later changes to the buyer's tax_exempt flag do not alter it. False for legacy orders without a snapshot.
The buyer's sales tax ID captured when the order was placed, or null when the buyer had none (or the order pre-dates the snapshot).
Whether the order contains only digital (non-physical) products. True for an order with no line items, which likewise has nothing to ship.
The order's country (its own country, else the ship-to address country, else the company default). Null when none resolves.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Decimal string.
Quoted shipping rate, as a decimal string. The stored quote's price when one exists, else the order's shipping amount. Not reduced by free shipping; shipping_cost is what was charged.
Shipping amount actually charged, as a decimal string; "0.0" when the order has free shipping. shipping is the quoted rate when one was stored.
curl --request PUT \
--url https://api.fluid.app/api/company/orders/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"order": {
"status": "shipped",
"shipped_on": "2026-09-15",
"tracking_informations_attributes": [
{
"tracking_number": "1Z999AA10123456784",
"shipping_carrier": "UPS"
}
]
}
}
'import requests
url = "https://api.fluid.app/api/company/orders/{id}"
payload = { "order": {
"status": "shipped",
"shipped_on": "2026-09-15",
"tracking_informations_attributes": [
{
"tracking_number": "1Z999AA10123456784",
"shipping_carrier": "UPS"
}
]
} }
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({
order: {
status: 'shipped',
shipped_on: '2026-09-15',
tracking_informations_attributes: [{tracking_number: '1Z999AA10123456784', shipping_carrier: 'UPS'}]
}
})
};
fetch('https://api.fluid.app/api/company/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/company/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([
'order' => [
'status' => 'shipped',
'shipped_on' => '2026-09-15',
'tracking_informations_attributes' => [
[
'tracking_number' => '1Z999AA10123456784',
'shipping_carrier' => 'UPS'
]
]
]
]),
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/company/orders/{id}"
payload := strings.NewReader("{\n \"order\": {\n \"status\": \"shipped\",\n \"shipped_on\": \"2026-09-15\",\n \"tracking_informations_attributes\": [\n {\n \"tracking_number\": \"1Z999AA10123456784\",\n \"shipping_carrier\": \"UPS\"\n }\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.fluid.app/api/company/orders/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"order\": {\n \"status\": \"shipped\",\n \"shipped_on\": \"2026-09-15\",\n \"tracking_informations_attributes\": [\n {\n \"tracking_number\": \"1Z999AA10123456784\",\n \"shipping_carrier\": \"UPS\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fluid.app/api/company/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 \"order\": {\n \"status\": \"shipped\",\n \"shipped_on\": \"2026-09-15\",\n \"tracking_informations_attributes\": [\n {\n \"tracking_number\": \"1Z999AA10123456784\",\n \"shipping_carrier\": \"UPS\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 48213,
"order_number": "DM-10482",
"external_id": "NS-SO-77120",
"status": "shipped",
"currency_code": "USD",
"first_name": "Holly",
"last_name": "Flax",
"email": "holly.flax@dundermifflin.com",
"amount": "123.57",
"subtotal": "109.98",
"discount": "0.0",
"transaction_fee": "0.0",
"enrollment_fee": "0.0",
"total_display_amount": "$123.57",
"sub_total_in_currency": "$109.98",
"tax_in_currency": "$6.60",
"discount_in_currency": "$0.00",
"total_cv": "80.0",
"total_qv": "80.0",
"order_on_behalf_of": false,
"item_refunds_allowed": true,
"company_country_tax_inclusive_pricing": null,
"warehouse_name": "Scranton Warehouse",
"created_at": "2026-09-14T15:32:08Z",
"updated_at": "2026-09-15T13:05:44Z",
"items": [
{
"id": 90417,
"title": "Dunder Mifflin 20lb Copy Paper",
"quantity": 2,
"price": "54.99",
"paid_amount": 109.98,
"refundable_quantity": 2,
"cv_total": "80.0",
"qv_total": "80.0",
"source_subscription": null
}
],
"price_inclusive_of_tax": false,
"price_inclusive_tax_name": null,
"totals": {
"gross_subtotal": "109.98",
"gross_subtotal_in_currency": "$109.98",
"net_subtotal": "109.98",
"net_subtotal_in_currency": "$109.98",
"item_tax": "6.6",
"item_tax_in_currency": "$6.60",
"shipping_net": "6.99",
"shipping_net_in_currency": "$6.99",
"shipping_tax": "0.0",
"shipping_tax_in_currency": "$0.00",
"total_tax": "6.6",
"total_tax_in_currency": "$6.60",
"price_inclusive_of_tax": false,
"tax_label": "Sales Tax"
}
}{
"status": "fail",
"data": {
"error": "<string>"
}
}{
"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",
"payment_uuid": "<string>",
"error_details": [
{
"code": "<string>",
"field": "<string>",
"payment": "not_attempted",
"message": "<string>"
}
],
"coded_recovery": true
}
}{
"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",
"payment_uuid": "<string>",
"error_details": [
{
"code": "<string>",
"field": "<string>",
"payment": "not_attempted",
"message": "<string>"
}
],
"coded_recovery": true
}
}