StateSet API Docs

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

const locations = await stateset.locations.list({
  type: 'warehouse',
  status: 'active',
  capabilities: ['fulfillment']
});

locations = stateset.locations.list(
  type='warehouse',
  status='active',
  capabilities=['fulfillment']
)

{
  "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
}

GET

locations

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

const locations = await stateset.locations.list({
  type: 'warehouse',
  status: 'active',
  capabilities: ['fulfillment']
});

locations = stateset.locations.list(
  type='warehouse',
  status='active',
  capabilities=['fulfillment']
)

{
  "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
}

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

integer

Number of items to return (default: 20, max: 100)

integer

Number of items to skip

string

Filter by type: “warehouse”, “store”, “distribution_center”, “dropship”

string

Filter by status: “active”, “inactive”, “maintenance”

array

Filter by capabilities: “storage”, “fulfillment”, “returns”, “cross_dock”, “pickup”

string

Filter by country code

string

Filter by state/province

string

Filter by city

string

Sort field: “created_at”, “name”, “code”, “capacity”

string

Sort order: “asc” or “desc”

Response

string

Object type, always “list”

array

Array of location objects

boolean

Whether more items exist

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

const locations = await stateset.locations.list({
  type: 'warehouse',
  status: 'active',
  capabilities: ['fulfillment']
});

locations = stateset.locations.list(
  type='warehouse',
  status='active',
  capabilities=['fulfillment']
)

{
  "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
}

Cancel Shipment Get Location

StateSet One API

StateSet API v1

Customer Management

Order Management

Checkouts

Returns Management

Warranty Management

Wholesale Management

Inventory Management

ASN Management

Purchase Orders

Manufacturing

Warehouse Operations

CRM

Suppliers

E-commerce

Financial

Fulfillment

Communication

System

StateSet Response API

StateSet Cloud API

StateSet Commerce API

List Locations

Authentication

Query Parameters

Response

​Authentication

​Query Parameters

​Response

Authentication

Query Parameters

Response