Export inventory stock (cursor pagination)

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

import requests

url = "https://{companyName}.api.joinluminous.com/external/api/v1/inventory/stocks/export"

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/inventory/stocks/export', 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/inventory/stocks/export",
  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/inventory/stocks/export"

	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/inventory/stocks/export")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/inventory/stocks/export")

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": 123,
      "sku": "<string>",
      "name": "<string>",
      "type": "<string>",
      "category_id": 123,
      "category_name": "<string>",
      "sub_category_id": 123,
      "sub_category_name": "<string>",
      "qty_onhand": 123,
      "qty_incoming": 123,
      "qty_available": 123,
      "qty_pending": 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",
      "location_stocks": [
        {
          "id": 123,
          "warehouse": {
            "id": 123,
            "status": "<string>",
            "name": "<string>",
            "parent_id": 123,
            "parent": "<unknown>",
            "is_pick_location": true,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "location": {
            "id": 123,
            "status": "<string>",
            "name": "<string>",
            "parent_id": 123,
            "parent": "<unknown>",
            "is_pick_location": true,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "qty_onhand": 123,
          "qty_incoming": 123,
          "qty_pending": 123,
          "qty_available": 123,
          "qty_available_via_assembly": 123,
          "qty_recoverable_via_disassembly": 123,
          "current_landed_unit_cost": 123,
          "lot_stocks": [
            {
              "lot_id": 123,
              "lot_number": "<string>",
              "production_date": "2023-12-25",
              "expiry_date": "2023-12-25",
              "location_id": 123,
              "qty_onhand": 123
            }
          ]
        }
      ]
    }
  ],
  "next_cursor": "<string>",
  "has_more": true,
  "meta": {
    "rows": 1
  }
}

{
  "error": "Unauthorized",
  "message": "Authentication credentials are missing or invalid",
  "status_code": 401
}

{
  "message": "<string>",
  "errors": {}
}

Inventory

Export inventory stock (cursor pagination)

Bulk-export stock for all active products (status > 0) using cursor-based keyset pagination. Designed for full inventory syncs and reporting pipelines that need every product’s warehouse, location, and lot-level stock in one pass.

Each row aggregates warehouse-level quantities and a per-location breakdown, with per-lot detail for lot-tracked products and FIFO landed unit cost at both the product and warehouse level.

Pagination

Parameter	Description
`cursor`	Opaque token from `next_cursor` on the previous response. Omit on the first page.
`limit`	Max products per page. Default `100`, maximum `1000`.

Pages are ordered ascending by product id (keyset). The run is anchored to a fixed cutoff captured on the first request, so pages stay stable while records change mid-run.

Example flow

# 1. Start a run
GET /inventory/stocks/export?limit=1000

# 2. Continue while has_more is true
GET /inventory/stocks/export?cursor=<next_cursor>

# 3. Stop when has_more is false

Notes

The cursor is cryptographically signed; do not modify it.
Only cursor and limit are accepted. Any other query parameter returns a 422. Some deployments rewrite to index.php?q=$uri&$args; the server ignores the q query parameter during validation.

GET

inventory

stocks

export

Export inventory stock (cursor pagination)

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

import requests

url = "https://{companyName}.api.joinluminous.com/external/api/v1/inventory/stocks/export"

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/inventory/stocks/export', 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/inventory/stocks/export",
  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/inventory/stocks/export"

	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/inventory/stocks/export")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/inventory/stocks/export")

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": 123,
      "sku": "<string>",
      "name": "<string>",
      "type": "<string>",
      "category_id": 123,
      "category_name": "<string>",
      "sub_category_id": 123,
      "sub_category_name": "<string>",
      "qty_onhand": 123,
      "qty_incoming": 123,
      "qty_available": 123,
      "qty_pending": 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",
      "location_stocks": [
        {
          "id": 123,
          "warehouse": {
            "id": 123,
            "status": "<string>",
            "name": "<string>",
            "parent_id": 123,
            "parent": "<unknown>",
            "is_pick_location": true,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "location": {
            "id": 123,
            "status": "<string>",
            "name": "<string>",
            "parent_id": 123,
            "parent": "<unknown>",
            "is_pick_location": true,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "qty_onhand": 123,
          "qty_incoming": 123,
          "qty_pending": 123,
          "qty_available": 123,
          "qty_available_via_assembly": 123,
          "qty_recoverable_via_disassembly": 123,
          "current_landed_unit_cost": 123,
          "lot_stocks": [
            {
              "lot_id": 123,
              "lot_number": "<string>",
              "production_date": "2023-12-25",
              "expiry_date": "2023-12-25",
              "location_id": 123,
              "qty_onhand": 123
            }
          ]
        }
      ]
    }
  ],
  "next_cursor": "<string>",
  "has_more": true,
  "meta": {
    "rows": 1
  }
}

{
  "error": "Unauthorized",
  "message": "Authentication credentials are missing or invalid",
  "status_code": 401
}

{
  "message": "<string>",
  "errors": {}
}

Authorizations

Authorization

string

header

required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Query Parameters

cursor

string

Signed continuation token from a previous response's next_cursor. Omit on the first page.

limit

integer

default:100

Maximum number of products to return per page.

Required range: 1 <= x <= 1000

Response

Successful export page

data

object[]

required

Show child attributes

next_cursor

string | null

required

Signed cursor token to fetch the next page. null when the export is complete.

has_more

boolean

required

true when the page is full (data.length === limit), indicating more rows may exist.

Products & Catalog

Companies & Contacts

Inventory & Warehousing

Purchasing

Sales & Fulfillment

Manufacturing

Accounts Payable

Reports & Analytics

Configuration

Integrations

Export inventory stock (cursor pagination)

Pagination

Example flow

Notes

Authorizations

Query Parameters

Response