List picklists
curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/picklists \
--header 'Authorization: Bearer <token>'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/picklists"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/picklists', 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/picklists",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/picklists"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/picklists")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/picklists")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 12,
"created_at": "2026-09-01T14:20:00.000000Z",
"updated_at": "2026-09-01T15:03:11.000000Z",
"status": "picking",
"picking_started_at": "2026-09-01T14:25:00.000000Z",
"picking_ended_at": null,
"packing_started_at": null,
"packing_ended_at": null,
"picked_by_user": {
"id": 123,
"name": "<string>"
},
"packed_by_user": {
"id": 123,
"name": "<string>"
},
"shipped_by_user": {
"id": 123,
"name": "<string>"
},
"items": [
{
"id": 4501,
"picklist_id": 12,
"location_id": 88,
"rfq_id": 1023,
"available_quantity": 25,
"picked_quantity": 10,
"lot_id": 305,
"lot_number": "L-546",
"production_date": "2026-01-15",
"expiry_date": "2027-01-15",
"lot_deduction_strategy": null,
"uom_id": 7,
"uom": {
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"unit_class_id": 123,
"unit_class": {
"id": 123,
"name": "<string>",
"base_class": true
},
"name": "<string>",
"description": "<string>",
"base_unit": true,
"unit_conversion_rules": [
{
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"base_unit_of_measure_id": 123,
"base_unit_of_measure": {
"id": 123,
"name": "<string>",
"unit_class_id": 123,
"base_unit": true
},
"converted_unit_of_measure_id": 123,
"converted_unit_of_measure": {
"id": 123,
"name": "<string>",
"unit_class_id": 123,
"base_unit": true
},
"conversion_factor": 123,
"type": "SYSTEM",
"product_id": 123,
"product": {},
"product_alternate_skus": [
{}
]
}
]
},
"created_at": "2026-09-01T14:22:00.000000Z",
"updated_at": "2026-09-01T15:03:11.000000Z",
"quantity_per_fulfillment_order": [
{
"fulfillment_order_id": 9001,
"order_key": "114-2938471-0011",
"quantity": 6,
"sales_items": [
{
"id": 77012,
"sku": "WIDGET-BLUE",
"name": "Blue Widget",
"quantity": 6,
"rfq_id": 1023,
"kit_id": null,
"order_item_id": "oi_88213"
}
]
}
],
"location": {
"id": 123,
"status": "<string>",
"name": "<string>",
"parent_id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"product": {
"id": 123,
"name": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123,
"unit_cost": 123,
"purchase_unit_cost": 123,
"purchase_currency": "<string>",
"landed_cost": 123,
"estimated_landed_cost": 123,
"design_link": "<string>",
"manufacturing_fee": 123,
"product_weight": [
{
"unit": "lb",
"value": 1
}
],
"product_weight_oz": 123,
"product_weight_lb": 123,
"dimensional_weight": [
{
"unit": "lb",
"value": 1
}
],
"dimensional_weight_oz": 123,
"dimensional_weight_lb": 123,
"product_length": 123,
"product_width": 123,
"product_height": 123,
"box_weight": [
{
"unit": "lb",
"value": 1
}
],
"box_weight_oz": 123,
"box_weight_lb": 123,
"box_length": 123,
"box_width": 123,
"box_height": 123,
"carton_weight": [
{
"unit": "lb",
"value": 1
}
],
"carton_weight_oz": 123,
"carton_weight_lb": 123,
"carton_length": 123,
"carton_width": 123,
"carton_height": 123,
"units_per_carton": 123,
"shipping_weight": [
{
"unit": "lb",
"value": 1
}
],
"shipping_weight_oz": 123,
"shipping_weight_lb": 123,
"shipping_length": 123,
"shipping_width": 123,
"shipping_height": 123,
"pallet_weight": [
{
"unit": "lb",
"value": 1
}
],
"pallet_weight_oz": 123,
"pallet_weight_lb": 123,
"pallet_length": 123,
"pallet_width": 123,
"pallet_height": 123,
"cartons_per_pallet": 123,
"units_per_pallet": 123,
"lead_time_days": 123,
"sellable": true,
"discontinued": true,
"is_drop_ship_item": true,
"taxable": true,
"lot_tracking": true,
"lot_deduction_strategy": "<string>",
"round_up_as_component": true,
"default_supply_method": "purchase",
"image_url": "<string>",
"category": {
"id": 123,
"name": "<string>"
},
"subcategory": {
"id": 123,
"name": "<string>"
},
"custom_fields": {},
"attachments": [
{
"id": 123,
"name": "<string>",
"type": "<string>",
"size": 123,
"full_url": "<string>",
"thumb_url": "<string>"
}
],
"variants": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"product_weight": [
{
"unit": "lb",
"value": 1
}
],
"product_weight_oz": 123,
"product_weight_lb": 123,
"dimensional_weight": [
{
"unit": "lb",
"value": 1
}
],
"dimensional_weight_oz": 123,
"dimensional_weight_lb": 123,
"box_weight": [
{
"unit": "lb",
"value": 1
}
],
"box_weight_oz": 123,
"box_weight_lb": 123,
"carton_weight": [
{
"unit": "lb",
"value": 1
}
],
"carton_weight_oz": 123,
"carton_weight_lb": 123,
"shipping_weight": [
{
"unit": "lb",
"value": 1
}
],
"shipping_weight_oz": 123,
"shipping_weight_lb": 123,
"pallet_weight": [
{
"unit": "lb",
"value": 1
}
],
"pallet_weight_oz": 123,
"pallet_weight_lb": 123,
"attachments": [
{
"id": 123,
"name": "<string>",
"type": "<string>",
"size": 123,
"full_url": "<string>",
"thumb_url": "<string>"
}
],
"retail_price": 123,
"wholesale_price": 123,
"custom_fields": [
{}
],
"variant_attributes": [
{
"variant_name": "<string>",
"variant_terms": [
"<string>"
]
}
],
"sku": "<string>",
"upc": "<string>",
"hs_code": "<string>",
"round_up_as_component": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"variant_attributes": [
{
"variant_name": "<string>",
"variant_terms": [
"<string>"
]
}
],
"sku": "<string>",
"alternate_skus": [
{
"id": 123,
"sku": "<string>"
}
],
"upc": "<string>",
"hs_code": "<string>",
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"substitutions": [
{
"id": 123,
"priority": 123,
"product": {
"id": 123,
"name": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123,
"unit_cost": 123,
"product_weight": [
{
"unit": "lb",
"value": 1
}
],
"product_weight_oz": 123,
"product_weight_lb": 123,
"dimensional_weight": [
{
"unit": "lb",
"value": 1
}
],
"dimensional_weight_oz": 123,
"dimensional_weight_lb": 123,
"product_length": 123,
"product_width": 123,
"product_height": 123,
"box_weight": [
{
"unit": "lb",
"value": 1
}
],
"box_weight_oz": 123,
"box_weight_lb": 123,
"box_length": 123,
"box_width": 123,
"box_height": 123,
"carton_weight": [
{
"unit": "lb",
"value": 1
}
],
"carton_weight_oz": 123,
"carton_weight_lb": 123,
"carton_length": 123,
"carton_width": 123,
"carton_height": 123,
"shipping_weight": [
{
"unit": "lb",
"value": 1
}
],
"shipping_weight_oz": 123,
"shipping_weight_lb": 123,
"shipping_length": 123,
"shipping_width": 123,
"shipping_height": 123,
"pallet_weight": [
{
"unit": "lb",
"value": 1
}
],
"pallet_weight_oz": 123,
"pallet_weight_lb": 123,
"pallet_length": 123,
"pallet_width": 123,
"pallet_height": 123,
"sellable": true,
"discontinued": true,
"is_drop_ship_item": true,
"taxable": true,
"image_url": "<string>",
"sku": "<string>",
"upc": "<string>",
"hs_code": "<string>",
"round_up_as_component": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
],
"supplier": {},
"type": "PRODUCT",
"kit_items": [
{
"id": 123,
"product_id": 123,
"quantity": 123,
"uom_id": 123,
"base_uom_quantity": 123,
"price": 123,
"original_price": 123,
"total": 123,
"product": {
"id": 123,
"name": "<string>",
"sku": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123
},
"unit_of_measure": {
"id": 123,
"name": "<string>",
"description": "<string>",
"base_unit": true
}
}
],
"priority_list": {
"id": 123,
"name": "<string>",
"description": "<string>"
},
"distribution_template": {
"id": 123,
"name": "<string>",
"source": "assigned"
},
"distribution_template_category": {
"id": 123,
"name": "<string>"
},
"boms": [
{
"id": 123,
"name": "<string>",
"items": [
{
"id": 123,
"bom_id": 123,
"product_id": 123,
"quantity": 123,
"product": {
"id": 123,
"name": "<string>",
"sku": "<string>",
"description": "<string>"
},
"base_quantity": 123,
"note": "<string>",
"uom_id": 123,
"unit_of_measure": {
"id": 123,
"name": "<string>"
},
"order": 123,
"consumption_basis": "planned",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"extra_costs": [
{
"id": 123,
"name": "<string>",
"quantity": 123,
"unit_price": 123,
"line_total": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": 123,
"updated_by": 123,
"created_via": "user"
}
}
],
"sales_orders": [
{
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"order_id": "<string>",
"order_number": "<string>",
"order_date": "2023-12-25",
"payment_date": "2023-12-25",
"ship_by_date": "2023-12-25",
"age": 123,
"order_status": "<string>",
"customer_id": "<string>",
"customer_username": "<string>",
"customer_email": "<string>",
"bill_to": {},
"ship_to": {},
"requested_shipping_service": "<string>",
"total": 123,
"total_paid": 123,
"total_tax": 123,
"total_shipping": 123,
"customer_notes": "<string>",
"internal_notes": "<string>",
"ship_date": "2023-12-25",
"hold_until_date": "2023-12-25",
"earliest_ship_date": "2023-12-25",
"user_id": 123,
"externally_fulfilled": true,
"externally_fulfilled_by": "<string>",
"is_posted": true,
"posted_by": "<string>",
"not_sync": true,
"sales_posted": true,
"split_order": true,
"skip_inventory": true,
"skip_sales_report": true,
"channel_id": 123,
"total_order_cost": 123,
"total_order_quantity": 123,
"order_cost_details": {},
"source": "<string>",
"shipstation_order_id": "<string>",
"type": "<string>",
"parent_id": 123,
"shipping_revenue": 123,
"product_total": 123,
"total_discount": 123,
"picking_status": "<string>",
"starred_description": "<string>",
"customer_po_number": "<string>",
"company_id": 123,
"company": {
"id": 123456,
"status": "active",
"name": "Acme Corporation",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"type": "Retail",
"phone": "555-123-4567",
"address": "123 Main St",
"address_line_2": "Suite 500",
"city": "Austin",
"state": "TX",
"postal_code": "78701",
"country": "USA",
"full_address": "123 Main St, Suite 500, Austin, TX 78701, USA",
"shipping_first_name": "John",
"shipping_last_name": "Doe",
"shipping_email": "shipping@acmecorp.com",
"shipping_phone": "555-987-6543",
"shipping_address": "456 Warehouse Blvd",
"shipping_city": "Austin",
"shipping_state": "TX",
"shipping_postal_code": "78745",
"shipping_country": "USA",
"shipping_full_address": "456 Warehouse Blvd, Austin, TX 78745, USA",
"payment_term": "Net 30",
"tax_exempt": false,
"tax_rate": 8.25,
"due_date_days": 30,
"credit_limit": 5000,
"header_discount_enabled": false,
"header_discount_type": "PERCENT",
"header_discount_value": 5,
"header_discount_effective_from": "2026-01-01",
"default_currency_code": "USD",
"price_level": {
"id": 123,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"status": "active",
"name": "Wholesale",
"type": "percentage",
"percent_increase": 15.5
},
"notes": "Key account, requires special handling",
"fein": "12-3456789",
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"default_shipping": {
"id": 789,
"company_id": 123456,
"address": "456 Warehouse Blvd",
"city": "Austin",
"state": "TX",
"postal_code": "78745",
"country": "USA",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"company_name": "Acme Corporation",
"address_line_2": "Building 2",
"full_address": "456 Warehouse Blvd, Building 2, Austin, TX 78745, USA",
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"phone": "555-987-6543",
"email": "shipping@acmecorp.com",
"is_default": true
},
"shipping_addresses": [
{
"id": 789,
"company_id": 123456,
"address": "456 Warehouse Blvd",
"city": "Austin",
"state": "TX",
"postal_code": "78745",
"country": "USA",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"company_name": "Acme Corporation",
"address_line_2": "Building 2",
"full_address": "456 Warehouse Blvd, Building 2, Austin, TX 78745, USA",
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"phone": "555-987-6543",
"email": "shipping@acmecorp.com",
"is_default": true
}
],
"billing_info": {
"id": 456,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"first_name": "Jane",
"last_name": "Smith",
"email": "accounting@acmecorp.com",
"receiving_bank_name": "First National Bank",
"receiving_bank_address": "789 Finance Street, Austin, TX 78701"
},
"client_type": {
"id": 123,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"name": "Retail",
"description": "Retail business client"
},
"parent_company_id": 456,
"invoice_export_template_id": 789,
"custom_fields": {
"Industry": "Manufacturing",
"Region": "Southwest",
"Annual Revenue": "$5M-$10M"
},
"assigned_sales_reps": [
{
"id": 42,
"email": "rep@example.com",
"first_name": "Jane",
"last_name": "Doe"
}
],
"sales_channel": {
"id": 123,
"status": "<string>",
"label": "<string>",
"channel_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
},
"custom_fields": {},
"items": [
{
"id": 123,
"line_number": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"name": "<string>",
"image_url": "<string>",
"weight": {},
"quantity": 123,
"unit_price": 123,
"tax": 123,
"shipping": 123,
"warehouse_location": "<string>",
"options": {},
"fulfillment_sku": "<string>",
"adjustment": 123,
"upc": "<string>",
"stock_id": 123,
"kit_id": 123,
"non_physical_item": true,
"ignore_item": true,
"is_locally_added": true,
"quantity_shipped": 123,
"quantity_cancelled": 123,
"quantity_invoiced": 123,
"quantity_ordered": 123,
"base_uom_id": 123,
"ordered_uom_id": 123,
"product_id": 123,
"total_returned_base_quantity": 123,
"parent_id": 123,
"status": "<string>",
"discount": 123,
"estimated_ship_date": "2023-12-25",
"custom_fields": {},
"product": {
"id": 123,
"name": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123,
"unit_cost": 123,
"product_weight": 123,
"product_length": 123,
"product_width": 123,
"product_height": 123,
"sellable": true,
"discontinued": true,
"image_url": "<string>",
"category": {
"id": 123,
"name": "<string>"
},
"subcategory": {
"id": 123,
"name": "<string>"
},
"custom_fields": {},
"variant_attributes": {},
"sku": "<string>",
"alternate_skus": [
{
"id": 123,
"sku": "<string>"
}
],
"upc": "<string>",
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"supplier": {},
"type": "PRODUCT",
"kit_items": [
{
"id": 123,
"product_id": 123,
"quantity": 123,
"uom_id": 123,
"base_uom_quantity": 123,
"price": 123,
"original_price": 123,
"total": 123,
"product": {
"id": 123,
"name": "<string>",
"sku": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123
},
"unit_of_measure": {
"id": 123,
"name": "<string>",
"description": "<string>",
"base_unit": true
}
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>",
"discount_structure": {},
"markup_structure": {}
}
]
}
],
"fulfillment_orders": [
{
"id": 123,
"order_number": "<string>",
"order_key": "<string>",
"order_status": "<string>",
"sales_order_id": 123,
"warehouse_group_id": 123,
"destination_oms_id": 123,
"destination_oms_store_id": 123,
"fulfillment_channel_id": 123,
"pushed_at": "2023-11-07T05:31:56Z",
"packing_slip_printed_at": "2023-11-07T05:31:56Z",
"error_message": "<string>",
"ship_by_date": "2023-12-25",
"total": 123,
"bill_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"ship_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"invoice_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"sales_order": {},
"picklists": [
{}
],
"fulfillment_order_items": [
{
"id": 123,
"shipment_id": 123,
"status": "<unknown>",
"sales_order_item_id": 123,
"product_id": 123,
"sku": "<string>",
"name": "<string>",
"weight": "<unknown>",
"dimensions": "<unknown>",
"quantity": 123,
"unit_price": 123,
"lot_id": 123,
"lot_number": "<string>",
"expiry_date": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_kit_component": true,
"parent_fulfillment_order_item_id": 123,
"kit_sales_order_item_id": 123,
"is_synthetic": true
}
],
"total_weight": {
"total_oz": 123,
"total_lb": 123,
"line_count": 123,
"weighed_line_count": 123,
"is_complete": true
},
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"purchase_orders": [
{
"id": 123,
"order_status": "active"
}
],
"source_reference_identifier": "<string>",
"held_for_item_change": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>",
"discount_structure": {},
"markup_structure": {}
}
]
}
],
"fulfillment_orders": [
{
"id": 123,
"order_number": "<string>",
"order_key": "<string>",
"order_status": "<string>",
"sales_order_id": 123,
"warehouse_group_id": 123,
"destination_oms_id": 123,
"destination_oms_store_id": 123,
"fulfillment_channel_id": 123,
"pushed_at": "2023-11-07T05:31:56Z",
"packing_slip_printed_at": "2023-11-07T05:31:56Z",
"error_message": "<string>",
"ship_by_date": "2023-12-25",
"total": 123,
"bill_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"ship_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"invoice_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"sales_order": {},
"picklists": [
{}
],
"fulfillment_order_items": [
{
"id": 123,
"shipment_id": 123,
"status": "<unknown>",
"sales_order_item_id": 123,
"product_id": 123,
"sku": "<string>",
"name": "<string>",
"weight": "<unknown>",
"dimensions": "<unknown>",
"quantity": 123,
"unit_price": 123,
"lot_id": 123,
"lot_number": "<string>",
"expiry_date": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_kit_component": true,
"parent_fulfillment_order_item_id": 123,
"kit_sales_order_item_id": 123,
"is_synthetic": true
}
],
"total_weight": {
"total_oz": 123,
"total_lb": 123,
"line_count": 123,
"weighed_line_count": 123,
"is_complete": true
},
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"purchase_orders": [
{
"id": 123,
"order_status": "active"
}
],
"source_reference_identifier": "<string>",
"held_for_item_change": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 5,
"per_page": 10,
"to": 10,
"total": 50
}
}{
"error": "Unauthorized",
"message": "Authentication credentials are missing or invalid",
"status_code": 401
}Picklists
List picklists
Get a paginated list of picklists with optional filtering. A picklist matches a filter if any linked fulfillment order or sales order matches.
Filters accept the same operators as other External V1 list endpoints (e.g. eq, contains, in). For details, see the Filter System Documentation.
Available Filters
Integer Filters
id: Picklist IDchannel_id: Sales channel ID of the linked order
String Filters
-
status: Picklist status (created,picking,picked,packed,deleted) -
order_number: Order number of the linked order. Matches the linked sales order number, the linked fulfillment order’s order number or order key, or the fulfillment order’s parent sales order number (a split fulfillment order’s number often differs from its parent sales order) -
requested_shipping_service: Requested shipping service on the linked fulfillment order or sales order -
channel_name: Sales channel label of the linked order -
tag: Sales order tag -
search: Single search box. Matches a picklist ID (PL-618or618), or a partial order number or ship-to name on the linked sales order, the linked fulfillment order (order number only), or the fulfillment order’s parent sales order. Always a contains match; operators are ignored
DateTime Filters
created_at: When the picklist was createdupdated_at: When the picklist was last updated
Queue View
Pass view=queue for a lighter payload suited to a picking queue. Each picklist still includes its sales_orders and fulfillment_orders, but items is always an empty array and fulfillment orders omit their line detail. Fetch GET /pickflow/picklists/{id} for a picklist’s full item, lot, and kit detail.
Kit lines on sales-order picklists
In the full view, each sales_orders[].items[].product with type = KIT includes its kit_items (components with their product). A picklist attached through sales orders has no fulfillment-order breakdown, so the picking app uses this bill of materials to pick the components behind a kit line instead of only the standalone quantity (CS-11261). Queue view omits sales-order line detail.
Examples
# Picklists on a specific channel
?channel_id[eq]=9
# Picklists for orders tagged "priority"
?tag[eq]=priority
# Picklists whose order requests overnight shipping
?requested_shipping_service[contains]=Overnight
# Picklists for a channel by name
?channel_name[eq]=FBM Hold Up
# Picklists for a split fulfillment order number, queue payload
?order_number[eq]=1001-F2&view=queue
# Find a picklist by its number, an order number, or a customer name
?search=PL-618
GET
/
pickflow
/
picklists
List picklists
curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/picklists \
--header 'Authorization: Bearer <token>'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/picklists"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/picklists', 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/picklists",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/picklists"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/picklists")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/picklists")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 12,
"created_at": "2026-09-01T14:20:00.000000Z",
"updated_at": "2026-09-01T15:03:11.000000Z",
"status": "picking",
"picking_started_at": "2026-09-01T14:25:00.000000Z",
"picking_ended_at": null,
"packing_started_at": null,
"packing_ended_at": null,
"picked_by_user": {
"id": 123,
"name": "<string>"
},
"packed_by_user": {
"id": 123,
"name": "<string>"
},
"shipped_by_user": {
"id": 123,
"name": "<string>"
},
"items": [
{
"id": 4501,
"picklist_id": 12,
"location_id": 88,
"rfq_id": 1023,
"available_quantity": 25,
"picked_quantity": 10,
"lot_id": 305,
"lot_number": "L-546",
"production_date": "2026-01-15",
"expiry_date": "2027-01-15",
"lot_deduction_strategy": null,
"uom_id": 7,
"uom": {
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"unit_class_id": 123,
"unit_class": {
"id": 123,
"name": "<string>",
"base_class": true
},
"name": "<string>",
"description": "<string>",
"base_unit": true,
"unit_conversion_rules": [
{
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"base_unit_of_measure_id": 123,
"base_unit_of_measure": {
"id": 123,
"name": "<string>",
"unit_class_id": 123,
"base_unit": true
},
"converted_unit_of_measure_id": 123,
"converted_unit_of_measure": {
"id": 123,
"name": "<string>",
"unit_class_id": 123,
"base_unit": true
},
"conversion_factor": 123,
"type": "SYSTEM",
"product_id": 123,
"product": {},
"product_alternate_skus": [
{}
]
}
]
},
"created_at": "2026-09-01T14:22:00.000000Z",
"updated_at": "2026-09-01T15:03:11.000000Z",
"quantity_per_fulfillment_order": [
{
"fulfillment_order_id": 9001,
"order_key": "114-2938471-0011",
"quantity": 6,
"sales_items": [
{
"id": 77012,
"sku": "WIDGET-BLUE",
"name": "Blue Widget",
"quantity": 6,
"rfq_id": 1023,
"kit_id": null,
"order_item_id": "oi_88213"
}
]
}
],
"location": {
"id": 123,
"status": "<string>",
"name": "<string>",
"parent_id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"product": {
"id": 123,
"name": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123,
"unit_cost": 123,
"purchase_unit_cost": 123,
"purchase_currency": "<string>",
"landed_cost": 123,
"estimated_landed_cost": 123,
"design_link": "<string>",
"manufacturing_fee": 123,
"product_weight": [
{
"unit": "lb",
"value": 1
}
],
"product_weight_oz": 123,
"product_weight_lb": 123,
"dimensional_weight": [
{
"unit": "lb",
"value": 1
}
],
"dimensional_weight_oz": 123,
"dimensional_weight_lb": 123,
"product_length": 123,
"product_width": 123,
"product_height": 123,
"box_weight": [
{
"unit": "lb",
"value": 1
}
],
"box_weight_oz": 123,
"box_weight_lb": 123,
"box_length": 123,
"box_width": 123,
"box_height": 123,
"carton_weight": [
{
"unit": "lb",
"value": 1
}
],
"carton_weight_oz": 123,
"carton_weight_lb": 123,
"carton_length": 123,
"carton_width": 123,
"carton_height": 123,
"units_per_carton": 123,
"shipping_weight": [
{
"unit": "lb",
"value": 1
}
],
"shipping_weight_oz": 123,
"shipping_weight_lb": 123,
"shipping_length": 123,
"shipping_width": 123,
"shipping_height": 123,
"pallet_weight": [
{
"unit": "lb",
"value": 1
}
],
"pallet_weight_oz": 123,
"pallet_weight_lb": 123,
"pallet_length": 123,
"pallet_width": 123,
"pallet_height": 123,
"cartons_per_pallet": 123,
"units_per_pallet": 123,
"lead_time_days": 123,
"sellable": true,
"discontinued": true,
"is_drop_ship_item": true,
"taxable": true,
"lot_tracking": true,
"lot_deduction_strategy": "<string>",
"round_up_as_component": true,
"default_supply_method": "purchase",
"image_url": "<string>",
"category": {
"id": 123,
"name": "<string>"
},
"subcategory": {
"id": 123,
"name": "<string>"
},
"custom_fields": {},
"attachments": [
{
"id": 123,
"name": "<string>",
"type": "<string>",
"size": 123,
"full_url": "<string>",
"thumb_url": "<string>"
}
],
"variants": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"product_weight": [
{
"unit": "lb",
"value": 1
}
],
"product_weight_oz": 123,
"product_weight_lb": 123,
"dimensional_weight": [
{
"unit": "lb",
"value": 1
}
],
"dimensional_weight_oz": 123,
"dimensional_weight_lb": 123,
"box_weight": [
{
"unit": "lb",
"value": 1
}
],
"box_weight_oz": 123,
"box_weight_lb": 123,
"carton_weight": [
{
"unit": "lb",
"value": 1
}
],
"carton_weight_oz": 123,
"carton_weight_lb": 123,
"shipping_weight": [
{
"unit": "lb",
"value": 1
}
],
"shipping_weight_oz": 123,
"shipping_weight_lb": 123,
"pallet_weight": [
{
"unit": "lb",
"value": 1
}
],
"pallet_weight_oz": 123,
"pallet_weight_lb": 123,
"attachments": [
{
"id": 123,
"name": "<string>",
"type": "<string>",
"size": 123,
"full_url": "<string>",
"thumb_url": "<string>"
}
],
"retail_price": 123,
"wholesale_price": 123,
"custom_fields": [
{}
],
"variant_attributes": [
{
"variant_name": "<string>",
"variant_terms": [
"<string>"
]
}
],
"sku": "<string>",
"upc": "<string>",
"hs_code": "<string>",
"round_up_as_component": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"variant_attributes": [
{
"variant_name": "<string>",
"variant_terms": [
"<string>"
]
}
],
"sku": "<string>",
"alternate_skus": [
{
"id": 123,
"sku": "<string>"
}
],
"upc": "<string>",
"hs_code": "<string>",
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"substitutions": [
{
"id": 123,
"priority": 123,
"product": {
"id": 123,
"name": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123,
"unit_cost": 123,
"product_weight": [
{
"unit": "lb",
"value": 1
}
],
"product_weight_oz": 123,
"product_weight_lb": 123,
"dimensional_weight": [
{
"unit": "lb",
"value": 1
}
],
"dimensional_weight_oz": 123,
"dimensional_weight_lb": 123,
"product_length": 123,
"product_width": 123,
"product_height": 123,
"box_weight": [
{
"unit": "lb",
"value": 1
}
],
"box_weight_oz": 123,
"box_weight_lb": 123,
"box_length": 123,
"box_width": 123,
"box_height": 123,
"carton_weight": [
{
"unit": "lb",
"value": 1
}
],
"carton_weight_oz": 123,
"carton_weight_lb": 123,
"carton_length": 123,
"carton_width": 123,
"carton_height": 123,
"shipping_weight": [
{
"unit": "lb",
"value": 1
}
],
"shipping_weight_oz": 123,
"shipping_weight_lb": 123,
"shipping_length": 123,
"shipping_width": 123,
"shipping_height": 123,
"pallet_weight": [
{
"unit": "lb",
"value": 1
}
],
"pallet_weight_oz": 123,
"pallet_weight_lb": 123,
"pallet_length": 123,
"pallet_width": 123,
"pallet_height": 123,
"sellable": true,
"discontinued": true,
"is_drop_ship_item": true,
"taxable": true,
"image_url": "<string>",
"sku": "<string>",
"upc": "<string>",
"hs_code": "<string>",
"round_up_as_component": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
],
"supplier": {},
"type": "PRODUCT",
"kit_items": [
{
"id": 123,
"product_id": 123,
"quantity": 123,
"uom_id": 123,
"base_uom_quantity": 123,
"price": 123,
"original_price": 123,
"total": 123,
"product": {
"id": 123,
"name": "<string>",
"sku": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123
},
"unit_of_measure": {
"id": 123,
"name": "<string>",
"description": "<string>",
"base_unit": true
}
}
],
"priority_list": {
"id": 123,
"name": "<string>",
"description": "<string>"
},
"distribution_template": {
"id": 123,
"name": "<string>",
"source": "assigned"
},
"distribution_template_category": {
"id": 123,
"name": "<string>"
},
"boms": [
{
"id": 123,
"name": "<string>",
"items": [
{
"id": 123,
"bom_id": 123,
"product_id": 123,
"quantity": 123,
"product": {
"id": 123,
"name": "<string>",
"sku": "<string>",
"description": "<string>"
},
"base_quantity": 123,
"note": "<string>",
"uom_id": 123,
"unit_of_measure": {
"id": 123,
"name": "<string>"
},
"order": 123,
"consumption_basis": "planned",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"extra_costs": [
{
"id": 123,
"name": "<string>",
"quantity": 123,
"unit_price": 123,
"line_total": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": 123,
"updated_by": 123,
"created_via": "user"
}
}
],
"sales_orders": [
{
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"order_id": "<string>",
"order_number": "<string>",
"order_date": "2023-12-25",
"payment_date": "2023-12-25",
"ship_by_date": "2023-12-25",
"age": 123,
"order_status": "<string>",
"customer_id": "<string>",
"customer_username": "<string>",
"customer_email": "<string>",
"bill_to": {},
"ship_to": {},
"requested_shipping_service": "<string>",
"total": 123,
"total_paid": 123,
"total_tax": 123,
"total_shipping": 123,
"customer_notes": "<string>",
"internal_notes": "<string>",
"ship_date": "2023-12-25",
"hold_until_date": "2023-12-25",
"earliest_ship_date": "2023-12-25",
"user_id": 123,
"externally_fulfilled": true,
"externally_fulfilled_by": "<string>",
"is_posted": true,
"posted_by": "<string>",
"not_sync": true,
"sales_posted": true,
"split_order": true,
"skip_inventory": true,
"skip_sales_report": true,
"channel_id": 123,
"total_order_cost": 123,
"total_order_quantity": 123,
"order_cost_details": {},
"source": "<string>",
"shipstation_order_id": "<string>",
"type": "<string>",
"parent_id": 123,
"shipping_revenue": 123,
"product_total": 123,
"total_discount": 123,
"picking_status": "<string>",
"starred_description": "<string>",
"customer_po_number": "<string>",
"company_id": 123,
"company": {
"id": 123456,
"status": "active",
"name": "Acme Corporation",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"type": "Retail",
"phone": "555-123-4567",
"address": "123 Main St",
"address_line_2": "Suite 500",
"city": "Austin",
"state": "TX",
"postal_code": "78701",
"country": "USA",
"full_address": "123 Main St, Suite 500, Austin, TX 78701, USA",
"shipping_first_name": "John",
"shipping_last_name": "Doe",
"shipping_email": "shipping@acmecorp.com",
"shipping_phone": "555-987-6543",
"shipping_address": "456 Warehouse Blvd",
"shipping_city": "Austin",
"shipping_state": "TX",
"shipping_postal_code": "78745",
"shipping_country": "USA",
"shipping_full_address": "456 Warehouse Blvd, Austin, TX 78745, USA",
"payment_term": "Net 30",
"tax_exempt": false,
"tax_rate": 8.25,
"due_date_days": 30,
"credit_limit": 5000,
"header_discount_enabled": false,
"header_discount_type": "PERCENT",
"header_discount_value": 5,
"header_discount_effective_from": "2026-01-01",
"default_currency_code": "USD",
"price_level": {
"id": 123,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"status": "active",
"name": "Wholesale",
"type": "percentage",
"percent_increase": 15.5
},
"notes": "Key account, requires special handling",
"fein": "12-3456789",
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"default_shipping": {
"id": 789,
"company_id": 123456,
"address": "456 Warehouse Blvd",
"city": "Austin",
"state": "TX",
"postal_code": "78745",
"country": "USA",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"company_name": "Acme Corporation",
"address_line_2": "Building 2",
"full_address": "456 Warehouse Blvd, Building 2, Austin, TX 78745, USA",
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"phone": "555-987-6543",
"email": "shipping@acmecorp.com",
"is_default": true
},
"shipping_addresses": [
{
"id": 789,
"company_id": 123456,
"address": "456 Warehouse Blvd",
"city": "Austin",
"state": "TX",
"postal_code": "78745",
"country": "USA",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"company_name": "Acme Corporation",
"address_line_2": "Building 2",
"full_address": "456 Warehouse Blvd, Building 2, Austin, TX 78745, USA",
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"phone": "555-987-6543",
"email": "shipping@acmecorp.com",
"is_default": true
}
],
"billing_info": {
"id": 456,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"first_name": "Jane",
"last_name": "Smith",
"email": "accounting@acmecorp.com",
"receiving_bank_name": "First National Bank",
"receiving_bank_address": "789 Finance Street, Austin, TX 78701"
},
"client_type": {
"id": 123,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"name": "Retail",
"description": "Retail business client"
},
"parent_company_id": 456,
"invoice_export_template_id": 789,
"custom_fields": {
"Industry": "Manufacturing",
"Region": "Southwest",
"Annual Revenue": "$5M-$10M"
},
"assigned_sales_reps": [
{
"id": 42,
"email": "rep@example.com",
"first_name": "Jane",
"last_name": "Doe"
}
],
"sales_channel": {
"id": 123,
"status": "<string>",
"label": "<string>",
"channel_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
},
"custom_fields": {},
"items": [
{
"id": 123,
"line_number": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"name": "<string>",
"image_url": "<string>",
"weight": {},
"quantity": 123,
"unit_price": 123,
"tax": 123,
"shipping": 123,
"warehouse_location": "<string>",
"options": {},
"fulfillment_sku": "<string>",
"adjustment": 123,
"upc": "<string>",
"stock_id": 123,
"kit_id": 123,
"non_physical_item": true,
"ignore_item": true,
"is_locally_added": true,
"quantity_shipped": 123,
"quantity_cancelled": 123,
"quantity_invoiced": 123,
"quantity_ordered": 123,
"base_uom_id": 123,
"ordered_uom_id": 123,
"product_id": 123,
"total_returned_base_quantity": 123,
"parent_id": 123,
"status": "<string>",
"discount": 123,
"estimated_ship_date": "2023-12-25",
"custom_fields": {},
"product": {
"id": 123,
"name": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123,
"unit_cost": 123,
"product_weight": 123,
"product_length": 123,
"product_width": 123,
"product_height": 123,
"sellable": true,
"discontinued": true,
"image_url": "<string>",
"category": {
"id": 123,
"name": "<string>"
},
"subcategory": {
"id": 123,
"name": "<string>"
},
"custom_fields": {},
"variant_attributes": {},
"sku": "<string>",
"alternate_skus": [
{
"id": 123,
"sku": "<string>"
}
],
"upc": "<string>",
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"supplier": {},
"type": "PRODUCT",
"kit_items": [
{
"id": 123,
"product_id": 123,
"quantity": 123,
"uom_id": 123,
"base_uom_quantity": 123,
"price": 123,
"original_price": 123,
"total": 123,
"product": {
"id": 123,
"name": "<string>",
"sku": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123
},
"unit_of_measure": {
"id": 123,
"name": "<string>",
"description": "<string>",
"base_unit": true
}
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>",
"discount_structure": {},
"markup_structure": {}
}
]
}
],
"fulfillment_orders": [
{
"id": 123,
"order_number": "<string>",
"order_key": "<string>",
"order_status": "<string>",
"sales_order_id": 123,
"warehouse_group_id": 123,
"destination_oms_id": 123,
"destination_oms_store_id": 123,
"fulfillment_channel_id": 123,
"pushed_at": "2023-11-07T05:31:56Z",
"packing_slip_printed_at": "2023-11-07T05:31:56Z",
"error_message": "<string>",
"ship_by_date": "2023-12-25",
"total": 123,
"bill_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"ship_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"invoice_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"sales_order": {},
"picklists": [
{}
],
"fulfillment_order_items": [
{
"id": 123,
"shipment_id": 123,
"status": "<unknown>",
"sales_order_item_id": 123,
"product_id": 123,
"sku": "<string>",
"name": "<string>",
"weight": "<unknown>",
"dimensions": "<unknown>",
"quantity": 123,
"unit_price": 123,
"lot_id": 123,
"lot_number": "<string>",
"expiry_date": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_kit_component": true,
"parent_fulfillment_order_item_id": 123,
"kit_sales_order_item_id": 123,
"is_synthetic": true
}
],
"total_weight": {
"total_oz": 123,
"total_lb": 123,
"line_count": 123,
"weighed_line_count": 123,
"is_complete": true
},
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"purchase_orders": [
{
"id": 123,
"order_status": "active"
}
],
"source_reference_identifier": "<string>",
"held_for_item_change": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>",
"discount_structure": {},
"markup_structure": {}
}
]
}
],
"fulfillment_orders": [
{
"id": 123,
"order_number": "<string>",
"order_key": "<string>",
"order_status": "<string>",
"sales_order_id": 123,
"warehouse_group_id": 123,
"destination_oms_id": 123,
"destination_oms_store_id": 123,
"fulfillment_channel_id": 123,
"pushed_at": "2023-11-07T05:31:56Z",
"packing_slip_printed_at": "2023-11-07T05:31:56Z",
"error_message": "<string>",
"ship_by_date": "2023-12-25",
"total": 123,
"bill_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"ship_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"invoice_to": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"street3": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>"
},
"sales_order": {},
"picklists": [
{}
],
"fulfillment_order_items": [
{
"id": 123,
"shipment_id": 123,
"status": "<unknown>",
"sales_order_item_id": 123,
"product_id": 123,
"sku": "<string>",
"name": "<string>",
"weight": "<unknown>",
"dimensions": "<unknown>",
"quantity": 123,
"unit_price": 123,
"lot_id": 123,
"lot_number": "<string>",
"expiry_date": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_kit_component": true,
"parent_fulfillment_order_item_id": 123,
"kit_sales_order_item_id": 123,
"is_synthetic": true
}
],
"total_weight": {
"total_oz": 123,
"total_lb": 123,
"line_count": 123,
"weighed_line_count": 123,
"is_complete": true
},
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"purchase_orders": [
{
"id": 123,
"order_status": "active"
}
],
"source_reference_identifier": "<string>",
"held_for_item_change": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 5,
"per_page": 10,
"to": 10,
"total": 50
}
}{
"error": "Unauthorized",
"message": "Authentication credentials are missing or invalid",
"status_code": 401
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Query Parameters
Page number for pagination
Number of items per page (max 100)
Required range:
x <= 100Filter by picklist ID
Filter by picklist status
Available options:
created, picking, picked, packed, deleted Filter by order number. Matches the linked sales order number, the linked fulfillment order's order number or order key, or the fulfillment order's parent sales order number.
Search by picklist ID (PL-618 or 618), or by partial order number or ship-to name on the linked sales order, the linked fulfillment order (order number only), or the fulfillment order's parent sales order.
Set to queue for a lighter list payload: items is returned empty and fulfillment orders omit line detail. Open a picklist with GET /pickflow/picklists/{id} for full detail.
Available options:
queue Filter by requested shipping service on the linked fulfillment order or sales order
Filter by sales channel label of the linked order
Filter by sales channel ID of the linked order
Filter by sales order tag
Filter by creation date
Filter by last update date