> ## Documentation Index > Fetch the complete documentation index at: https://docs.joinluminous.com/llms.txt > Use this file to discover all available pages before exploring further. # 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](/filters). ## Available Filters ### Integer Filters - `id`: Picklist ID - `channel_id`: Sales channel ID of the linked order ### String Filters - `status`: Picklist status (`created`, `picking`, `picked`, `packed`, `deleted`) - `order_number`: Linked sales order number - `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 ### DateTime Filters - `created_at`: When the picklist was created - `updated_at`: When the picklist was last updated ## 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 ``` ## OpenAPI ````yaml /api-reference/build.yaml get /pickflow/picklists openapi: 3.0.0 info: title: Luminous API version: 1.0.0 description: API documentation for Luminous servers: - url: https://{companyName}.api.joinluminous.com/external/api/v1 variables: companyName: default: companyName description: Your company-specific subdomain security: [] tags: - name: Products description: Get and manage products - name: Pricing description: Manage price schedules, levels, and customizations - name: BOMs description: Manage Bills of Materials (BOMs) - name: Labels description: Label rendering via Labelary ZPL service - name: Companies description: Manage business accounts and their associated data - name: Contacts description: Manage contact information for individuals - name: Suppliers description: Manage suppliers (factories) — vendors used on purchase orders - name: Supplier SKUs description: Manage per-supplier SKU and unit-cost overrides for products - name: Locations description: Manage warehouses and locations - name: Inventory description: Get and adjust product stock levels - name: Lots description: Create, update, and delete product lots (batches) - name: Transfer Orders description: Manage transfer orders - name: Fulfillment Orders description: Manage fulfillment orders and picklists - name: Fulfillment Priority Lists description: Configure fulfillment routing priority lists - name: Purchase Orders description: Get and modify purchase orders - name: Supplier Portal description: >- Read a supplier's response to a purchase order and control the one-click portal link - name: Receiving Reports description: Manage receiving reports - name: Payment Obligations description: Manage payment obligations for purchase orders - name: Sales Orders description: Manage sales orders and sales order shipments - name: Purgatory description: >- Inspect and resolve non-posted sales orders in the purgatory staging workflow - name: PickFlow Shipping description: >- Provider-agnostic shipping rates, services, packages, and label purchase for PickFlow - name: Cycle Counts description: >- Create, drive, and post PickFlow cycle counts — batches, per-warehouse sessions, and CSV import/export - name: Print Stations description: List paired print stations and enqueue print jobs to them - name: Invoices description: Get and manage invoices - name: Work Orders description: >- Manage work orders — production lifecycle, steps, materials, links, shipments, and comments - name: Production Batches description: Group and manage work orders as production batches - name: Bills description: >- Accounts payable bill management, payments, attachments, allocations, and variance - name: Prepayments description: Manage vendor prepayments and applications - name: Vendor Credits description: Manage vendor credits and applications - name: Vendor Returns description: Manage vendor returns and credit generation - name: Customer Returns description: Manage customer returns (sales returns), receiving, and restock behavior - name: Stock Snapshot description: Point-in-time stock snapshots with export support - name: Consumption description: Consumption reports and exports - name: Inventory Aging description: Cost-layer-based inventory aging reports - name: Bills Reports description: Accounts payable bills aging reports - name: Forecast description: Materialized forecast data - name: Reports description: Close the books, inventory discrepancy, transaction COGS, and EDI reports - name: Tags description: Add/remove tags across various resources - name: Custom Fields description: Get and set custom fields across various resources - name: Currency description: Currency configuration, exchange rates, and conversion - name: Integration Mappings description: Manage integration mappings for external systems - name: Integration Field Mappings description: Manage field-level mappings between Luminous and external systems paths: /pickflow/picklists: get: tags: - Picklists summary: List picklists description: >- 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](/filters). ## Available Filters ### Integer Filters - `id`: Picklist ID - `channel_id`: Sales channel ID of the linked order ### String Filters - `status`: Picklist status (`created`, `picking`, `picked`, `packed`, `deleted`) - `order_number`: Linked sales order number - `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 ### DateTime Filters - `created_at`: When the picklist was created - `updated_at`: When the picklist was last updated ## 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 ``` operationId: listPicklists parameters: - in: query name: page schema: type: integer default: 1 description: Page number for pagination - in: query name: per_page schema: type: integer default: 10 maximum: 100 description: Number of items per page (max 100) - in: query name: id schema: type: integer description: Filter by picklist ID - in: query name: status schema: type: string enum: - created - picking - picked - packed - deleted description: Filter by picklist status - in: query name: order_number schema: type: string description: Filter by linked sales order number - in: query name: requested_shipping_service schema: type: string description: >- Filter by requested shipping service on the linked fulfillment order or sales order - in: query name: channel_name schema: type: string description: Filter by sales channel label of the linked order - in: query name: channel_id schema: type: integer description: Filter by sales channel ID of the linked order - in: query name: tag schema: type: string description: Filter by sales order tag - in: query name: created_at schema: type: string format: date-time description: Filter by creation date - in: query name: updated_at schema: type: string format: date-time description: Filter by last update date responses: '200': description: A paginated list of picklists. content: application/json: schema: type: object properties: data: type: array items: type: object description: >- A picklist groups the items to be picked for one or more fulfillment orders or sales orders, and tracks the picking/packing lifecycle. properties: id: type: integer description: Picklist ID example: 12 created_at: type: string format: date-time nullable: true example: '2026-09-01T14:20:00.000000Z' updated_at: type: string format: date-time nullable: true example: '2026-09-01T15:03:11.000000Z' status: type: string description: External picklist status. enum: - created - picking - picked - packed - deleted example: picking picking_started_at: type: string format: date-time nullable: true example: '2026-09-01T14:25:00.000000Z' picking_ended_at: type: string format: date-time nullable: true example: null packing_started_at: type: string format: date-time nullable: true example: null packing_ended_at: type: string format: date-time nullable: true example: null items: type: array description: The line items on this picklist. items: type: object description: >- A single line on a picklist — the product/RFQ to pick, from where, and how much. properties: id: type: integer description: Picklist item ID example: 4501 picklist_id: type: integer description: ID of the parent picklist example: 12 location_id: type: integer nullable: true description: >- ID of the inventory location the item is picked from example: 88 rfq_id: type: integer nullable: true description: ID of the product (RFQ) being picked example: 1023 available_quantity: type: number format: float nullable: true description: Quantity available to pick at the location example: 25 picked_quantity: type: number format: float nullable: true description: Quantity that has been picked so far example: 10 lot_id: type: integer nullable: true description: >- ID of the lot the item is picked from, when lot tracking applies example: 305 lot_number: type: string nullable: true description: >- Human-readable lot number the item is assigned to — the number printed on the carton. `null` for non-lot stock. Only reflects the eager-loaded lot. example: L-546 production_date: type: string format: date nullable: true description: >- Production date of the assigned lot (`YYYY-MM-DD`). `null` for non-lot stock. example: '2026-01-15' expiry_date: type: string format: date nullable: true description: >- Expiry date of the assigned lot (`YYYY-MM-DD`). `null` for non-lot stock. example: '2027-01-15' lot_deduction_strategy: type: string nullable: true description: >- Which lot Luminous would pick when a caller omits `lot_id`. `null` means no per-product override (the warehouse group setting, or newest-lot fallback, applies). PickFlow can suggest this to the picker. example: null uom_id: type: integer nullable: true description: >- ID of the unit of measure for the picked quantities example: 7 uom: description: >- Unit of measure for the picked quantities. Only present when loaded. nullable: true allOf: - type: object description: >- A single unit of measure (e.g. "Pound", "Kilogram") belonging to a unit class. properties: id: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time status: type: string nullable: true unit_class_id: type: integer unit_class: type: object description: Present when the relation is loaded. nullable: true properties: id: type: integer name: type: string base_class: type: boolean name: type: string description: type: string nullable: true base_unit: type: boolean description: >- True if this UOM is the base unit for its class. unit_conversion_rules: type: array description: Present when the relation is loaded. items: type: object description: > A rule converting from one unit of measure to another. `type=SYSTEM` rules apply globally for a class (e.g. 1 lb = 0.453592 kg). `type=SKU` rules override system rules for a specific product (`product_id`). properties: id: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time status: type: string nullable: true base_unit_of_measure_id: type: integer base_unit_of_measure: type: object description: Present when the relation is loaded. nullable: true properties: id: type: integer name: type: string unit_class_id: type: integer base_unit: type: boolean converted_unit_of_measure_id: type: integer converted_unit_of_measure: type: object description: Present when the relation is loaded. nullable: true properties: id: type: integer name: type: string unit_class_id: type: integer base_unit: type: boolean conversion_factor: type: number description: >- Multiply a quantity in `base_unit_of_measure` by this factor to get the quantity in `converted_unit_of_measure`. type: type: string enum: - SYSTEM - SKU product_id: type: integer nullable: true description: >- Required when `type=SKU`; null when `type=SYSTEM`. product: type: object nullable: true description: >- Present when the relation is loaded. Shape mirrors the standard product resource. additionalProperties: true product_alternate_skus: type: array description: Present when the relation is loaded. items: type: object additionalProperties: true created_at: type: string format: date-time nullable: true example: '2026-09-01T14:22:00.000000Z' updated_at: type: string format: date-time nullable: true example: '2026-09-01T15:03:11.000000Z' quantity_per_fulfillment_order: type: array description: >- Breakdown showing how this item's aggregated quantity is distributed across the fulfillment orders on the picklist. items: type: object properties: fulfillment_order_id: type: integer example: 9001 order_key: type: string nullable: true description: >- External order key of the fulfillment order, when available example: 114-2938471-0011 quantity: type: number format: float example: 6 sales_items: type: array description: >- The underlying sales items that make up this quantity. items: type: object properties: id: type: integer example: 77012 sku: type: string nullable: true example: WIDGET-BLUE name: type: string nullable: true example: Blue Widget quantity: type: number format: float example: 6 rfq_id: type: integer nullable: true example: 1023 kit_id: type: integer nullable: true description: >- Set when the sales item is a component of a kit example: null order_item_id: type: string nullable: true example: oi_88213 location: description: >- The inventory location the item is picked from. Only present when loaded. nullable: true allOf: - type: object properties: id: type: integer status: type: string name: type: string parent_id: type: integer nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time product: description: >- The product (RFQ) being picked. Only present when loaded. nullable: true allOf: - type: object properties: id: type: integer description: Unique identifier for the product name: type: string description: Product name description: type: string nullable: true description: Product description retail_price: type: number format: float description: Retail price wholesale_price: type: number format: float description: Wholesale price unit_cost: type: number format: float description: Cost per unit landed_cost: type: number format: float nullable: true description: Landed cost per unit manufacturing_fee: type: number format: float nullable: true description: Manufacturing fee per unit product_weight: type: array nullable: true items: type: object required: - unit - value properties: unit: type: string enum: - lb - oz description: Weight unit value: type: number format: float minimum: 0 description: Weight value product_weight_oz: type: number format: float nullable: true description: >- Total product weight in ounces (computed from product_weight) product_weight_lb: type: number format: float nullable: true description: >- Total product weight in pounds (computed from product_weight) dimensional_weight: type: array nullable: true items: type: object required: - unit - value properties: unit: type: string enum: - lb - oz description: Weight unit value: type: number format: float minimum: 0 description: Weight value dimensional_weight_oz: type: number format: float nullable: true description: >- Total dimensional weight in ounces (computed from dimensional_weight) dimensional_weight_lb: type: number format: float nullable: true description: >- Total dimensional weight in pounds (computed from dimensional_weight) product_length: type: number format: float description: Length of the product (in inches) product_width: type: number format: float description: Width of the product (in inches) product_height: type: number format: float description: Height of the product (in inches) box_weight: type: array nullable: true items: type: object required: - unit - value properties: unit: type: string enum: - lb - oz description: Weight unit value: type: number format: float minimum: 0 description: Weight value box_weight_oz: type: number format: float nullable: true description: >- Total box weight in ounces (computed from box_weight) box_weight_lb: type: number format: float nullable: true description: >- Total box weight in pounds (computed from box_weight) box_length: type: number format: float nullable: true description: Length of the box (in inches) box_width: type: number format: float nullable: true description: Width of the box (in inches) box_height: type: number format: float nullable: true description: Height of the box (in inches) carton_weight: type: array nullable: true items: type: object required: - unit - value properties: unit: type: string enum: - lb - oz description: Weight unit value: type: number format: float minimum: 0 description: Weight value carton_weight_oz: type: number format: float nullable: true description: >- Total carton weight in ounces (computed from carton_weight) carton_weight_lb: type: number format: float nullable: true description: >- Total carton weight in pounds (computed from carton_weight) carton_length: type: number format: float nullable: true description: Length of the carton (in inches) carton_width: type: number format: float nullable: true description: Width of the carton (in inches) carton_height: type: number format: float nullable: true description: Height of the carton (in inches) shipping_weight: type: array nullable: true items: type: object required: - unit - value properties: unit: type: string enum: - lb - oz description: Weight unit value: type: number format: float minimum: 0 description: Weight value shipping_weight_oz: type: number format: float nullable: true description: >- Total shipping weight in ounces (computed from shipping_weight) shipping_weight_lb: type: number format: float nullable: true description: >- Total shipping weight in pounds (computed from shipping_weight) shipping_length: type: number format: float nullable: true description: Shipping length (in inches) shipping_width: type: number format: float nullable: true description: Shipping width (in inches) shipping_height: type: number format: float nullable: true description: Shipping height (in inches) pallet_weight: type: array nullable: true items: type: object required: - unit - value properties: unit: type: string enum: - lb - oz description: Weight unit value: type: number format: float minimum: 0 description: Weight value pallet_weight_oz: type: number format: float nullable: true description: >- Total pallet weight in ounces (computed from pallet_weight) pallet_weight_lb: type: number format: float nullable: true description: >- Total pallet weight in pounds (computed from pallet_weight) pallet_length: type: number format: float nullable: true description: Length of the pallet (in inches) pallet_width: type: number format: float nullable: true description: Width of the pallet (in inches) pallet_height: type: number format: float nullable: true description: Height of the pallet (in inches) sellable: type: boolean description: Whether the product can be sold discontinued: type: boolean description: >- Whether the product is discontinued. Discontinued products will be hidden in the Luminous UI by default. is_drop_ship_item: type: boolean description: >- Whether the product is flagged as a drop-ship item. A preference marker only — it does not currently change fulfillment-order routing or purchase-order creation. taxable: type: boolean description: >- Whether the product is subject to sales tax. Defaults to true when not set. lot_tracking: type: boolean description: >- Whether lot (batch) tracking is enabled for this product. When true, on-hand stock is tracked per lot and lot-aware endpoints (e.g. `/lots`, the `lot_stocks` breakdown on inventory stock, and lot fields on adjustments/receiving) apply. lot_deduction_strategy: type: string nullable: true description: >- Which lot Luminous picks on its own when a caller omits `lot_id` on a lot-tracked pick or shipment. `null` means there is no per-product override, so the warehouse group's setting (or a newest-lot fallback) applies. PickFlow should suggest this lot to the picker so its suggestion matches what Luminous would have chosen. round_up_as_component: type: boolean description: >- Whether this product, when consumed as a BOM component, has its consumption quantity rounded up to whole units. Intended for discrete items (e.g. labels, boxes) that cannot be consumed fractionally. default_supply_method: type: string nullable: true enum: - purchase - vendor_supplied - assemble - on_hand - assembly_order - buy_and_ship - brand_supplied description: >- Default supply mode used when planning replenishment for this product image_url: type: string nullable: true description: URL to the product's main image category: type: object nullable: true properties: id: type: integer name: type: string description: Product category information subcategory: type: object nullable: true properties: id: type: integer name: type: string description: Product subcategory information custom_fields: type: object description: >- Dynamic custom fields with key-value pairs additionalProperties: type: string attachments: type: array description: Product attachments items: type: object properties: id: type: integer description: Unique identifier for the attachment name: type: string description: Filename of the attachment type: type: string description: MIME type of the attachment size: type: integer description: File size in bytes full_url: type: string description: Full resolution URL of the attachment thumb_url: type: string description: >- Thumbnail URL of the attachment (if applicable) required: - id - name - type - size - full_url variants: type: array description: Product variants items: type: object properties: id: type: integer name: type: string description: type: string nullable: true product_weight: type: array nullable: true items: type: object required: - unit - value properties: unit: type: string enum: - lb - oz description: Weight unit value: type: number format: float minimum: 0 description: Weight value product_weight_oz: type: number format: float nullable: true product_weight_lb: type: number format: float nullable: true dimensional_weight: type: array nullable: true items: type: object required: - unit - value properties: unit: type: string enum: - lb - oz description: Weight unit value: type: number format: float minimum: 0 description: Weight value dimensional_weight_oz: type: number format: float nullable: true dimensional_weight_lb: type: number format: float nullable: true box_weight: type: array nullable: true items: type: object required: - unit - value properties: unit: type: string enum: - lb - oz description: Weight unit value: type: number format: float minimum: 0 description: Weight value box_weight_oz: type: number format: float nullable: true box_weight_lb: type: number format: float nullable: true carton_weight: type: array nullable: true items: type: object required: - unit - value properties: unit: type: string enum: - lb - oz description: Weight unit value: type: number format: float minimum: 0 description: Weight value carton_weight_oz: type: number format: float nullable: true carton_weight_lb: type: number format: float nullable: true shipping_weight: type: array nullable: true items: type: object required: - unit - value properties: unit: type: string enum: - lb - oz description: Weight unit value: type: number format: float minimum: 0 description: Weight value shipping_weight_oz: type: number format: float nullable: true shipping_weight_lb: type: number format: float nullable: true pallet_weight: type: array nullable: true items: type: object required: - unit - value properties: unit: type: string enum: - lb - oz description: Weight unit value: type: number format: float minimum: 0 description: Weight value pallet_weight_oz: type: number format: float nullable: true pallet_weight_lb: type: number format: float nullable: true attachments: type: array description: Variant-specific attachments items: type: object properties: id: type: integer description: Unique identifier for the attachment name: type: string description: Filename of the attachment type: type: string description: MIME type of the attachment size: type: integer description: File size in bytes full_url: type: string description: Full resolution URL of the attachment thumb_url: type: string description: >- Thumbnail URL of the attachment (if applicable) required: - id - name - type - size - full_url retail_price: type: number format: float wholesale_price: type: number format: float custom_fields: type: array items: type: object variant_attributes: type: array nullable: true description: > The variant option terms this child SKU is assigned to (e.g. Size=Large, Color=Red). Returned in the same `[{variant_name, variant_terms[]}]` shape as the parent product's `variant_attributes` taxonomy, with each entry holding the term(s) selected for this child on that axis. items: type: object properties: variant_name: type: string description: Name of the variant axis (e.g. "Size") variant_terms: type: array description: >- Term value(s) selected for this child on that axis items: type: string sku: type: string upc: type: string hs_code: type: string nullable: true description: >- HS/HTS tariff code for the product (max 50 characters) round_up_as_component: type: boolean description: >- Whether this product, when consumed as a BOM component, has its consumption quantity rounded up to whole units. Intended for discrete items (e.g. labels, boxes) that cannot be consumed fractionally. created_at: type: string format: date-time updated_at: type: string format: date-time variant_attributes: type: array nullable: true description: > Variant option taxonomy for this product — the axes (e.g. Size, Color) and the allowed terms on each axis. On a parent product, this is the union of all terms used by its child variants. On a child variant, this holds the specific term(s) the child is assigned to. Set via the request field `product_variants` (same shape) on create/update. items: type: object properties: variant_name: type: string description: >- Name of the variant axis (e.g. "Size", "Color") variant_terms: type: array description: Terms on this axis items: type: string sku: type: string description: Internal SKU alternate_skus: type: array description: Alternate SKUs items: type: object properties: id: type: integer sku: type: string upc: type: string description: UPC/Barcode hs_code: type: string nullable: true description: >- HS/HTS tariff code for the product (max 50 characters) tags: type: array description: Tags associated with the product items: type: object properties: id: type: integer description: Unique identifier for the tag name: type: string description: Name of the tag description: type: string nullable: true description: Description of the tag icon: type: string nullable: true description: Icon identifier or URL for the tag color: type: string nullable: true description: Color code for the tag required: - id - name substitutions: type: array description: >- Product substitutions, these products may be substituted if the main product is out of stock items: type: object properties: id: type: integer description: Substitution record ID priority: type: integer description: >- Substitution priority (lower number = higher priority) product: type: object description: The substitute product properties: id: type: integer description: Unique identifier for the product name: type: string description: Product name description: type: string nullable: true description: Product description retail_price: type: number format: float description: Retail price wholesale_price: type: number format: float description: Wholesale price unit_cost: type: number format: float description: Cost per unit product_weight: type: array nullable: true items: type: object required: - unit - value properties: unit: type: string enum: - lb - oz description: Weight unit value: type: number format: float minimum: 0 description: Weight value product_weight_oz: type: number format: float nullable: true product_weight_lb: type: number format: float nullable: true dimensional_weight: type: array nullable: true items: type: object required: - unit - value properties: unit: type: string enum: - lb - oz description: Weight unit value: type: number format: float minimum: 0 description: Weight value dimensional_weight_oz: type: number format: float nullable: true dimensional_weight_lb: type: number format: float nullable: true product_length: type: number format: float description: Length of the product (in inches) product_width: type: number format: float description: Width of the product (in inches) product_height: type: number format: float description: Height of the product (in inches) box_weight: type: array nullable: true items: type: object required: - unit - value properties: unit: type: string enum: - lb - oz description: Weight unit value: type: number format: float minimum: 0 description: Weight value box_weight_oz: type: number format: float nullable: true box_weight_lb: type: number format: float nullable: true box_length: type: number format: float nullable: true description: Length of the box (in inches) box_width: type: number format: float nullable: true description: Width of the box (in inches) box_height: type: number format: float nullable: true description: Height of the box (in inches) carton_weight: type: array nullable: true items: type: object required: - unit - value properties: unit: type: string enum: - lb - oz description: Weight unit value: type: number format: float minimum: 0 description: Weight value carton_weight_oz: type: number format: float nullable: true carton_weight_lb: type: number format: float nullable: true carton_length: type: number format: float nullable: true description: Length of the carton (in inches) carton_width: type: number format: float nullable: true description: Width of the carton (in inches) carton_height: type: number format: float nullable: true description: Height of the carton (in inches) shipping_weight: type: array nullable: true items: type: object required: - unit - value properties: unit: type: string enum: - lb - oz description: Weight unit value: type: number format: float minimum: 0 description: Weight value shipping_weight_oz: type: number format: float nullable: true shipping_weight_lb: type: number format: float nullable: true shipping_length: type: number format: float nullable: true description: Shipping length (in inches) shipping_width: type: number format: float nullable: true description: Shipping width (in inches) shipping_height: type: number format: float nullable: true description: Shipping height (in inches) pallet_weight: type: array nullable: true items: type: object required: - unit - value properties: unit: type: string enum: - lb - oz description: Weight unit value: type: number format: float minimum: 0 description: Weight value pallet_weight_oz: type: number format: float nullable: true pallet_weight_lb: type: number format: float nullable: true pallet_length: type: number format: float nullable: true description: Length of the pallet (in inches) pallet_width: type: number format: float nullable: true description: Width of the pallet (in inches) pallet_height: type: number format: float nullable: true description: Height of the pallet (in inches) sellable: type: boolean description: Whether the product can be sold discontinued: type: boolean description: Whether the product is discontinued is_drop_ship_item: type: boolean description: >- Whether the product is flagged as a drop-ship item. A preference marker only — it does not currently change fulfillment-order routing or purchase-order creation. taxable: type: boolean description: >- Whether the product is subject to sales tax. Defaults to true when not set. image_url: type: string nullable: true description: URL to the product's main image sku: type: string description: Internal SKU upc: type: string description: UPC/Barcode hs_code: type: string nullable: true description: >- HS/HTS tariff code for the product (max 50 characters) round_up_as_component: type: boolean description: >- Whether this product, when consumed as a BOM component, has its consumption quantity rounded up to whole units. Intended for discrete items (e.g. labels, boxes) that cannot be consumed fractionally. created_at: type: string format: date-time description: Timestamp when the product was created updated_at: type: string format: date-time description: >- Timestamp when the product was last updated supplier: type: object nullable: true description: Supplier information type: type: string enum: - PRODUCT - KIT description: >- Product type. PRODUCT for regular products, KIT for kit products that contain other products as components. kit_items: type: array nullable: true description: >- Kit items (components) for kit products. Only present when type = KIT. items: type: object properties: id: type: integer description: Unique identifier for the kit item product_id: type: integer description: ID of the product component quantity: type: number format: float description: Quantity of this component in the kit uom_id: type: integer description: Unit of measure ID for the quantity base_uom_quantity: type: number format: float description: >- Quantity converted to base unit of measure price: type: number format: float description: Price for this kit item original_price: type: number format: float description: Original price for this kit item total: type: number format: float description: Calculated total (quantity * price) product: type: object nullable: true description: >- Product information for this kit item (when loaded) properties: id: type: integer name: type: string sku: type: string description: type: string nullable: true retail_price: type: number format: float wholesale_price: type: number format: float unit_of_measure: type: object nullable: true description: >- Unit of measure information (when loaded) properties: id: type: integer name: type: string description: type: string nullable: true base_unit: type: boolean priority_list: type: object nullable: true description: >- Fulfillment priority list assigned to this product properties: id: type: integer description: Priority list ID name: type: string description: Priority list name description: type: string nullable: true description: Priority list description distribution_template: type: object nullable: true description: > The distribution template (size curve) directly assigned to this product. Returns `null` when no template is assigned (the tenant default applies when resolving for production-run drafting). Use the dedicated `PUT /products/{productId}/distribution-template` endpoint to assign one. properties: id: type: integer description: Distribution template ID name: type: string description: Distribution template name source: type: string enum: - assigned description: >- Always `assigned` — only directly assigned templates are returned here. distribution_template_category: type: object nullable: true description: > The size-curve category assigned to this master SKU, used for category × warehouse resolution of a distribution template when no template is directly pinned. Returns `null` when no category is assigned. Use the dedicated `PUT /products/{productId}/distribution-template-category` endpoint to assign one. properties: id: type: integer description: Size-curve category ID name: type: string description: Size-curve category name boms: type: array description: >- BOMs (Bills of Materials) associated with this product items: type: object properties: id: type: integer description: Unique identifier for the BOM name: type: string description: BOM name items: type: array description: BOM items (components/products) items: type: object properties: id: type: integer description: Unique identifier for the BOM item bom_id: type: integer description: ID of the BOM this item belongs to product_id: type: integer description: ID of the product/component product: type: object nullable: true description: Product information (when loaded) properties: id: type: integer name: type: string sku: type: string description: type: string nullable: true quantity: type: number format: float description: Quantity required for this item base_quantity: type: number format: float description: >- Base quantity (converted to base unit of measure) note: type: string nullable: true description: Optional note for this item uom_id: type: integer nullable: true description: Unit of measure ID unit_of_measure: type: object nullable: true description: >- Unit of measure information (when loaded) properties: id: type: integer name: type: string order: type: integer nullable: true description: Display order for this item consumption_basis: type: string enum: - planned - actual description: >- Determines how much of this component an assembly/work order consumes. `planned` consumes the BOM-defined quantity; `actual` consumes the quantity actually reported during production. Defaults to `planned`. created_at: type: string format: date-time description: Timestamp when the item was created updated_at: type: string format: date-time description: Timestamp when the item was last updated required: - id - bom_id - product_id - quantity extra_costs: type: array description: Additional costs associated with the BOM items: type: object properties: id: type: integer description: Unique identifier for the extra cost name: type: string description: Name/description of the extra cost quantity: type: number format: float description: Quantity for this cost item unit_price: type: number format: float description: Unit price for this cost item line_total: type: number format: float description: >- Total cost (quantity × unit_price), calculated automatically on the backend. This field is read-only and should not be provided when creating or updating extra costs. created_at: type: string format: date-time description: >- Timestamp when the extra cost was created updated_at: type: string format: date-time description: >- Timestamp when the extra cost was last updated required: - id - name - quantity - unit_price - line_total created_at: type: string format: date-time description: Timestamp when the BOM was created updated_at: type: string format: date-time description: Timestamp when the BOM was last updated required: - id - name created_at: type: string format: date-time description: Timestamp when the product was created updated_at: type: string format: date-time description: >- Timestamp when the product was last updated sales_orders: type: array description: >- Sales orders linked to this picklist. Only present when loaded. A picklist attaches through either sales orders or fulfillment orders. items: type: object properties: id: type: integer description: Unique identifier for the sales order created_at: type: string format: date-time description: Timestamp when the order was created updated_at: type: string format: date-time description: Timestamp when the order was last updated status: type: string description: Current status of the order order_id: type: string description: External order identifier order_number: type: string description: Order number order_date: type: string format: date description: Date when the order was placed payment_date: type: string format: date description: Date when payment was received ship_by_date: type: string format: date description: Required ship by date age: type: integer description: Age of the order in days order_status: type: string description: Status of the order customer_id: type: string description: Customer identifier customer_username: type: string description: Customer's username customer_email: type: string description: Customer's email address bill_to: type: object description: Billing information ship_to: type: object description: Shipping information requested_shipping_service: type: string nullable: true description: >- What shipping service to use when shipping this order total: type: number format: float description: Total order amount total_paid: type: number format: float description: Amount paid total_tax: type: number format: float description: Total tax amount total_shipping: type: number format: float description: Total shipping amount customer_notes: type: string description: Notes from the customer internal_notes: type: string description: Internal notes ship_date: type: string format: date description: Date when order was shipped hold_until_date: type: string format: date description: Hold until date earliest_ship_date: type: string format: date nullable: true description: Earliest date the order can be shipped user_id: type: integer description: User ID associated with the order externally_fulfilled: type: boolean description: Whether the order is fulfilled externally externally_fulfilled_by: type: string description: Entity fulfilling the order externally is_posted: type: boolean description: Whether the order is posted posted_by: type: string description: User who posted the order not_sync: type: boolean description: Sync status sales_posted: type: boolean description: Sales posting status split_order: type: boolean description: Whether the order is split skip_inventory: type: boolean description: Whether to skip inventory skip_sales_report: type: boolean description: Whether to skip sales report channel_id: type: integer description: Channel identifier total_order_cost: type: number format: float description: Total cost of order total_order_quantity: type: number format: float description: Total quantity of items order_cost_details: type: object description: Detailed order cost information source: type: string description: Order source shipstation_order_id: type: string description: ShipStation order identifier type: type: string description: Order type parent_id: type: integer description: Parent order ID if applicable shipping_revenue: type: number format: float description: Revenue from shipping product_total: type: number format: float description: Total product amount total_discount: type: number format: float description: Total discount amount picking_status: type: string description: Status of picking process starred_description: type: string description: Description for starred orders customer_po_number: type: string description: Customer PO number company_id: type: integer nullable: true description: >- ID of the company (business account) associated with this sales order. Only present when a company is associated with the order. example: 123 company: nullable: true description: >- Full company (business account) details associated with this sales order. Only present when a company is associated with the order. type: object properties: id: type: integer description: Unique identifier for the company example: 123456 created_at: type: string format: date-time description: When the company was created example: '2023-03-15T14:30:00Z' updated_at: type: string format: date-time description: When the company was last updated example: '2023-03-15T14:30:00Z' status: type: string description: Status of the company enum: - active - inactive example: active name: type: string description: Company name example: Acme Corporation type: type: string nullable: true description: Type of business example: Retail phone: type: string nullable: true description: Primary phone number for the company example: 555-123-4567 address: type: string nullable: true description: Street address for the company example: 123 Main St address_line_2: type: string nullable: true description: Additional address information example: Suite 500 city: type: string nullable: true description: City example: Austin state: type: string nullable: true description: State/province example: TX postal_code: type: string nullable: true description: Postal/ZIP code example: '78701' country: type: string nullable: true description: Country example: USA full_address: type: string nullable: true description: Complete formatted address example: >- 123 Main St, Suite 500, Austin, TX 78701, USA shipping_first_name: type: string nullable: true description: >- First name for shipping contact (legacy field) example: John shipping_last_name: type: string nullable: true description: >- Last name for shipping contact (legacy field) example: Doe shipping_email: type: string format: email nullable: true description: Email for shipping contact (legacy field) example: shipping@acmecorp.com shipping_phone: type: string nullable: true description: >- Phone number for shipping contact (legacy field) example: 555-987-6543 shipping_address: type: string nullable: true description: Shipping street address (legacy field) example: 456 Warehouse Blvd shipping_city: type: string nullable: true description: Shipping city (legacy field) example: Austin shipping_state: type: string nullable: true description: Shipping state/province (legacy field) example: TX shipping_postal_code: type: string nullable: true description: Shipping postal/ZIP code (legacy field) example: '78745' shipping_country: type: string nullable: true description: Shipping country (legacy field) example: USA shipping_full_address: type: string nullable: true description: >- Complete formatted shipping address (legacy field) example: 456 Warehouse Blvd, Austin, TX 78745, USA payment_term: type: string nullable: true description: Payment terms for the company example: Net 30 tax_exempt: type: boolean nullable: true description: Whether the company is exempt from taxes example: false tax_rate: type: number format: float nullable: true description: Tax rate applied to the company's orders example: 8.25 due_date_days: type: integer nullable: true description: Number of days until payment is due example: 30 header_discount_enabled: type: boolean description: >- Whether an order-header trade discount is applied by default for this company example: false header_discount_type: type: string nullable: true enum: - PERCENT - FIXED_AMOUNT description: >- How the header discount is calculated — a percentage of the order or a fixed amount example: PERCENT header_discount_value: type: number format: float nullable: true description: >- The header discount amount — a percentage when `header_discount_type` is `PERCENT`, otherwise a fixed currency amount example: 5 header_discount_effective_from: type: string format: date nullable: true description: >- Date from which the header discount takes effect (YYYY-MM-DD) example: '2026-01-01' default_currency_code: type: string nullable: true description: >- Default ISO 4217 currency code for this company. Auto-applied to new orders created for the company. example: USD price_level: nullable: true description: Price level associated with this company type: object properties: id: type: number description: Unique identifier for the price level example: 123 created_at: type: string format: date-time description: When the price level was created example: '2023-03-15T14:30:00Z' updated_at: type: string format: date-time description: When the price level was last updated example: '2023-03-15T14:30:00Z' status: type: string description: Status of the price level enum: - active - inactive example: active name: type: string description: Name of the price level example: Wholesale type: type: string description: Type of the price level example: percentage percent_increase: type: number format: float description: >- Percentage increase (or decrease) for this price level example: 15.5 notes: type: string nullable: true description: Additional notes about the company example: Key account, requires special handling fein: type: string nullable: true description: Federal Employer Identification Number example: 12-3456789 tags: type: array nullable: true description: List of tags associated with the company items: type: object properties: id: type: integer description: Unique identifier for the tag name: type: string description: Name of the tag description: type: string nullable: true description: Description of the tag icon: type: string nullable: true description: Icon identifier or URL for the tag color: type: string nullable: true description: Color code for the tag required: - id - name default_shipping: nullable: true description: Default shipping address type: object properties: id: type: integer description: >- Unique identifier for the shipping address example: 789 created_at: type: string format: date-time description: When the shipping address was created example: '2023-03-15T14:30:00Z' updated_at: type: string format: date-time description: >- When the shipping address was last updated example: '2023-03-15T14:30:00Z' company_id: type: integer description: >- ID of the company this shipping address belongs to example: 123456 company_name: type: string nullable: true description: Name of the company example: Acme Corporation address: type: string description: Street address example: 456 Warehouse Blvd address_line_2: type: string nullable: true description: Additional address information example: Building 2 city: type: string description: City example: Austin state: type: string description: State/province example: TX postal_code: type: string description: Postal/ZIP code example: '78745' country: type: string description: Country example: USA full_address: type: string description: Complete formatted address example: >- 456 Warehouse Blvd, Building 2, Austin, TX 78745, USA full_name: type: string description: Full name of the contact person example: John Doe first_name: type: string nullable: true description: First name of the contact person example: John last_name: type: string nullable: true description: Last name of the contact person example: Doe phone: type: string nullable: true description: Phone number example: 555-987-6543 email: type: string format: email nullable: true description: Email address example: shipping@acmecorp.com is_default: type: boolean description: >- Whether this is the default shipping address example: true required: - id - company_id - address - city - state - postal_code - country shipping_addresses: type: array nullable: true description: List of shipping addresses for the company items: type: object properties: id: type: integer description: >- Unique identifier for the shipping address example: 789 created_at: type: string format: date-time description: When the shipping address was created example: '2023-03-15T14:30:00Z' updated_at: type: string format: date-time description: >- When the shipping address was last updated example: '2023-03-15T14:30:00Z' company_id: type: integer description: >- ID of the company this shipping address belongs to example: 123456 company_name: type: string nullable: true description: Name of the company example: Acme Corporation address: type: string description: Street address example: 456 Warehouse Blvd address_line_2: type: string nullable: true description: Additional address information example: Building 2 city: type: string description: City example: Austin state: type: string description: State/province example: TX postal_code: type: string description: Postal/ZIP code example: '78745' country: type: string description: Country example: USA full_address: type: string description: Complete formatted address example: >- 456 Warehouse Blvd, Building 2, Austin, TX 78745, USA full_name: type: string description: Full name of the contact person example: John Doe first_name: type: string nullable: true description: First name of the contact person example: John last_name: type: string nullable: true description: Last name of the contact person example: Doe phone: type: string nullable: true description: Phone number example: 555-987-6543 email: type: string format: email nullable: true description: Email address example: shipping@acmecorp.com is_default: type: boolean description: >- Whether this is the default shipping address example: true required: - id - company_id - address - city - state - postal_code - country billing_info: type: object nullable: true description: Billing information properties: id: type: integer example: 456 created_at: type: string format: date-time example: '2023-03-15T14:30:00Z' updated_at: type: string format: date-time example: '2023-03-15T14:30:00Z' first_name: type: string nullable: true example: Jane last_name: type: string nullable: true example: Smith email: type: string format: email nullable: true example: accounting@acmecorp.com receiving_bank_name: type: string nullable: true example: First National Bank receiving_bank_address: type: string nullable: true example: 789 Finance Street, Austin, TX 78701 client_type: type: object nullable: true description: Type of client properties: id: type: integer example: 123 created_at: type: string format: date-time example: '2023-03-15T14:30:00Z' updated_at: type: string format: date-time example: '2023-03-15T14:30:00Z' name: type: string example: Retail description: type: string nullable: true example: Retail business client parent_company_id: type: integer nullable: true description: ID of the parent company example: 456 invoice_export_template_id: type: integer nullable: true description: ID of the invoice export template example: 789 custom_fields: type: object description: Custom fields for the company example: Industry: Manufacturing Region: Southwest Annual Revenue: $5M-$10M assigned_sales_reps: type: array description: > Sales rep users assigned to this company (Go Team members). Resolved from the company's `goTeamMember.user` relation. Only present when the relation is loaded. items: type: object properties: id: type: integer description: User ID of the assigned sales rep example: 42 email: type: string description: >- Email of the assigned sales rep (PII-hashed when PII filtering is enabled) example: rep@example.com first_name: type: string nullable: true example: Jane last_name: type: string nullable: true example: Doe sales_channel: allOf: - type: object properties: id: type: integer description: Sales channel ID. status: type: string description: Sales channel status (e.g. active). label: type: string nullable: true description: Human-readable channel label. channel_type: type: string nullable: true description: >- Channel type (e.g. the integration/platform the channel represents). created_at: type: string format: date-time updated_at: type: string format: date-time nullable: true description: >- The company's default sales channel. Only present when the relation is loaded. required: - id - name - status custom_fields: type: object description: Dynamic custom fields with key-value pairs additionalProperties: type: string items: type: array items: type: object properties: id: type: integer description: Unique identifier for the order item line_number: type: integer description: >- Sequential line number for this item on the sales order, only unique within the order, starts at 1 created_at: type: string format: date-time description: Creation timestamp updated_at: type: string format: date-time description: Last update timestamp sku: type: string description: Stock keeping unit name: type: string description: Product name image_url: type: string description: URL of product image weight: type: object description: Weight information quantity: type: number format: float description: Ordered quantity unit_price: type: number format: float description: Price per unit tax: type: number format: float description: Tax amount shipping: type: number format: float description: Shipping amount warehouse_location: type: string description: Location in warehouse options: type: object description: Additional options fulfillment_sku: type: string description: SKU used for fulfillment adjustment: type: number format: float description: Price adjustment upc: type: string description: Universal Product Code stock_id: type: integer description: Stock identifier kit_id: type: integer description: Kit identifier if part of a kit non_physical_item: type: boolean description: Whether item is non-physical ignore_item: type: boolean description: Whether to ignore this item quantity_shipped: type: number format: float description: Quantity shipped quantity_cancelled: type: number format: float description: Quantity cancelled quantity_invoiced: type: number format: float description: Quantity invoiced quantity_ordered: type: number format: float description: >- Quantity ordered, expressed in the product's base unit of measure. When the line was ordered in a non-base unit (see `ordered_uom_id`), this is the converted base-unit equivalent, not the originally submitted quantity. base_uom_id: type: integer description: >- ID of the product's base unit of measure — the unit `quantity_ordered` is expressed in. ordered_uom_id: type: integer description: >- ID of the unit of measure the line was ordered in (the `uom_id` submitted on create). May differ from `base_uom_id` when ordering in a non-base unit. product_id: type: integer description: Product identifier total_returned_base_quantity: type: number format: float description: Total quantity returned parent_id: type: integer description: Parent item ID status: type: string description: Item status discount: type: number format: float description: Discount amount estimated_ship_date: type: string format: date description: Estimated shipping date custom_fields: type: object description: >- Dynamic custom fields with key-value pairs additionalProperties: type: string product: type: object description: Product information properties: id: type: integer description: Unique identifier for the product name: type: string description: Product name description: type: string nullable: true description: Product description retail_price: type: number format: float description: Retail price wholesale_price: type: number format: float description: Wholesale price unit_cost: type: number format: float description: Cost per unit product_weight: type: number format: float description: Weight of the product product_length: type: number format: float description: Length of the product (in inches) product_width: type: number format: float description: Width of the product (in inches) product_height: type: number format: float description: Height of the product (in inches) sellable: type: boolean description: Whether the product can be sold discontinued: type: boolean description: >- Whether the product is discontinued. Discontinued products will be hidden in the Luminous UI by default. image_url: type: string nullable: true description: URL to the product's main image category: type: object nullable: true properties: id: type: integer name: type: string description: Product category information subcategory: type: object nullable: true properties: id: type: integer name: type: string description: Product subcategory information custom_fields: type: object description: >- Dynamic custom fields with key-value pairs additionalProperties: type: string variant_attributes: type: object nullable: true description: Available variant attributes sku: type: string description: Internal SKU alternate_skus: type: array description: Alternate SKUs items: type: object properties: id: type: integer sku: type: string upc: type: string description: UPC/Barcode tags: type: array description: Tags associated with the product items: type: object properties: id: type: integer description: Unique identifier for the tag name: type: string description: Name of the tag description: type: string nullable: true description: Description of the tag icon: type: string nullable: true description: Icon identifier or URL for the tag color: type: string nullable: true description: Color code for the tag required: - id - name supplier: type: object nullable: true description: Supplier information created_at: type: string format: date-time description: Timestamp when the product was created updated_at: type: string format: date-time description: >- Timestamp when the product was last updated tags: type: array items: type: object properties: id: type: integer name: type: string description: type: string icon: type: string color: type: string discount_structure: type: object markup_structure: type: object description: >- Tags associated with the sales order item description: Line items in the order tags: type: array items: type: object properties: id: type: integer name: type: string description: type: string icon: type: string color: type: string discount_structure: type: object markup_structure: type: object description: Tags associated with the order fulfillment_orders: type: array description: >- Fulfillment orders linked to this picklist. Only present when loaded. A picklist attaches through either fulfillment orders or sales orders. items: type: object properties: id: type: integer description: Fulfillment order ID order_number: type: string description: Fulfillment order number order_key: type: string nullable: true description: Fulfillment order key order_status: type: string description: Fulfillment order status sales_order_id: type: integer description: Associated sales order ID warehouse_group_id: type: integer nullable: true description: Warehouse group ID destination_oms_id: type: integer nullable: true description: Destination app integration account ID destination_oms_store_id: type: integer nullable: true fulfillment_channel_id: type: integer nullable: true pushed_at: type: string format: date-time nullable: true error_message: type: string nullable: true description: >- Last push error from the destination OMS, when the fulfillment order is in Error status ship_by_date: type: string format: date nullable: true description: Ship by date total: type: number format: float nullable: true description: Order total bill_to: type: object nullable: true description: Billing address properties: name: type: string company: type: string street1: type: string street2: type: string street3: type: string city: type: string state: type: string postal_code: type: string country: type: string phone: type: string ship_to: type: object nullable: true description: Shipping address properties: name: type: string company: type: string street1: type: string street2: type: string street3: type: string city: type: string state: type: string postal_code: type: string country: type: string phone: type: string invoice_to: type: object nullable: true description: Invoice address properties: name: type: string company: type: string street1: type: string street2: type: string street3: type: string city: type: string state: type: string postal_code: type: string country: type: string phone: type: string sales_order: type: object nullable: true description: Nested sales order data picklists: type: array description: Associated picklists items: type: object fulfillment_order_items: type: array description: Fulfillment order line items items: type: object total_weight: type: object nullable: true description: >- Total product weight of this fulfillment order's own lines, at the fulfillment quantity. Present only when the line items are loaded. A product with no recorded weight contributes nothing, so a total of `0` usually means "weight unknown" rather than "weightless" — check `is_complete` before treating the total as authoritative. properties: total_oz: type: number format: float description: Total weight in ounces total_lb: type: number format: float description: Total weight in pounds line_count: type: integer description: Number of fulfillment order lines weighed_line_count: type: integer description: >- Number of lines that had a usable weight and contributed to the total is_complete: type: boolean description: >- True only when there is at least one line and every line contributed a weight. When false, the total omits one or more lines whose product has no recorded weight. tags: type: array description: >- Tags attached directly to this fulfillment order. Present when the relation is loaded. Tags inherited from the parent sales order are not included. items: type: object properties: id: type: integer description: Unique identifier for the tag name: type: string description: Name of the tag description: type: string nullable: true description: Description of the tag icon: type: string nullable: true description: Icon identifier or URL for the tag color: type: string nullable: true description: Color code for the tag required: - id - name purchase_orders: type: array description: >- Linked purchase orders. Present when the relation is loaded; deduplicated by ID. items: type: object properties: id: type: integer order_status: type: string nullable: true enum: - active - deleted - completed source_reference_identifier: type: string nullable: true description: >- The source system's reference identifier for this fulfillment order (e.g. the originating OMS order ID) created_at: type: string format: date-time description: When the fulfillment order was created updated_at: type: string format: date-time description: When the fulfillment order was last updated meta: type: object properties: current_page: type: integer description: The current page number example: 1 from: type: integer description: The starting index of the paginated results example: 1 last_page: type: integer description: The last page number example: 5 per_page: type: integer description: Number of items per page example: 10 to: type: integer description: The ending index of the paginated results example: 10 total: type: integer description: Total number of items across all pages example: 50 '401': description: Authentication credentials were missing or invalid content: application/json: schema: type: object properties: error: type: string example: Unauthorized message: type: string example: Authentication credentials are missing or invalid status_code: type: integer example: 401 security: - BearerAuth: [] components: securitySchemes: BearerAuth: type: http scheme: bearer description: >- Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token. ````