Market Warehouse IDs
The method is available for the FBY model.
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
- pricing — Manage prices
- pricing:read-only — View prices
- offers-and-cards-management — Manage products and cards
- offers-and-cards-management:read-only — View products and cards
- promotion — Product promotion
- promotion:read-only — View promotion information
- finance-and-accounting — View financial data and reports
- communication — Customer communication
- settings-management — Store settings
- supplies-management:read-only — View FBY requests
- all-methods — Full account management
- all-methods:read-only — View all data
Retrieves a list of Market warehouses with their IDs.
| ⚙️ Limit: 100 requests per minute |
|---|
Request
GET
https://api.partner.market.yandex.ru/v2/warehouses
Query parameters
|
Name |
Description |
|
campaignId |
Type: integer<int64> The campaign ID. It is indicated if you need to return all the Market warehouses that are linked to a specific campaign. You can find it using a query GET v2/campaigns or find it in the seller's office on the Market — click on the name of your business and go to the page:
, Do not send the store ID instead, which is indicated in the seller's account on the Market next to the store name and in some reports. |
Responses
200 OK
List of warehouses.
Body
application/json
{
"status": "OK",
"result": {
"warehouses": [
{
"id": 0,
"name": "string",
"address": {
"city": "string",
"street": "string",
"number": "string",
"building": "string",
"block": "string",
"gps": {
"latitude": 0,
"longitude": 0
}
}
}
]
}
}
|
Name |
Description |
|
status* |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
|
result |
Type: FulfillmentWarehousesDTO List of Market warehouses (FBY). |
ApiResponseStatusType
The type of response. Possible values:
OK— there are no mistakes.ERROR— an error occurred while processing the request.
|
Type |
Description |
|
Enum: |
FulfillmentWarehousesDTO
List of Market warehouses (FBY).
|
Name |
Description |
|
warehouses* |
Type: FulfillmentWarehouseDTO[] List of Market warehouses (FBY). |
FulfillmentWarehouseDTO
Market Warehouse (FBY).
|
Name |
Description |
|
id* |
Type: integer<int64> The warehouse ID. |
|
name* |
Type: string The name of the warehouse. |
|
address |
Type: WarehouseAddressDTO Адрес склада. |
WarehouseAddressDTO
Warehouse address.
|
Name |
Description |
|
city* |
Type: string City. Max length: |
|
gps* |
Type: GpsDTO GPS coordinates of latitude and longitude. |
|
block |
Type: string Building number. Max length: |
|
building |
Type: string Building number. Max length: |
|
number |
Type: string The house number. Max length: |
|
street |
Type: string Street. Max length: |
GpsDTO
GPS coordinates of latitude and longitude.
|
Name |
Description |
|
latitude* |
Type: number Width. |
|
longitude* |
Type: number Longitude. |
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: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
ApiErrorDTO
The general error format.
|
Name |
Description |
|
code* |
Type: string The error code. |
|
message |
Type: string Description of the error. |
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: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType 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: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType 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: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType 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: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType 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: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.