Получение списка ПВЗ #
Адрес метода #
Параметры запроса #
Параметр | Тип параметра | Тип данных | Описание | Обязательность | Пример |
---|---|---|---|---|---|
limit | запрос | число | да | 23 | |
offset | запрос | число | да | 0 | |
filter | запрос | строка | Возможна фильтрация по полям: id, providerKey, code, codeOriginal, name, postIndex, lat, lng, countryCode, region, regionType, city, cityGuid, cityType, area, street, streetType, house, block, office, address, url, email, phone, availableOperation, type, cod, paymentCash, paymentCard, fittingRoom. Например: city=Москва;providerKey=cdek;availableOperation=[2,3]. Документация работы фильтра: https://docs.apiship.ru/docs/api/query-filter/ | да | city=Москва;providerKey=cdek;availableOperation=[2,3] |
fields | запрос | строка | перечень отдаваемых полей, если не указан, отдаются все поля | нет | 0 |
stateCheckOff | запрос | булев | Если stateCheckOff=1 отдаются также ПВЗ у которых указан не точный адрес расположения | да | true |
Пример данных запроса #
|
|
|
|
Параметры ответа #
Раздел | Параметр | Описание | Тип | Обязательный | Пример |
---|---|---|---|---|---|
rows | |||||
id | ID ПВЗ | число | нет | 16222 | |
providerKey | Идентификатор службы доставки | строка | нет | boxberry | |
code | Код терминала в системе службы доставки | строка | нет | 97151 | |
name | Название | строка | нет | Москва Алтуфьевское_9715_С | |
postIndex | Индекс | строка | нет | 127349 | |
lat | Широта отправителя | число | нет | 55.7553172 | |
lng | Долгота отправителя | число | нет | 37.5942631 | |
countryCode | Код страны | строка | нет | RU | |
region | Регион | строка | нет | Москва | |
regionType | Тип региона | строка | нет | г | |
city | Город | строка | нет | Москва | |
cityGuid | ID города в базе ФИА | строка | нет | 0c5b2444-70a0-4932-980c-b4dc0d3f02b5" | |
cityType | Тип населенного пункта | строка | нет | г | |
area | Район | строка | нет | Москва | |
street | Улица | строка | нет | Алтуфьевское | |
streetType | Тип улицы (ул., переулок и т.п.) | строка | нет | ш. | |
house | Дом | строка | нет | 80 | |
block | Корпус | строка | нет | null | |
office | Офис | строка | нет | null | |
address | Полный адрес, полученный от СД | строка | нет | 127349, Москва г, Алтуфьевское ш, д.80 | |
url | Домашняя страница | строка | нет | null | |
строка | нет | null | |||
phone | Телефон | строка | нет | 8-499-391-56-22 | |
timetable | Режим работы | строка | нет | пн-пт: 10.00-20.30, сб: 10.00-19.00 | |
worktime | Режим работы по дням (1 - пн; 7 - вс) Отсутствие дня означает выходной | массив чисел | нет | “1”: “10:00/20:30”,“2”: “10:00/20:30”, “3”: “10:00/20:30”, “4”: “10:00/20:30”, “5”: “10:00/20:30”, “6”: “10:00/19:00”, “7”: “12:00/19:00” | |
fittingRoom | Наличие примерочной | число | нет | 0 | |
cod | Имеется ли возможность оплаты при доставке (null - нет данных, 1 - оплата доступна, 0 - оплата не доступна) | число | нет | 1 | |
paymentCash | Имеется ли возможность оплаты наличными (null - нет данных, 1 - оплата наличными доступна, 0 - оплата наличными не доступна) | число | нет | null | |
paymentCard | Имеется ли возможность оплаты банковской картой (null - нет данных, 1 - оплата картой доступна, 0 - оплата картой не доступна) | число | нет | 1 | |
multiplaceDeliveryAllowed | Возможна ли выдача многоместных отправлений (null - нет данных, 1 - выдача возможна, 0 - выдача невозможна) | число | нет | 1 | |
availableOperation | Тип операции (1 - прием, 2 - выдача, 3 - прием и выдача) | число | нет | 3 | |
type | Тип точки (1 - Пункт выдачи заказа, 2 - Постамат, 3 - Отделение Почты России, 4 - Терминал) | число | нет | 1 | |
description | Описание ПВЗ, как пройти | строка | нет | “Метро: "Алтуфьево", \nПоследний вагон из центра.\nПримерное расстояние от метро до отделения - 300 метров.\nТД "Арфа".\nЦентральный вход.\n2 этаж.\nОтдел: "Пункт выдачи заказов".\n” | |
photos | Фото | массив строк | нет | “https://storage.apiship.ru/file/get?file=1cc2069ad409c6b207aacde3916625c3.jpeg" | |
metro | |||||
distance | Дистанция | число | нет | 0.5 | |
line | Линия | строка | нет | Серпуховско-Тимирязевская | |
name | Имя | строка | нет | Алтуфьево | |
extra | |||||
key | Название дополнительного параметра | строка | нет | return | |
value | Значение дополнительного параметра | строка | нет | null | |
limits | |||||
maxSizeA | Максимальная длина стороны А в см | число | нет | 62 | |
maxSizeB | Максимальная длина стороны И в см | число | нет | 67 | |
maxSizeC | Максимальная длина стороны С в см | число | нет | 56 | |
maxSizeSum | Максимальная сумма длин всех сторон в см | число | нет | 180 | |
minWeight | Минимальный вес в г | число | нет | 0 | |
maxWeight | Максимальный вес в г | число | нет | 15000 | |
maxCod | Максимальная сумма НП в рублях | число | нет | 100.2 | |
maxVolume | Максимальный обьем в см3 | число | нет | 1000000 | |
meta | |||||
total | число | нет | 0 | ||
offset | число | нет | 0 | ||
limit | число | нет | 0 |
Пример данных ответа #
|
|
|
|