Get a warehouse
Retrieves detailed information about a specific warehouse, including its address and linked markets.
/api/v1/{team_slug}/{app_slug}/warehouses/{warehouse_slug}- API
- Management
- OpenAPI
- management-api
- Updated
- Apr 26, 2026
management-api:GET:/api/v1/{team_slug}/{app_slug}/warehouses/{warehouse_slug}
Retrieves detailed information about a specific warehouse, including its address and linked markets.
API ownership
- API family: Management API
- Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
- Do not use from: Browser-only storefront code or public clients.
- Guide route: /apis/management/latest
The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.
Operation
- Method:
GET - Path:
/api/v1/\{team_slug\}/\{app_slug\}/warehouses/\{warehouse_slug\} - Summary: Get a warehouse
- Description: Retrieves detailed information about a specific warehouse, including its address and linked markets.
- OpenAPI contract: management-api
- Operation ID: Not documented in the OpenAPI contract.
Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| warehouse_slug | path | Yes | string | Warehouse slug |
| app_slug | path | Yes | string | App slug |
| team_slug | path | Yes | string | Team slug |
Request body
Not documented in the OpenAPI contract.
Responses
| Status | Description | Content |
|---|---|---|
| 200 | Warehouse data | application/json (object) |
| 400 | Invalid request (e.g. bad UUID, validation error) | application/json (object) |
| 401 | Unauthorized access | application/json (object) |
| 500 | Internal server error | application/json (object) |
200 - object
Warehouse Response
| Property | Type | Required | Details |
|---|---|---|---|
data | object | No | - |
details | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes |
success | boolean | No | - |
Warehouse With Markets
| Property | Type | Required | Details |
|---|---|---|---|
address | object | No | - |
app_id | string | No | - |
available_online | boolean | No | - |
created_at | string | No | - |
id | string | No | - |
markets | object[] | No | - |
name | string | No | - |
slug | string | No | - |
updated_at | string | No | - |
Warehouse Address
| Property | Type | Required | Details |
|---|---|---|---|
city | string | No | - |
country | string | Yes | Country value needs to follow ISO3166_1_alpha2, which means we want a country value written in alpha-2 two-letter country codes, Example: SE or FI |
postal_code | string | No | - |
state | string | No | - |
street_address | string | No | - |
Market
| Property | Type | Required | Details |
|---|---|---|---|
active | boolean | No | - |
country_codes | string[] | No | - |
created_at | string | No | - |
currency_code | string | No | - |
id | string | No | - |
locale | string | No | - |
name | string | No | - |
slug | string | No | - |
updated_at | string | No | - |
Generated example (synthetic):
{
"data": {
"address": {
"city": "string",
"country": "string",
"postal_code": "string",
"state": "string",
"street_address": "string"
},
"app_id": "string",
"available_online": false,
"created_at": "string",
"id": "string",
"markets": [
{
"active": false,
"country_codes": [],
"created_at": "string",
"currency_code": "string",
"id": "string",
"locale": "string",
"name": "string",
"slug": "string",
"updated_at": "string"
}
],
"name": "string",
"slug": "string",
"updated_at": "string"
},
"details": [
"string"
],
"success": false
}400 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}401 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}500 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}Contract identity
Use these fields to confirm you are implementing the intended endpoint contract.
- API family: Management API
- Method:
GET - Path:
/api/v1/\{team_slug\}/\{app_slug\}/warehouses/\{warehouse_slug\} - Operation ID: Not documented in the OpenAPI contract.
- OpenAPI tag: Warehouses
- OpenAPI summary: Get a warehouse