Swagger API Личный кабинет Центр поддержки

Получение списка ПВЗ #

Адрес метода #

GET /lists/points

Параметры запроса #

ПараметрТип параметраТип данныхОписаниеОбязательностьПример
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

Пример данных запроса #

1
2
3
4
5
6
{
    "limit": "1000",
    "offset": "0",
    "filter": "city=Ижевск;type=[1,2,3,4];providerKey=cdek;availableOperation=[1,3]",
    "stateCheckOff": "0"
}
1
2
3
4
5
6
7
8

<?xml version="1.0" encoding="UTF-8"?>
<request>
   <filter>city=Ижевск;type=[1,2,3,4];providerKey=cdek;availableOperation=[1,3]</filter>
   <limit>1000</limit>
   <offset>0</offset>
   <stateCheckOff>0</stateCheckOff>
</request>

Параметры ответа #

РазделПараметрОписаниеТипОбязательныйПример
rows
idID ПВЗчислонет16222
providerKeyИдентификатор службы доставкистроканетboxberry
codeКод терминала в системе службы доставкистроканет97151
nameНазваниестроканетМосква Алтуфьевское_9715_С
postIndexИндексстроканет127349
latШирота отправителячислонет55.7553172
lngДолгота отправителячислонет37.5942631
countryCodeКод страныстроканетRU
regionРегионстроканетМосква
regionTypeТип регионастроканетг
cityГородстроканетМосква
cityGuidID города в базе ФИАстроканет0c5b2444-70a0-4932-980c-b4dc0d3f02b5”
cityTypeТип населенного пунктастроканетг
areaРайонстроканетМосква
streetУлицастроканетАлтуфьевское
streetTypeТип улицы (ул., переулок и т.п.)строканетш.
houseДомстроканет80
blockКорпусстроканетnull
officeОфисстроканетnull
addressПолный адрес, полученный от СДстроканет127349, Москва г, Алтуфьевское ш, д.80
urlДомашняя страницастроканетnull
emailemailстроканет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

Пример данных ответа #

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
{
  "rows": [
    {
      "id": "521456",
      "providerKey": "cse",
      "type": 2,
      "availableOperation": 2,
      "cod": 1,
      "paymentCash": null,
      "paymentCard": 1,
      "name": "Почтомат 5post в Пятерочке OM103327",
      "lat": 56.3286537,
      "lng": 37.5211701,
      "code": "c4b96690-d4cc-11eb-80fe-0090faaaf8e4",
      "postIndex": "141804",
      "countryCode": "RU",
      "region": "Московская",
      "regionType": "обл",
      "area": null,
      "city": "Дмитров",
      "cityType": "г",
      "cityGuid": "0d8a246f-6446-403e-91c6-3aec9cdbfc32",
      "community": null,
      "communityType": null,
      "communityGuid": null,
      "street": "Веретенникова",
      "streetType": "ул",
      "house": "25",
      "address": "141804, обл Московская, г Дмитров, ул Веретенникова, дом 25",
      "block": null,
      "office": null,
      "url": null,
      "email": null,
      "phone": "88005118800",
      "timetable": "ПН 08:01 - 23:01,ВТ 08:01 - 23:01,СР 08:01 - 23:01,ЧТ 08:01 - 23:01,ПТ 08:01 - 23:01,СБ 08:01 - 23:01,ВС 08:01 - 23:01",
      "worktime": {
        "1": "08:01/23:01",
        "2": "08:01/23:01",
        "3": "08:01/23:01",
        "4": "08:01/23:01",
        "5": "08:01/23:01",
        "6": "08:01/23:01",
        "7": "08:01/23:01"
      },
      "photos": null,
      "fittingRoom": 0,
      "description": null,
      "metro": null,
      "multiplaceDeliveryAllowed": null,
      "extra": [
        {
          "key": "ownerCode",
          "value": "Почтомат"
        }
      ],
      "limits": {
        "maxSizeA": null,
        "maxSizeB": null,
        "maxSizeC": null,
        "maxSizeSum": null,
        "minWeight": null,
        "maxWeight": null,
        "maxCod": 100000
      }
    }
  ],
  "meta": {
    "total": 1,
    "offset": 0,
    "limit": 10
  }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
<?xml version="1.0" encoding="UTF-8"?>
<response>
    <rows>
        <item>
            <id>521456</id>
            <providerKey>cse</providerKey>
            <type>2</type>
            <availableOperation>2</availableOperation>
            <cod>1</cod>
            <paymentCash></paymentCash>
            <paymentCard>1</paymentCard>
            <name>Почтомат 5post в Пятерочке OM103327</name>
            <lat>56.3286537</lat>
            <lng>37.5211701</lng>
            <code>c4b96690-d4cc-11eb-80fe-0090faaaf8e4</code>
            <postIndex>141804</postIndex>
            <countryCode>RU</countryCode>
            <region>Московская</region>
            <regionType>обл</regionType>
            <area></area>
            <city>Дмитров</city>
            <cityType>г</cityType>
            <cityGuid>0d8a246f-6446-403e-91c6-3aec9cdbfc32</cityGuid>
            <community></community>
            <communityType></communityType>
            <communityGuid></communityGuid>
            <street>Веретенникова</street>
            <streetType>ул</streetType>
            <house>25</house>
            <address>141804, обл Московская, г Дмитров, ул Веретенникова, дом 25</address>
            <block></block>
            <office></office>
            <url></url>
            <email></email>
            <phone>88005118800</phone>
            <timetable>ПН 08:01 - 23:01,ВТ 08:01 - 23:01,СР 08:01 - 23:01,ЧТ 08:01 - 23:01,ПТ 08:01 - 23:01,СБ 08:01 - 23:01,ВС 08:01 - 23:01</timetable>
            <worktime>
                <text>08:01/23:01</text>
                <text>08:01/23:01</text>
                <text>08:01/23:01</text>
                <text>08:01/23:01</text>
                <text>08:01/23:01</text>
                <text>08:01/23:01</text>
                <text>08:01/23:01</text>
            </worktime>
            <photos></photos>
            <fittingRoom>0</fittingRoom>
            <description></description>
            <metro></metro>
            <multiplaceDeliveryAllowed></multiplaceDeliveryAllowed>
            <extra>
                <item>
                    <key>ownerCode</key>
                    <value>Почтомат</value>
                </item>
            </extra>
            <limits>
                <maxSizeA></maxSizeA>
                <maxSizeB></maxSizeB>
                <maxSizeC></maxSizeC>
                <maxSizeSum></maxSizeSum>
                <minWeight></minWeight>
                <maxWeight></maxWeight>
                <maxCod>100000</maxCod>
            </limits>
        </item>
    </rows>
    <meta>
        <total>1</total>
        <offset>0</offset>
        <limit>10</limit>
    </meta>
</response>