Auto-generate fulfillment orders (synchronous)
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{salesOrderId}/auto-generate-fulfillment-orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"skip_status_check": true
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{salesOrderId}/auto-generate-fulfillment-orders"
payload = { "skip_status_check": True }
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({skip_status_check: true})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{salesOrderId}/auto-generate-fulfillment-orders', 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/{salesOrderId}/auto-generate-fulfillment-orders",
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([
'skip_status_check' => true
]),
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/{salesOrderId}/auto-generate-fulfillment-orders"
payload := strings.NewReader("{\n \"skip_status_check\": true\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/sales-orders/{salesOrderId}/auto-generate-fulfillment-orders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"skip_status_check\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{salesOrderId}/auto-generate-fulfillment-orders")
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 \"skip_status_check\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"sales_order_id": 12345,
"order_number": "SO-1001",
"status": "SUCCESS",
"message": "2 Fulfillment Order(s) Generated.",
"count": 2,
"fulfillment_order_ids": [
5001,
5002
],
"has_shortages": true,
"shortage_items": [
{}
]
}
}{
"message": "<string>"
}{
"data": {
"sales_order_id": 123,
"status": "ERROR",
"message": "<string>"
}
}Sales Orders
Auto-generate fulfillment orders (synchronous)
Generate fulfillment orders for a single sales order synchronously and return
the outcome inline. Contrast with POST /sales-orders/{salesOrderId}/refresh, which
dispatches an asynchronous order-refresh job.
Use this when you need the fulfillment orders created and their IDs back in the same request (e.g. an automation that immediately pushes them).
POST
/
sales-orders
/
{salesOrderId}
/
auto-generate-fulfillment-orders
Auto-generate fulfillment orders (synchronous)
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{salesOrderId}/auto-generate-fulfillment-orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"skip_status_check": true
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{salesOrderId}/auto-generate-fulfillment-orders"
payload = { "skip_status_check": True }
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({skip_status_check: true})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{salesOrderId}/auto-generate-fulfillment-orders', 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/{salesOrderId}/auto-generate-fulfillment-orders",
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([
'skip_status_check' => true
]),
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/{salesOrderId}/auto-generate-fulfillment-orders"
payload := strings.NewReader("{\n \"skip_status_check\": true\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/sales-orders/{salesOrderId}/auto-generate-fulfillment-orders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"skip_status_check\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{salesOrderId}/auto-generate-fulfillment-orders")
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 \"skip_status_check\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"sales_order_id": 12345,
"order_number": "SO-1001",
"status": "SUCCESS",
"message": "2 Fulfillment Order(s) Generated.",
"count": 2,
"fulfillment_order_ids": [
5001,
5002
],
"has_shortages": true,
"shortage_items": [
{}
]
}
}{
"message": "<string>"
}{
"data": {
"sales_order_id": 123,
"status": "ERROR",
"message": "<string>"
}
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
Sales order ID
Body
application/json
Response
Fulfillment orders generated
Show child attributes
Show child attributes