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

Retrieves the 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<int64>

The campaign ID.

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

Min value: 1

Query parameters

Name	Description
limit	Type: integer<int32> The number of values per page. Min value: `1` Example: `20`
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==`
regionId ⦸	Type: integer<int64> Instead, use `region_id`.
region_id	Type: integer<int64> 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.
shop_outlet_code	Type: string The ID of the point of sale assigned by the store.

Responses

200 OK

Information about points of sale.

Body

application/json

{
    "outlets": [
        {
            "name": "string",
            "type": "DEPOT",
            "coords": "string",
            "isMain": false,
            "shopOutletCode": "string",
            "visibility": "HIDDEN",
            "address": {
                "regionId": 0,
                "street": "string",
                "number": "string",
                "building": "string",
                "estate": "string",
                "block": "string",
                "additional": "string",
                "km": 0,
                "city": "string"
            },
            "phones": [
                "string"
            ],
            "workingSchedule": {
                "workInHoliday": false,
                "scheduleItems": [
                    {
                        "startDay": "MONDAY",
                        "endDay": "MONDAY",
                        "startTime": "09:59",
                        "endTime": "23:59"
                    }
                ]
            },
            "deliveryRules": [
                {
                    "minDeliveryDays": 0,
                    "maxDeliveryDays": 0,
                    "deliveryServiceId": 0,
                    "orderBefore": 0,
                    "priceFreePickup": 0,
                    "unspecifiedDeliveryInterval": false
                }
            ],
            "storagePeriod": 0,
            "id": 0,
            "status": "AT_MODERATION",
            "region": {
                "id": 0,
                "name": "string",
                "type": "OTHER"
            },
            "shopOutletId": "string",
            "workingTime": "string",
            "moderationReason": "string"
        }
    ],
    "paging": {
        "nextPageToken": "string",
        "prevPageToken": "string"
    },
    "pager": {
        "total": 0,
        "from": 0,
        "to": 0,
        "currentPage": 0,
        "pagesCount": 0,
        "pageSize": 0
    }
}

Name

Description

outlets*

Type: object[]

Information about points of sale.
Information about the point of sale.
Information about the point of sale.

pager

Type: object

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

A model for pagination.

paging

Type: object

nextPageToken

Type: string

ID of the next results page.

prevPageToken

Type: string

ID of the previous results page.

Information about the result pages.
The ID of the next page.

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: object[]

A list of errors.
The general error format.

Min items: 1

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

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: object[]

A list of errors.
The general error format.

Min items: 1

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

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: object[]

A list of errors.
The general error format.

Min items: 1

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

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: object[]

A list of errors.
The general error format.

Min items: 1

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

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: object[]

A list of errors.
The general error format.

Min items: 1

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

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: object[]

A list of errors.
The general error format.

Min items: 1

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

Was the article helpful?

One point of sale

Creation