Skip to main content
GET
/
warehouses
Warehouses
curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/warehouses \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "status": "<string>",
      "name": "<string>",
      "address": "<string>",
      "street_address_1": "<string>",
      "street_address_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "is_pick_location": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}

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

​
page
integer
default:1

Page number for pagination

​
per_page
integer
default:10

Number of items per page (max 100)

Required range: x <= 100
​
name
string

Filter by warehouse name

Response

Successful response

​
data
object[]
​
meta
object