GET /stocks/warehouses/{warehouseId}

Get a warehouse

This endpoint allows you to get a specific Warehouse.

Operation ID: getStockWarehouse

lock This endpoint requires a Bearer token in the Authorization header.

Path Parameters

Name Type Description

Name	Type	Description
`warehouseId` required path	string	The unique identifier of the warehouse within the system. This ID is immutable and assigned upon creation. Example: `1`

warehouseId required

path

string

The unique identifier of the warehouse within the system. This ID is immutable and assigned upon creation.

Example: 1

Query Parameters

Name	Type	Description
`expand` query	string	A comma-separated list of related resources to include in the response data. `operators`

Responses

data object

Detailed structure of a warehouse model.

id string read-only

The unique identifier of the warehouse within the system. This ID is immutable and assigned upon creation.

Example: 1

type string read-only

The resource type, identifying this as a warehouse.

stock-warehouse

attributes object

warehouse_id string

The unique identifier of the warehouse within the system. This ID is immutable and assigned upon creation.

Example: 1

name string

The descriptive name of the warehouse, intended for readability and identification within the application's user interface.

Example: Warehouse

code string

A unique code assigned to the warehouse, intended for readability and identification within the application's user interface.

Example: WZ1

address string | null

The physical street address of the warehouse. This provides the geographical location of the storage facility.

Example: Warehouse street, 10, Country

observations string | null

Free-text field for any additional notes, specific instructions, or relevant details pertaining to this warehouse.

Example: Operational hours from 9am to 7pm, entrance by the large door on the side.

created_at string (date-time)

The timestamp indicating when the warehouse record was initially created in the system. This value is automatically set upon the creation of a new warehouse.

Example: 2025-05-27T11:44:46.000Z

updated_at string (date-time)

The timestamp indicating when the warehouse record was last modified. This value is automatically updated whenever any attribute of the warehouse is changed and saved.

Example: 2025-05-27T11:44:46.000Z

associated_operators array<object>

A list of operators associated with this warehouse. This defines the personnel linked to this storage location and their respective roles or responsibilities.

operator_id integer

The unique identifier of the operator within the system. This ID is used to reference the specific personnel associated with the warehouse.

Example: 1

permission string

The specific permission or role assigned to this operator in relation to the warehouse. This dictates the actions the operator is authorized to perform.

manager

status string

error

error object

http_code integer

401

message string

Example: Authentication token invalid.

more_info string

status string

error

error object

http_code integer

404

message string

Example: Resource not found

more_info string | null

status string

error

error object

http_code integer

429

message string

Example: Too Many Requests.

more_info string

status string

error

error object

http_code integer

500

message string

Example: An error has occurred during the request.

more_info string

play_circle Try It

Environment

Authorization

Bearer

Path Parameters

warehouseId

filter_alt Filters

Pagination

GET https://api.sandbox.infraspeak.com/v3/stocks/warehouses/1

curl -X GET \
  'https://api.sandbox.infraspeak.com/v3/stocks/warehouses/1' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.sandbox.infraspeak.com/v3/stocks/warehouses/1', {
  method: 'GET',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_TOKEN',
  },
});

const data = await response.json();

$response = Http::withHeaders([
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
])->withToken('YOUR_API_TOKEN')
  ->get('https://api.sandbox.infraspeak.com/v3/stocks/warehouses/1');

import requests

response = requests.get(
    'https://api.sandbox.infraspeak.com/v3/stocks/warehouses/1',
    headers={
        'Accept': 'application/json',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_API_TOKEN',
    },
)

data = response.json()

data_object Example Response

200 OK

{
    "data": {
        "id": "1",
        "type": "stock-warehouse",
        "attributes": {
            "warehouse_id": "1",
            "name": "Warehouse",
            "code": "WZ1",
            "address": "Warehouse street, 10, Country",
            "observations": "Operational hours from 9am to 7pm, entrance by the large door on the side.",
            "created_at": "2025-05-27T11:44:46.000Z",
            "updated_at": "2025-05-27T11:44:46.000Z",
            "associated_operators": {
                "operator_id": 1,
                "permission": "manager"
            }
        }
    }
}

401 Unauthorized. Authentication or permission error. E.g.: missing, incorrect or invalid Access Token.

{
    "status": "error",
    "error": {
        "http_code": 401,
        "message": "Authentication token invalid.",
        "more_info": "string"
    }
}

404 Resource Not Found. Requests to resources that don't exist or are malformed.

{
    "status": "error",
    "error": {
        "http_code": 404,
        "message": "Resource not found",
        "more_info": "string"
    }
}

429 Too Many Requests. The client has sent too many requests in a given amount of time (check Throttling section).

{
    "status": "error",
    "error": {
        "http_code": 429,
        "message": "Too Many Requests.",
        "more_info": "string"
    }
}

500 Internal Server Error. Please, report us and try to provide as much information as possible, such as the endpoint, HTTP request headers and request body if applicable.

{
    "status": "error",
    "error": {
        "http_code": 500,
        "message": "An error has occurred during the request.",
        "more_info": "string"
    }
}