Inventory stock

curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/inventory/stocks \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "sku": "<string>",
      "name": "<string>",
      "type": "<string>",
      "qty_onhand": 123,
      "qty_pending": 123,
      "qty_available": 123,
      "qty_incoming": 123,
      "qty_backordered": 123,
      "qty_available_via_assembly": 123,
      "qty_recoverable_via_disassembly": 123,
      "qty_outstanding": 123,
      "current_landed_unit_cost": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "category_id": 123,
      "sub_category_id": 123,
      "category_name": "<string>",
      "sub_category_name": "<string>",
      "location_stocks": [
        {
          "id": 123,
          "warehouse": {
            "id": 123,
            "status": "<string>",
            "name": "<string>",
            "parent_id": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "location": {
            "id": 123,
            "status": "<string>",
            "name": "<string>",
            "parent_id": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "qty_onhand": 123,
          "qty_pending": 123,
          "qty_available": 123,
          "qty_incoming": 123,
          "qty_available_via_assembly": 123,
          "qty_recoverable_via_disassembly": 123,
          "current_landed_unit_cost": 123
        }
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}

Inventory

Inventory stock

Get a paginated list of inventory stock levels with various filter options.

For detailed information about the filtering system and available operators, refer to the Filter System Documentation.

⚠️ Important: Default Sorting and Pagination

By default, results are sorted by updated_at in descending order. This field changes frequently as stock levels are updated, which can cause issues when paginating through results:

Items may be skipped or duplicated between pages
The same item may appear on multiple pages
Some items may never appear if they’re updated while you’re paginating

Recommendation: When pulling all stocks or paginating through large datasets, use a more stable sort field such as:

product.id:asc - Sort by product ID (most stable)
product.sku:asc - Sort by product SKU
product.name:asc - Sort by product name

Example: ?sort=product.id:asc&per_page=100

Available Sort Fields

product.id - Sort by product ID
product.sku - Sort by product SKU
product.name - Sort by product name
updated_at - Sort by last stock update date (default: updated_at:desc)

Sort format: field:direction where direction is asc (ascending) or desc (descending).

Examples:

?sort=product.id:asc - Sort by product ID ascending
?sort=product.sku:desc - Sort by product SKU descending
?sort=product.name:asc - Sort by product name ascending
?sort=updated_at:asc - Sort by update date ascending (overrides default)

Available Filters

Inventory Filters

location: Filter by location ID
warehouse_ids: Filter by warehouse ID(s), comma-separated
warehouse_group_ids: Filter by warehouse group ID(s), comma-separated
qty_onhand: Filter by quantity on hand
qty_pending: Filter by pending quantity
qty_available: Filter by available quantity
qty_incoming: Filter by incoming quantity
qty_backordered: Filter by quantity backordered
qty_available_via_assembly: Filter by quantity available via assembly
qty_recoverable_via_disassembly: Filter by quantity recoverable via disassembly
qty_outstanding: Filter by quantity outstanding
updated_at: Filter by last stock update date
discontinued: Filter by discontinued status (0 = not discontinued, 1 = discontinued, 2+ = all)
sku: Filter by SKU (searches product name, internal SKU, UPC, and alternate SKUs)
product_name: Filter by product name
category_id: Filter by category ID(s), comma-separated
subcategory_ids: Filter by subcategory ID(s), comma-separated

Product String Filters

product.name: Product name
product.description: Product description
product.sku: Product SKU (searches both internal SKU and alternate SKUs)
product.upc: Product UPC/Barcode
product.tag: Product tags
product.q: General search matches name OR upc OR sku
product.category.name: Filter by category name
product.sub_category.name: Filter by sub-category name
product.supplier.name: Filter by supplier name

Product Integer Filters

product.id: Filter by product ID
product.category.id: Filter by category ID
product.sub_category.id: Filter by sub-category ID
product.supplier.id: Filter by supplier ID
product_type_id: Filter by product type ID

Product String Filters (Product Type)

product_type: Filter by product type

Product Float Filters

product.retail_price: Product retail price
product.wholesale_price: Product wholesale price
product.product_weight: Product weight
product.product_length: Product length (in inches)
product.product_width: Product width (in inches)
product.product_height: Product height (in inches)
product.box_length: Box length (in inches)
product.box_width: Box width (in inches)
product.box_height: Box height (in inches)
product.carton_length: Carton length (in inches)
product.carton_width: Carton width (in inches)
product.carton_height: Carton height (in inches)
product.shipping_length: Shipping length (in inches)
product.shipping_width: Shipping width (in inches)
product.shipping_height: Shipping height (in inches)
product.pallet_length: Pallet length (in inches)
product.pallet_width: Pallet width (in inches)
product.pallet_height: Pallet height (in inches)

Product String Filters (Dimension Weights)

product.box_weight: Box weight
product.carton_weight: Carton weight
product.shipping_weight: Shipping weight
product.pallet_weight: Pallet weight

Product Boolean Filters

product.sellable: If the product is sellable or not
product.discontinued: If the product is discontinued

Product DateTime Filters

product.created_at: When the product was created
product.updated_at: When the product was last updated

Examples

# Find stock for products by SKU
?product.sku[eq]=SKU-001

# Find stock for products by multiple SKUs
?product.sku[in]=SKU-001,SKU-002,SKU-003

# Find stock for specific product by ID
?product.id[eq]=12345

# Find stock for multiple products by ID
?product.id[in]=12345,67890,11111

# Find stock for products in specific price range
?product.retail_price[gte]=50.00&product.retail_price[lte]=100.00

# Find stock for recently updated products
?product.updated_at[gte]=2024-01-01 00:00:00

# Find stock for products where name contains "Partial text"
?product.name[contains]=Partial text

# Find stock for products in specific category and location
?product.category.name[eq]=Electronics&location=123

# Find stock for products from specific supplier in certain warehouses
?product.supplier.name[contains]=Acme&warehouse_ids=1,2,3

# Find stock with specific quantity levels
?qty_onhand[gte]=100&qty_available[gt]=0

# Find stock with low inventory
?qty_onhand[lte]=10

# Find stock with pending quantities
?qty_pending[gt]=0

# Find stock with incoming inventory
?qty_incoming[gte]=50

# Find stock with backordered quantities
?qty_backordered[gt]=0

# Find stock with assembly availability
?qty_available_via_assembly[gte]=10

# Find stock recoverable via disassembly
?qty_recoverable_via_disassembly[gt]=5

# Find stock with outstanding quantities
?qty_outstanding[gt]=0

# Find stock updated after a specific date
?updated_at[gte]=2024-01-01 00:00:00

# Find stock by product type
?product_type[eq]=KIT

# Find stock by product type ID
?product_type_id[eq]=1

# Find stock for sellable products only
?product.sellable=1

# Find stock for discontinued products
?product.discontinued=1

# Search across multiple product fields
?product.q[contains]=laptop

# Sort examples (recommended for pagination)
# Sort by product ID for stable pagination
?sort=product.id:asc&per_page=100

# Sort by product SKU
?sort=product.sku:asc

# Sort by product name
?sort=product.name:asc

# Sort by update date ascending (overrides default DESC)
?sort=updated_at:asc

# Combine sorting with filters
?product.category.id[eq]=5&sort=product.name:asc&per_page=50

GET

inventory

stocks

Inventory stock

curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/inventory/stocks \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "sku": "<string>",
      "name": "<string>",
      "type": "<string>",
      "qty_onhand": 123,
      "qty_pending": 123,
      "qty_available": 123,
      "qty_incoming": 123,
      "qty_backordered": 123,
      "qty_available_via_assembly": 123,
      "qty_recoverable_via_disassembly": 123,
      "qty_outstanding": 123,
      "current_landed_unit_cost": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "category_id": 123,
      "sub_category_id": 123,
      "category_name": "<string>",
      "sub_category_name": "<string>",
      "location_stocks": [
        {
          "id": 123,
          "warehouse": {
            "id": 123,
            "status": "<string>",
            "name": "<string>",
            "parent_id": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "location": {
            "id": 123,
            "status": "<string>",
            "name": "<string>",
            "parent_id": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "qty_onhand": 123,
          "qty_pending": 123,
          "qty_available": 123,
          "qty_incoming": 123,
          "qty_available_via_assembly": 123,
          "qty_recoverable_via_disassembly": 123,
          "current_landed_unit_cost": 123
        }
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}

Authorizations

Authorization

string

header

required

Authenticate using a bearer token. To obtain a token, contact developers@joinluminous.com

Query Parameters

page

integer

default:1

Page number for pagination

per_page

integer

default:100

Number of items per page

sort

string

default:updated_at:desc

Sort results by field and direction. Format: field:direction

⚠️ Warning: Default sorting by updated_at changes frequently and can cause pagination issues. For stable pagination, use product.id:asc, product.sku:asc, or product.name:asc.

Available sort fields:

product.id - Product ID
product.sku - Product SKU
product.name - Product name
updated_at - Last stock update date (default)

Examples:

product.id:asc - Sort by product ID ascending
product.sku:desc - Sort by product SKU descending
product.name:asc - Sort by product name ascending
updated_at:asc - Sort by update date ascending

location

integer

Filter by location ID

warehouse_ids

string

Filter by warehouse ID(s), comma-separated

warehouse_group_ids

string

Filter by warehouse group ID(s), comma-separated

qty_onhand

integer

Filter by quantity on hand

qty_pending

integer

Filter by pending quantity

qty_available

integer

Filter by available quantity

qty_incoming

integer

Filter by incoming quantity

qty_backordered

number<float>

Filter by quantity backordered

qty_available_via_assembly

number<float>

Filter by quantity available via assembly

qty_recoverable_via_disassembly

number<float>

Filter by quantity recoverable via disassembly

qty_outstanding

number<float>

Filter by quantity outstanding

updated_at

string<date-time>

Filter by last stock update date

discontinued

integer

Filter by discontinued status (0 = not discontinued, 1 = discontinued, 2+ = all)

sku

string

Filter by SKU (searches product name, internal SKU, UPC, and alternate SKUs)

product_name

string

Filter by product name

category_id

string

Filter by category ID(s), comma-separated

subcategory_ids

string

Filter by subcategory ID(s), comma-separated

product_type

string

Filter by product type

product_type_id

integer

Filter by product type ID

product.q

string

Filter by name OR upc OR sku

product.id

integer

Filter by product ID

product.name

string

Filter by product name

product.description

string

Filter by product description

product.sku

string

Filter by SKU (searches both internal and alternate SKUs)

product.upc

string

Filter by UPC/Barcode

product.sellable

boolean

Filter by sellable status

product.discontinued

boolean

Filter by whether the product is discontinued

product.retail_price

number<float>

Filter by retail price

product.wholesale_price

number<float>

Filter by wholesale price

product.created_at

string<date-time>

Filter by creation date

product.updated_at

string<date-time>

Filter by last update date

product.tag

string

Filter by product tags

product.category.id

integer

Filter by category ID

product.category.name

string

Filter by category name

product.sub_category.id

integer

Filter by sub-category ID

product.sub_category.name

string

Filter by sub-category name

product.supplier.id

integer

Filter by supplier ID

product.supplier.name

string

Filter by supplier name

Response

Successful response

data

object[]

Show child attributes

Products

Purchase Orders

Inventory

Transfer Orders

Receiving Reports

Sales Orders

Invoices

Tags

Custom Fields

Locations

Companies

Contacts

Pricing

BOMs

Inventory stock

⚠️ Important: Default Sorting and Pagination

Available Sort Fields

Available Filters

Inventory Filters

Product String Filters

Product Integer Filters

Product String Filters (Product Type)

Product Float Filters

Product String Filters (Dimension Weights)

Product Boolean Filters

Product DateTime Filters

Examples

Authorizations

Query Parameters

Response