Skip to content
ShipperOne Developer Portal

List warehouses

GET
/V1/warehouses

List the warehouse locations available to the tenant. Used to discover warehouse codes for routing fulfillment orders and syncing stock.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
page
integer

Responses

Section titled “ Responses ”

200

Section titled “200 ”

200 Success.

Array<object>
object
name
required
string
code
required
string
active
required
boolean
Example generated
[
  {
    "name": "example",
    "code": "example",
    "active": true
  }
]

400

Section titled “400 ”

400 Bad Request

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
  "message": "example",
  "errors": [
    {
      "message": "example",
      "parameters": [
        {
          "resources": "example",
          "fieldName": "example",
          "fieldValue": "example"
        }
      ]
    }
  ],
  "code": 1,
  "parameters": [
    {
      "resources": "example",
      "fieldName": "example",
      "fieldValue": "example"
    }
  ],
  "trace": "example"
}

401

Section titled “401 ”

401 Unauthorized

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
  "message": "example",
  "errors": [
    {
      "message": "example",
      "parameters": [
        {
          "resources": "example",
          "fieldName": "example",
          "fieldValue": "example"
        }
      ]
    }
  ],
  "code": 1,
  "parameters": [
    {
      "resources": "example",
      "fieldName": "example",
      "fieldValue": "example"
    }
  ],
  "trace": "example"
}

500

Section titled “500 ”

Internal Server error

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
  "message": "example",
  "errors": [
    {
      "message": "example",
      "parameters": [
        {
          "resources": "example",
          "fieldName": "example",
          "fieldValue": "example"
        }
      ]
    }
  ],
  "code": 1,
  "parameters": [
    {
      "resources": "example",
      "fieldName": "example",
      "fieldValue": "example"
    }
  ],
  "trace": "example"
}

default

Section titled “default ”

Unexpected error

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
  "message": "example",
  "errors": [
    {
      "message": "example",
      "parameters": [
        {
          "resources": "example",
          "fieldName": "example",
          "fieldValue": "example"
        }
      ]
    }
  ],
  "code": 1,
  "parameters": [
    {
      "resources": "example",
      "fieldName": "example",
      "fieldValue": "example"
    }
  ],
  "trace": "example"
}