2.02. Получение списка точек самопривоза и ПВЗ

Получение списка точек самопривоза и самостоятельного получения заказа.
Метод принимает пустое тело запроса, в этом случае вернутся все доступные способы доставки.

Request

POST

b2b.taxi.tst.yandex.net/api/b2b/platform/pickup-points/list

Тестовое окружение

POST

b2b-authproxy.taxi.yandex.net/api/b2b/platform/pickup-points/list

Продакшен-окружение

Body

application/json
{
    "pickup_point_ids": [
        "string"
    ],
    "geo_id": 0,
    "longitude": {
        "from": 0,
        "to": 0
    },
    "latitude": {
        "from": 0,
        "to": 0
    },
    "type": "pickup_point",
    "payment_method": "already_paid",
    "available_for_dropoff": false,
    "is_yandex_branded": false,
    "is_not_branded_partner_station": false,
    "is_post_office": false,
    "payment_methods": [
        "already_paid"
    ]
}

Name

Description

available_for_dropoff

Type: boolean

Возможность отгрузки заказов в точку (самопривоз).

geo_id

Type: integer

Min value: 0

is_not_branded_partner_station

Type: boolean

Признак добавляющий партнерские ПВЗ.

Default: false

is_post_office

Type: boolean

Признак добавляющий ПВЗ почты россии.

Default: false

is_yandex_branded

Type: boolean

Признак брендированные ли ПВЗ.

Default: false

latitude

Type: CoordinateInterval

Интервал для выбора всех объектов в отрезке по широте.

longitude

Type: CoordinateInterval

Интервал для выбора всех объектов в отрезке по долготе.

payment_method

Type: PaymentMethod

Тип оплаты в точке самостоятельного получения заказа.

Enum: already_paid, cash_on_receipt, card_on_receipt

payment_methods

Type: PaymentMethod[]

Набор типов оплаты, которы должны быть доступны в самостоятельного точке получения заказа.

Enum: already_paid, cash_on_receipt, card_on_receipt

pickup_point_ids

Type: string[]

Идентификаторы точек получения заказа.

type

Type: PickupStationType

Тип точки приема/выдачи заказа.

Enum: pickup_point, terminal, post_office, sorting_center

CoordinateInterval

Name

Description

from

Type: number

Нижняя граница интервала

to

Type: number

Верхняя граница интервала

PaymentMethod

Type

Description

PaymentMethod

Enum: already_paid, cash_on_receipt, card_on_receipt

PickupStationType

pickup_point - пункт выдачи заказов;
terminal - постомат;
post_office - почтовое отделение;
sorting_center - сортировочный центр;

Type

Description

PickupStationType

Enum: pickup_point, terminal, post_office, sorting_center

Responses

200 OK

Успешный запрос

Body

application/json
{
    "points": [
        {
            "ID": "string",
            "operator_station_id": "string",
            "name": "string",
            "type": "pickup_point",
            "position": {
                "latitude": 0,
                "longitude": 0
            },
            "address": {
                "geoId": "213",
                "country": "Россия",
                "region": "Москва",
                "subRegion": "string",
                "locality": "Москва",
                "street": "Пролетарский проспект",
                "house": "19",
                "housing": "string",
                "apartment": "string",
                "building": "string",
                "comment": "string",
                "full_address": "Москва, Пролетарский проспект, 19",
                "postal_code": "string"
            },
            "instruction": "string",
            "payment_methods": [
                "already_paid"
            ],
            "contact": {
                "first_name": "string",
                "last_name": "string",
                "partonymic": "string",
                "phone": "string",
                "email": "string"
            },
            "schedule": {
                "time_zone": 0,
                "restrictions": [
                    {
                        "days": [
                            0
                        ],
                        "time_from": {
                            "hours": 0,
                            "minutes": 0
                        },
                        "time_to": {
                            "hours": 0,
                            "minutes": 0
                        }
                    }
                ]
            },
            "is_yandex_branded": false,
            "is_market_partner": false,
            "is_dark_store": false,
            "is_post_office": false,
            "dayoffs": [
                {
                    "date": "1733356800",
                    "date_utc": "2024-12-05T00:00:00+0000"
                }
            ]
        }
    ]
}

Name

Description

points*

Type: PickupStation[]

PickupStation

Name

Description

ID*

Type: string

Идентификатор точки забора заказа. Должен использоваться при получении вариантов доставки в качестве конечной точки

address*

Type: LocationDetails

Полный адрес точки забора заказа

contact*

Type: StationContact

Данные для связи с точкой забора заказа

name*

Type: string

Название точки забора заказа

payment_methods*

Type: PaymentMethod[]

Возможные методы оплаты заказа при получении

Enum: already_paid, cash_on_receipt, card_on_receipt

position*

Type: GeoPoint

Точка, в которой находится точка забора заказа

schedule*

Type: StationSchedule

Расписание работы точки

type*

Type: PickupStationType

Тип точки забора заказа

Enum: pickup_point, terminal, post_office, sorting_center

dayoffs

Type: DayOffs[]

Нерабочие дни ПВЗ

instruction

Type: string

Дополнительные указания по тому, как добраться до точки получения заказа

is_dark_store

Type: boolean

Признак даркстора

Default: false

is_market_partner

Type: boolean

Признак партнерского ПВЗ

Default: false

is_post_office

Type: boolean

Признак Почты России

Default: false

is_yandex_branded

Type: boolean

Признак брендированные ли ПВЗ

Default: false

operator_station_id

Type: string

Идентификатор точки забора заказа в системе оператора

LocationDetails

Адрес квартиры обязателен при наличии

Name

Description

apartment

Type: string

Номер квартиры

building

Type: string

Строение

comment

Type: string

Комментарий

country

Type: string

Страна

Example: Россия

full_address

Type: string

Полный адрес с указанием города, улицы и номера дома

Example: Москва, Пролетарский проспект, 19

geoId

Type: number

Идентификатор города

Example: 213

house

Type: string

Номер дома

Example: 19

housing

Type: string

Корпус

locality

Type: string

Населенный пункт

Example: Москва

postal_code

Type: string

Индекс

region

Type: string

Регион

Example: Москва

street

Type: string

Улица

Example: Пролетарский проспект

subRegion

Type: string

Область

StationContact

Name

Description

phone*

Type: string

Номер телефона

email

Type: string

Адрес электронной почты

first_name

Type: string

Имя

last_name

Type: string

Фамилия

partonymic

Type: string

Отчество

GeoPoint

Name

Description

latitude

Type: number

Широта.

longitude

Type: number

Долгота.

StationSchedule

Name

Description

restrictions

Type: StationScheduleRestriction[]

Правила, задающие расписание работы.

time_zone

Type: integer

Часовая зона; смещение в часах относительно всемирного координированного времени UTC.

DayOffs

Name

Description

date

Type: integer

Дата в формате UNIX

Example: 1733356800

date_utc

Type: integer

Дата в формате UTC

Example: 2024-12-05T00:00:00+0000

StationScheduleRestriction

Name

Description

days

Type: integer[]

Номера дней недели, к которым применяется правило. 1 - понедельник, 2 - вторник, ..., 7 - воскресенье.

Min value: 1

Max value: 7

time_from

Type: DayTime

Время начала работы.

time_to

Type: DayTime

Время окончания работы.

DayTime

Name

Description

hours

Type: integer

Часы

Min value: 0

Max value: 23

minutes

Type: integer

Минуты

Min value: 0

Max value: 59