Create a production batch
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/production-batches \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"vendor_id": 123,
"co_manufacturer_id": 123,
"production_warehouse_id": 123,
"destination_warehouse_id": 123,
"notes": "<string>",
"payment_terms": "Net 30",
"work_order_ids": [
123
],
"custom_fields": {
"Line": "Line A",
"Shift": "Night"
}
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/production-batches"
payload = {
"name": "<string>",
"vendor_id": 123,
"co_manufacturer_id": 123,
"production_warehouse_id": 123,
"destination_warehouse_id": 123,
"notes": "<string>",
"payment_terms": "Net 30",
"work_order_ids": [123],
"custom_fields": {
"Line": "Line A",
"Shift": "Night"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
vendor_id: 123,
co_manufacturer_id: 123,
production_warehouse_id: 123,
destination_warehouse_id: 123,
notes: '<string>',
payment_terms: 'Net 30',
work_order_ids: [123],
custom_fields: {Line: 'Line A', Shift: 'Night'}
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/production-batches', 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/production-batches",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'vendor_id' => 123,
'co_manufacturer_id' => 123,
'production_warehouse_id' => 123,
'destination_warehouse_id' => 123,
'notes' => '<string>',
'payment_terms' => 'Net 30',
'work_order_ids' => [
123
],
'custom_fields' => [
'Line' => 'Line A',
'Shift' => 'Night'
]
]),
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/production-batches"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"vendor_id\": 123,\n \"co_manufacturer_id\": 123,\n \"production_warehouse_id\": 123,\n \"destination_warehouse_id\": 123,\n \"notes\": \"<string>\",\n \"payment_terms\": \"Net 30\",\n \"work_order_ids\": [\n 123\n ],\n \"custom_fields\": {\n \"Line\": \"Line A\",\n \"Shift\": \"Night\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://{companyName}.api.joinluminous.com/external/api/v1/production-batches")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"vendor_id\": 123,\n \"co_manufacturer_id\": 123,\n \"production_warehouse_id\": 123,\n \"destination_warehouse_id\": 123,\n \"notes\": \"<string>\",\n \"payment_terms\": \"Net 30\",\n \"work_order_ids\": [\n 123\n ],\n \"custom_fields\": {\n \"Line\": \"Line A\",\n \"Shift\": \"Night\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/production-batches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"vendor_id\": 123,\n \"co_manufacturer_id\": 123,\n \"production_warehouse_id\": 123,\n \"destination_warehouse_id\": 123,\n \"notes\": \"<string>\",\n \"payment_terms\": \"Net 30\",\n \"work_order_ids\": [\n 123\n ],\n \"custom_fields\": {\n \"Line\": \"Line A\",\n \"Shift\": \"Night\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"batch_number": "<string>",
"name": "<string>",
"status": "<string>",
"vendor_id": 123,
"co_manufacturer_id": 123,
"vendor": {
"id": 123,
"name": "<string>"
},
"production_warehouse_id": 123,
"production_warehouse": {
"id": 123,
"name": "<string>"
},
"destination_warehouse_id": 123,
"destination_warehouse": {
"id": 123,
"name": "<string>"
},
"work_order_count": 123,
"work_orders": [
{
"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,
"completion_trigger": "manual",
"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,
"co_manufacturer_id": 123,
"vendor": {
"id": 123,
"name": "<string>"
},
"co_manufacturer": {
"id": 123,
"name": "<string>"
},
"bom_id": 123,
"work_order_kind": "build",
"service_unit_price": 123,
"cost_rule_resolution": {
"used_cost_rule": true,
"cost_rule_id": 123,
"cost_rule_name": "<string>",
"resolved_unit_cost": 123,
"fallback_source": "<string>",
"tier_min_qty": 123,
"breakdown": [
{
"effect": "<string>",
"description": "<string>",
"amount": "<string>",
"delta": "<string>",
"result": "<string>",
"costRuleId": 123,
"costRuleName": "<string>"
}
],
"next_tier_hint": {
"min_qty": 123,
"unit_cost": 123,
"savings": 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>"
}
}
],
"expected_completion_date": "2023-12-25",
"notes": "<string>",
"payment_terms": "Net 30",
"custom_fields": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": 123,
"updated_by": 123,
"links": {
"self": "<string>",
"work_orders": "<string>",
"summary": "<string>",
"po_links": "<string>",
"ao_links": "<string>",
"status_history": "<string>"
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}Production Batches
Create a production batch
Create a new production batch, optionally linking work orders.
POST
/
production-batches
Create a production batch
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/production-batches \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"vendor_id": 123,
"co_manufacturer_id": 123,
"production_warehouse_id": 123,
"destination_warehouse_id": 123,
"notes": "<string>",
"payment_terms": "Net 30",
"work_order_ids": [
123
],
"custom_fields": {
"Line": "Line A",
"Shift": "Night"
}
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/production-batches"
payload = {
"name": "<string>",
"vendor_id": 123,
"co_manufacturer_id": 123,
"production_warehouse_id": 123,
"destination_warehouse_id": 123,
"notes": "<string>",
"payment_terms": "Net 30",
"work_order_ids": [123],
"custom_fields": {
"Line": "Line A",
"Shift": "Night"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
vendor_id: 123,
co_manufacturer_id: 123,
production_warehouse_id: 123,
destination_warehouse_id: 123,
notes: '<string>',
payment_terms: 'Net 30',
work_order_ids: [123],
custom_fields: {Line: 'Line A', Shift: 'Night'}
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/production-batches', 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/production-batches",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'vendor_id' => 123,
'co_manufacturer_id' => 123,
'production_warehouse_id' => 123,
'destination_warehouse_id' => 123,
'notes' => '<string>',
'payment_terms' => 'Net 30',
'work_order_ids' => [
123
],
'custom_fields' => [
'Line' => 'Line A',
'Shift' => 'Night'
]
]),
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/production-batches"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"vendor_id\": 123,\n \"co_manufacturer_id\": 123,\n \"production_warehouse_id\": 123,\n \"destination_warehouse_id\": 123,\n \"notes\": \"<string>\",\n \"payment_terms\": \"Net 30\",\n \"work_order_ids\": [\n 123\n ],\n \"custom_fields\": {\n \"Line\": \"Line A\",\n \"Shift\": \"Night\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://{companyName}.api.joinluminous.com/external/api/v1/production-batches")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"vendor_id\": 123,\n \"co_manufacturer_id\": 123,\n \"production_warehouse_id\": 123,\n \"destination_warehouse_id\": 123,\n \"notes\": \"<string>\",\n \"payment_terms\": \"Net 30\",\n \"work_order_ids\": [\n 123\n ],\n \"custom_fields\": {\n \"Line\": \"Line A\",\n \"Shift\": \"Night\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/production-batches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"vendor_id\": 123,\n \"co_manufacturer_id\": 123,\n \"production_warehouse_id\": 123,\n \"destination_warehouse_id\": 123,\n \"notes\": \"<string>\",\n \"payment_terms\": \"Net 30\",\n \"work_order_ids\": [\n 123\n ],\n \"custom_fields\": {\n \"Line\": \"Line A\",\n \"Shift\": \"Night\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"batch_number": "<string>",
"name": "<string>",
"status": "<string>",
"vendor_id": 123,
"co_manufacturer_id": 123,
"vendor": {
"id": 123,
"name": "<string>"
},
"production_warehouse_id": 123,
"production_warehouse": {
"id": 123,
"name": "<string>"
},
"destination_warehouse_id": 123,
"destination_warehouse": {
"id": 123,
"name": "<string>"
},
"work_order_count": 123,
"work_orders": [
{
"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,
"completion_trigger": "manual",
"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,
"co_manufacturer_id": 123,
"vendor": {
"id": 123,
"name": "<string>"
},
"co_manufacturer": {
"id": 123,
"name": "<string>"
},
"bom_id": 123,
"work_order_kind": "build",
"service_unit_price": 123,
"cost_rule_resolution": {
"used_cost_rule": true,
"cost_rule_id": 123,
"cost_rule_name": "<string>",
"resolved_unit_cost": 123,
"fallback_source": "<string>",
"tier_min_qty": 123,
"breakdown": [
{
"effect": "<string>",
"description": "<string>",
"amount": "<string>",
"delta": "<string>",
"result": "<string>",
"costRuleId": 123,
"costRuleName": "<string>"
}
],
"next_tier_hint": {
"min_qty": 123,
"unit_cost": 123,
"savings": 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>"
}
}
],
"expected_completion_date": "2023-12-25",
"notes": "<string>",
"payment_terms": "Net 30",
"custom_fields": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": 123,
"updated_by": 123,
"links": {
"self": "<string>",
"work_orders": "<string>",
"summary": "<string>",
"po_links": "<string>",
"ao_links": "<string>",
"status_history": "<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.
Body
application/json
Name of the production batch.
Maximum string length:
255Vendor associated with the batch.
Alias of vendor_id. When both are sent, vendor_id wins.
ID of the warehouse where the batch is produced.
ID of the warehouse that receives the finished goods.
Free-form notes for the batch.
Payment terms for the batch. Must exactly match one of Luminous's standard payment term names (e.g. Net 30, 50/50, Due on Receipt, 100% Down); matching is case-sensitive and any other value returns 422.
Maximum string length:
255Example:
"Net 30"
Work order IDs to link to the batch on creation.
Custom field values for the production batch, keyed by field label.
Show child attributes
Show child attributes
Example:
{ "Line": "Line A", "Shift": "Night" }
Response
Created
Show child attributes
Show child attributes