Update a sales order
curl --request PATCH \
--url https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"order_status": "<string>",
"customer_email": "jsmith@example.com",
"customer_username": "<string>",
"customer_po_number": "<string>",
"bill_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"ship_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"ship_date": "2023-12-25",
"hold_until_date": "2023-12-25",
"ship_by_date": "2023-12-25",
"earliest_ship_date": "2023-12-25",
"requested_shipping_service": "<string>",
"carrier_code": "<string>",
"tracking_number": "<string>",
"service_code": "<string>",
"customer_notes": "<string>",
"internal_notes": "<string>",
"gift_message": "<string>",
"gift": true,
"international_options": [
{}
],
"custom_fields": [
null
],
"tags": [
"<string>"
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{id}"
payload = {
"order_status": "<string>",
"customer_email": "jsmith@example.com",
"customer_username": "<string>",
"customer_po_number": "<string>",
"bill_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"ship_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"ship_date": "2023-12-25",
"hold_until_date": "2023-12-25",
"ship_by_date": "2023-12-25",
"earliest_ship_date": "2023-12-25",
"requested_shipping_service": "<string>",
"carrier_code": "<string>",
"tracking_number": "<string>",
"service_code": "<string>",
"customer_notes": "<string>",
"internal_notes": "<string>",
"gift_message": "<string>",
"gift": True,
"international_options": [{}],
"custom_fields": [None],
"tags": ["<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_status: '<string>',
customer_email: 'jsmith@example.com',
customer_username: '<string>',
customer_po_number: '<string>',
bill_to: {
name: '<string>',
company: '<string>',
street1: '<string>',
street2: '<string>',
street3: '<string>',
city: '<string>',
state: '<string>',
postal_code: '<string>',
country: '<string>',
phone: '<string>'
},
ship_to: {
name: '<string>',
company: '<string>',
street1: '<string>',
street2: '<string>',
street3: '<string>',
city: '<string>',
state: '<string>',
postal_code: '<string>',
country: '<string>',
phone: '<string>'
},
ship_date: '2023-12-25',
hold_until_date: '2023-12-25',
ship_by_date: '2023-12-25',
earliest_ship_date: '2023-12-25',
requested_shipping_service: '<string>',
carrier_code: '<string>',
tracking_number: '<string>',
service_code: '<string>',
customer_notes: '<string>',
internal_notes: '<string>',
gift_message: '<string>',
gift: true,
international_options: [{}],
custom_fields: [null],
tags: ['<string>']
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/sales-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://{companyName}.api.joinluminous.com/external/api/v1/sales-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_status' => '<string>',
'customer_email' => 'jsmith@example.com',
'customer_username' => '<string>',
'customer_po_number' => '<string>',
'bill_to' => [
'name' => '<string>',
'company' => '<string>',
'street1' => '<string>',
'street2' => '<string>',
'street3' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => '<string>',
'phone' => '<string>'
],
'ship_to' => [
'name' => '<string>',
'company' => '<string>',
'street1' => '<string>',
'street2' => '<string>',
'street3' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => '<string>',
'phone' => '<string>'
],
'ship_date' => '2023-12-25',
'hold_until_date' => '2023-12-25',
'ship_by_date' => '2023-12-25',
'earliest_ship_date' => '2023-12-25',
'requested_shipping_service' => '<string>',
'carrier_code' => '<string>',
'tracking_number' => '<string>',
'service_code' => '<string>',
'customer_notes' => '<string>',
'internal_notes' => '<string>',
'gift_message' => '<string>',
'gift' => true,
'international_options' => [
[
]
],
'custom_fields' => [
null
],
'tags' => [
'<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://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{id}"
payload := strings.NewReader("{\n \"order_status\": \"<string>\",\n \"customer_email\": \"jsmith@example.com\",\n \"customer_username\": \"<string>\",\n \"customer_po_number\": \"<string>\",\n \"bill_to\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"street3\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"ship_to\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"street3\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"ship_date\": \"2023-12-25\",\n \"hold_until_date\": \"2023-12-25\",\n \"ship_by_date\": \"2023-12-25\",\n \"earliest_ship_date\": \"2023-12-25\",\n \"requested_shipping_service\": \"<string>\",\n \"carrier_code\": \"<string>\",\n \"tracking_number\": \"<string>\",\n \"service_code\": \"<string>\",\n \"customer_notes\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"gift_message\": \"<string>\",\n \"gift\": true,\n \"international_options\": [\n {}\n ],\n \"custom_fields\": [\n null\n ],\n \"tags\": [\n \"<string>\"\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://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"order_status\": \"<string>\",\n \"customer_email\": \"jsmith@example.com\",\n \"customer_username\": \"<string>\",\n \"customer_po_number\": \"<string>\",\n \"bill_to\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"street3\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"ship_to\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"street3\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"ship_date\": \"2023-12-25\",\n \"hold_until_date\": \"2023-12-25\",\n \"ship_by_date\": \"2023-12-25\",\n \"earliest_ship_date\": \"2023-12-25\",\n \"requested_shipping_service\": \"<string>\",\n \"carrier_code\": \"<string>\",\n \"tracking_number\": \"<string>\",\n \"service_code\": \"<string>\",\n \"customer_notes\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"gift_message\": \"<string>\",\n \"gift\": true,\n \"international_options\": [\n {}\n ],\n \"custom_fields\": [\n null\n ],\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/sales-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_status\": \"<string>\",\n \"customer_email\": \"jsmith@example.com\",\n \"customer_username\": \"<string>\",\n \"customer_po_number\": \"<string>\",\n \"bill_to\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"street3\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"ship_to\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"street3\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"ship_date\": \"2023-12-25\",\n \"hold_until_date\": \"2023-12-25\",\n \"ship_by_date\": \"2023-12-25\",\n \"earliest_ship_date\": \"2023-12-25\",\n \"requested_shipping_service\": \"<string>\",\n \"carrier_code\": \"<string>\",\n \"tracking_number\": \"<string>\",\n \"service_code\": \"<string>\",\n \"customer_notes\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"gift_message\": \"<string>\",\n \"gift\": true,\n \"international_options\": [\n {}\n ],\n \"custom_fields\": [\n null\n ],\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"order_id": "<string>",
"order_number": "<string>",
"order_date": "2023-12-25",
"payment_date": "2023-12-25",
"ship_by_date": "2023-12-25",
"age": 123,
"order_status": "<string>",
"customer_id": "<string>",
"customer_username": "<string>",
"customer_email": "<string>",
"bill_to": {},
"ship_to": {},
"requested_shipping_service": "<string>",
"total": 123,
"total_paid": 123,
"total_tax": 123,
"total_shipping": 123,
"customer_notes": "<string>",
"internal_notes": "<string>",
"ship_date": "2023-12-25",
"hold_until_date": "2023-12-25",
"earliest_ship_date": "2023-12-25",
"user_id": 123,
"externally_fulfilled": true,
"externally_fulfilled_by": "<string>",
"is_posted": true,
"posted_by": "<string>",
"not_sync": true,
"sales_posted": true,
"split_order": true,
"skip_inventory": true,
"skip_sales_report": true,
"channel_id": 123,
"total_order_cost": 123,
"total_order_quantity": 123,
"order_cost_details": {},
"source": "<string>",
"shipstation_order_id": "<string>",
"type": "<string>",
"parent_id": 123,
"shipping_revenue": 123,
"product_total": 123,
"total_discount": 123,
"picking_status": "<string>",
"starred_description": "<string>",
"customer_po_number": "<string>",
"company_id": 123,
"company": {
"id": 123456,
"status": "active",
"name": "Acme Corporation",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"type": "Retail",
"phone": "555-123-4567",
"address": "123 Main St",
"address_line_2": "Suite 500",
"city": "Austin",
"state": "TX",
"postal_code": "78701",
"country": "USA",
"full_address": "123 Main St, Suite 500, Austin, TX 78701, USA",
"shipping_first_name": "John",
"shipping_last_name": "Doe",
"shipping_email": "shipping@acmecorp.com",
"shipping_phone": "555-987-6543",
"shipping_address": "456 Warehouse Blvd",
"shipping_city": "Austin",
"shipping_state": "TX",
"shipping_postal_code": "78745",
"shipping_country": "USA",
"shipping_full_address": "456 Warehouse Blvd, Austin, TX 78745, USA",
"payment_term": "Net 30",
"tax_exempt": false,
"tax_rate": 8.25,
"due_date_days": 30,
"header_discount_enabled": false,
"header_discount_type": "PERCENT",
"header_discount_value": 5,
"header_discount_effective_from": "2026-01-01",
"price_level": {
"id": 123,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"status": "active",
"name": "Wholesale",
"type": "percentage",
"percent_increase": 15.5
},
"notes": "Key account, requires special handling",
"fein": "12-3456789",
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"default_shipping": {
"id": 789,
"company_id": 123456,
"address": "456 Warehouse Blvd",
"city": "Austin",
"state": "TX",
"postal_code": "78745",
"country": "USA",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"company_name": "Acme Corporation",
"address_line_2": "Building 2",
"full_address": "456 Warehouse Blvd, Building 2, Austin, TX 78745, USA",
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"phone": "555-987-6543",
"email": "shipping@acmecorp.com",
"is_default": true
},
"shipping_addresses": [
{
"id": 789,
"company_id": 123456,
"address": "456 Warehouse Blvd",
"city": "Austin",
"state": "TX",
"postal_code": "78745",
"country": "USA",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"company_name": "Acme Corporation",
"address_line_2": "Building 2",
"full_address": "456 Warehouse Blvd, Building 2, Austin, TX 78745, USA",
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"phone": "555-987-6543",
"email": "shipping@acmecorp.com",
"is_default": true
}
],
"billing_info": {
"id": 456,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"first_name": "Jane",
"last_name": "Smith",
"email": "accounting@acmecorp.com",
"receiving_bank_name": "First National Bank",
"receiving_bank_address": "789 Finance Street, Austin, TX 78701"
},
"client_type": {
"id": 123,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"name": "Retail",
"description": "Retail business client"
},
"parent_company_id": 456,
"invoice_export_template_id": 789,
"custom_fields": {
"Industry": "Manufacturing",
"Region": "Southwest",
"Annual Revenue": "$5M-$10M"
},
"assigned_sales_reps": [
{
"id": 42,
"email": "rep@example.com",
"first_name": "Jane",
"last_name": "Doe"
}
],
"sales_channel": {
"id": 123,
"status": "<string>",
"label": "<string>",
"channel_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
},
"items": [
{
"id": 123,
"line_number": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"name": "<string>",
"image_url": "<string>",
"weight": {},
"quantity": 123,
"unit_price": 123,
"tax": 123,
"shipping": 123,
"warehouse_location": "<string>",
"options": {},
"fulfillment_sku": "<string>",
"adjustment": 123,
"upc": "<string>",
"stock_id": 123,
"kit_id": 123,
"non_physical_item": true,
"ignore_item": true,
"quantity_shipped": 123,
"quantity_cancelled": 123,
"quantity_invoiced": 123,
"quantity_ordered": 123,
"base_uom_id": 123,
"ordered_uom_id": 123,
"product_id": 123,
"total_returned_base_quantity": 123,
"parent_id": 123,
"status": "<string>",
"discount": 123,
"estimated_ship_date": "2023-12-25",
"custom_fields": {},
"product": {
"id": 123,
"name": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123,
"unit_cost": 123,
"product_weight": 123,
"product_length": 123,
"product_width": 123,
"product_height": 123,
"sellable": true,
"discontinued": true,
"image_url": "<string>",
"category": {
"id": 123,
"name": "<string>"
},
"subcategory": {
"id": 123,
"name": "<string>"
},
"custom_fields": {},
"variant_attributes": {},
"sku": "<string>",
"alternate_skus": [
{
"id": 123,
"sku": "<string>"
}
],
"upc": "<string>",
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"supplier": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>",
"discount_structure": {},
"markup_structure": {}
}
]
}
],
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>",
"discount_structure": {},
"markup_structure": {}
}
],
"shipments": [
{
"id": 123,
"sales_order_id": 123,
"ship_date": "2023-12-25",
"tracking_number": "<string>",
"bol_number": "BOL-123456789",
"pro_number": "PRO-987654321",
"partner_reference_number": "PARTNER-REF-001",
"is_return": true,
"carrier_code": "<string>",
"scac": "<string>",
"service_code": "<string>",
"package_code": "<string>",
"shipment_cost": 123,
"insurance_cost": 123,
"warehouse_group_id": 123,
"status": 123,
"ship_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"phone": "<string>",
"residential": true
},
"weight": {
"value": 123
},
"dimensions": {
"length": 123,
"width": 123,
"height": 123
},
"items": [
{
"id": 123,
"shipment_id": 123,
"product_id": 123,
"sales_order_item_id": 123,
"quantity": 123,
"weight": {
"value": 123
},
"unit_price": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"custom_fields": {}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Sales Orders
Update a sales order
Partially update an existing sales order. All body fields are optional — only send fields you want to change.
Order Status Values
Valid order statuses include: pending, shipped, fulfilled, cancelled,
awaiting_shipment, partially_shipped, on_hold, backorder
Status changes are applied through the canonical sales-order update flow, so moving an
order to shipped creates a shipment and fires the related downstream events. Include
tracking_number and carrier_code in the same request to stamp them onto that shipment.
A status that cannot be applied returns 400.
PATCH
/
sales-orders
/
{id}
Update a sales order
curl --request PATCH \
--url https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"order_status": "<string>",
"customer_email": "jsmith@example.com",
"customer_username": "<string>",
"customer_po_number": "<string>",
"bill_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"ship_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"ship_date": "2023-12-25",
"hold_until_date": "2023-12-25",
"ship_by_date": "2023-12-25",
"earliest_ship_date": "2023-12-25",
"requested_shipping_service": "<string>",
"carrier_code": "<string>",
"tracking_number": "<string>",
"service_code": "<string>",
"customer_notes": "<string>",
"internal_notes": "<string>",
"gift_message": "<string>",
"gift": true,
"international_options": [
{}
],
"custom_fields": [
null
],
"tags": [
"<string>"
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{id}"
payload = {
"order_status": "<string>",
"customer_email": "jsmith@example.com",
"customer_username": "<string>",
"customer_po_number": "<string>",
"bill_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"ship_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"ship_date": "2023-12-25",
"hold_until_date": "2023-12-25",
"ship_by_date": "2023-12-25",
"earliest_ship_date": "2023-12-25",
"requested_shipping_service": "<string>",
"carrier_code": "<string>",
"tracking_number": "<string>",
"service_code": "<string>",
"customer_notes": "<string>",
"internal_notes": "<string>",
"gift_message": "<string>",
"gift": True,
"international_options": [{}],
"custom_fields": [None],
"tags": ["<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_status: '<string>',
customer_email: 'jsmith@example.com',
customer_username: '<string>',
customer_po_number: '<string>',
bill_to: {
name: '<string>',
company: '<string>',
street1: '<string>',
street2: '<string>',
street3: '<string>',
city: '<string>',
state: '<string>',
postal_code: '<string>',
country: '<string>',
phone: '<string>'
},
ship_to: {
name: '<string>',
company: '<string>',
street1: '<string>',
street2: '<string>',
street3: '<string>',
city: '<string>',
state: '<string>',
postal_code: '<string>',
country: '<string>',
phone: '<string>'
},
ship_date: '2023-12-25',
hold_until_date: '2023-12-25',
ship_by_date: '2023-12-25',
earliest_ship_date: '2023-12-25',
requested_shipping_service: '<string>',
carrier_code: '<string>',
tracking_number: '<string>',
service_code: '<string>',
customer_notes: '<string>',
internal_notes: '<string>',
gift_message: '<string>',
gift: true,
international_options: [{}],
custom_fields: [null],
tags: ['<string>']
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/sales-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://{companyName}.api.joinluminous.com/external/api/v1/sales-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_status' => '<string>',
'customer_email' => 'jsmith@example.com',
'customer_username' => '<string>',
'customer_po_number' => '<string>',
'bill_to' => [
'name' => '<string>',
'company' => '<string>',
'street1' => '<string>',
'street2' => '<string>',
'street3' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => '<string>',
'phone' => '<string>'
],
'ship_to' => [
'name' => '<string>',
'company' => '<string>',
'street1' => '<string>',
'street2' => '<string>',
'street3' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => '<string>',
'phone' => '<string>'
],
'ship_date' => '2023-12-25',
'hold_until_date' => '2023-12-25',
'ship_by_date' => '2023-12-25',
'earliest_ship_date' => '2023-12-25',
'requested_shipping_service' => '<string>',
'carrier_code' => '<string>',
'tracking_number' => '<string>',
'service_code' => '<string>',
'customer_notes' => '<string>',
'internal_notes' => '<string>',
'gift_message' => '<string>',
'gift' => true,
'international_options' => [
[
]
],
'custom_fields' => [
null
],
'tags' => [
'<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://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{id}"
payload := strings.NewReader("{\n \"order_status\": \"<string>\",\n \"customer_email\": \"jsmith@example.com\",\n \"customer_username\": \"<string>\",\n \"customer_po_number\": \"<string>\",\n \"bill_to\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"street3\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"ship_to\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"street3\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"ship_date\": \"2023-12-25\",\n \"hold_until_date\": \"2023-12-25\",\n \"ship_by_date\": \"2023-12-25\",\n \"earliest_ship_date\": \"2023-12-25\",\n \"requested_shipping_service\": \"<string>\",\n \"carrier_code\": \"<string>\",\n \"tracking_number\": \"<string>\",\n \"service_code\": \"<string>\",\n \"customer_notes\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"gift_message\": \"<string>\",\n \"gift\": true,\n \"international_options\": [\n {}\n ],\n \"custom_fields\": [\n null\n ],\n \"tags\": [\n \"<string>\"\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://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"order_status\": \"<string>\",\n \"customer_email\": \"jsmith@example.com\",\n \"customer_username\": \"<string>\",\n \"customer_po_number\": \"<string>\",\n \"bill_to\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"street3\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"ship_to\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"street3\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"ship_date\": \"2023-12-25\",\n \"hold_until_date\": \"2023-12-25\",\n \"ship_by_date\": \"2023-12-25\",\n \"earliest_ship_date\": \"2023-12-25\",\n \"requested_shipping_service\": \"<string>\",\n \"carrier_code\": \"<string>\",\n \"tracking_number\": \"<string>\",\n \"service_code\": \"<string>\",\n \"customer_notes\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"gift_message\": \"<string>\",\n \"gift\": true,\n \"international_options\": [\n {}\n ],\n \"custom_fields\": [\n null\n ],\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/sales-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_status\": \"<string>\",\n \"customer_email\": \"jsmith@example.com\",\n \"customer_username\": \"<string>\",\n \"customer_po_number\": \"<string>\",\n \"bill_to\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"street3\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"ship_to\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"street3\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"ship_date\": \"2023-12-25\",\n \"hold_until_date\": \"2023-12-25\",\n \"ship_by_date\": \"2023-12-25\",\n \"earliest_ship_date\": \"2023-12-25\",\n \"requested_shipping_service\": \"<string>\",\n \"carrier_code\": \"<string>\",\n \"tracking_number\": \"<string>\",\n \"service_code\": \"<string>\",\n \"customer_notes\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"gift_message\": \"<string>\",\n \"gift\": true,\n \"international_options\": [\n {}\n ],\n \"custom_fields\": [\n null\n ],\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"order_id": "<string>",
"order_number": "<string>",
"order_date": "2023-12-25",
"payment_date": "2023-12-25",
"ship_by_date": "2023-12-25",
"age": 123,
"order_status": "<string>",
"customer_id": "<string>",
"customer_username": "<string>",
"customer_email": "<string>",
"bill_to": {},
"ship_to": {},
"requested_shipping_service": "<string>",
"total": 123,
"total_paid": 123,
"total_tax": 123,
"total_shipping": 123,
"customer_notes": "<string>",
"internal_notes": "<string>",
"ship_date": "2023-12-25",
"hold_until_date": "2023-12-25",
"earliest_ship_date": "2023-12-25",
"user_id": 123,
"externally_fulfilled": true,
"externally_fulfilled_by": "<string>",
"is_posted": true,
"posted_by": "<string>",
"not_sync": true,
"sales_posted": true,
"split_order": true,
"skip_inventory": true,
"skip_sales_report": true,
"channel_id": 123,
"total_order_cost": 123,
"total_order_quantity": 123,
"order_cost_details": {},
"source": "<string>",
"shipstation_order_id": "<string>",
"type": "<string>",
"parent_id": 123,
"shipping_revenue": 123,
"product_total": 123,
"total_discount": 123,
"picking_status": "<string>",
"starred_description": "<string>",
"customer_po_number": "<string>",
"company_id": 123,
"company": {
"id": 123456,
"status": "active",
"name": "Acme Corporation",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"type": "Retail",
"phone": "555-123-4567",
"address": "123 Main St",
"address_line_2": "Suite 500",
"city": "Austin",
"state": "TX",
"postal_code": "78701",
"country": "USA",
"full_address": "123 Main St, Suite 500, Austin, TX 78701, USA",
"shipping_first_name": "John",
"shipping_last_name": "Doe",
"shipping_email": "shipping@acmecorp.com",
"shipping_phone": "555-987-6543",
"shipping_address": "456 Warehouse Blvd",
"shipping_city": "Austin",
"shipping_state": "TX",
"shipping_postal_code": "78745",
"shipping_country": "USA",
"shipping_full_address": "456 Warehouse Blvd, Austin, TX 78745, USA",
"payment_term": "Net 30",
"tax_exempt": false,
"tax_rate": 8.25,
"due_date_days": 30,
"header_discount_enabled": false,
"header_discount_type": "PERCENT",
"header_discount_value": 5,
"header_discount_effective_from": "2026-01-01",
"price_level": {
"id": 123,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"status": "active",
"name": "Wholesale",
"type": "percentage",
"percent_increase": 15.5
},
"notes": "Key account, requires special handling",
"fein": "12-3456789",
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"default_shipping": {
"id": 789,
"company_id": 123456,
"address": "456 Warehouse Blvd",
"city": "Austin",
"state": "TX",
"postal_code": "78745",
"country": "USA",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"company_name": "Acme Corporation",
"address_line_2": "Building 2",
"full_address": "456 Warehouse Blvd, Building 2, Austin, TX 78745, USA",
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"phone": "555-987-6543",
"email": "shipping@acmecorp.com",
"is_default": true
},
"shipping_addresses": [
{
"id": 789,
"company_id": 123456,
"address": "456 Warehouse Blvd",
"city": "Austin",
"state": "TX",
"postal_code": "78745",
"country": "USA",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"company_name": "Acme Corporation",
"address_line_2": "Building 2",
"full_address": "456 Warehouse Blvd, Building 2, Austin, TX 78745, USA",
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"phone": "555-987-6543",
"email": "shipping@acmecorp.com",
"is_default": true
}
],
"billing_info": {
"id": 456,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"first_name": "Jane",
"last_name": "Smith",
"email": "accounting@acmecorp.com",
"receiving_bank_name": "First National Bank",
"receiving_bank_address": "789 Finance Street, Austin, TX 78701"
},
"client_type": {
"id": 123,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"name": "Retail",
"description": "Retail business client"
},
"parent_company_id": 456,
"invoice_export_template_id": 789,
"custom_fields": {
"Industry": "Manufacturing",
"Region": "Southwest",
"Annual Revenue": "$5M-$10M"
},
"assigned_sales_reps": [
{
"id": 42,
"email": "rep@example.com",
"first_name": "Jane",
"last_name": "Doe"
}
],
"sales_channel": {
"id": 123,
"status": "<string>",
"label": "<string>",
"channel_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
},
"items": [
{
"id": 123,
"line_number": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"name": "<string>",
"image_url": "<string>",
"weight": {},
"quantity": 123,
"unit_price": 123,
"tax": 123,
"shipping": 123,
"warehouse_location": "<string>",
"options": {},
"fulfillment_sku": "<string>",
"adjustment": 123,
"upc": "<string>",
"stock_id": 123,
"kit_id": 123,
"non_physical_item": true,
"ignore_item": true,
"quantity_shipped": 123,
"quantity_cancelled": 123,
"quantity_invoiced": 123,
"quantity_ordered": 123,
"base_uom_id": 123,
"ordered_uom_id": 123,
"product_id": 123,
"total_returned_base_quantity": 123,
"parent_id": 123,
"status": "<string>",
"discount": 123,
"estimated_ship_date": "2023-12-25",
"custom_fields": {},
"product": {
"id": 123,
"name": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123,
"unit_cost": 123,
"product_weight": 123,
"product_length": 123,
"product_width": 123,
"product_height": 123,
"sellable": true,
"discontinued": true,
"image_url": "<string>",
"category": {
"id": 123,
"name": "<string>"
},
"subcategory": {
"id": 123,
"name": "<string>"
},
"custom_fields": {},
"variant_attributes": {},
"sku": "<string>",
"alternate_skus": [
{
"id": 123,
"sku": "<string>"
}
],
"upc": "<string>",
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"supplier": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>",
"discount_structure": {},
"markup_structure": {}
}
]
}
],
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>",
"discount_structure": {},
"markup_structure": {}
}
],
"shipments": [
{
"id": 123,
"sales_order_id": 123,
"ship_date": "2023-12-25",
"tracking_number": "<string>",
"bol_number": "BOL-123456789",
"pro_number": "PRO-987654321",
"partner_reference_number": "PARTNER-REF-001",
"is_return": true,
"carrier_code": "<string>",
"scac": "<string>",
"service_code": "<string>",
"package_code": "<string>",
"shipment_cost": 123,
"insurance_cost": 123,
"warehouse_group_id": 123,
"status": 123,
"ship_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"phone": "<string>",
"residential": true
},
"weight": {
"value": 123
},
"dimensions": {
"length": 123,
"width": 123,
"height": 123
},
"items": [
{
"id": 123,
"shipment_id": 123,
"product_id": 123,
"sales_order_item_id": 123,
"quantity": 123,
"weight": {
"value": 123
},
"unit_price": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"custom_fields": {}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
ID of the sales order to update
Body
application/json
Sales order partial update. All fields are optional — only send fields to change.
Order status. Valid values: pending, shipped, fulfilled, cancelled, awaiting_shipment, partially_shipped, on_hold, backorder. Status changes are routed through the canonical sales-order update flow, so transitioning to shipped creates a shipment (and fires the associated downstream events). Provide tracking_number and carrier_code in the same request to stamp them onto that shipment. A status that cannot be applied returns 400.
Customer email address
Customer username
Customer purchase order number
Billing address. If provided, name is required.
Show child attributes
Show child attributes
Shipping address. If provided, name is required.
Show child attributes
Show child attributes
Ship date
Hold until date
Ship by date
Earliest ship date
Requested shipping service
Carrier code. When order_status is set to shipped, this carrier is applied to the shipment created by the status change.
Tracking number. When order_status is set to shipped, this tracking number is applied to the shipment created by the status change.
Maximum string length:
255Service code
Customer-facing notes
Internal notes
Gift message
Whether the order is a gift
International shipping options
Custom field values
Array of tag strings
Response
Successful response
Show child attributes
Show child attributes
⌘I