Skip to main content
GET
/
stock-snapshot
Stock snapshot (JSON, CSV, or Excel)
curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/stock-snapshot \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {}
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}

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.

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

​
start_date
string
required

Start date in Y-m-d H:i:s format

Example:

"2025-01-01 00:00:00"

​
end_date
string
required

End date in Y-m-d H:i:s format, must be >= start_date

Example:

"2025-01-31 23:59:59"

​
warehouse_id
integer

Filter by warehouse ID

​
per_page
integer
default:10

Number of items per page (max 100)

Required range: x <= 100
​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
export
enum<string>

When set to excel or csv, returns a file download instead of JSON.

Available options:
excel,
csv
​
columns
string

JSON string of export column configuration (when exporting).

Response

Paginated snapshot rows

​
data
object[]
​
meta
object