GetReferenceData: PVZ — Список пунктов выдачи заказов
- Endpoint:
GetReferenceData - SOAP-метод:
PVZ - Группа: GetReferenceData
- Создано: 16.04.2026 · Обновлено: 08.05.2026
Описание
Функция позволяет получить информацию о пунктах выдачи заказов. Полученные данные можно использовать в других методах web-сервиса.
Параметры запроса
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
login | string | да | логин |
password | string | да | пароль |
parameters | Element | да | список параметров |
Описание параметра parameters
Параметр parameters содержит настройки запроса в виде иерархической структуры, соответствующей XML-представлению.
Он должен включать:
Key: строка со значением parameters (обязательное);
List: непустой массив элементов, каждый из которых представляет отдельный параметр и сам является структурой с тремя полями:
- Key: имя параметра (например, Reference);
- Value: значение параметра указывающая на то какой parameters описывается;
- ValueType: тип значения — строка, указывающая тип Value(string, int и т.д.).
Пример одного элемента из List:
car:List>
car:Key>Referencecar:Key>
car:Value>pvzcar:Value>
car:ValueType>stringcar:ValueType>
car:List>
Каждый такой элемент — независимый узел внутри parameters. Если List отсутствует или пуст — запрос отклоняется.
Иерархия структуры parameters:
parameters → List (массив) → каждый элемент List → Key, Value, ValueType.
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
Reference | string | да | Список ПВЗ для получения груза. Имя справочника (Value) должно быть равно «pvz». |
Other | string | нет | Параметр используется если надо вывести список ПВЗ для сдачи груза. В поле "Key" необходимо передать значение «sender». |
Ingroup | string | нет | Тип ПВЗ для отбора. Данные берутся из параметра TypeOfPVZ ответа метода. |
Возвращаемые параметры
Параметр Element в ответе содержит информацию о ПВЗ.
Он включает элементы справочника:
Key: идентификатор справочника, строка со значением PVZ;
List: массив элементов справочника (пунктов выдачи).
Структура ответа иерархична:
Element → Key + List (массив) → каждый элемент List→ Key + Value +ValueType +Properties (массив)+Fields+List→ каждый элемент Properties/Fields → Key, Value, ValueType.
---
Если во время запроса произошла ошибка, информация о ней будет отражена в свойстве Properties (см. метод GetReferenceData: ErrorCodes — Коды ошибок).
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
Key | string | да | Уникальный номер элемента справочника в формате GUID (Globally Unique Identifier) |
List | Element | нет | Список ПВЗ |
Описание возможных возвращаемых параметров List
Каждый элемент из списка List описывает один пункт выдачи и содержит в себе:
- Key: идентификационный номер пункта выдачи заказов (например, 8cb28d91-c183-11e8-80c9-7cd30aebf951);
- Value: наименование пункта выдачи заказов (например, Офис Октябрьский на ул. Островского);
- ValueType: тип значения — строка, указывающая тип Value (string, dateTime и т.п.);
- Properties: массив блоков с режимом работы пункта выдачи заказов;
- Fields: массив атрибутов пункта выдачи;
- List: массив вспомогательных блоков (ContactInfo, Geo).
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
Key | string | да | GUID пункта выдачи заказов |
Value | string | да | Название пункта выдачи заказов |
Fields | Element | да | Реквизиты ПВЗ |
Properties | Element | нет | График работы ПВЗ |
Описание возможных возвращаемых параметров properties
Массив Properties представляет расписание работы пункта выдачи. Повторяется для каждого дня недели и содержит в себе элементы:
- Key: идентификатор блока режима работы WorkTime;
- Fields: массив полей, описывающих расписание на один день.
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
DayOfWeek | string | нет | День недели |
StartReceiving | string | нет | Время начала приема отправлений |
EndReceiving | string | нет | Время окончания приема отправлений |
StartIssue | string | нет | Время начала выдачи отправлений |
EndIssue | string | нет | Время окончания выдачи отправлений |
Info | string | нет | Дополнительная информация по режиму работы (может быть пустым) |
Описание возможных возвращаемых параметров Fields
Блок Fields содержит в себе основные атрибуты пункта выдачи и состоит из элементов:
- Key: имя поля (всегда PVZID);
- Value: код карточки пункта выдачи (например,000000151);
- ValueType: тип значения — строка, указывающая тип Value (string, boolean и т.п.).
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
Office | string | нет | GUID офиса, к которому привязан ПВЗ |
Geography | string | нет | GUID (Globally Unique Identifier) географии ПВЗ |
GeographyName | string | нет | Название населенного пунтка ПВЗ |
GeographyKladr | string | нет | Код КЛАДР (Классификатор адресов Российской Федерации) |
FIAS | string | нет | Код ФИАС (Федеральная информационная адресная система), значение для этого параметра передается из поля «Код ФИАС» Справочника "География" |
Phone | float | нет | Номер телефона пункта выдачи заказов |
Address | float | нет | Адрес пункта выдачи заказов |
LocationMap | string | нет | Текстовое описание маршрута/местоположения |
TypeOfPVZ | float | нет | Тип пункта выдачи (например, офис) |
CodePVZ | string | нет | Код ПВЗ |
WeightLimite | float | нет | Максимальный вес отправления (кг) |
HightLimite | float | нет | Максимальная высота (см) |
LengthLimite | float | нет | Максимальная длина (см) |
WidthLimite | float | нет | Максимальная ширина (см) |
QtyLimite | float | нет | Ограничение по количеству |
MaxDimensionLimite | float | нет | Ограничение по максимальному размеру одного из габаритов |
SumDimensionLimite | float | нет | Ограничение по сумме габаритов |
CODLimite | float | нет | Максимальная сумма наложенного платежа (руб.) |
IssuanceOfShipping | boolean | нет | Возможность выдачи отправлений |
PaymentByCard | boolean | нет | Оплата банковской картой |
PaymentByCash | boolean | нет | Оплата наличными |
ReceivingSending | boolean | нет | Возможность возврата груза |
TryOn | boolean | нет | Возможность примерки товара |
PartialBuyout | boolean | нет | Частичный выкуп заказа |
Comment | string | нет | Дополнительная информация |
StorageLife | decimal | нет | Срок хранения груза на пункте (дней) |
FZ54 | boolean | нет | Поддержка 54-ФЗ (онлайн-кассы) |
PartialPrePay | boolean | нет | Частичная предоплата |
Описание возможных возвращаемых параметров List (ContactInfo)
ContactInfo — блок контактной информации
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
Name | string | нет | Описание контактной информации |
Type | string | нет | Тип контактной информации (например, Адрес) |
SubType | string | нет | Подтип контактной информации (например, Адрес офиса) |
Описание возможных возвращаемых параметров List (Geo)
Geo — блок географических координат
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
Lat | decimal | нет | Широта |
Lan | decimal | нет | Долгота |
Пример запроса (XML Request)
<soap:Envelope
xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:car="http://www.cargo3.ru">
<soap:Header/>
<soap:Body>
<car:GetReferenceData>
<car:login>test</car:login>
<car:password>2016</car:password>
<car:parameters>
<car:Key>parameters</car:Key>
<car:List>
<car:Key>Reference</car:Key>
<car:Value>pvz</car:Value>
<car:ValueType>string</car:ValueType>
</car:List>
</car:parameters>
</car:GetReferenceData>
</soap:Body>
</soap:Envelope>
Пример ответа (XML Response)
<soap:Envelope
xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
<soap:Body>
<m:GetReferenceDataResponse
xmlns:m="http://www.cargo3.ru">
<m:return
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<m:Key>PVZ</m:Key>
<m:List>
<m:Key>8cb28d91-c183-11e8-80c9-7cd30aebf951</m:Key>
<m:Value xsi:type="xs:string">Офис Октябрьский на ул. Островского</m:Value>
<m:ValueType>string</m:ValueType>
<m:Properties>
<m:Key>WorkTime</m:Key>
<m:Fields>
<m:Key>DayOfWeek</m:Key>
<m:Value xsi:type="xs:string">Понедельник</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>StartReceiving</m:Key>
<m:Value xsi:type="xs:time">09:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>EndReceiving</m:Key>
<m:Value xsi:type="xs:time">18:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>StartIssue</m:Key>
<m:Value xsi:type="xs:time">09:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>EndIssue</m:Key>
<m:Value xsi:type="xs:time">18:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>Info</m:Key>
<m:Value xsi:type="xs:string"/>
<m:ValueType>string</m:ValueType>
</m:Fields>
</m:Properties>
<m:Properties>
<m:Key>WorkTime</m:Key>
<m:Fields>
<m:Key>DayOfWeek</m:Key>
<m:Value xsi:type="xs:string">Вторник</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>StartReceiving</m:Key>
<m:Value xsi:type="xs:time">09:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>EndReceiving</m:Key>
<m:Value xsi:type="xs:time">18:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>StartIssue</m:Key>
<m:Value xsi:type="xs:time">09:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>EndIssue</m:Key>
<m:Value xsi:type="xs:time">18:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>Info</m:Key>
<m:Value xsi:type="xs:string"/>
<m:ValueType>string</m:ValueType>
</m:Fields>
</m:Properties>
<m:Properties>
<m:Key>WorkTime</m:Key>
<m:Fields>
<m:Key>DayOfWeek</m:Key>
<m:Value xsi:type="xs:string">Среда</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>StartReceiving</m:Key>
<m:Value xsi:type="xs:time">09:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>EndReceiving</m:Key>
<m:Value xsi:type="xs:time">18:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>StartIssue</m:Key>
<m:Value xsi:type="xs:time">09:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>EndIssue</m:Key>
<m:Value xsi:type="xs:time">18:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>Info</m:Key>
<m:Value xsi:type="xs:string"/>
<m:ValueType>string</m:ValueType>
</m:Fields>
</m:Properties>
<m:Properties>
<m:Key>WorkTime</m:Key>
<m:Fields>
<m:Key>DayOfWeek</m:Key>
<m:Value xsi:type="xs:string">Четверг</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>StartReceiving</m:Key>
<m:Value xsi:type="xs:time">09:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>EndReceiving</m:Key>
<m:Value xsi:type="xs:time">18:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>StartIssue</m:Key>
<m:Value xsi:type="xs:time">09:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>EndIssue</m:Key>
<m:Value xsi:type="xs:time">18:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>Info</m:Key>
<m:Value xsi:type="xs:string"/>
<m:ValueType>string</m:ValueType>
</m:Fields>
</m:Properties>
<m:Properties>
<m:Key>WorkTime</m:Key>
<m:Fields>
<m:Key>DayOfWeek</m:Key>
<m:Value xsi:type="xs:string">Пятница</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>StartReceiving</m:Key>
<m:Value xsi:type="xs:time">09:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>EndReceiving</m:Key>
<m:Value xsi:type="xs:time">18:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>StartIssue</m:Key>
<m:Value xsi:type="xs:time">09:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>EndIssue</m:Key>
<m:Value xsi:type="xs:time">18:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>Info</m:Key>
<m:Value xsi:type="xs:string"/>
<m:ValueType>string</m:ValueType>
</m:Fields>
</m:Properties>
<m:Fields>
<m:Key>PVZID</m:Key>
<m:Value xsi:type="xs:string">000000151</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>Office</m:Key>
<m:Value xsi:type="xs:string">dd978e3f-b559-11e6-ac0b-001e67086478</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>Geography</m:Key>
<m:Value xsi:type="xs:string">f2cd6494-4422-11dc-9497-0015170f8c09</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>GeographyName</m:Key>
<m:Value xsi:type="xs:string">Октябрьский г</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>GeographyKladr</m:Key>
<m:Value xsi:type="xs:string">02000004000</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>Fias</m:Key>
<m:Value xsi:type="xs:string">abd1bc35-ec51-437a-abee-76a4f620f662</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>Phone</m:Key>
<m:Value xsi:type="xs:string">+7 347 226 71 12</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>Address</m:Key>
<m:Value xsi:type="xs:string">452600 Респ Башкортостан, г Октябрьский, ул Островского, дом 6А</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>LocationMap</m:Key>
<m:Value xsi:type="xs:string">Остановка «Чемпион». Автобусы - 1, 1м, 1д, 5, 5б, 12, 13, 14, 15, 16, 16м, 22. Пройти до центрального рынка по ул.Губкина, свернуть на ул.Свердлова, дойти до дома Свердлова 37, за ним направо вдоль дома, пройти через ворота центрального рынка, за студией детских праздников «Сумасшедшая Лаборатория» следующая дверь.</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>TypeOfPVZ</m:Key>
<m:Value xsi:type="xs:string">Офис</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>CodePVZ</m:Key>
<m:Value xsi:type="xs:string"/>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>WeightLimite</m:Key>
<m:Value xsi:type="xs:decimal">30</m:Value>
<m:ValueType>float</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>HightLimite</m:Key>
<m:Value xsi:type="xs:decimal">0</m:Value>
<m:ValueType>float</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>LengthLimite</m:Key>
<m:Value xsi:type="xs:decimal">0</m:Value>
<m:ValueType>float</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>WidthLimite</m:Key>
<m:Value xsi:type="xs:decimal">0</m:Value>
<m:ValueType>float</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>QtyLimite</m:Key>
<m:Value xsi:type="xs:decimal">0</m:Value>
<m:ValueType>float</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>MaxDimensionLimite</m:Key>
<m:Value xsi:type="xs:decimal">0</m:Value>
<m:ValueType>float</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>SumDimensionLimite</m:Key>
<m:Value xsi:type="xs:decimal">0</m:Value>
<m:ValueType>float</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>CODLimite</m:Key>
<m:Value xsi:type="xs:decimal">200000</m:Value>
<m:ValueType>float</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>IssuanceOfShipping</m:Key>
<m:Value xsi:type="xs:boolean">true</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>PaymentByCard</m:Key>
<m:Value xsi:type="xs:boolean">true</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>PaymentByCash</m:Key>
<m:Value xsi:type="xs:boolean">true</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>ReceivingSending</m:Key>
<m:Value xsi:type="xs:boolean">true</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>TryOn</m:Key>
<m:Value xsi:type="xs:boolean">true</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>PartialBuyout</m:Key>
<m:Value xsi:type="xs:boolean">true</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>Comment</m:Key>
<m:Value xsi:type="xs:string"/>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>StorageLife</m:Key>
<m:Value xsi:type="xs:decimal">14</m:Value>
<m:ValueType>float</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>FZ54</m:Key>
<m:Value xsi:type="xs:boolean">true</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>PartialPrePay</m:Key>
<m:Value xsi:type="xs:boolean">true</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Fields>
<m:List>
<m:Key>ContactInfo</m:Key>
<m:Fields>
<m:Key>Name</m:Key>
<m:Value xsi:type="xs:string">452614, Башкортостан Респ, Октябрьский г, Островского ул, дом № 6а</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>Type</m:Key>
<m:Value xsi:type="xs:string">Адрес</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>SubType</m:Key>
<m:Value xsi:type="xs:string">Адрес офиса</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
</m:List>
<m:List>
<m:Key>Geo</m:Key>
<m:Fields>
<m:Key>Lat</m:Key>
<m:Value xsi:type="xs:decimal">54.4848791</m:Value>
<m:ValueType>float</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>Lan</m:Key>
<m:Value xsi:type="xs:decimal">53.4690388</m:Value>
<m:ValueType>float</m:ValueType>
</m:Fields>
</m:List>
</m:List>
</m:return>
</m:GetReferenceDataResponse>
</soap:Body>
</soap:Envelope>
Смежные методы
AvailableDeliveryDates
Функция позволяет получить информацию о возможных датах доставки груза.
BaseUnitsOfMeasurement
Функция позволяет получить список базовых единиц измерения, использующиеся в других функциях при вызове web-сервиса.
CargoStates
Функция позволяет получить список доступных состояний грузов.