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": "01946f4f013c7337874ec2fb848a58a4",
  "geo_id": 0,
  "longitude": {
    "from": 0.5,
    "to": 0.5
  },
  "latitude": null,
  "type": "pickup_point",
  "payment_method": "already_paid",
  "available_for_dropoff": true,
  "is_yandex_branded": false,
  "is_not_branded_partner_station": false,
  "payment_methods": [
    null
  ],
  "pickup_services": {
    "is_fitting_allowed": true,
    "is_partial_refuse_allowed": true,
    "is_paperless_pickup_allowed": true,
    "is_unboxing_allowed": true
  }
}

Name

Description

available_for_dropoff

Type: boolean

Возможность отгрузки заказов в точку самопривоза. Для точки с типом warehouse обязательно передавайте значение true

geo_id

Type: integer

Min value: 0

is_not_branded_partner_station

Type: boolean

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

Default: false

is_yandex_branded

Type: boolean

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

Default: false

latitude

Type: CoordinateInterval

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

Example
{
  "from": 0.5,
  "to": 0.5
}

longitude

Type: CoordinateInterval

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

Example
{
  "from": 0.5,
  "to": 0.5
}

payment_method

Type: PaymentMethod

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

Enum: already_paid, card_on_receipt, postpay

payment_methods

Type: PaymentMethod[]

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

Example
[
  "already_paid"
]

pickup_point_ids

Type: string[]

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

Example: 01946f4f013c7337874ec2fb848a58a4

pickup_services

Type: PickupServices

Услуги с коробками/товарами, которые доступны на ПВЗ

Example
{
  "is_fitting_allowed": true,
  "is_partial_refuse_allowed": true,
  "is_paperless_pickup_allowed": true,
  "is_unboxing_allowed": true
}

type

Type: PickupStationType

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

pickup_point — пункт выдачи заказов;
terminal — постомат;
warehouse — сортировочный центр;

Enum: pickup_point, terminal, warehouse

CoordinateInterval

Name

Description

from

Type: number

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

to

Type: number

Верхняя граница интервала
Example
{
  "from": 0.5,
  "to": 0.5
}

PickupStationType

pickup_point — пункт выдачи заказов;
terminal — постомат;
warehouse — сортировочный центр;

Type: string

Enum: pickup_point, terminal, warehouse

PaymentMethod

Type: string

Enum: already_paid, card_on_receipt, postpay

PickupServices

Name

Description

is_fitting_allowed

Type: boolean

Разрешена ли примерка на ПВЗ

is_paperless_pickup_allowed

Type: boolean

Разрешена ли сдача без бумаг на ПВЗ

is_partial_refuse_allowed

Type: boolean

Разрешен ли частичный выкуп на ПВЗ

is_unboxing_allowed

Type: boolean

Разрешено ли вскрытие транспортной упаковки
Example
{
  "is_fitting_allowed": true,
  "is_partial_refuse_allowed": true,
  "is_paperless_pickup_allowed": true,
  "is_unboxing_allowed": true
}

Responses

200 OK

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

Body

application/json
{
  "points": [
    {
      "id": "0198602de4a6749aba12e151bdf4caaa",
      "operator_station_id": "10035218565",
      "name": "Пункт выдачи заказов Яндекс Маркета",
      "type": "pickup_point",
      "position": {
        "latitude": 55.666624,
        "longitude": 37.51573
      },
      "address": {
        "geoId": 213,
        "country": "Россия",
        "region": "Москва",
        "subRegion": "Московская область",
        "locality": "Москва",
        "street": "Пролетарский проспект",
        "house": "19",
        "housing": "1",
        "apartment": "2",
        "building": "1",
        "comment": "Станция метро Щукинская (4выход) второй дом слева. Вход со двора с дальнего края дома. Ориентир вывеска Яндекс Маркет",
        "full_address": "Москва, Пролетарский проспект, 19",
        "postal_code": "123182"
      },
      "instruction": "Станция метро Щукинская (4выход) второй дом слева. Вход со двора с дальнего края дома. Ориентир вывеска Яндекс Маркет",
      "payment_methods": [
        "already_paid"
      ],
      "contact": {
        "first_name": "Василий",
        "last_name": "Пупкин",
        "patronymic": "Михайлович",
        "phone": "+74959999999",
        "email": "pupkin@mail.ru"
      },
      "schedule": {
        "time_zone": 0,
        "restrictions": [
          {}
        ]
      },
      "is_yandex_branded": false,
      "is_market_partner": false,
      "is_dark_store": false,
      "pickup_services": {
        "is_fitting_allowed": true,
        "is_partial_refuse_allowed": true,
        "is_paperless_pickup_allowed": true,
        "is_unboxing_allowed": true
      },
      "deactivation_date": "null",
      "deactivation_date_predicted_debt": "null",
      "available_for_dropoff": true,
      "available_for_c2c_dropoff": true,
      "dayoffs": [
        {
          "date": 1733356800,
          "date_utc": "2024-12-05T00:00:00+0000"
        }
      ]
    }
  ]
}

Name

Description

points

Type: PickupStation[]

Example
[
  {
    "id": "0198602de4a6749aba12e151bdf4caaa",
    "operator_station_id": "10035218565",
    "name": "Пункт выдачи заказов Яндекс Маркета",
    "type": "pickup_point",
    "position": {
      "latitude": 55.666624,
      "longitude": 37.51573
    },
    "address": {
      "geoId": 213,
      "country": "Россия",
      "region": "Москва",
      "subRegion": "Московская область",
      "locality": "Москва",
      "street": "Пролетарский проспект",
      "house": "19",
      "housing": "1",
      "apartment": "2",
      "building": "1",
      "comment": "Станция метро Щукинская (4выход) второй дом слева. Вход со двора с дальнего края дома. Ориентир вывеска Яндекс Маркет",
      "full_address": "Москва, Пролетарский проспект, 19",
      "postal_code": "123182"
    },
    "instruction": "Станция метро Щукинская (4выход) второй дом слева. Вход со двора с дальнего края дома. Ориентир вывеска Яндекс Маркет",
    "payment_methods": [
      "already_paid"
    ],
    "contact": {
      "first_name": "Василий",
      "last_name": "Пупкин",
      "patronymic": "Михайлович",
      "phone": "+74959999999",
      "email": "pupkin@mail.ru"
    },
    "schedule": {
      "time_zone": 0,
      "restrictions": [
        {
          "days": [
            null
          ],
          "time_from": {},
          "time_to": null
        }
      ]
    },
    "is_yandex_branded": false,
    "is_market_partner": false,
    "is_dark_store": false,
    "pickup_services": {
      "is_fitting_allowed": true,
      "is_partial_refuse_allowed": true,
      "is_paperless_pickup_allowed": true,
      "is_unboxing_allowed": true
    },
    "deactivation_date": "null",
    "deactivation_date_predicted_debt": "null",
    "available_for_dropoff": true,
    "available_for_c2c_dropoff": true,
    "dayoffs": [
      {
        "date": 1733356800,
        "date_utc": "2024-12-05T00:00:00+0000"
      }
    ]
  }
]

GeoPoint

Name

Description

latitude

Type: number

Широта

longitude

Type: number

Долгота
Example
{
  "latitude": 55.666624,
  "longitude": 37.51573
}

LocationDetails

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

Name

Description

apartment

Type: string

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

Example: 2

building

Type: string

Строение

Example: 1

comment

Type: string

Комментарий

Example: Станция метро Щукинская (4выход) второй дом слева. Вход со двора с дальнего края дома. Ориентир вывеска Яндекс Маркет

country

Type: string

Страна

Example: Россия

full_address

Type: string

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

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

geoId

Type: number

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

house

Type: string

Номер дома

Example: 19

housing

Type: string

Корпус

Example: 1

locality

Type: string

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

Example: Москва

postal_code

Type: string

Индекс

Example: 123182

region

Type: string

Регион

Example: Москва

street

Type: string

Улица

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

subRegion

Type: string

Область

Example: Московская область
Example
{
  "geoId": 213,
  "country": "Россия",
  "region": "Москва",
  "subRegion": "Московская область",
  "locality": "Москва",
  "street": "Пролетарский проспект",
  "house": "19",
  "housing": "1",
  "apartment": "2",
  "building": "1",
  "comment": "Станция метро Щукинская (4выход) второй дом слева. Вход со двора с дальнего края дома. Ориентир вывеска Яндекс Маркет",
  "full_address": "Москва, Пролетарский проспект, 19",
  "postal_code": "123182"
}

StationContact

Name

Description

phone

Type: string

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

Example: +74959999999

email

Type: string

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

Example: pupkin@mail.ru

first_name

Type: string

Имя

Example: Василий

last_name

Type: string

Фамилия

Example: Пупкин

patronymic

Type: string

Отчество

Example: Михайлович
Example
{
  "first_name": "Василий",
  "last_name": "Пупкин",
  "patronymic": "Михайлович",
  "phone": "+74959999999",
  "email": "pupkin@mail.ru"
}

DayTime

Name

Description

hours

Type: integer

Часы

Min value: 0

Max value: 23

minutes

Type: integer

Минуты

Min value: 0

Max value: 59
Example
{
  "hours": 0,
  "minutes": 0
}

StationScheduleRestriction

Name

Description

days

Type: integer[]

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

Example
[
  1
]

time_from

Type: DayTime

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

Example
{
  "hours": 0,
  "minutes": 0
}

time_to

Type: DayTime

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

Example
{
  "hours": 0,
  "minutes": 0
}
Example
{
  "days": [
    1
  ],
  "time_from": {
    "hours": 0,
    "minutes": 0
  },
  "time_to": null
}

StationSchedule

Name

Description

restrictions

Type: StationScheduleRestriction[]

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

Example
[
  {
    "days": [
      1
    ],
    "time_from": {
      "hours": 0,
      "minutes": 0
    },
    "time_to": null
  }
]

time_zone

Type: integer

Часовая зона; смещение в часах относительно всемирного координированного времени UTC.
Example
{
  "time_zone": 0,
  "restrictions": [
    {
      "days": [
        1
      ],
      "time_from": {
        "hours": 0,
        "minutes": 0
      },
      "time_to": null
    }
  ]
}

DayOffs

Name

Description

date

Type: integer

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

date_utc

Type: integer

Дата в формате UTC
Example
{
  "date": 1733356800,
  "date_utc": "2024-12-05T00:00:00+0000"
}

PickupStation

Name

Description

address

Type: LocationDetails

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

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

Example
{
  "geoId": 213,
  "country": "Россия",
  "region": "Москва",
  "subRegion": "Московская область",
  "locality": "Москва",
  "street": "Пролетарский проспект",
  "house": "19",
  "housing": "1",
  "apartment": "2",
  "building": "1",
  "comment": "Станция метро Щукинская (4выход) второй дом слева. Вход со двора с дальнего края дома. Ориентир вывеска Яндекс Маркет",
  "full_address": "Москва, Пролетарский проспект, 19",
  "postal_code": "123182"
}

contact

Type: StationContact

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

Example
{
  "first_name": "Василий",
  "last_name": "Пупкин",
  "patronymic": "Михайлович",
  "phone": "+74959999999",
  "email": "pupkin@mail.ru"
}

name

Type: string

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

Example: Пункт выдачи заказов Яндекс Маркета

payment_methods

Type: PaymentMethod[]

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

Example
[
  "already_paid"
]

position

Type: GeoPoint

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

Example
{
  "latitude": 55.666624,
  "longitude": 37.51573
}

schedule

Type: StationSchedule

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

Example
{
  "time_zone": 0,
  "restrictions": [
    {
      "days": [
        1
      ],
      "time_from": {
        "hours": 0,
        "minutes": 0
      },
      "time_to": null
    }
  ]
}

type

Type: PickupStationType

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

pickup_point — пункт выдачи заказов;
terminal — постомат;
warehouse — сортировочный центр;

Enum: pickup_point, terminal, warehouse

available_for_c2c_dropoff

Type: boolean

Доступен ли ПВЗ для сдачи физическими лицами

available_for_dropoff

Type: boolean

Доступен ли ПВЗ для сдачи юридическими лицами

dayoffs

Type: DayOffs[]

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

Example
[
  {
    "date": 1733356800,
    "date_utc": "2024-12-05T00:00:00+0000"
  }
]

deactivation_date

Type: string

Дата деактивации ПВЗ

Example: null

deactivation_date_predicted_debt

Type: string

Дата деактивации ПВЗ в случае неоплаты

Example: null

id

Type: string

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

Example: 0198602de4a6749aba12e151bdf4caaa

instruction

Type: string

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

Example: Станция метро Щукинская (4выход) второй дом слева. Вход со двора с дальнего края дома. Ориентир вывеска Яндекс Маркет

is_dark_store

Type: boolean

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

Default: false

is_market_partner

Type: boolean

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

Default: false

is_yandex_branded

Type: boolean

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

Default: false

operator_station_id

Type: string

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

Example: 10035218565

pickup_services

Type: PickupServices

Доступные услуги с коробками/товарами на ПВЗ

Example
{
  "is_fitting_allowed": true,
  "is_partial_refuse_allowed": true,
  "is_paperless_pickup_allowed": true,
  "is_unboxing_allowed": true
}
Example
{
  "id": "0198602de4a6749aba12e151bdf4caaa",
  "operator_station_id": "10035218565",
  "name": "Пункт выдачи заказов Яндекс Маркета",
  "type": "pickup_point",
  "position": {
    "latitude": 55.666624,
    "longitude": 37.51573
  },
  "address": {
    "geoId": 213,
    "country": "Россия",
    "region": "Москва",
    "subRegion": "Московская область",
    "locality": "Москва",
    "street": "Пролетарский проспект",
    "house": "19",
    "housing": "1",
    "apartment": "2",
    "building": "1",
    "comment": "Станция метро Щукинская (4выход) второй дом слева. Вход со двора с дальнего края дома. Ориентир вывеска Яндекс Маркет",
    "full_address": "Москва, Пролетарский проспект, 19",
    "postal_code": "123182"
  },
  "instruction": "Станция метро Щукинская (4выход) второй дом слева. Вход со двора с дальнего края дома. Ориентир вывеска Яндекс Маркет",
  "payment_methods": [
    "already_paid"
  ],
  "contact": {
    "first_name": "Василий",
    "last_name": "Пупкин",
    "patronymic": "Михайлович",
    "phone": "+74959999999",
    "email": "pupkin@mail.ru"
  },
  "schedule": {
    "time_zone": 0,
    "restrictions": [
      {
        "days": [
          1
        ],
        "time_from": {
          "hours": 0,
          "minutes": 0
        },
        "time_to": null
      }
    ]
  },
  "is_yandex_branded": false,
  "is_market_partner": false,
  "is_dark_store": false,
  "pickup_services": {
    "is_fitting_allowed": true,
    "is_partial_refuse_allowed": true,
    "is_paperless_pickup_allowed": true,
    "is_unboxing_allowed": true
  },
  "deactivation_date": "null",
  "deactivation_date_predicted_debt": "null",
  "available_for_dropoff": true,
  "available_for_c2c_dropoff": true,
  "dayoffs": [
    {
      "date": 1733356800,
      "date_utc": "2024-12-05T00:00:00+0000"
    }
  ]
}

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

Предыдущая
2.01. Получение идентификатора населённого пункта
Следующая
3.01. Создание заявки