Update a work order
curl --request PUT \
--url https://{companyName}.api.joinluminous.com/external/api/v1/work-orders/{workOrderId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"produced_sku_id": 123,
"planned_qty": 1.0001,
"production_warehouse_id": 123,
"destination_warehouse_id": 123,
"vendor_id": 123,
"bom_id": 123,
"expected_completion_date": "2023-12-25",
"service_unit_price": 1,
"notes": "<string>",
"custom_fields": {},
"alternate_ids": [
"<string>"
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/work-orders/{workOrderId}"
payload = {
"produced_sku_id": 123,
"planned_qty": 1.0001,
"production_warehouse_id": 123,
"destination_warehouse_id": 123,
"vendor_id": 123,
"bom_id": 123,
"expected_completion_date": "2023-12-25",
"service_unit_price": 1,
"notes": "<string>",
"custom_fields": {},
"alternate_ids": ["<string>"]
}
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({
produced_sku_id: 123,
planned_qty: 1.0001,
production_warehouse_id: 123,
destination_warehouse_id: 123,
vendor_id: 123,
bom_id: 123,
expected_completion_date: '2023-12-25',
service_unit_price: 1,
notes: '<string>',
custom_fields: {},
alternate_ids: ['<string>']
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/work-orders/{workOrderId}', 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/work-orders/{workOrderId}",
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([
'produced_sku_id' => 123,
'planned_qty' => 1.0001,
'production_warehouse_id' => 123,
'destination_warehouse_id' => 123,
'vendor_id' => 123,
'bom_id' => 123,
'expected_completion_date' => '2023-12-25',
'service_unit_price' => 1,
'notes' => '<string>',
'custom_fields' => [
],
'alternate_ids' => [
'<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/work-orders/{workOrderId}"
payload := strings.NewReader("{\n \"produced_sku_id\": 123,\n \"planned_qty\": 1.0001,\n \"production_warehouse_id\": 123,\n \"destination_warehouse_id\": 123,\n \"vendor_id\": 123,\n \"bom_id\": 123,\n \"expected_completion_date\": \"2023-12-25\",\n \"service_unit_price\": 1,\n \"notes\": \"<string>\",\n \"custom_fields\": {},\n \"alternate_ids\": [\n \"<string>\"\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://{companyName}.api.joinluminous.com/external/api/v1/work-orders/{workOrderId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"produced_sku_id\": 123,\n \"planned_qty\": 1.0001,\n \"production_warehouse_id\": 123,\n \"destination_warehouse_id\": 123,\n \"vendor_id\": 123,\n \"bom_id\": 123,\n \"expected_completion_date\": \"2023-12-25\",\n \"service_unit_price\": 1,\n \"notes\": \"<string>\",\n \"custom_fields\": {},\n \"alternate_ids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/work-orders/{workOrderId}")
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 \"produced_sku_id\": 123,\n \"planned_qty\": 1.0001,\n \"production_warehouse_id\": 123,\n \"destination_warehouse_id\": 123,\n \"vendor_id\": 123,\n \"bom_id\": 123,\n \"expected_completion_date\": \"2023-12-25\",\n \"service_unit_price\": 1,\n \"notes\": \"<string>\",\n \"custom_fields\": {},\n \"alternate_ids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"work_order_number": "<string>",
"status": "<string>",
"is_on_hold": true,
"produced_sku_id": 123,
"produced_sku": {
"id": 123,
"sku": "<string>",
"description": "<string>"
},
"planned_qty": 123,
"expected_completion_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"production_warehouse_id": 123,
"production_warehouse": {
"id": 123,
"name": "<string>"
},
"destination_warehouse_id": 123,
"destination_warehouse": {
"id": 123,
"name": "<string>"
},
"vendor_id": 123,
"vendor": {
"id": 123,
"name": "<string>"
},
"bom_id": 123,
"service_unit_price": 123,
"notes": "<string>",
"hold_reason": "<string>",
"cancel_reason": "<string>",
"held_at": "2023-11-07T05:31:56Z",
"created_by": 123,
"updated_by": 123,
"held_by": 123,
"production_batch_id": 123,
"steps": [
{
"id": 123,
"work_order_id": 123,
"sequence": 123,
"status": "<string>",
"output_sku_id": 123,
"output_sku": {
"id": 123,
"sku": "<string>",
"description": "<string>"
},
"planned_qty": 123,
"completed_qty": 123,
"is_outside_processing": true,
"supply_mode": "<string>",
"vendor_id": 123,
"skipped_at": "2023-11-07T05:31:56Z",
"skipped_by": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"custom_fields": {},
"alternate_ids": [
"<string>"
],
"links": {
"self": "<string>",
"steps": "<string>",
"completions": "<string>",
"production_entries": "<string>",
"status_history": "<string>"
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Work Orders
Update a work order
Update an existing work order. All fields are optional; only the provided fields are updated.
PUT
/
work-orders
/
{workOrderId}
Update a work order
curl --request PUT \
--url https://{companyName}.api.joinluminous.com/external/api/v1/work-orders/{workOrderId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"produced_sku_id": 123,
"planned_qty": 1.0001,
"production_warehouse_id": 123,
"destination_warehouse_id": 123,
"vendor_id": 123,
"bom_id": 123,
"expected_completion_date": "2023-12-25",
"service_unit_price": 1,
"notes": "<string>",
"custom_fields": {},
"alternate_ids": [
"<string>"
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/work-orders/{workOrderId}"
payload = {
"produced_sku_id": 123,
"planned_qty": 1.0001,
"production_warehouse_id": 123,
"destination_warehouse_id": 123,
"vendor_id": 123,
"bom_id": 123,
"expected_completion_date": "2023-12-25",
"service_unit_price": 1,
"notes": "<string>",
"custom_fields": {},
"alternate_ids": ["<string>"]
}
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({
produced_sku_id: 123,
planned_qty: 1.0001,
production_warehouse_id: 123,
destination_warehouse_id: 123,
vendor_id: 123,
bom_id: 123,
expected_completion_date: '2023-12-25',
service_unit_price: 1,
notes: '<string>',
custom_fields: {},
alternate_ids: ['<string>']
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/work-orders/{workOrderId}', 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/work-orders/{workOrderId}",
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([
'produced_sku_id' => 123,
'planned_qty' => 1.0001,
'production_warehouse_id' => 123,
'destination_warehouse_id' => 123,
'vendor_id' => 123,
'bom_id' => 123,
'expected_completion_date' => '2023-12-25',
'service_unit_price' => 1,
'notes' => '<string>',
'custom_fields' => [
],
'alternate_ids' => [
'<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/work-orders/{workOrderId}"
payload := strings.NewReader("{\n \"produced_sku_id\": 123,\n \"planned_qty\": 1.0001,\n \"production_warehouse_id\": 123,\n \"destination_warehouse_id\": 123,\n \"vendor_id\": 123,\n \"bom_id\": 123,\n \"expected_completion_date\": \"2023-12-25\",\n \"service_unit_price\": 1,\n \"notes\": \"<string>\",\n \"custom_fields\": {},\n \"alternate_ids\": [\n \"<string>\"\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://{companyName}.api.joinluminous.com/external/api/v1/work-orders/{workOrderId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"produced_sku_id\": 123,\n \"planned_qty\": 1.0001,\n \"production_warehouse_id\": 123,\n \"destination_warehouse_id\": 123,\n \"vendor_id\": 123,\n \"bom_id\": 123,\n \"expected_completion_date\": \"2023-12-25\",\n \"service_unit_price\": 1,\n \"notes\": \"<string>\",\n \"custom_fields\": {},\n \"alternate_ids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/work-orders/{workOrderId}")
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 \"produced_sku_id\": 123,\n \"planned_qty\": 1.0001,\n \"production_warehouse_id\": 123,\n \"destination_warehouse_id\": 123,\n \"vendor_id\": 123,\n \"bom_id\": 123,\n \"expected_completion_date\": \"2023-12-25\",\n \"service_unit_price\": 1,\n \"notes\": \"<string>\",\n \"custom_fields\": {},\n \"alternate_ids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"work_order_number": "<string>",
"status": "<string>",
"is_on_hold": true,
"produced_sku_id": 123,
"produced_sku": {
"id": 123,
"sku": "<string>",
"description": "<string>"
},
"planned_qty": 123,
"expected_completion_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"production_warehouse_id": 123,
"production_warehouse": {
"id": 123,
"name": "<string>"
},
"destination_warehouse_id": 123,
"destination_warehouse": {
"id": 123,
"name": "<string>"
},
"vendor_id": 123,
"vendor": {
"id": 123,
"name": "<string>"
},
"bom_id": 123,
"service_unit_price": 123,
"notes": "<string>",
"hold_reason": "<string>",
"cancel_reason": "<string>",
"held_at": "2023-11-07T05:31:56Z",
"created_by": 123,
"updated_by": 123,
"held_by": 123,
"production_batch_id": 123,
"steps": [
{
"id": 123,
"work_order_id": 123,
"sequence": 123,
"status": "<string>",
"output_sku_id": 123,
"output_sku": {
"id": 123,
"sku": "<string>",
"description": "<string>"
},
"planned_qty": 123,
"completed_qty": 123,
"is_outside_processing": true,
"supply_mode": "<string>",
"vendor_id": 123,
"skipped_at": "2023-11-07T05:31:56Z",
"skipped_by": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"custom_fields": {},
"alternate_ids": [
"<string>"
],
"links": {
"self": "<string>",
"steps": "<string>",
"completions": "<string>",
"production_entries": "<string>",
"status_history": "<string>"
}
}
}{
"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
ID of the work order.
Body
application/json
ID of the SKU to produce (references a request_for_quotes SKU record).
Planned quantity to produce. Must be at least 0.0001.
Required range:
x >= 0.0001Warehouse where production occurs.
Warehouse where the produced goods are received.
Vendor performing the work (for subcontracted production).
Bill of materials to use for this work order.
Expected completion date for the work order.
Event that marks the work order as complete.
Available options:
finish_step, receipt Per-unit service price for subcontracted production.
Required range:
x >= 0Free-form notes for the work order.
Custom field key/value pairs.
Alternate identifiers for the work order.
Response
Successful response
Show child attributes
Show child attributes
⌘I