curl --request PUT \
--url https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/custom-fields \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fields": {
"Tote ID": "TOTE-001",
"Priority": "High"
},
"set_on_sales_order": false
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/custom-fields"
payload = {
"fields": {
"Tote ID": "TOTE-001",
"Priority": "High"
},
"set_on_sales_order": False
}
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({fields: {'Tote ID': 'TOTE-001', Priority: 'High'}, set_on_sales_order: false})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/custom-fields', 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/fulfillment-orders/{fulfillmentOrderId}/custom-fields",
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([
'fields' => [
'Tote ID' => 'TOTE-001',
'Priority' => 'High'
],
'set_on_sales_order' => false
]),
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/fulfillment-orders/{fulfillmentOrderId}/custom-fields"
payload := strings.NewReader("{\n \"fields\": {\n \"Tote ID\": \"TOTE-001\",\n \"Priority\": \"High\"\n },\n \"set_on_sales_order\": false\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://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/custom-fields")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fields\": {\n \"Tote ID\": \"TOTE-001\",\n \"Priority\": \"High\"\n },\n \"set_on_sales_order\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/custom-fields")
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 \"fields\": {\n \"Tote ID\": \"TOTE-001\",\n \"Priority\": \"High\"\n },\n \"set_on_sales_order\": false\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"data": {
"fulfillment_order_id": 123,
"sales_order_id": 123,
"order_key": "<string>",
"set_on_sales_order": true,
"fields": {}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Set custom field values on a fulfillment order
Sets one or more custom field values on a fulfillment order. Each key in the
fields object must match the label of a pre-configured CustomField
definition that is set up for FulfillmentOrder records.
Unlike the tote-ID endpoint, this endpoint does not auto-create field definitions — tenants must configure them in advance under Settings → Custom Fields.
When set_on_sales_order=true, the same field values are also written to the
associated sales order (if a matching SalesOrder custom field definition exists).
Returns 404 if any label has no matching definition, or the matched definition isn’t configured for the target record type.
curl --request PUT \
--url https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/custom-fields \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fields": {
"Tote ID": "TOTE-001",
"Priority": "High"
},
"set_on_sales_order": false
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/custom-fields"
payload = {
"fields": {
"Tote ID": "TOTE-001",
"Priority": "High"
},
"set_on_sales_order": False
}
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({fields: {'Tote ID': 'TOTE-001', Priority: 'High'}, set_on_sales_order: false})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/custom-fields', 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/fulfillment-orders/{fulfillmentOrderId}/custom-fields",
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([
'fields' => [
'Tote ID' => 'TOTE-001',
'Priority' => 'High'
],
'set_on_sales_order' => false
]),
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/fulfillment-orders/{fulfillmentOrderId}/custom-fields"
payload := strings.NewReader("{\n \"fields\": {\n \"Tote ID\": \"TOTE-001\",\n \"Priority\": \"High\"\n },\n \"set_on_sales_order\": false\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://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/custom-fields")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fields\": {\n \"Tote ID\": \"TOTE-001\",\n \"Priority\": \"High\"\n },\n \"set_on_sales_order\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/custom-fields")
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 \"fields\": {\n \"Tote ID\": \"TOTE-001\",\n \"Priority\": \"High\"\n },\n \"set_on_sales_order\": false\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"data": {
"fulfillment_order_id": 123,
"sales_order_id": 123,
"order_key": "<string>",
"set_on_sales_order": true,
"fields": {}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
Fulfillment order ID
Body
Map of custom field label → value. The label must exactly match a
pre-configured CustomField definition for FulfillmentOrder.
Show child attributes
Show child attributes
{ "Tote ID": "TOTE-001", "Priority": "High" }
When true, also write the same field values to the associated
sales order (requires matching definitions on SalesOrder).