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
Number of items to return (default: 20, max: 100)
Filter by type: “warehouse”, “store”, “distribution_center”, “dropship”
Filter by status: “active”, “inactive”, “maintenance”
Filter by capabilities: “storage”, “fulfillment”, “returns”, “cross_dock”, “pickup”
Sort field: “created_at”, “name”, “code”, “capacity”
Sort order: “asc” or “desc”
Response
Object type, always “list”
Array of location objects
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
}
