Warehouse - Get

Retrieve all warehouses for the current account.

GET /warehouse/get

Warehouse - Get

cURL

curl --request GET \
  --url https://api.skulabs.com/warehouse/get \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "name": "<string>",
    "type": "<string>",
    "store_id": "507f1f77bcf86cd799439011",
    "is_default": true,
    "address": {
      "address": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country_code": "<string>",
      "phone": "<string>",
      "company": "<string>",
      "name": "<string>"
    },
    "states": [
      "<string>"
    ]
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

selector · object · required

Query selector object for filtering results

limit · number

Max results to return

Example:

50

skip · number

Number of results to skip

Example:

0

sort · object

Sort fields object, e.g. { "name": 1 }

Response

200

application/json

Array of warehouses

_id · string · required

Unique warehouse identifier

Example:

"507f1f77bcf86cd799439011"

name · string · required

Warehouse name

type · string · required

Warehouse type

store_id · string

Associated store ID

Example:

"507f1f77bcf86cd799439011"

is_default · boolean

Whether this is the default warehouse

address · object

Warehouse address

Show child attributes

states · string[]

State routing assignments