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

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

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

GET /lists/points

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

ПараметрТип параметраТип данныхОписаниеОбязательностьПример
limitзапросчислода23
offsetзапросчислода0
filterзапросстрокаВозможна фильтрация по полям: id, providerKey, code, 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Имеется ли возможность оплаты при доставкечислонет1
paymentCashИмеется ли возможность оплаты наличнымичислонетnull
paymentCardИмеется ли возможность оплаты банковской картойчислонет1
availableOperationТип операции (1 - прием, 2 - выдача, 3 - прием и выдача)числонет3
typeТип точки (Пункт выдачи заказа, Постамат, Отделение Почты России и Терминал, etc)числонет1
descriptionОписание ПВЗ, как пройтистроканет“Метро: "Алтуфьево", \nПоследний вагон из центра.\nПримерное расстояние от метро до отделения - 300 метров.\nТД "Арфа".\nЦентральный вход.\n2 этаж.\nОтдел: "Пункт выдачи заказов".\n”
photosФотомассив строкнетhttps://storage.apiship.ru/file/get?file=1cc2069ad409c6b207aacde3916625c3.jpeg"
metro
distanceДистанциячислонетАлтуфьево
lineЛиниястроканетСерпуховско-Тимирязевская
nameИмястроканет0.5
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числонет

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

 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
{
  "rows": [
    {
      "id": "9634",
      "providerKey": "boxberry",
      "type": 1,
      "availableOperation": 3,
      "cod": 1,
      "paymentCash": null,
      "paymentCard": 1,
      "name": "Москва Алтуфьевское_9715_С",
      "lat": 55.8943232,
      "lng": 37.5882424,
      "code": "97151",
      "postIndex": "127349",
      "countryCode": "RU",
      "region": "Москва",
      "regionType": "г",
      "area": null,
      "city": "Москва",
      "cityType": "г",
      "cityGuid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
      "street": "Алтуфьевское",
      "streetType": "ш",
      "address": "127349, Москва г, Алтуфьевское ш, д.80",
      "url": null,
      "email": null,
      "phone": "8-499-391-56-22",
      "timetable": "пн-пт:10.00-20.30, сб:10.00-19.00",
      "worktime": {
        "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"
      },
      "photos": [
        "http:\/\/storage.stage.apiship.ru\/file\/get?file=8d8886b04486a229696b755bb50b3f68.jpeg",
        "http:\/\/storage.stage.apiship.ru\/file\/get?file=def6b3c3adcaddaf4e33e43eba10bad1.jpeg",
        "http:\/\/storage.stage.apiship.ru\/file\/get?file=67afbfa7a98232c672e69b3b61f657fe.jpeg",
        "http:\/\/storage.stage.apiship.ru\/file\/get?file=1645a2d8059be9c570e4151dc6dc0874.jpeg"
      ],
      "fittingRoom": null,
      "description": "Метро: \"Алтуфьево\", \nПоследний вагон из центра.\nПримерное расстояние от метро до отделения - 300 метров.\nТД \"Арфа\".\nЦентральный вход.\n2 этаж.\nОтдел: \"Пункт выдачи заказов\".\n",
      "metro": null,
      "house": "80",
      "block": null,
      "office": null,
      "limits": {
        "maxSizeA": 120,
        "maxSizeB": 80,
        "maxSizeC": 50,
        "maxSizeSum": null,
        "minWeight": null,
        "maxWeight": 31000,
        "maxCod": null
      }
    }
  ],
  "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
<response>
    <rows>
        <item>
            <id>9634</id>
            <providerKey>boxberry</providerKey>
            <type>1</type>
            <availableOperation>3</availableOperation>
            <cod>1</cod>
            <paymentCash/>
            <paymentCard>1</paymentCard>
            <name>Москва Алтуфьевское_9715_С</name>
            <lat>55.8943232</lat>
            <lng>37.5882424</lng>
            <code>97151</code>
            <postIndex>127349</postIndex>
            <countryCode>RU</countryCode>
            <region>Москва</region>
            <regionType>г</regionType>
            <area/>
            <city>Москва</city>
            <cityType>г</cityType>
            <cityGuid>0c5b2444-70a0-4932-980c-b4dc0d3f02b5</cityGuid>
            <street>Алтуфьевское</street>
            <streetType>ш</streetType>
            <address>127349, Москва г, Алтуфьевское ш, д.80</address>
            <url/>
            <email/>
            <phone>8-499-391-56-22</phone>
            <timetable>пн-пт:10.00-20.30, сб:10.00-19.00</timetable>
            <worktime>
                <text>10:00/20:30</text>
                <text>10:00/20:30</text>
                <text>10:00/20:30</text>
                <text>10:00/20:30</text>
                <text>10:00/20:30</text>
                <text>10:00/19:00</text>
            </worktime>
            <photos>
                <item>http://storage.stage.apiship.ru/file/get?file=8d8886b04486a229696b755bb50b3f68.jpeg</item>
                <item>http://storage.stage.apiship.ru/file/get?file=def6b3c3adcaddaf4e33e43eba10bad1.jpeg</item>
                <item>http://storage.stage.apiship.ru/file/get?file=67afbfa7a98232c672e69b3b61f657fe.jpeg</item>
                <item>http://storage.stage.apiship.ru/file/get?file=1645a2d8059be9c570e4151dc6dc0874.jpeg</item>
            </photos>
            <fittingRoom/>
            <description>Метро: "Алтуфьево",
                Последний вагон из центра.
                Примерное расстояние от метро до отделения - 300 метров.
                ТД "Арфа".
                Центральный вход.
                2 этаж.
                Отдел: "Пункт выдачи заказов".
            </description>
            <metro/>
            <house>80</house>
            <block/>
            <office/>
            <limits>
                <maxSizeA>120</maxSizeA>
                <maxSizeB>80</maxSizeB>
                <maxSizeC>50</maxSizeC>
                <maxSizeSum/>
                <minWeight/>
                <maxWeight>31000</maxWeight>
                <maxCod/>
            </limits>
        </item>
    </rows>
    <meta>
        <total>1</total>
        <offset>0</offset>
        <limit>10</limit>
    </meta>
</response>