Skip to content
/Warehouses

Warehouses

The Warehouses API allows you to retrieve a list of warehouses that you have access to (within a company).

The result contains the identifier for each warehouse, which you can use in the rest of the API calls, whenever a Warehouse needs to be specified.

Operations

List Available Warehouses

Request

Security
TokenAuth
Path
company_slugstringrequired
curl -i -X GET \
  'https://docs.scurri.com/_mock/connect/consignments-api/versions/1.0.0/openapi/_api/v1/company/{company_slug}/warehouses/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Request was successful

Bodyapplication/json
Array [
identifierstringrequired

A unique, human readable, identifier for the service.

Example:"api-test-company|Test Warehouse"
namestringrequired

The name of the warehouse.

Example:"Test Warehouse"
]
Response
[
  {
    "identifier": "api-test-company|Test Warehouse",
    "name": "Test Warehouse"
  }
]