GET /warehouses/{warehouseId} Deprecated

Get a Warehouse

This endpoint allows you to get a specific Warehouse.

Operation ID: getWarehouse

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

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.

warehouse

attributes object

warehouse_id integer

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

Example: 1

entity_id integer read-only

The identifier of the account (entity, organization, or client) that owns or manages this warehouse.

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

full_code string

A hierarchical code representing the complete lineage of the warehouse within the storage structure. It's formed by concatenating the codes of all its parent warehouses or sections, separated by a dot, followed by the warehouse's own code.

Example: WZ0.WZ1

parent_id integer | null

The identifier of the immediate parent warehouse or section in the storage hierarchy. If this is a top-level warehouse, this field will be null.

Example: 2

is_real boolean

A boolean flag indicating the nature of this storage item. `true` signifies a physical, tangible warehouse location, while `false` represents a logical grouping or section within a larger warehouse.

observation 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.

address string | null

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

Example: Warehouse street, 10, Country

status string

error

error object

properties object

Only present when related to property validation error

dev_message string

Example: Property validation error. Check the "properties" section in the response.

http_code integer

400

message string

Example: Property validation error.

more_info string

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/warehouses/1

curl -X GET \
  'https://api.sandbox.infraspeak.com/v3/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/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/warehouses/1');

import requests

response = requests.get(
    'https://api.sandbox.infraspeak.com/v3/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": "warehouse",
        "attributes": {
            "warehouse_id": 1,
            "entity_id": 1,
            "name": "Warehouse",
            "code": "WZ1",
            "full_code": "WZ0.WZ1",
            "parent_id": 2,
            "is_real": true,
            "observation": "Operational hours from 9am to 7pm, entrance by the large door on the side.",
            "address": "Warehouse street, 10, Country"
        }
    }
}

400 Bad Request. Occurs when invalid parameters are provided or on data validation errors. For example, trying to create a resource without providing required fields. In this case, you can check the `properties` attribute on the response for more details.

{
    "status": "error",
    "error": {
        "properties": {},
        "dev_message": "Property validation error. Check the \"properties\" section in the response.",
        "http_code": 400,
        "message": "Property validation error.",
        "more_info": "string"
    }
}

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