curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/purchase-orders/{purchaseOrderId}/allocate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sales_order_id": 5001,
"lines": [
{
"sales_order_item_id": 78001,
"quantity": 10
}
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/purchase-orders/{purchaseOrderId}/allocate"
payload = {
"sales_order_id": 5001,
"lines": [
{
"sales_order_item_id": 78001,
"quantity": 10
}
]
}
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({sales_order_id: 5001, lines: [{sales_order_item_id: 78001, quantity: 10}]})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/purchase-orders/{purchaseOrderId}/allocate', 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/purchase-orders/{purchaseOrderId}/allocate",
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([
'sales_order_id' => 5001,
'lines' => [
[
'sales_order_item_id' => 78001,
'quantity' => 10
]
]
]),
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/purchase-orders/{purchaseOrderId}/allocate"
payload := strings.NewReader("{\n \"sales_order_id\": 5001,\n \"lines\": [\n {\n \"sales_order_item_id\": 78001,\n \"quantity\": 10\n }\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/purchase-orders/{purchaseOrderId}/allocate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sales_order_id\": 5001,\n \"lines\": [\n {\n \"sales_order_item_id\": 78001,\n \"quantity\": 10\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/purchase-orders/{purchaseOrderId}/allocate")
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 \"sales_order_id\": 5001,\n \"lines\": [\n {\n \"sales_order_item_id\": 78001,\n \"quantity\": 10\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"pegsCreated": 1,
"purchaseOrderIds": [
9001
],
"fulfillmentOrderIds": []
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Allocate a sales order onto a purchase order
Peg one or more sales-order lines onto an existing active purchase order so they auto-fulfil when the purchase order is received (the “add-to-existing-PO” step of the Purchase-to-Order / container workflow). The allocation appends the required line to the purchase order and creates a peg from the sales-order line to it; on receipt the peg is released and an auto-generated fulfillment order ships the pegged quantity.
For each line, fulfillment_channel_id is optional — when omitted the service resolves the
channel from the line’s routing suggestion and strict-fails with 422 if routing is
ambiguous, rather than risk mis-pinning the fulfillment order. In that case, retry with an
explicit fulfillment_channel_id.
Only active purchase orders accept new allocations; a 409 Conflict is returned otherwise.
Note: This endpoint is gated by the
PURCHASE_TO_ORDERfeature flag. Contact Luminous to have it enabled for your tenant.
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/purchase-orders/{purchaseOrderId}/allocate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sales_order_id": 5001,
"lines": [
{
"sales_order_item_id": 78001,
"quantity": 10
}
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/purchase-orders/{purchaseOrderId}/allocate"
payload = {
"sales_order_id": 5001,
"lines": [
{
"sales_order_item_id": 78001,
"quantity": 10
}
]
}
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({sales_order_id: 5001, lines: [{sales_order_item_id: 78001, quantity: 10}]})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/purchase-orders/{purchaseOrderId}/allocate', 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/purchase-orders/{purchaseOrderId}/allocate",
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([
'sales_order_id' => 5001,
'lines' => [
[
'sales_order_item_id' => 78001,
'quantity' => 10
]
]
]),
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/purchase-orders/{purchaseOrderId}/allocate"
payload := strings.NewReader("{\n \"sales_order_id\": 5001,\n \"lines\": [\n {\n \"sales_order_item_id\": 78001,\n \"quantity\": 10\n }\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/purchase-orders/{purchaseOrderId}/allocate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sales_order_id\": 5001,\n \"lines\": [\n {\n \"sales_order_item_id\": 78001,\n \"quantity\": 10\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/purchase-orders/{purchaseOrderId}/allocate")
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 \"sales_order_id\": 5001,\n \"lines\": [\n {\n \"sales_order_item_id\": 78001,\n \"quantity\": 10\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"pegsCreated": 1,
"purchaseOrderIds": [
9001
],
"fulfillmentOrderIds": []
}
}{
"message": "<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 purchase order to allocate onto
Body
ID of the sales order whose lines are being allocated
5001
Sales-order lines to peg onto this purchase order
1Show child attributes
Show child attributes
When true, attempt to release the whole sales order as a single ship-complete
fulfillment once every held line is coverable. Omit to leave the order's existing
ship-complete behavior unchanged.
false
Response
Sales order lines allocated
Show child attributes
Show child attributes