List of warehouses and groups of warehouses

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?

POST v2/businesses/{businessId}/warehouses

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

Cabinet ID. To find out, use the request GET v2/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": "example",
        "campaignId": 1,
        "express": true,
        "address": {}
      }
    ],
    "warehouseGroups": [
      {
        "name": "example",
        "mainWarehouse": {},
        "warehouses": [
          null
        ]
      }
    ]
  }
}

Type: object

All of 2 types

Type: object
status

Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

result

Type: object

warehouseGroups

Type: object[]

mainWarehouse

Type: object

campaignId

Type: integer

The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.

You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:

block Campaign ID;
tab Query log → drop-down list in the block Show logs.

⚠️ Do not confuse it with:

the store's identifier, which is displayed in the merchant's personal account.
advertising campaigns.

Min value: 1

express

Type: boolean

Is delivery possible according to the model Express.

Type: integer

The warehouse ID.

name

Type: string

The name of the warehouse.

Example: example

address

Type: object

city

Type: string

City.

Max length: 200

Example: example

gps

Type: object

latitude

Type: number

Width.

longitude

Type: number

Longitude.

GPS coordinates of latitude and longitude.

Example

{
  "latitude": 0.5,
  "longitude": 0.5
}

block

Type: string

Building number.

Max length: 16

Example: example

building

Type: string

Building number.

Max length: 16

Example: example

number

Type: string

The house number.

Max length: 256

Example: example

street

Type: string

Street.

Max length: 512

Example: example

Warehouse address.

Example

{
  "city": "example",
  "street": "example",
  "number": "example",
  "building": "example",
  "block": "example",
  "gps": {
    "latitude": 0.5,
    "longitude": 0.5
  }
}

Information about the warehouse.

Example

{
  "id": 0,
  "name": "example",
  "campaignId": 1,
  "express": true,
  "address": {
    "city": "example",
    "street": "example",
    "number": "example",
    "building": "example",
    "block": "example",
    "gps": {
      "latitude": 0.5,
      "longitude": 0.5
    }
  }
}

name

Type: string

The name of the warehouse group.

Example: example

warehouses

Type: object[]

campaignId

Type: integer

You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:

block Campaign ID;
tab Query log → drop-down list in the block Show logs.

⚠️ Do not confuse it with:

the store's identifier, which is displayed in the merchant's personal account.
advertising campaigns.

Min value: 1

express

Type: boolean

Is delivery possible according to the model Express.

Type: integer

The warehouse ID.

name

Type: string

The name of the warehouse.

Example: example

address

Type: object

city

Type: string

City.

Max length: 200

Example: example

gps

Type: object

latitude

Type: number

Width.

longitude

Type: number

Longitude.

GPS coordinates of latitude and longitude.

Example

{
  "latitude": 0.5,
  "longitude": 0.5
}

block

Type: string

Building number.

Max length: 16

Example: example

building

Type: string

Building number.

Max length: 16

Example: example

number

Type: string

The house number.

Max length: 256

Example: example

street

Type: string

Street.

Max length: 512

Example: example

Warehouse address.

Example

{
  "city": "example",
  "street": "example",
  "number": "example",
  "building": "example",
  "block": "example",
  "gps": {
    "latitude": 0.5,
    "longitude": 0.5
  }
}

The list of warehouses included in the group.

Example

[
  {
    "id": 0,
    "name": "example",
    "campaignId": 1,
    "express": true,
    "address": {
      "city": "example",
      "street": "example",
      "number": "example",
      "building": "example",
      "block": "example",
      "gps": {
        "latitude": 0.5,
        "longitude": 0.5
      }
    }
  }
]

List of warehouse groups.

Example

[
  {
    "name": "example",
    "mainWarehouse": {
      "id": 0,
      "name": "example",
      "campaignId": 1,
      "express": true,
      "address": {
        "city": "example",
        "street": "example",
        "number": "example",
        "building": "example",
        "block": "example",
        "gps": {
          "latitude": 0.5,
          "longitude": 0.5
        }
      }
    },
    "warehouses": [
      {
        "id": 0,
        "name": "example",
        "campaignId": 1,
        "express": true,
        "address": {
          "city": "example",
          "street": "example",
          "number": "example",
          "building": "example",
          "block": "example",
          "gps": {}
        }
      }
    ]
  }
]

warehouses

Type: object[]

campaignId

Type: integer

You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:

block Campaign ID;
tab Query log → drop-down list in the block Show logs.

⚠️ Do not confuse it with:

the store's identifier, which is displayed in the merchant's personal account.
advertising campaigns.

Min value: 1

express

Type: boolean

Is delivery possible according to the model Express.

Type: integer

The warehouse ID.

name

Type: string

The name of the warehouse.

Example: example

address

Type: object

city

Type: string

City.

Max length: 200

Example: example

gps

Type: object

latitude

Type: number

Width.

longitude

Type: number

Longitude.

GPS coordinates of latitude and longitude.

Example

{
  "latitude": 0.5,
  "longitude": 0.5
}

block

Type: string

Building number.

Max length: 16

Example: example

building

Type: string

Building number.

Max length: 16

Example: example

number

Type: string

The house number.

Max length: 256

Example: example

street

Type: string

Street.

Max length: 512

Example: example

Warehouse address.

Example

{
  "city": "example",
  "street": "example",
  "number": "example",
  "building": "example",
  "block": "example",
  "gps": {
    "latitude": 0.5,
    "longitude": 0.5
  }
}

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

Example

[
  {
    "id": 0,
    "name": "example",
    "campaignId": 1,
    "express": true,
    "address": {
      "city": "example",
      "street": "example",
      "number": "example",
      "building": "example",
      "block": "example",
      "gps": {
        "latitude": 0.5,
        "longitude": 0.5
      }
    }
  }
]

Information about warehouses and groups of warehouses.

Example

{
  "warehouses": [
    {
      "id": 0,
      "name": "example",
      "campaignId": 1,
      "express": true,
      "address": {
        "city": "example",
        "street": "example",
        "number": "example",
        "building": "example",
        "block": "example",
        "gps": {
          "latitude": 0.5,
          "longitude": 0.5
        }
      }
    }
  ],
  "warehouseGroups": [
    {
      "name": "example",
      "mainWarehouse": {
        "id": 0,
        "name": "example",
        "campaignId": 1,
        "express": true,
        "address": {
          "city": "example",
          "street": "example",
          "number": "example",
          "building": "example",
          "block": "example",
          "gps": {}
        }
      },
      "warehouses": [
        {
          "id": 0,
          "name": "example",
          "campaignId": 1,
          "express": true,
          "address": {}
        }
      ]
    }
  ]
}

Example

{
  "result": {
    "warehouses": [
      {
        "id": 0,
        "name": "example",
        "campaignId": 1,
        "express": true,
        "address": {
          "city": "example",
          "street": "example",
          "number": "example",
          "building": "example",
          "block": "example",
          "gps": {}
        }
      }
    ],
    "warehouseGroups": [
      {
        "name": "example",
        "mainWarehouse": {
          "id": 0,
          "name": "example",
          "campaignId": 1,
          "express": true,
          "address": {}
        },
        "warehouses": [
          {}
        ]
      }
    ]
  }
}

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

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": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

404 Not Found

The requested resource was not found. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

500 Internal Server Error

Internal error of Yandex. Market. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Was the article helpful?

Market Prices Report

How to work with notifications