List of warehouses and groups of warehouses
The method is available for models: FBS, Express and DBS.
If you are using an API Key token, one of the accesses in the list is required to call the method
- inventory-and-order-processing — Order processing and inventory
- inventory-and-order-processing:read-only — View order information
- all-methods — Full account management
- all-methods:read-only — View all data
Which method should I use instead of the outdated one?
Returns a list of warehouses and, if warehouses are combined, a list of warehouse groups. What are warehouse groups and why are they needed?
Among other things, the request allows you to determine the identifier to be used when transferring balances for a group of warehouses.
| ⚙️ Limit: 100 requests per minute |
|---|
Request
GET
https://api.partner.market.yandex.ru/v2/businesses/{businessId}/warehouses
Path parameters
|
Name |
Description |
|
businessId* |
Type: integer<int64> Cabinet ID. To find out, use the request GET v2/campaigns. ℹ️ What is a cabinet and a store on the Market?
Min value: |
Responses
200 OK
A list of warehouses and groups of warehouses.
Body
application/json
{
"status": "OK",
"result": {
"warehouses": [
{
"id": 0,
"name": "string",
"campaignId": 0,
"express": false,
"address": {
"city": "string",
"street": "string",
"number": "string",
"building": "string",
"block": "string",
"gps": {
"latitude": 0,
"longitude": 0
}
}
}
],
"warehouseGroups": [
{
"name": "string",
"mainWarehouse": {
"id": 0,
"name": "string",
"campaignId": 0,
"express": false,
"address": {
"city": "string",
"street": "string",
"number": "string",
"building": "string",
"block": "string",
"gps": {
"latitude": 0,
"longitude": 0
}
}
},
"warehouses": [
{
"id": 0,
"name": "string",
"campaignId": 0,
"express": false,
"address": {
"city": "string",
"street": "string",
"number": "string",
"building": "string",
"block": "string",
"gps": {
"latitude": 0,
"longitude": 0
}
}
}
]
}
]
}
}
|
Name |
Description |
||||
|
status* |
Type: string The type of response. Possible values:
Enum: |
||||
|
result |
Type: object
Information about warehouses and groups of warehouses. |
400 Bad Request
The request contains incorrect data. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
401 Unauthorized
The authorization data is not specified in the request. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
403 Forbidden
The authorization data is incorrect or access to the resource is prohibited. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
404 Not Found
The requested resource was not found. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
420 Method Failure
The resource access limit has been exceeded. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
500 Internal Server Error
Internal error of the Market. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.