List 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

Returns a list of warehouses and information about them.

Restriction for the parameter limit

Do not transmit a value greater than 25.

⚙️ Limit: 1,000 requests per hour

Request

POST

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

Query parameters

Name

Description

limit

Type: integer

The number of values per page.

Min value: 1

page_token

Type: string

ID of the results page.

If the parameter is omitted, the first page is returned.

We recommend transmitting the value of the output parameter nextPageToken, received during the last request.

If set page_token and the request has parameters page and pageSize they are ignored.

Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json
{
  "components": [
    "ADDRESS"
  ],
  "campaignIds": [
    1
  ]
}

Name

Description

campaignIds

Type: integer[] | null

A list of campaign IDs of those stores whose warehouses need to be returned.

You can find them 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 use store IDs instead, which are listed in the seller's account on the Market next to the store name and in some reports.

Min items: 1

Max items: 25

Unique items: true

Example
[
  1
]

components

Type: string[] | null

Properties of warehouses that need to be returned. If some parameter value is omitted, this information will not be included in the response.

Pass the parameter only if you need the information it returns.

You can pass multiple values at once.

Min items: 1

Unique items: true

Example
[
  "ADDRESS"
]

Responses

200 OK

The list of warehouses and their properties that you requested.

Body

application/json
{
  "status": "OK",
  "result": {
    "warehouses": [
      {
        "id": 0,
        "name": "example",
        "campaignId": 1,
        "express": true,
        "groupInfo": {},
        "address": {},
        "status": {}
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

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

    warehouses
    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 for the model Express.

    id

    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
  }
}

    groupInfo
    Type: object

    id

    Type: integer

    ID of the warehouse group.

    name

    Type: string

    The name of the group that the warehouse belongs to.

    Example: example

    Information about the group to which the warehouse belongs.

    It is returned only for warehouses in groups.

    What are warehouse groups and why are they needed?

    Example
    {
  "name": "example",
  "id": 0
}

    status
    Type: object

    status

    Type: string

    Warehouse status:

    • DISABLED_MANUALLY – disabled by you.
    • OTHER – different status. For example, a warehouse is enabled or disabled by Yandex. Market.

    Enum: DISABLED_MANUALLY, OTHER

    Information about the status of the warehouse.

    Example
    {
  "status": "DISABLED_MANUALLY"
}

    List of warehouses.

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

    paging
    Type: object

    nextPageToken

    Type: string

    ID of the next results page.

    Example: example

    The ID of the next page.

    Example
    {
  "nextPageToken": "example"
}

    Information about warehouses in the cabinet.

    Example
    {
  "warehouses": [
    {
      "id": 0,
      "name": "example",
      "campaignId": 1,
      "express": true,
      "groupInfo": {
        "name": "example",
        "id": 0
      },
      "address": {
        "city": "example",
        "street": "example",
        "number": "example",
        "building": "example",
        "block": "example",
        "gps": {
          "latitude": 0.5,
          "longitude": 0.5
        }
      },
      "status": {
        "status": "DISABLED_MANUALLY"
      }
    }
  ],
  "paging": {
    "nextPageToken": "example"
  }
}
    Example
    {
  "result": {
    "warehouses": [
      {
        "id": 0,
        "name": "example",
        "campaignId": 1,
        "express": true,
        "groupInfo": {
          "name": "example",
          "id": 0
        },
        "address": {
          "city": "example",
          "street": "example",
          "number": "example",
          "building": "example",
          "block": "example",
          "gps": {}
        },
        "status": {
          "status": "DISABLED_MANUALLY"
        }
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

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"
    }
  ]
}

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"
    }
  ]
}

No longer supported, please use an alternative and newer version.

Previous
Sending a file
Next
Changing the warehouse status