Information about multiple points of sale

Info

Console

The method is available for the DBS model.

If you are using an API Key token, one of the accesses in the list is required to call the method

settings-management — Store settings
all-methods — Full account management
all-methods:read-only — View all data

Returns a list of the store's points of sale.

⚙️ Limit: 100,000 requests per hour

Request

GET

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/outlets

Path parameters

Name

Description

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

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==`
region_id	Type: integer ID of the region. If you set the ID of the parent region at any level, the output data will display the points of sale of all child regions. You can get the region ID using the method GET v2/regions.
regionId	Type: integer Instead, use `region_id`.
shop_outlet_code	Type: string The ID of the point of sale assigned by the store. Example: ``

Responses

200 OK

Information about points of sale.

Body

application/json

{
  "outlets": [
    {
      "name": "example",
      "type": "DEPOT",
      "coords": "example",
      "isMain": true,
      "shopOutletCode": "example",
      "visibility": "HIDDEN",
      "address": {
        "regionId": 0,
        "street": "example",
        "number": "example",
        "building": "example",
        "estate": "example",
        "block": "example",
        "additional": "example",
        "km": 0,
        "city": "example"
      },
      "phones": [
        "example"
      ],
      "workingSchedule": {
        "workInHoliday": true,
        "scheduleItems": [
          null
        ]
      },
      "deliveryRules": [
        {}
      ],
      "storagePeriod": 0
    }
  ],
  "paging": {
    "nextPageToken": "example"
  },
  "pager": {
    "total": 0,
    "from": 0,
    "to": 0,
    "currentPage": 0,
    "pagesCount": 0,
    "pageSize": 0
  }
}

Name

Description

outlets

Type: object[]

Information about points of sale.

Example

[
  {
    "name": "example",
    "type": "DEPOT",
    "coords": "example",
    "isMain": true,
    "shopOutletCode": "example",
    "visibility": "HIDDEN",
    "address": {
      "regionId": 0,
      "street": "example",
      "number": "example",
      "building": "example",
      "estate": "example",
      "block": "example",
      "additional": "example",
      "km": 0,
      "city": "example"
    },
    "phones": [
      "example"
    ],
    "workingSchedule": {
      "workInHoliday": true,
      "scheduleItems": [
        {}
      ]
    },
    "deliveryRules": [
      {
        "minDeliveryDays": 0,
        "maxDeliveryDays": 0,
        "deliveryServiceId": 0,
        "orderBefore": 0,
        "priceFreePickup": 0.5,
        "unspecifiedDeliveryInterval": true
      }
    ],
    "storagePeriod": 0
  }
]

pager

Type: object

currentPage	Type: integer The current page.
from	Type: integer The initial number of the found element on the page.
pagesCount	Type: integer The total number of pages.
pageSize	Type: integer Page size.
to	Type: integer The final number of the found element on the page.
total	Type: integer How many items were found in total.

A model for pagination.

Example

{
  "total": 0,
  "from": 0,
  "to": 0,
  "currentPage": 0,
  "pagesCount": 0,
  "pageSize": 0
}

paging

Type: object

All of 2 types

Type: object

nextPageToken

Type: string

ID of the next results page.

Example: example

The ID of the next page.
Example
```
{
  "nextPageToken": "example"
}
```
Type: object

prevPageToken

Type: string

ID of the previous results page.

Example: example
Example
```
{
  "prevPageToken": "example"
}
```

Information about the result pages.

Example

{
  "nextPageToken": "example"
}

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

{
  "status": "OK"
}

Type: object

401 Unauthorized

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

Body

application/json

{
  "status": "OK"
}

Type: object

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json

{
  "status": "OK"
}

Type: object

404 Not Found

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

Body

application/json

{
  "status": "OK"
}

Type: object

420 Method Failure

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

Body

application/json

{
  "status": "OK"
}

Type: object

500 Internal Server Error

Internal error of the Market. More information about the error

Body

application/json

{
  "status": "OK"
}

Type: object

pathParams:
  - description: "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.\n\nYou can find it using a query [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) 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**:\n\n* block **Campaign ID**;\n* tab **Query log** → drop-down list in the block **Show logs**.\n\n⚠️ Do not confuse it with:\n- the store's identifier, which is displayed in the merchant's personal account.\n- advertising campaigns.\n"
    name: campaignId
    in: path
    required: true
    schema:
      type: integer
      format: int64
      minimum: 1
searchParams:
  - name: page_token
    description: >
      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.
    in: query
    required: false
    example: eyBuZXh0SWQ6IDIzNDIgfQ==
    schema:
      type: string
  - name: limit
    description: |
      The number of values per page.
    in: query
    required: false
    example: 20
    schema:
      type: integer
      format: int32
      minimum: 1
  - description: "ID of the region.\nIf you set the ID of the parent region at any level, the output data will display the points of sale of all child regions.\nYou can get the region ID using the method [GET\_v2/regions](../../reference/regions/searchRegionsByName.md).\n"
    name: region_id
    in: query
    required: false
    schema:
      type: integer
      format: int64
  - description: The ID of the point of sale assigned by the store.
    name: shop_outlet_code
    in: query
    required: false
    schema:
      type: string
  - description: "{% note warning \"Instead, use `region_id`.\" %}\n\n\_\n\n{% endnote %}\n"
    name: regionId
    deprecated: true
    in: query
    required: false
    schema:
      type: integer
      format: int64
headers: []
body: null
schema: {}
method: get
security:
  - type: apiKey
    name: 'Api-Key'
    in: header
  - type: oauth2
    x-inline: true
    flows:
      implicit:
        authorizationUrl: https://oauth.yandex.ru/authorize
        scopes:
          market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v2/campaigns/{campaignId}/outlets
host: https://api.partner.market.yandex.ru

Was the article helpful?

One point of sale

Creation