List of warehouses and warehouse groups

Deprecated

Info

Console

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/businesses/{businessId}/warehouses

Path parameters

Name

Description

businessId*

Type: integer<int64>

Cabinet ID. To find out, use the request GET campaigns.

ℹ️ What is a cabinet and a store on the Market?

Min value: 1

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

result

Type: WarehousesDTO

Information about warehouses and groups of warehouses.

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

WarehousesDTO

Information about warehouses and groups of warehouses.

Name

Description

warehouseGroups*

Type: WarehouseGroupDTO[]

List of warehouse groups.
Information about the warehouse group.

warehouses*

Type: WarehouseDTO[]

A list of warehouses that are not included in the groups.
Information about the warehouse.

ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

WarehouseGroupDTO

Information about the warehouse group.

Name	Description
mainWarehouse*	Type: WarehouseDTO Information about the warehouse.
name*	Type: string The name of the warehouse group.
warehouses*	Type: WarehouseDTO[] The list of warehouses included in the group. Information about the warehouse.

WarehouseDTO

Information about the warehouse.

Name	Description
campaignId*	Type: integer<int64> The campaign ID. You can find it using a query GET campaigns or find it in the seller's office on the Market — click on the name of your business and go to the page: Modules and APIs → block Sending data to Yandex.Market. Query log → drop-down list in the block Show logs. , 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.
express*	Type: boolean Is Express delivery possible?
id*	Type: integer<int64> The warehouse ID.
name*	Type: string The name of the warehouse.
address	Type: WarehouseAddressDTO Warehouse address.

WarehouseAddressDTO

Warehouse address.

Name	Description
city*	Type: string City. Max length: `200`
gps*	Type: GpsDTO GPS coordinates of latitude and longitude.
block	Type: string Building number. Max length: `16`
building	Type: string Building number. Max length: `16`
number	Type: string The house number. Max length: `256`
street	Type: string Street. Max length: `512`

GpsDTO

GPS coordinates of latitude and longitude.

Name

Description

latitude*

Type: number<decimal>

Width.

longitude*

Type: number<decimal>

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.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error of Yandex. 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.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

Was the article helpful?

Market Prices Report

One model