Get a warehouse by ID
Scope: inventory:warehouses.read https://api.alladdin.com/api/v2/warehouses/{warehouseId}
Retrieves the details of a single warehouse by its unique identifier.
The response includes the warehouse name, contact information, address, and whether it is the default warehouse.
Parameters
Path parameters
warehouseId string required
Warehouse ID (24-char hex ObjectId)
Request
import requests
url = "https://api.alladdin.com/api/v2/warehouses/{warehouseId}"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/json",
}
response = requests.get(url, headers=headers)
print(response.json())Responses
Response
{
"id": "507f1f77bcf86cd799439011",
"user_id": "string",
"name": "string",
"notes": "string",
"email": "string",
"phone": "string",
"mobile": "string",
"default": false,
"color": "#3498db",
"icon": "string",
"address": {
"address": "string",
"city": "string",
"province": "string",
"postal_code": "string",
"country": "string",
"country_code": "ES"
}
}Success responses
200 Warehouse found application/json object id string
Unique identifier of the warehouse
user_id string | null
Identifier of the user managing this warehouse
name string
Name of the warehouse
notes string | null
Additional notes about the warehouse
email string | null
Contact email for the warehouse
phone string | null
Phone number of the warehouse
mobile string | null
Mobile phone number of the warehouse
default boolean
Whether this is the default warehouse
color string
Color assigned to the warehouse for visual identification
icon string
Icon identifier for the warehouse
address object
Physical address of the warehouse
address string | null city string | null province string | null postal_code string | null country string | null country_code string | null
Error responses
401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Warehouse not found application/json 429 Rate limit exceeded application/json