Skip to main content
GET
/
v1
/
locations
curl --location 'https://api.stateset.com/v1/locations?type=warehouse&status=active' \
--header 'Authorization: Bearer YOUR_API_KEY'

{
  "object": "list",
  "data": [
    {
      "id": "loc_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
      "object": "location",
      "name": "West Coast Distribution Center",
      "code": "WH-WEST-01",
      "type": "warehouse",
      "status": "active",
      "address": {
        "city": "Los Angeles",
        "state": "CA",
        "country": "US"
      },
      "capabilities": ["storage", "fulfillment", "returns"],
      "capacity": {
        "utilization_percent": 4.0,
        "available_units": 4850
      }
    },
    {
      "id": "loc_7823f083-bb2c-54d6-bf6d-1b8e3fc75f41",
      "object": "location",
      "name": "East Coast Fulfillment Center",
      "code": "WH-EAST-01",
      "type": "warehouse",
      "status": "active",
      "address": {
        "city": "Newark",
        "state": "NJ",
        "country": "US"
      },
      "capabilities": ["storage", "fulfillment", "cross_dock"],
      "capacity": {
        "utilization_percent": 65.0,
        "available_units": 1750
      }
    }
  ],
  "has_more": true,
  "total_count": 8
}

Documentation Index

Fetch the complete documentation index at: https://docs.stateset.com/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint retrieves a paginated list of locations. Use filters to narrow results by type, capabilities, and status.

​
Authentication

This endpoint requires a valid API key with locations:read permissions. 
Authorization: Bearer YOUR_API_KEY

​
Query Parameters

​
limit
integer
Number of items to return (default: 20, max: 100)
​
offset
integer
Number of items to skip
​
type
string
Filter by type: “warehouse”, “store”, “distribution_center”, “dropship”
​
status
string
Filter by status: “active”, “inactive”, “maintenance”
​
capabilities
array
Filter by capabilities: “storage”, “fulfillment”, “returns”, “cross_dock”, “pickup”
​
country
string
Filter by country code
​
state
string
Filter by state/province
​
city
string
Filter by city
​
sort_by
string
Sort field: “created_at”, “name”, “code”, “capacity”
​
sort_order
string
Sort order: “asc” or “desc”

​
Response

​
object
string
Object type, always “list”
​
data
array
Array of location objects
​
has_more
boolean
Whether more items exist
curl --location 'https://api.stateset.com/v1/locations?type=warehouse&status=active' \
--header 'Authorization: Bearer YOUR_API_KEY'

{
  "object": "list",
  "data": [
    {
      "id": "loc_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
      "object": "location",
      "name": "West Coast Distribution Center",
      "code": "WH-WEST-01",
      "type": "warehouse",
      "status": "active",
      "address": {
        "city": "Los Angeles",
        "state": "CA",
        "country": "US"
      },
      "capabilities": ["storage", "fulfillment", "returns"],
      "capacity": {
        "utilization_percent": 4.0,
        "available_units": 4850
      }
    },
    {
      "id": "loc_7823f083-bb2c-54d6-bf6d-1b8e3fc75f41",
      "object": "location",
      "name": "East Coast Fulfillment Center",
      "code": "WH-EAST-01",
      "type": "warehouse",
      "status": "active",
      "address": {
        "city": "Newark",
        "state": "NJ",
        "country": "US"
      },
      "capabilities": ["storage", "fulfillment", "cross_dock"],
      "capacity": {
        "utilization_percent": 65.0,
        "available_units": 1750
      }
    }
  ],
  "has_more": true,
  "total_count": 8
}