Buy a shipping label for a fulfillment order
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/fulfillment-orders/{fulfillmentOrderId}/label \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"carrier_code": "<string>",
"service_code": "<string>",
"weight": {
"value": 1.01,
"units": "<string>"
},
"package_code": "<string>",
"confirmation": "<string>",
"ship_date": "2023-12-25",
"dimensions": {
"length": 123,
"width": 123,
"height": 123,
"units": "<string>"
},
"ship_to": {
"name": "<string>",
"street1": "<string>",
"postal_code": "<string>"
},
"test_label": true,
"print_station_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"packing_session_id": "<string>",
"items": [
{
"order_item_id": 123,
"product_id": 123,
"quantity": 1.01,
"lot_id": 123
}
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/fulfillment-orders/{fulfillmentOrderId}/label"
payload = {
"carrier_code": "<string>",
"service_code": "<string>",
"weight": {
"value": 1.01,
"units": "<string>"
},
"package_code": "<string>",
"confirmation": "<string>",
"ship_date": "2023-12-25",
"dimensions": {
"length": 123,
"width": 123,
"height": 123,
"units": "<string>"
},
"ship_to": {
"name": "<string>",
"street1": "<string>",
"postal_code": "<string>"
},
"test_label": True,
"print_station_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"packing_session_id": "<string>",
"items": [
{
"order_item_id": 123,
"product_id": 123,
"quantity": 1.01,
"lot_id": 123
}
]
}
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({
carrier_code: '<string>',
service_code: '<string>',
weight: {value: 1.01, units: '<string>'},
package_code: '<string>',
confirmation: '<string>',
ship_date: '2023-12-25',
dimensions: {length: 123, width: 123, height: 123, units: '<string>'},
ship_to: {name: '<string>', street1: '<string>', postal_code: '<string>'},
test_label: true,
print_station_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
packing_session_id: '<string>',
items: [{order_item_id: 123, product_id: 123, quantity: 1.01, lot_id: 123}]
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/fulfillment-orders/{fulfillmentOrderId}/label', 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/pickflow/fulfillment-orders/{fulfillmentOrderId}/label",
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([
'carrier_code' => '<string>',
'service_code' => '<string>',
'weight' => [
'value' => 1.01,
'units' => '<string>'
],
'package_code' => '<string>',
'confirmation' => '<string>',
'ship_date' => '2023-12-25',
'dimensions' => [
'length' => 123,
'width' => 123,
'height' => 123,
'units' => '<string>'
],
'ship_to' => [
'name' => '<string>',
'street1' => '<string>',
'postal_code' => '<string>'
],
'test_label' => true,
'print_station_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'packing_session_id' => '<string>',
'items' => [
[
'order_item_id' => 123,
'product_id' => 123,
'quantity' => 1.01,
'lot_id' => 123
]
]
]),
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/pickflow/fulfillment-orders/{fulfillmentOrderId}/label"
payload := strings.NewReader("{\n \"carrier_code\": \"<string>\",\n \"service_code\": \"<string>\",\n \"weight\": {\n \"value\": 1.01,\n \"units\": \"<string>\"\n },\n \"package_code\": \"<string>\",\n \"confirmation\": \"<string>\",\n \"ship_date\": \"2023-12-25\",\n \"dimensions\": {\n \"length\": 123,\n \"width\": 123,\n \"height\": 123,\n \"units\": \"<string>\"\n },\n \"ship_to\": {\n \"name\": \"<string>\",\n \"street1\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"test_label\": true,\n \"print_station_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"packing_session_id\": \"<string>\",\n \"items\": [\n {\n \"order_item_id\": 123,\n \"product_id\": 123,\n \"quantity\": 1.01,\n \"lot_id\": 123\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/pickflow/fulfillment-orders/{fulfillmentOrderId}/label")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"carrier_code\": \"<string>\",\n \"service_code\": \"<string>\",\n \"weight\": {\n \"value\": 1.01,\n \"units\": \"<string>\"\n },\n \"package_code\": \"<string>\",\n \"confirmation\": \"<string>\",\n \"ship_date\": \"2023-12-25\",\n \"dimensions\": {\n \"length\": 123,\n \"width\": 123,\n \"height\": 123,\n \"units\": \"<string>\"\n },\n \"ship_to\": {\n \"name\": \"<string>\",\n \"street1\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"test_label\": true,\n \"print_station_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"packing_session_id\": \"<string>\",\n \"items\": [\n {\n \"order_item_id\": 123,\n \"product_id\": 123,\n \"quantity\": 1.01,\n \"lot_id\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/fulfillment-orders/{fulfillmentOrderId}/label")
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 \"carrier_code\": \"<string>\",\n \"service_code\": \"<string>\",\n \"weight\": {\n \"value\": 1.01,\n \"units\": \"<string>\"\n },\n \"package_code\": \"<string>\",\n \"confirmation\": \"<string>\",\n \"ship_date\": \"2023-12-25\",\n \"dimensions\": {\n \"length\": 123,\n \"width\": 123,\n \"height\": 123,\n \"units\": \"<string>\"\n },\n \"ship_to\": {\n \"name\": \"<string>\",\n \"street1\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"test_label\": true,\n \"print_station_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"packing_session_id\": \"<string>\",\n \"items\": [\n {\n \"order_item_id\": 123,\n \"product_id\": 123,\n \"quantity\": 1.01,\n \"lot_id\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"print_job_id": "<string>",
"items": [
{
"order_item_id": 123,
"product_id": 123,
"quantity": 123,
"lot_id": 123,
"lot_number": "<string>",
"expiry_date": "2023-12-25"
}
]
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}PickFlow Shipping
Buy a shipping label for a fulfillment order
Buy a shipping label for the given fulfillment order, register the shipment in Luminous, and return the base64 label bytes plus tracking. This operation is idempotent per fulfillment order — retries return the already-purchased label instead of buying postage twice. Success bodies are wrapped in a top-level "data" key; errors return { "error": "<reason>" }.
Optionally route the label to a printer: pass print_station_id (a Luminous print station from GET /pickflow/print-stations) to enqueue the purchased label into that station's print queue. The response then carries print_job_id.
POST
/
pickflow
/
fulfillment-orders
/
{fulfillmentOrderId}
/
label
Buy a shipping label for a fulfillment order
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/fulfillment-orders/{fulfillmentOrderId}/label \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"carrier_code": "<string>",
"service_code": "<string>",
"weight": {
"value": 1.01,
"units": "<string>"
},
"package_code": "<string>",
"confirmation": "<string>",
"ship_date": "2023-12-25",
"dimensions": {
"length": 123,
"width": 123,
"height": 123,
"units": "<string>"
},
"ship_to": {
"name": "<string>",
"street1": "<string>",
"postal_code": "<string>"
},
"test_label": true,
"print_station_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"packing_session_id": "<string>",
"items": [
{
"order_item_id": 123,
"product_id": 123,
"quantity": 1.01,
"lot_id": 123
}
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/fulfillment-orders/{fulfillmentOrderId}/label"
payload = {
"carrier_code": "<string>",
"service_code": "<string>",
"weight": {
"value": 1.01,
"units": "<string>"
},
"package_code": "<string>",
"confirmation": "<string>",
"ship_date": "2023-12-25",
"dimensions": {
"length": 123,
"width": 123,
"height": 123,
"units": "<string>"
},
"ship_to": {
"name": "<string>",
"street1": "<string>",
"postal_code": "<string>"
},
"test_label": True,
"print_station_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"packing_session_id": "<string>",
"items": [
{
"order_item_id": 123,
"product_id": 123,
"quantity": 1.01,
"lot_id": 123
}
]
}
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({
carrier_code: '<string>',
service_code: '<string>',
weight: {value: 1.01, units: '<string>'},
package_code: '<string>',
confirmation: '<string>',
ship_date: '2023-12-25',
dimensions: {length: 123, width: 123, height: 123, units: '<string>'},
ship_to: {name: '<string>', street1: '<string>', postal_code: '<string>'},
test_label: true,
print_station_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
packing_session_id: '<string>',
items: [{order_item_id: 123, product_id: 123, quantity: 1.01, lot_id: 123}]
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/fulfillment-orders/{fulfillmentOrderId}/label', 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/pickflow/fulfillment-orders/{fulfillmentOrderId}/label",
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([
'carrier_code' => '<string>',
'service_code' => '<string>',
'weight' => [
'value' => 1.01,
'units' => '<string>'
],
'package_code' => '<string>',
'confirmation' => '<string>',
'ship_date' => '2023-12-25',
'dimensions' => [
'length' => 123,
'width' => 123,
'height' => 123,
'units' => '<string>'
],
'ship_to' => [
'name' => '<string>',
'street1' => '<string>',
'postal_code' => '<string>'
],
'test_label' => true,
'print_station_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'packing_session_id' => '<string>',
'items' => [
[
'order_item_id' => 123,
'product_id' => 123,
'quantity' => 1.01,
'lot_id' => 123
]
]
]),
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/pickflow/fulfillment-orders/{fulfillmentOrderId}/label"
payload := strings.NewReader("{\n \"carrier_code\": \"<string>\",\n \"service_code\": \"<string>\",\n \"weight\": {\n \"value\": 1.01,\n \"units\": \"<string>\"\n },\n \"package_code\": \"<string>\",\n \"confirmation\": \"<string>\",\n \"ship_date\": \"2023-12-25\",\n \"dimensions\": {\n \"length\": 123,\n \"width\": 123,\n \"height\": 123,\n \"units\": \"<string>\"\n },\n \"ship_to\": {\n \"name\": \"<string>\",\n \"street1\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"test_label\": true,\n \"print_station_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"packing_session_id\": \"<string>\",\n \"items\": [\n {\n \"order_item_id\": 123,\n \"product_id\": 123,\n \"quantity\": 1.01,\n \"lot_id\": 123\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/pickflow/fulfillment-orders/{fulfillmentOrderId}/label")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"carrier_code\": \"<string>\",\n \"service_code\": \"<string>\",\n \"weight\": {\n \"value\": 1.01,\n \"units\": \"<string>\"\n },\n \"package_code\": \"<string>\",\n \"confirmation\": \"<string>\",\n \"ship_date\": \"2023-12-25\",\n \"dimensions\": {\n \"length\": 123,\n \"width\": 123,\n \"height\": 123,\n \"units\": \"<string>\"\n },\n \"ship_to\": {\n \"name\": \"<string>\",\n \"street1\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"test_label\": true,\n \"print_station_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"packing_session_id\": \"<string>\",\n \"items\": [\n {\n \"order_item_id\": 123,\n \"product_id\": 123,\n \"quantity\": 1.01,\n \"lot_id\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/fulfillment-orders/{fulfillmentOrderId}/label")
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 \"carrier_code\": \"<string>\",\n \"service_code\": \"<string>\",\n \"weight\": {\n \"value\": 1.01,\n \"units\": \"<string>\"\n },\n \"package_code\": \"<string>\",\n \"confirmation\": \"<string>\",\n \"ship_date\": \"2023-12-25\",\n \"dimensions\": {\n \"length\": 123,\n \"width\": 123,\n \"height\": 123,\n \"units\": \"<string>\"\n },\n \"ship_to\": {\n \"name\": \"<string>\",\n \"street1\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"test_label\": true,\n \"print_station_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"packing_session_id\": \"<string>\",\n \"items\": [\n {\n \"order_item_id\": 123,\n \"product_id\": 123,\n \"quantity\": 1.01,\n \"lot_id\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"print_job_id": "<string>",
"items": [
{
"order_item_id": 123,
"product_id": 123,
"quantity": 123,
"lot_id": 123,
"lot_number": "<string>",
"expiry_date": "2023-12-25"
}
]
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
The fulfillment order to buy a label for.
Body
application/json
Carrier code to ship with.
Shipping service code to use.
Show child attributes
Show child attributes
Package type code.
Delivery confirmation option.
Date the shipment will be tendered to the carrier.
Show child attributes
Show child attributes
Optional override of the ship-to address.
Show child attributes
Show child attributes
Format of the returned label.
Available options:
pdf, png, zpl, PDF, PNG, ZPL When true, request a test (non-billable) label.
Optional print routing. ID of a Luminous print station (from GET /pickflow/print-stations) to enqueue the purchased label into that station's print queue. Enqueue failures are non-fatal — the label is always returned.
Optional packing session identifier to associate with the print job.
WIP lot allocations (CS-10083). Required when the fulfillment order has lot-tracked lines; omit entirely for a non-lot FO so existing PickFlow clients keep working. Buy-label ships the whole FO, so lot-tracked lines must total the FO line quantity. Duplicate lines for the same product + lot are summed before the on-hand check. Validation runs before postage is purchased; lot problems return 422 keyed items.N.lot_id.
Show child attributes
Show child attributes
Response
Label purchased (or already-purchased label returned)
Base64 label bytes and tracking details.
Show child attributes
Show child attributes