Получение точек ПВЗ

.

Пока недоступен для продавцов Market Yandex Go.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Возвращает список пунктов выдачи заказов.

Регулярно запрашивайте эту информацию, чтобы в системе магазина хранить актуальные данные. Например, раз в день.

⚙️ Лимит: 10 000 запросов в час

Request

POST

https://api.partner.market.yandex.ru/v1/businesses/{businessId}/logistics-points

Path parameters

Name

Description

businessId*

Type: integer<int64>

Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

Количество значений на одной странице.

Min value: 1
Example: 20

page_token

Type: string

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуем передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры page и pageSize, они игнорируются.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Responses

200 OK

Информация о пунктах выдачи заказов.

Body

application/json
{
    "status": "OK",
    "result": {
        "logisticPoints": [
            {
                "logisticPointId": 0,
                "brand": "MARKET",
                "address": {
                    "fullAddress": "string",
                    "gps": {
                        "latitude": 0,
                        "longitude": 0
                    },
                    "regionId": 0,
                    "city": "string",
                    "street": "string",
                    "house": "string",
                    "building": "string",
                    "block": "string",
                    "km": 0,
                    "additional": "string"
                },
                "workingSchedule": {
                    "schedule": [
                        {
                            "day": "MONDAY",
                            "startTime": "string",
                            "endTime": "string"
                        }
                    ],
                    "holidays": [
                        "string"
                    ]
                },
                "deliveryRestrictions": {
                    "dimensionsRestrictions": {
                        "weight": 0,
                        "height": 0,
                        "width": 0,
                        "length": 0,
                        "dimensionsSum": 0
                    }
                },
                "features": [
                    "RETURN_ALLOWED"
                ],
                "paymentTypes": [
                    "PREPAID"
                ],
                "storagePeriod": 0
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Description

status*

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

result

Type: GetLogisticsPointsDTO

Информация о пунктах выдачи заказов.

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

GetLogisticsPointsDTO

Информация о пунктах выдачи заказов.

Name

Description

logisticPoints*

Type: LogisticPointDTO[]

Пункты выдачи заказов.
Информация о пункте выдачи.

paging

Type: ForwardScrollingPagerDTO

Идентификатор следующей страницы.

LogisticPointDTO

Информация о пункте выдачи.

Name

Description

address*

Type: LogisticPointAddressDTO

Адрес пункта выдачи.

brand*

Type: LogisticPointBrandType

Тип пункта выдачи:

  • MARKET — пункт выдачи Маркета.

Enum: MARKET

deliveryRestrictions*

Type: LogisticPointDeliveryRestrictionDTO

Ограничения на доставку в пункт выдачи.

logisticPointId*

Type: integer<int64>

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

Его можно узнать с помощью метода POST v1/businesses/{businessId}/logistics-points.

Min value: 1

paymentTypes*

Type: DeliveryPaymentType[]

Способы оплаты, которые доступны в этом пункте выдачи.
Тип оплаты заказа:

  • PREPAID — оплата при оформлении заказа.

Enum: PREPAID

Min items: 1

Unique items  

storagePeriod*

Type: integer<int64>

Срок хранения заказа в пункте выдачи.

Указывается в днях.

workingSchedule*

Type: LogisticPointScheduleDTO

Расписание работы пункта выдачи.

features

Type: LogisticPointFeatureType[]

Свойства пункта выдачи.
Свойство пункта выдачи:

  • RETURN_ALLOWED — доступен для возврата товаров.

Enum: RETURN_ALLOWED

Min items: 1

Unique items  

ForwardScrollingPagerDTO

Идентификатор следующей страницы.

Name

Description

nextPageToken

Type: string

Идентификатор следующей страницы результатов.

LogisticPointAddressDTO

Адрес пункта выдачи.

Name

Description

fullAddress*

Type: string

Полный адрес.

Min length: 1

Max length: 512

gps*

Type: GpsDTO

GPS-координаты широты и долготы.

regionId*

Type: integer<int64>

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

Информацию о регионе можно получить c помощью метода GET v2/regions.

additional

Type: string

Дополнительная информация.

Min length: 1

Max length: 1024

block

Type: string

Номер корпуса.

Min length: 1

Max length: 16

building

Type: string

Номер строения.

Min length: 1

Max length: 16

city

Type: string

Город.

Min length: 1

Max length: 128

house

Type: string

Номер дома.

Min length: 1

Max length: 16

km

Type: integer<int32>

Порядковый номер километра, на котором располагается пункт выдачи.

Указывается, если в адресе нет улицы.

Min value: 0

street

Type: string

Улица.

Min length: 1

Max length: 128

LogisticPointBrandType

Тип пункта выдачи:

  • MARKET — пункт выдачи Маркета.

Type

Description

LogisticPointBrandType

Enum: MARKET

LogisticPointDeliveryRestrictionDTO

Ограничения на доставку в пункт выдачи.

Name

Description

dimensionsRestrictions*

Type: LogisticPointDimensionRestrictionsDTO

Ограничения по размеру одного товара.

DeliveryPaymentType

Тип оплаты заказа:

  • PREPAID — оплата при оформлении заказа.

Type

Description

DeliveryPaymentType

Enum: PREPAID

LogisticPointScheduleDTO

Расписание работы пункта выдачи.

Name

Description

schedule*

Type: ScheduleDayDTO[]

График работы.
День и время работы.

Min items: 1

holidays

Type: string[]

Расписание праздничных дней.
Праздничный день.

Формат даты: ГГГГ-ММ-ДД.

Min items: 1

Unique items  

LogisticPointFeatureType

Свойство пункта выдачи:

  • RETURN_ALLOWED — доступен для возврата товаров.

Type

Description

LogisticPointFeatureType

Enum: RETURN_ALLOWED

GpsDTO

GPS-координаты широты и долготы.

Name

Description

latitude*

Type: number

Широта.

longitude*

Type: number

Долгота.

LogisticPointDimensionRestrictionsDTO

Ограничения по размеру одного товара.

Name

Description

dimensionsSum*

Type: integer<int32>

Максимальная сумма измерений в сантиметрах.

Min value: 1

height*

Type: integer<int32>

Максимальная высота в сантиметрах.

Min value: 1

length*

Type: integer<int32>

Максимальная длина в сантиметрах.

Min value: 1

weight*

Type: integer<int32>

Максимальный вес в граммах.

Min value: 1

width*

Type: integer<int32>

Максимальная ширина в сантиметрах.

Min value: 1

ScheduleDayDTO

День и время работы.

Name

Description

day*

Type: DayOfWeekType

День недели:

  • MONDAY — понедельник.
  • TUESDAY — вторник.
  • WEDNESDAY — среда.
  • THURSDAY — четверг.
  • FRIDAY — пятница.
  • SATURDAY — суббота.
  • SUNDAY — воскресенье.

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

endTime*

Type: string

Время конца рабочего дня.

Формат: ЧЧ:ММ.

Pattern: ^([0-1][0-9]<code>&#124;</code>2[0-3]):[0-5][0-9]$

startTime*

Type: string

Время начала рабочего дня.

Формат: ЧЧ:ММ.

Pattern: ^([0-1][0-9]<code>&#124;</code>2[0-3]):[0-5][0-9]$

DayOfWeekType

День недели:

  • MONDAY — понедельник.
  • TUESDAY — вторник.
  • WEDNESDAY — среда.
  • THURSDAY — четверг.
  • FRIDAY — пятница.
  • SATURDAY — суббота.
  • SUNDAY — воскресенье.

Type

Description

DayOfWeekType

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

Общий формат ошибки.

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

Описание ошибки.

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

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