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/campaigns/{campaignId}/outlets

Path parameters

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.

Min value: 1

Query parameters

Name	Description
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 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",
                "parent": {
                    "id": 0,
                    "name": "string",
                    "type": "OTHER",
                    "children": [
                        null
                    ]
                },
                "children": [
                    null
                ]
            },
            "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: FullOutletDTO[] Information about points of sale. Information about the point of sale. Information about the point of sale.
pager	Type: FlippingPagerDTO A model for pagination.
paging	Type: ScrollingPagerDTO Information about the result pages. The ID of the next page.

FullOutletDTO

Information about the point of sale.

Name

Description

address*

Type: OutletAddressDTO

The address of the point of sale.

id*

Type: integer<int64>

The ID of the point of sale assigned by Yandex.Market.

name*

Type: string

The name of the point of sale.

phones*

Type: string[]

The phone numbers of the point of sale. Send in the format: +7 (999) 999-99-99.

Min length: 1

Min items: 1

Unique items

type*

Type: OutletType

The type of point of sale.

Possible values:

DEPOT — order pick-up point.
MIXED — a mixed type of point of sale (sales floor and order pick-up point).
RETAIL — retail point of sale (sales floor).
NOT_DEFINED — unknown type of point of sale. An error occurred when determining the type.

Enum: DEPOT, MIXED, RETAIL, NOT_DEFINED

workingSchedule*

Type: OutletWorkingScheduleDTO

The list of operating modes of the point of sale.

coords

Type: string

Coordinates of the point of sale.

Format: longitude, latitude. Delimiters: comma and/or space. For example, 20.4522144, 54.7104264.

If no parameter is passed, the coordinates will be determined by the values of the parameters nested in address.

deliveryRules

Type: OutletDeliveryRuleDTO[]

Information about the terms of delivery for this point of sale.

Required parameter if the parameter type=DEPOT or type=MIXED.
Information about the terms of delivery for this point of sale.

Min items: 1

isMain

Type: boolean

Indicates the main point of sale.

Possible values:

false — non-primary point of sale.
true — the main point of sale.

moderationReason

Type: string

The moderation status.

region

Type: RegionDTO

The delivery region.

shopOutletCode

Type: string

The ID of the point of sale assigned by the store.

shopOutletId

⦸

Type: string

Instead, use shopOutletCode.

The ID of the point of sale set by the store.

status

Type: OutletStatusType

The status of the point of sale.

Possible values:

AT_MODERATION — it's being checked.
FAILED — failed verification and was rejected by the moderator.
MODERATED — tested and approved.
NONMODERATED — a new point, needs to be checked.
UNKNOWN — the status is not specified. An error occurred when determining the status.

Enum: AT_MODERATION, FAILED, MODERATED, NONMODERATED, UNKNOWN

storagePeriod

Type: integer<int64>

The storage period of the order at its own order pick-up point. It is calculated in days.

visibility

Type: OutletVisibilityType

The status of the point of sale.

Possible values:

HIDDEN — the point of sale is disabled.
VISIBLE — the point of sale is enabled.
UNKNOWN — unknown condition of the point of sale. An error occurred when determining the status.

Enum: HIDDEN, VISIBLE, UNKNOWN

workingTime

⦸

Type: string

Instead, use workingSchedule.

Working hours.

FlippingPagerDTO

A model for pagination.

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

ScrollingPagerDTO

Information about the result pages.

Name

Description

nextPageToken

Type: string

ID of the next results page.

prevPageToken

Type: string

ID of the previous results page.

OutletAddressDTO

The address of the point of sale.

Name	Description
regionId*	Type: integer<int64> ID of the region. You can get the ID using a request GET regions. Types of regions when creating and editing points of sale Specify only the following types of regions `TOWN` (city), `CITY` (large city) and `REPUBLIC_AREA` (district of the federal subject). The type of the region is specified in the output parameters `type` requests GET regions and GET regions/{regionId}.
additional	Type: string Additional information.
block	Type: string Building number. Max length: `16`
building	Type: string Building number. Max length: `16`
city ⦸	Type: string In the responses, cities and towns are returned in the parameter `regionId`. Max length: `200`
estate	Type: string Ownership number. Max length: `16`
km	Type: integer<int32> The ordinal number of the kilometer of the road where the point of sale is located, if there is no street.
number	Type: string The house number. Max length: `256`
street	Type: string Street. Max length: `512`

OutletType

The type of point of sale.

Possible values:

DEPOT — order pick-up point.
MIXED — a mixed type of point of sale (sales floor and order pick-up point).
RETAIL — retail point of sale (sales floor).
NOT_DEFINED — unknown type of point of sale. An error occurred when determining the type.

Type	Description
OutletType	Enum: `DEPOT`, `MIXED`, `RETAIL`, `NOT_DEFINED`

OutletWorkingScheduleDTO

The list of operating modes of the point of sale.

Name

Description

scheduleItems*

Type: OutletWorkingScheduleItemDTO[]

A list of the point of sale's opening hours.
The opening hours of the point of sale.

Min items: 1

workInHoliday

Type: boolean

Indicates whether the point of sale is open on public holidays.

Possible values:

false — the point of sale is closed on public holidays.
true — the point of sale is open on public holidays.

OutletDeliveryRuleDTO

Information about the terms of delivery for this point of sale.

Name	Description
deliveryServiceId	Type: integer<int64> ID of the product delivery service to the point of sale. Information about the delivery service can be obtained by requesting GET delivery/services.
maxDeliveryDays	Type: integer<int32> The maximum delivery time for goods to the point of sale. It is specified in business days. Minimum value: `0` — delivery on the day of the order. Maximum value: `60`. Acceptable delivery time (the difference between `minDeliveryDays` and `maxDeliveryDays`) depend on the region. For delivery in your region, the difference should not exceed two days. For example, if `minDeliveryDays` is equal to 1, then for `maxDeliveryDays` values from 1 to 3 are allowed. For delivery to other regions: If `minDeliveryDays` up to 18 days, the difference should not exceed four days. For example, if `minDeliveryDays` is equal to 10, then for `maxDeliveryDays` values from 10 to 14 are allowed. If `minDeliveryDays` more than 18 days, the difference should not be more than twice. For example, if `minDeliveryDays` is equal to 21, then for `maxDeliveryDays` values from 21 to 42 are allowed. Required parameter if `type="DEPOT"` or `type="MIXED"`. Mutually exclusive with the parameter `unspecifiedDeliveryInterval`. Min value: `0` Max value: `60`
minDeliveryDays	Type: integer<int32> The minimum delivery time for goods to the point of sale. It is specified in business days. Minimum value: `0` — delivery on the day of the order. Maximum value: `60`. Acceptable delivery time (the difference between `minDeliveryDays` and `maxDeliveryDays`) depend on the region. For delivery in your region, the difference should not exceed two days. For example, if `minDeliveryDays` is equal to 1, then for `maxDeliveryDays` values from 1 to 3 are allowed. For delivery to other regions: If `minDeliveryDays` up to 18 days, the difference should not exceed four days. For example, if `minDeliveryDays` is equal to 10, then for `maxDeliveryDays` values from 10 to 14 are allowed. If `minDeliveryDays` more than 18 days, the difference should not be more than twice. For example, if `minDeliveryDays` is equal to 21, then for `maxDeliveryDays` values from 21 to 42 are allowed. Required parameter if `type="DEPOT"` or `type="MIXED"`. Mutually exclusive with the parameter `unspecifiedDeliveryInterval`. Min value: `0` Max value: `60`
orderBefore	Type: integer<int32> The hour before which the customer needs to place the order so that it can be delivered to the point of sale on time from `minDeliveryDays` before `maxDeliveryDays`. If the customer places the order after the specified hour, it will be delivered on time from `minDeliveryDays` + 1 business day before `maxDeliveryDays` + 1 working day. Default value: `24`. Min value: `0` Max value: `24`
priceFreePickup	Type: number The price of the product, starting from which the free pickup of the product from the point of sale is valid.
unspecifiedDeliveryInterval	Type: boolean Indicates the delivery of goods to the point of sale on order. This flag is set if: the exact delivery time to the point of sale is unknown in advance (for example, if the store collects several orders for shipment to the point or locality). all products are made or delivered to order. Possible values: `true` — the goods are delivered to the point of sale on order. The parameter is specified only with the value `true`. Mutually exclusive with parameters `minDeliveryDays` and `maxDeliveryDays`.

RegionDTO

The delivery region.

Name	Description
id*	Type: integer<int64> ID of the region.
name*	Type: string The name of the region.
type*	Type: RegionType The type of region. Possible values: `CITY_DISTRICT` — the area of the city. `CITY` — a large city. `CONTINENT` — the continent. `COUNTRY_DISTRICT` — area. `COUNTRY` — country. `REGION` — region. `REPUBLIC_AREA` — district of the subject of the federation. `REPUBLIC` — the subject of the Federation. `SUBWAY_STATION` — the metro station. `VILLAGE` — the city. `OTHER` — unknown region. Enum: `OTHER`, `CONTINENT`, `REGION`, `COUNTRY`, `COUNTRY_DISTRICT`, `REPUBLIC`, `CITY`, `VILLAGE`, `CITY_DISTRICT`, `SUBWAY_STATION`, `REPUBLIC_AREA`
children	Type: RegionDTO[] Child regions. The delivery region. Min items: `1`
parent	Type: RegionDTO Information about the parent region. Parent regions are specified up to the country level.

OutletStatusType

The status of the point of sale.

Possible values:

AT_MODERATION — it's being checked.
FAILED — failed verification and was rejected by the moderator.
MODERATED — tested and approved.
NONMODERATED — a new point, needs to be checked.
UNKNOWN — the status is not specified. An error occurred when determining the status.

Type	Description
OutletStatusType	Enum: `AT_MODERATION`, `FAILED`, `MODERATED`, `NONMODERATED`, `UNKNOWN`

OutletVisibilityType

The status of the point of sale.

Possible values:

HIDDEN — the point of sale is disabled.
VISIBLE — the point of sale is enabled.
UNKNOWN — unknown condition of the point of sale. An error occurred when determining the status.

Type	Description
OutletVisibilityType	Enum: `HIDDEN`, `VISIBLE`, `UNKNOWN`

OutletWorkingScheduleItemDTO

The opening hours of the point of sale.

Name	Description
endDay*	Type: DayOfWeekType Day of the week: `MONDAY` — Monday. `TUESDAY` "Tuesday." `WEDNESDAY` — Wednesday. `THURSDAY` — Thursday. `FRIDAY` — Friday. `SATURDAY` "Saturday." `SUNDAY` — Sunday. Enum: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`
endTime*	Type: string The point of sale is open until the specified hour. Format: `HH:MM`. Example: `23:59` Pattern: `^([0-1][0-9]<code>\|</code>2[0-3]):[0-5][0-9]$`
startDay*	Type: DayOfWeekType Day of the week: `MONDAY` — Monday. `TUESDAY` "Tuesday." `WEDNESDAY` — Wednesday. `THURSDAY` — Thursday. `FRIDAY` — It's Friday. `SATURDAY` "Saturday." `SUNDAY` — Sunday. Enum: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`
startTime*	Type: string The point of sale is open starting from the specified hour. Format: `HH:MM`. Example: `09:59` Pattern: `^([0-1][0-9]<code>\|</code>2[0-3]):[0-5][0-9]$`

RegionType

The type of region.

Possible values:

CITY_DISTRICT — the area of the city.
CITY — a large city.
CONTINENT — the continent.
COUNTRY_DISTRICT — area.
COUNTRY — country.
REGION — region.
REPUBLIC_AREA — district of the subject of the federation.
REPUBLIC — the subject of the Federation.
SUBWAY_STATION — the metro station.
VILLAGE — the city.
OTHER — unknown region.

Type	Description
RegionType	Enum: `OTHER`, `CONTINENT`, `REGION`, `COUNTRY`, `COUNTRY_DISTRICT`, `REPUBLIC`, `CITY`, `VILLAGE`, `CITY_DISTRICT`, `SUBWAY_STATION`, `REPUBLIC_AREA`

DayOfWeekType

Day of the week:

MONDAY — Monday.
TUESDAY "Tuesday."
WEDNESDAY — Wednesday.
THURSDAY — Thursday.
FRIDAY — Friday.
SATURDAY "Saturday."
SUNDAY — Sunday.

Type	Description
DayOfWeekType	Enum: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`

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.

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`

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?

One point of sale

Creation