Группа /cargos/
— операции с грузами
Метод /cargos/status/
— запрос статусов грузов
Доступ
- Зарегистрированные пользователи. Для заполнения ряда полей требуются оформленные права на доступ к информации от юридических лиц/ИП/физ.лиц,
которые являются участниками перевозки. Для получения доступа оформите в личном кабинете "Расширенный личный кабинет", либо оформите доступ на чтение через
Заявление на подключение личного кабинета (см. раздел Договоры и бланки документов
на сайте pecom.ru)
Комментарии
- Максимальное количество кодов грузов в одном запросе: 15
- Возможные значения поля
cargos[].info.cargoStatus
(статус груза):
Аннулировано до приемки груза
,
Заявка на забор зарегистрирована
,
Ожидается передача груза от отправителя
,
Отображение детализации статуса В пути
,
Принят к перевозке
,
Принят на ПВЗ
,
Возвращен отправителю
,
Оформлен
,
В пути
,
В пути на терминал
,
Прибыл
,
Прибыл частично
,
Разгружается. Ожидайте оповещения
,
Выполняется адресная доставка
,
Выдан получателю
,
Доставлен получателю
,
Отправлен на возврат
,
Утилизирован
,
Изъят на таможне
,
Возврат груза отправителю
, Выдан ( мест { количество_мест } из { количество_мест } )
- Для груза, который является возвратом документов по другому грузу, в ответе возвращается поле
cargos[].cargo.parentCargoCode
с кодом исходного груза.
- Возможные значения поля
cargos[].info.cargoStatus
(id статуса груза): /cargos/statustables/
- Поле
intakeAddress
будет заполнено только для грузов с забором.
Формат запроса
{
"cargoCodes": [ // Коды грузов [Array]
"780339690775", // Код груза [String]
"999932277461",
"772193116238",
...
]
}
Формат ответа
{
"cargos": [ // Статусы грузов [Array]
{
"info": { // Общая информация о грузе [Object]
"cargoStatus": "выдан", // Статус груза [String]
"cargoStatusId": 8, // id статуса груза [Number]
"businessUnit": "Холдинг", // Бизнес Юнит [String]
"intakePlanDateTime": null, // Плановая дата и время забора груза [DateTime]
"takeOnStockPlanDateTime": "2011-03-01T14:51:40", // Плановая дата и время сдачи груза на склад [DateTime]
"takeOnStockDateTime": "2011-03-01T13:51:40", // Дата и время сдачи груза [DateTime]
"takeOnStockPackageState": "ВОЗВРАТНАЯ ТАРА, Внешние повреждения", // Состояние упаковки при сдаче груза
"sendingDateTime": null, // Дата и время отправки груза [DateTime]
"arrivalDateTime": "2011-03-05T11:15:20", // Дата и время прибытия [DateTime]
"arrivalContractDateTime": "2021-10-20T19:26:50", // Дата и время крайнего срока прибытия в отделение выдачи клиенту/передачи на доставку [DateTime]
"giveOutDateTime": "2011-03-10T09:24:24", // Дата и время выдачи с основного отделения филиала получения (на доставку, клиенту) [DateTime]
"arrivalPlanDateTime": "2011-03-04T08:17:59", // Дата и время прибытия в отделение назначения [DateTime], т.е. окончание межтерминальной перевозки внутри ПЭК
"deliveryPlanDate": "2021-08-19T00:00:00", // Дата и время плановой доставки до двери [DateTime], т.е. дата и время, на которые назначена последняя миля
"receivedByClientDateTime": "2011-03-11Т14:01:15", // Дата получения груза грузополучателем (с учетом перенаправок) [DateTime]
"position": "56.304143;43.490851", // Приблизительные координаты [String]
"сallStatus": "Оповещен получатель", // Статус по оповещению [String]
"сallStatusDateTime": "2015-05-21T00:00:00+03:00", // Дата статуса по оповещению [DateTime]
"storageStartPlanDate": "2015-05-21T00:00:00", // Дата начала платного хранения [DateTime]
"statuses": [] // В актуальной версии протокола не используется. Для получения истории используйте метод
},
"cargo": { // Параметры груза [Object]
"code": "780339690775", // Код груза [String]
// возвращается для груза, который является возвратом документов по др. грузу
"parentCargoCode": "772193116238", // Возврат документов по грузу [String]
"amount": 3.0, // Количество мест [Number]
"amountProcessed": 2.0, // Количество прибывших мест [Number]
"weight": 26.0, // Вес, кг [Number]
"volume": 0.25, // Объем, м3 [Number]
"maxSize": 1.000, // Максимальный габарит [Number]
"description": "Запчасти", // Наименование груза [String]
"orderNumber": "№23434-АБ", // Номер заказа клиента [String]
"cargoBarCode": "555810002522", // Штрих-код груза [String]
"positionBarCodes": [ // Штрих-коды грузомест [Array]
"5558100025220001"
]
},
"services": { // Услуги [Object]
"items": [ // Массив услуг [Array]
{
"branch": "Петрозаводск", // Филиал [String]
"description": "Перевозка Петрозаводск - Москва Восток", // Описание [String]
"price": 300.0, // Стоимость, руб. [Number]
"payerType": 1, // Плательщик (1 - отправитель, 2 - получатель, 3 - третье лицо) [Number]
"payerName": "Иванов", // Описание [String]
"currencyName": "руб.", // Валюта [String]
"payerForm": 1, // Тип контрагента плательщика за услугу [Number] (1 - юридическое лицо, 2 - ИП, 3 - физическое лицо)
"paid": 300.0, // Оплаченная сумма, руб [Number]
"paymentMethod": "Касса", // Выбранный способ оплаты задолженности [String]
"payToReceive": true // Необходима оплата задолженности для получения груза [Boolean]
},
{
"branch": "Петрозаводск", // Филиал [String]
"description": "Защитная транспортировочная упаковка Петрозаводск", // Описание [String]
"price": 150.0, // Стоимость, руб. [Number]
"payerType": 1, // Плательщик (1 - отправитель, 2 - получатель, 3 - третье лицо) [Number]
"payerName": "Иванов", // Описание [String]
"currencyName": "руб.", // Валюта [String]
"payerForm": 1, // Тип контрагента плательщика за услугу [Number] (1 - юридическое лицо, 2 - ИП, 3 - физическое лицо)
"paid": 300.0, // Оплаченная сумма, руб [Number]
"paymentMethod": "Касса", // Выбранный способ оплаты задолженности [String]
"payToReceive": true // Необходима оплата задолженности для получения груза [Boolean]
}
],
"sum": 450.0, // Итого, руб. [Number]
"hardPack": false, // Защитная транспортировочная упаковка [Boolean]
"insurance": false, // Страхование [Boolean]
"resendDocs": false, // Груз является возвратными документами [Boolean]
"freeService": false, // В актуальной версии протокола не используется
"debt": 17075.37, // Задолженность, которую необходимо оплатить для получения груза, руб. [Number]
"debtList": [] // В актуальной версии протокола не используется
},
"sender": { // Отправитель [Object]
"branch": "Петрозаводск", // Филиал [String]
"branchInfo": { // Филиал отправителя [Object]
"city": "Петрозаводск", // Филиал [String]
"address": "Республика Карелия, г. Петрозаводск, ул. Зайцева, д. 65 корп. 4", // Адрес [String]
"phone": "8(8142) 599-499", // Телефоны [String]
"email": "pz@pecom.ru", // Email [String]
},
"intakeAddress": "Петрозаводск, Красная улица, 45", // Адрес забора груза, если заказана услуга забора [String]. Требуются права на получение информации.
"sender": "Наименование организации", // Наименование [String]
"person": "Иван Иванович Иванов", // Ответственное лицо [String]
"phone": "11-11-11,12-12-12" // Телефоны [String],
"counterpartPaymentType": 5, // Тип договора с клиентом [Number]
// 1 - Предоплата,
// 2 - Отсрочка платежа (тип 1),
// 3 - Отсрочка платежа (тип 2),
// 4 - Договор с интернет магазином,
// 5 - Оферта или стандартный договор (оплата до выдачи груза),
// 0 - Прочие договоры
},
"receiver": { // Получатель [Object]
"branch": { // Филиал получателя [Object]
"city": "Москва Восток", // Филиал [String]
"address": "1-й Вязовский пр., д. 4, 109428", // Адрес [String]
"phone": "(495) 925-88-14, 790-76-82", // Телефоны [String]
"email": "pecom@pecom.ru", // Email [String]
},
"receiver": "Наименование организации", // Наименование [String]
"person": "Фёдоров Фёдор Фёдорович", // Ответственное лицо [String]
"phone": "333-33-33", // Телефоны [String]
"abbreviated": { // информация об актуальном получателе, не требующая специаальных прав доступа
"privatePerson": { // блок выводится, если получатель - физичекое лицо. В противном случае блок не выводится
"Name": "М.З.Г", // первые буквы Фамилии Имени и Отчества как они заданы у нас в системе
"phone": "*51", // последние 2 цифры номера телефона получателя
}
"legalPerson": { // блок выводится, если получатель юр.лицо или ИП (наименование юр.лица/ИП не содержит)
"inn": "*77", // Последние 2 цифры ИНН получателя
"kpp": "*31" // Послдение 2 цифры КПП получателя (для ИП пустое)
}
},
"isCorrect": true, // Данные по получателю и способу получения груза в ответе метода достоверны
// (в редких случаях информация в API может быть не достоверной)
// (true - данные достоверны, false - под данным получателя необходима консультация сотрудника ПЭК) [Boolean]
"receivingByDocument": true, // Груз можно получить предъявив документ удостоверяющий личность и доверенность (при получении по доверенности)
// (значения true - если получение по документу возможно /false в противном случае) [Boolean]
"receivingBySMSCode": false, // Груз можно получить по СМС коду (true - если возможно, false - если невозможно) [Boolean]
"counterpartPaymentType": 5, // Тип договора с клиентом [Number]
// 1 - Предоплата,
// 2 - Отсрочка платежа (тип 1),
// 3 - Отсрочка платежа (тип 2),
// 4 - Договор с интернет магазином,
// 5 - Оферта или стандартный договор (оплата до выдачи груза),
// 0 - Прочие договоры
}
},
{
... // Информация о втором грузе, в формате, аналогичном первому объекту массива "cargos" выше
},
{
... // Информация о третьем грузе, в формате, аналогичном первому объекту массива "cargos" выше
},
...
]
}
Метод /cargos/basicstatus/
— базовая информация о статусе грузов
Доступ
- Зарегистрированные пользователи
- Сторонние неперсонифицированные приложения
Комментарии
- Максимальное количество кодов грузов в одном запросе: 50
- В качестве кода груза можно указывать предварительный или фактический код груза.
- Возможные значения поля
cargos[].info.cargoStatus
(статус груза):
Аннулировано до приемки груза
,
Заявка на забор зарегистрирована
,
Ожидается передача груза от отправителя
,
Отображение детализации статуса В пути
,
Принят к перевозке
,
Принят на ПВЗ
,
Возвращен отправителю
,
Оформлен
,
В пути
,
В пути на терминал
,
Прибыл
,
Прибыл частично
,
Разгружается. Ожидайте оповещения
,
Выполняется адресная доставка
,
Выдан получателю
,
Доставлен получателю
,
Отправлен на возврат
,
Утилизирован
,
Изъят на таможне
,
Возврат груза отправителю
, Выдан ( мест { количество_мест } из { количество_мест } )
Формат запроса
{
"cargoCodes": [ // Коды грузов [Array]
"780339690775", // Код груза [String]
"999932277461",
"772193116238",
...
],
}
Формат ответа
{
"cargos": [ // Статусы грузов [Array]
{
"info": { // Общая информация о грузе [Object]
"cargoStatus": "выдан", // Статус груза [String]
"takeOnStockDateTime": "2011-03-01T13:51:40", // Дата и время сдачи груза [DateTime]
"sendingDateTime": null, // Дата и время отправки груза [DateTime]
"arrivalDateTime": "2011-03-05T11:15:20", // Дата и время прибытия [DateTime]
"giveOutDateTime": "2011-03-10T09:24:24", // Дата и время выдачи с основного отделения филиала получения (на доставку, клиенту) [DateTime]
"arrivalPlanDateTime": "2011-03-04T08:17:59" // Дата и время прибытия в отделение назначения [DateTime], т.е. окончание межтерминальной перевозки внутри ПЭК
"deliveryPlanDate": "2011-03-05T08:17:59", // Дата и время плановой доставки до двери [DateTime], т.е. дата и время, на которые назначена последняя миля
"receivedByClientDateTime": "2011-03-11Т14:01:15" // Дата получения груза грузополучателем (с учетом перенаправок) [DateTime]
},
"cargo": { // Параметры груза [Object]
"code": "780339690775", // Код груза [String]
"cargoBarCode": "780339690775", // Штрих-код груза [String]
"positionBarCodes": [ // Штрих-коды грузомест [Array]
"7803396907750001"
]
}
},
{
... // Информация о втором грузе, в формате, аналогичном первому объекту массива "cargos" выше
},
{
... // Информация о третьем грузе, в формате, аналогичном первому объекту массива "cargos" выше
},
...
]
}
Метод /cargos/deliverystatus/
— предоставляет данные по доставке груза.
Доступ
-
Зарегистрированные пользователи. Для заполнения ряда полей требуются оформленные права на доступ к информации от юридических лиц/ИП/физ.лиц,
которые являются участниками перевозки. Для получения доступа оформите в личном кабинете "Расширенный личный кабинет", либо оформите доступ на чтение через
Заявление на подключение личного кабинета (см. раздел Договоры и бланки документов
на сайте pecom.ru)
Формат запроса
{
"cargoCodes": [ // индексы грузов [Array]
"772193116238", // Индекс груза [String]
"780339690775",
"999932277461"
...
]
}
Формат ответа
[
{
"deliveryAgreedDate": "2022-04-12T00:00:00", // Согласованная дата доставки [DateTime]
"deliveryPlanDate": "2022-04-12T00:00:00", // Дата и время плановой доставки до двери [DateTime], т.е. дата и время, на которые назначена последняя миля
"cargoCode": "772193116238", // Индекс груза [String]
"deliveryAddress": "Москва, Сормовский проезд, 7а, корпус 2", // Адрес доставки [String]. Для получения требуются права доступа
"intervalFrom": "09:00", // Время, с [String]
"intervalTo": "19:00", // Время, до [String]
"intervallunchBreakFrom": "13:00", // Перерыв, с [String]
"intervallunchBreakTo": "14:00", // Перерыв, до [String]
"delivieryHypermarket": false, // Доставка до гипермаркета [Boolean]. true - доставка до гипермаркета, false - получатель не гипермаркет.
"isLoading": true, // Заказана разгрузка "до двери" силами «ПЭК» [Boolean]
"deliveryStatusCode": 3010, // Код статуса доставки [Number]
"deliveryStatus": "Новая", // Статус доставки [String]
// Перечень возможных кодов и статусов доставки:
// 3000 - "Другое"; 3010 - "Новая"; 3030 - "Отложено"; 3050 - "Перенесено"; 3070 -
// "Запланировано"; 3090 - "Выполняется"; 3200 - "Выполнено"; 3500 - "Аннулировано"
"carDriver": "Аникин Валерий Михайлович", // Водитель [String]
"carDriverPhone": "89106769405", // Телефон водителя [String]
"carNumber": "У313РВ33", // Номер автомобиля [String]
"carBrand": "Газель" // Наименование автомобиля [String]
},
...
]
Метод /cargos/routesanddriverinfo/
— выводит персональные данные водителей, осуществляющих забор/доставку груза.
Доступ
Комментарии
- Метод выводит персональные данные водителей, осуществляющих забор/доставку груза для возможности использования их данных для заказа пропусков. Данные по водителям забора доступны только логину, которые имеет доступ к отправителю груза. Данные по водителям доставки доступны только получателям грузам. Метод работает только по маршрутным листам текущей или будущих дат
Формат запроса
{
"cityFullAddress": "Москва", // Полный адрес, включая название населенного пункта
// [String] поле обязательно
"dateRoute": "2023-03-10" // Дата выполнения операции забора/доставки груза
// [String] поле обязательно
}
Формат ответа
[ // массив адресов, на которых на дату запроса запланированы операции забора/доставки грузов [Array]
{ // [Object]
"coordinates": { // Координаты, по которым будут выполняться операции забора/доставки грузов
"latitude": "55.761011", //Координата широты
"longitude": "37.627553" //Координата долготы
},
"geoData": { //Датализация адреса
"kind": "house",
"address": {
"country_code": "RU",
"formatted": "Россия, Республика Татарстан, Набережные Челны, Промышленная улица, 93",
"components": [{
"kind": "country",
"name": "Россия"
}, {
"kind": "province",
"name": "Приволжский федеральный округ"
}, {
"kind": "province",
"name": "Республика Татарстан"
}, {
"kind": "area",
"name": "городской округ Набережные Челны"
}, {
"kind": "locality",
"name": "Набережные Челны"
}, {
"kind": "street",
"name": "Промышленная улица"
}, {
"kind": "house",
"name": "93"
}
]
}
},
"operationAddresses": // Перечень строковых представлений адресов - как они указаны в системах ПЭК
[
"Республика Татарстан, Набережные Челны, Промышленная улица, 93",
"Набережные Челны, Промышленная улица д.93",
"Набережные Челны Промышленная улица"
],
"routeMaps": [ // если на адрес в один день будет назначено более 1 машины, то в массиве будет 2 элемента, каждый содержит информацию об одном маршрутном листе/водителе
{ // [Object]
"routeMapUID": "c5cdb1a4-b9c9-11ed-b8a0-00155d26b34c", // Внутренний идентификатор маршрутного листа водителя [Guid]
"branchName": "Москва Восток", // Наименование филиала ПЭК, к которому относится маршрутный лист [String]
"vehicleBrand": "СОБОЛЬ", // наименование марки автомобиля водитлея [String]
"vehicleNumber": "В509ВР797", // государственный номер автомобиля [String]
"driverFIO": "АЛЕКСЕЕВ АЛЕКСЕЙ ВЯЧЕСЛАВОВИЧ", // ФИО водителя [String]
"driverPhone": "89652405889", // Номер телефона водителя [String]
"driverPassport": "Паспорт серия 4508 номер 297855 Выдан 24.11.2005 Кем ОВД Нагорного района города Москва", // паспортные данные водителя (используются для заказа пропусков) [String]
"counterpartsInRouteMap": [ // [Array]
{ // [Object]
"counterpart": { // Контрагент, к информации которого у логина есть доступ
// (прочие контрагенты маршрутного листа не выводятся в ответе метода) [Object]
"form": 1, // Тип контрагента (1 - юридическое лицо, 2 - ИП, 3 - физическое лицо) [Number]
"name": "ДЖЕЙКЕЙ ЛОГИСТИК ООО", // Наименование юр.лица/ИП или имя физ.лица [String]
"legalPerson": { // блок выводится, если контрагент юр.лицо или ИП [Object]
"inn": "7802734714", // ИНН контрагента [String]
"kpp": "780201001" // КПП контрагента [String]
},
"privatePerson": { // блок выводится, если контрагент - физичекое лицо. В противном случае блок не выводится
"identityCard": { // Документ удостоверяющий личность [Object]
"typeName": "Водительское удостоверение", // Наименование вида документа, удостоверяющего личность
"series": "1234", // Серия [String]
"number": "56789", // Номер [String]
}
}
},
"countCargosForIntake": 1, // количество грузов, запланированных к забору [Number]
"countCargosForDelivery": 0 // количество грузов, запланированных к доставке [Number]
}
]
}
]
}
]
Метод /cargos/details/
— информация о грузе, фотографии
Доступ
- Зарегистрированные пользователи
Комментарии
- Фотографии доступны только для грузов, отправленных из филиала Москва Восток.
Формат запроса
{
"cargoCode": "780339690775" // Код груза [String]
}
Формат ответа
{
"cargoCode":"780339690775", // Код груза [String]
"senderInn": "7716542310", // ИНН отправителя [String]
"details":[ // Информация о составе груза [Array]
{
"positionsCount":8, // Количество мест [Number]
"volume":0.75, // Объём, м3 [Number]
"weight":196, // Вес, кг [Number]
"photos":[ // Фотографии [Array]
{ // Информация о фотографии [Object]
"mimeType":"image\/jpeg", // MIME-тип [String]
"filename":"ebf646be-b89b-4318-8810-0a502999ed43.jpg", // Имя файла [String]
"data":"/9j/4AAQSkZJRgABAQEBLAEsAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsK
CwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/2wBDAQMEBAUEBQkFBQkUDQsNFBQUFBQU
...
LXFlDUC+l4A9IMKfYCT/AABBDY2E7QqdtV2V0TFFJZmpenzodS23OoSl0bt1bSrhKlD1zZIsTpbx
QQB//9k=" // Содержимое файла [Binary]
},
{
"mimeType":"image\/jpeg",
"filename":"090dd3e5-c665-4909-a56f-f2d3b3e7895e.jpg",
"data":"/9j/4AAQSkZJRgABAQEBLAEsAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsK
CwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/2wBDAQMEBAUEBQkFBQkUDQsNFBQUFBQU
...
LXFlDUC+l4A9IMKfYCT/AABBDY2E7QqdtV2V0TFFJZmpenzodS23OoSl0bt1bSrhKlD1zZIsTpbx
QQB//9k="
}
]
},
...
]
}
Метод /cargos/listallorderbylogin/
— возвращает все грузы контрагентов, к которым есть доступ в личном кабинете через оформленное официальное письмо или получение расширенного личного кабинета
Доступ
- Зарегистрированные пользователи
Формат запроса
{
"selectBy": 1, // Число, обязательное. По какой дате делать выборку грузов: 0 - по дате приемки груза на склад ПЭК, 1 - по дате подачи заявки, 2 - по дате забора груза [Number]
"dateBegin": "2022-08-10", // Дата, от [Date]
"dateEnd": "2022-08-16" // Дата, до [Date]
}
Формат ответа
{
"сargos": [{
"сode": "999942345766", // Код груза [String]
"orderNumber": "№23434-АБ", // Номер заказа клиента [String]
"cargoStatus": 3, // Статус груза [Number]
"description": "Посуда", // Наименование груза [String]
"orderDate": "2022-12-20T17:12:39.237", // Дата и время создания заявки [DateTime]
"intakePlanDateTime": "2022-12-20T11:33:56", // Плановая дата забора груза [DateTime]
"takeOnStockDateTime": "22022-12-21T17:03:17", // Дата и время сдачи груза [DateTime]
"kindOfTransportationType": "Обычный", // Вид перевозки [String]
"shippingType": "Автоперевозка" // Тип перевозки [String]
"Sender": { // Отправитель [Object]
"branchId": "f47574d0-570b-11dd-bf69-0017085a0478", // Идентификатор филиала [String]
"IsIntake": true, // Заказана услуга забора груза [Boolean]
"IntakeAddress": "Петрозаводск, Красная улица, 45", // Адрес забора груза, если заказана услуга забора [String]
"WarehouseId": "DC6C746D-812D-11E4-BBFC-001999D8B3C5", // Идентификатор склада отправления [String]
"WarehouseAddress": "г.Москва, Рябиновая, 28Ас3", // Адрес склада в городе отправления [String]
"Counterpart": {
"Type": 0; // Тип контрагента 0 - юр.лицо/ИП (есть ИНН), 1 - физическое лицо (по документу удостоверяющему личность) [Number]
"Name": "ООО Ромашка", // Наименование юр.лица/Наименование ИП/ФИО физ.лица
"LegalEntity": { // Блок выводится только для вывода информации о юр.лице и ИП
"INN": "7716542310", // ИНН [String]
"KPP": "773301001" // КПП [String]
},
"PhysicalPerson": { // Блок выводится только для вывода информации о физ.лице
"typeDocumet": 10, // тип документа [Number] (1 - ПАСПОРТ ИНОСТРАННОГО ГРАЖДАНИНА,
// 2 - РАЗРЕШЕННИЕ НА ВРЕМЕННОЕ ПРОЖИВАНИЕ, 3 - ВОДИТЕЛЬСКОЕ УДОСТОВЕРЕНИЕ,
// 4 - ВИД НА ЖИТЕЛЬСТВО, 5 - ЗАГРАНИЧНЫЙ ПАСПОРТ, 6 - УДОСТОВЕРЕНИЕ БЕЖЕНЦА,
// 7 - ВРЕМЕННОЕ УДОСТОВЕРЕНИЕ ЛИЧНОСТИ ГРАЖДАНИНА РФ,
// 8 - СВИДЕТЕЛЬСТВО О ПРЕДОСТАВЛЕНИИ ВРЕМЕННОГО УБЕЖИЩА НА ТЕРРИТОРИИ РФ,
// 9 - ПАСПОРТ МОРЯКА, 10 - ПАСПОРТ ГРАЖДАНИНА РФ,
// 11 - СВИДЕТЕЛЬСТВО О РАССМОТРЕНИИ ХОДАТАЙСТВА О ПРИЗНАНИИ БЕЖЕНЦЕМ,
// 12 - ВОЕННЫЙ БИЛЕТ)
"Series": "3605", // Серия [String]
"Number": "537752" // Номер [String]
}
}
},
"Receiver": { // Получатель [Object]
"IsDelivery": true, // Заказана услуга доставки до адреса получателя [Boolean]
"DelivieryAddress": "Красноярск, улица Петра Ломако, 16", // Адрес доставки груза, если заказана услуга доставки до адреса [String]
"WarehouseId": "D0B35028-8E74-11DF-BB3B-0019BBC941CE", // Идентификатор склада получения [String]
"WarehouseAddress": "г.Орел, Спивака, 74А", // Адрес склада в городе получени [String]
"Counterpart": {
"Type": 0; // Тип контрагента 0 - юр.лицо/ИП (есть ИНН), 1 - физическое лицо (по документу удостоверяющему личность) [Number]
"Name": "ООО Ромашка", // Наименование юр.лица/Наименование ИП/ФИО физ.лица [String]
"LegalEntity": { // Блок выводится только для вывода информации о юр.лице и ИП
"INN": "7716542310", // ИНН [String]
"KPP": "773301001" // КПП [String]
},
"PhysicalPerson": { // Блок выводится только для вывода информации о физ.лице
// тип документа [Number] (
// 0 - БЕЗ ПРЕДОСТАВЛЕНИЯ ДОКУМЕНТА,
// 1 - ПАСПОРТ ИНОСТРАННОГО ГРАЖДАНИНА,
// 2 - РАЗРЕШЕННИЕ НА ВРЕМЕННОЕ ПРОЖИВАНИЕ, 3 - ВОДИТЕЛЬСКОЕ УДОСТОВЕРЕНИЕ,
// 4 - ВИД НА ЖИТЕЛЬСТВО, 5 - ЗАГРАНИЧНЫЙ ПАСПОРТ, 6 - УДОСТОВЕРЕНИЕ БЕЖЕНЦА,
// 7 - ВРЕМЕННОЕ УДОСТОВЕРЕНИЕ ЛИЧНОСТИ ГРАЖДАНИНА РФ,
// 8 - СВИДЕТЕЛЬСТВО О ПРЕДОСТАВЛЕНИИ ВРЕМЕННОГО УБЕЖИЩА НА ТЕРРИТОРИИ РФ,
// 9 - ПАСПОРТ МОРЯКА, 10 - ПАСПОРТ ГРАЖДАНИНА РФ,
// 11 - СВИДЕТЕЛЬСТВО О РАССМОТРЕНИИ ХОДАТАЙСТВА О ПРИЗНАНИИ БЕЖЕНЦЕМ,
// 12 - ВОЕННЫЙ БИЛЕТ)
"Series": "3605", // Серия [String]
"Number": "537752" // Номер [String]
}
}
}
}
]
}
Метод /cargos/statusfullhistory/
— история изменения статусов по заявке/ грузу
Доступ
- Зарегистрированные пользователи
Комментарии
- Метод выводит дату и время установки статусов.
Формат запроса
{
"cargoCodes": [ // Коды грузов [Array]
"780339690775",// Код груза [String]
"999932277461",
"772193116238",
...
]
}
Формат ответа
[
{
"cargoCode": "780339690775",
"statuses": [ // Все время в часовом поясе UTC + 3 часа
{
"id": 4000,// id статуса груза [Number]
"date": "2022-09-26T17:42:37",// Дата и время статуса [DateTime]
"name": "Забор груза заказан",// Статус груза [String]
"isCancel": false,// Признак того, что статус был выставлен, а позднее отменен [Boolean]
// Т.е. учетная операция, изменившая статус, в настоящее время отменена.
"isFinal": false // Признак того, что данный статус является конечным [Boolean]
// Внимание! Может быть ошибочным и позднее отменен.
},
{
"id": 4100,
"date": "2022-09-26T19:36:14",
"name": "Забор груза запланирован",
"isCancel": false,
"isFinal": false
},
...
{
"id": 8,
"date": "2022-09-30T12:54:41",
"name": "Выдан на складе",
"isCancel": false,
"isFinal": false
}
]
},
{
"cargoCode": "999932277461",// Информация о втором грузе, в формате, аналогичном первому объекту массива "statuses" выше
"statuses": [
...
},
{
... // Информация о третьем грузе, в формате, аналогичном первому объекту массива "statuses" выше
},
...
]
Метод /cargos/statustables/
— список доступных статусов по грузам
Доступ
- Зарегистрированные пользователи
Комментарии
- Значения statusId используются в поле cargoStatusId (id статуса груза) в ответе метода
/cargos/status/
- Значения name используются в поле cargoStatus (статуса груза) в ответе метода
/cargos/status/
Формат запроса
// Пустой объект или null
{
}
Формат ответа
[
{
"statusId": 1, // клиентский идентификатор статуса груза, неуникален, служит для ориентации по жизненному циклу перевозки груза [Number]
"isFinal": true, // признак того, что данный статус является конечным
// true означает, что статус конечный[Boolean]
"name": "Принят", // наименование статуса груза [String]
"id": 3, // идентификатор статуса, уникальный [Number]
"typeId": "cargo" // "cargo" - статусы по перевозке груза, "pickup" - статусы заявки на забор
},
{
"statusId": 2,
"isFinal": false,
"name": "Возвращен отправителю",
"id": 4,
"typeId": "cargo"
},
...
]
Метод /cargos/statusbypositionbarcodes/
— запрос статусов грузов по клиентским штрих-кодам
Доступ
- Зарегистрированные пользователи
Комментарии
- Максимальное количество штрих-кодов в одном запросе: 15
- Возможные значения поля
cargos[].info.cargoStatus
(статус груза):
Аннулировано до приемки груза
,
Заявка на забор зарегистрирована
,
Ожидается передача груза от отправителя
,
Отображение детализации статуса В пути
,
Принят к перевозке
,
Принят на ПВЗ
,
Возвращен отправителю
,
Оформлен
,
В пути
,
В пути на терминал
,
Прибыл
,
Прибыл частично
,
Разгружается. Ожидайте оповещения
,
Выполняется адресная доставка
,
Выдан получателю
,
Доставлен получателю
,
Отправлен на возврат
,
Утилизирован
,
Изъят на таможне
,
Возврат груза отправителю
, Выдан ( мест { количество_мест } из { количество_мест } )
- Для груза, который является возвратом документов по другому грузу, в ответе возвращается поле
cargos[].cargo.parentCargoCode
с кодом исходного груза.
- Возможные значения поля
cargos[].info.cargoStatus
(id статуса груза): /cargos/statustable/
- Поле
intakeAddress
будет заполнено только для грузов с забором.
Формат запроса
{
"positionBarCodes": [ // Штрих-коды [Array]
"5558100025220001", // Штрих-код [String]
"5558100025220002",
"5558100025220003",
"5558100025220004",
...
]
}
Формат ответа
{
"cargos": [ // Статусы грузов [Array]
{
"positionBarCodes": [ // Штрих-коды [Array]
"5558100025220001", // Штрих-коды, переданные при создании заявки [String]
"5558100025220002"
],
"info": { // Общая информация о грузе [Object]
"cargoStatus": "выдан", // Статус груза [String]
"cargoStatusId": 8, // id статуса груза [Number]
"intakePlanDateTime": null, // Плановая дата и время забора груза [DateTime]
"takeOnStockPlanDateTime": "2011-03-01T14:51:40", // Плановая дата и время сдачи груза на склад [DateTime]
"takeOnStockDateTime": "2011-03-01T13:51:40", // Дата и время сдачи груза [DateTime]
"takeOnStockPackageState": "ВОЗВРАТНАЯ ТАРА, Внешние повреждения", // Состояние упаковки при сдаче груза
"sendingDateTime": null, // Дата и время отправки груза [DateTime]
"arrivalDateTime": "2011-03-05T11:15:20", // Дата и время прибытия [DateTime]
"arrivalContractDateTime": "2021-10-20T19:26:50", // Дата и время крайнего срока прибытия в отделение выдачи клиенту/передачи на доставку [DateTime]
"giveOutDateTime": "2011-03-10T09:24:24", // Дата и время выдачи с основного отделения филиала получения (на доставку, клиенту) [DateTime]
"arrivalPlanDateTime": "2011-03-04T08:17:59", // Дата и время прибытия в отделение назначения [DateTime], т.е. окончание межтерминальной перевозки внутри ПЭК
"deliveryPlanDate": "2021-08-19T00:00:00", // Дата и время плановой доставки до двери [DateTime], т.е. дата и время, на которые назначена последняя миля
"receivedByClientDateTime": "2011-03-11Т14:01:15" , // Дата получения груза грузополучателем (с учетом перенаправок) [DateTime]
"position": "56.304143;43.490851", // Приблизительные координаты [String]
"сallStatus": "Оповещен получатель", // Статус по оповещению [String]
"сallStatusDateTime": "2015-05-21T00:00:00+03:00", // Дата статуса по оповещению [DateTime]
"storageStartPlanDate": "2015-05-21T00:00:00", // Дата начала платного хранения [DateTime]
"receivingByDocument": true, // Получение возможно после предъявление документа подтверждающего личность, указанного отправителем, иначе по коду СМС (значения true - если получение по документу возможно /false в противном случае) [Boolean]
"receivingBySMSCode": false, // Возможно получение по СМС коду (true - если возможно, false - если невозможно) [Boolean]
"statuses": [] // В актуальной версии протокола не используется. Для получения истории используйте метод
},
"cargo": { // Параметры груза [Object]
"code": "555810002522", // Код груза [String]
// возвращается для груза, который является возвратом документов по др. грузу
"parentCargoCode": "772193116238", // Возврат документов по грузу [String]
"type": 0, // Тип тарифа / продукта [Number]
"amount": 3.0, // Количество мест [Number]
"amountProcessed": 2.0, // Количество прибывших мест [Number]
"weight": 26.0, // Вес, кг [Number]
"volume": 0.25, // Объем, м3 [Number]
"maxSize": 1.000, // Максимальный габарит [Number]
"description": "Запчасти", // Наименование груза [String]
"orderNumber": "№23434-АБ", // Номер заказа клиента [String]
"cargoBarCode": "555810002522", // Штрих-код груза [String]
"positionBarCodes": [ // Штрих-коды грузомест принятые [Array]
"5558100025220001",
"5558100025220002",
"5558100025220003"
]
},
"services": { // Услуги [Object]
"items": [ // Массив услуг [Array]
{
"branch": "Петрозаводск", // Филиал [String]
"description": "Перевозка Петрозаводск - Москва Восток", // Описание [String]
"price": 300.0, // Стоимость, руб. [Number]
"payerType": 1, // Плательщик (1 - отправитель, 2 - получатель, 3 - третье лицо) [Number]
"payerName": "Иванов", // Описание [String]
"currencyName": "руб.", // Валюта [String]
"payerForm": 1, // Тип контрагента плательщика за услугу [Number] (1 - юридическое лицо, 2 - ИП, 3 - физическое лицо)
"paid": 300.0, // Оплаченная сумма, руб [Number]
"paymentMethod": "Касса", // Выбранный способ оплаты задолженности [String]
"payToReceive": true // Необходима оплата задолженности для получения груза [Boolean]
},
{
"branch": "Петрозаводск", // Филиал [String]
"description": "Защитная транспортировочная упаковка Петрозаводск", // Описание [String]
"price": 150.0, // Стоимость, руб. [Number]
"payerType": 1, // Плательщик (1 - отправитель, 2 - получатель, 3 - третье лицо) [Number]
"payerName": "Иванов", // Описание [String]
"currencyName": "руб.", // Валюта [String]
"payerForm": 1, // Тип контрагента плательщика за услугу [Number] (1 - юридическое лицо, 2 - ИП, 3 - физическое лицо)
"paid": 300.0, // Оплаченная сумма, руб [Number]
"paymentMethod": "Касса", // Выбранный способ оплаты задолженности [String]
"payToReceive": true // Необходима оплата задолженности для получения груза [Boolean]
}
],
"sum": 450.0, // Итого, руб. [Number]
"hardPack": false, // Защитная транспортировочная упаковка [Boolean]
"insurance": false, // Страхование [Boolean]
"resendDocs": false, // Груз является возвратными документами [Boolean]
"freeService": false, // В актуальной версии протокола не используется
"debt": 17075.37, // Задолженность, которую необходимо оплатить для получения груза, руб. [Number]
"debtList": [] // В актуальной версии протокола не используется
},
"sender": { // Отправитель [Object]
"branch": "Петрозаводск", // Филиал [String]
"branchInfo": { // Филиал отправителя [Object]
"city": "Петрозаводск", // Филиал [String]
"address": "Республика Карелия, г. Петрозаводск, ул. Зайцева, д. 65 корп. 4", // Адрес [String]
"phone": "8(8142) 599-499", // Телефоны [String]
"email": "pz@pecom.ru", // Email [String]
},
"intakeAddress": "Петрозаводск, Красная улица, 45", // Адрес забора груза, если заказана услуга забора [String]
"sender": "Наименование организации", // Наименование [String]
"person": "Иван Иванович Иванов", // Ответственное лицо [String]
"phone": "11-11-11,12-12-12" // Телефоны [String]
},
"receiver": { // Получатель [Object]
"branch": { // Филиал получателя [Object]
"city": "Москва Восток", // Филиал [String]
"address": "1-й Вязовский пр., д. 4, 109428", // Адрес [String]
"phone": "(495) 925-88-14, 790-76-82", // Телефоны [String]
"email": "pecom@pecom.ru", // Email [String]
},
"receiver": "Наименование организации", // Наименование [String]
"person": "Фёдоров Фёдор Фёдорович", // Ответственное лицо [String]
"phone": "333-33-33" // Телефоны [String]
}
},
{
. .. // Информация о втором грузе, в формате, аналогичном первому объекту массива "cargos" выше
} ,
{
. .. // Информация о третьем грузе, в формате, аналогичном первому объекту массива "cargos" выше
} ,
...
]
}
Метод /cargos/getinfoforcedstorage/
— Вывод информации по рассчитанному ВХ
Доступ
- Зарегистрированные пользователи
Формат запроса
{
"cargoCodes": [ // Коды грузов [Array]
"990448618415" // Код груза [String]
]
}
Формат ответа
[
{
"holidays": [ // Праздничные дни [Array]
"2023-02-23T00:00:00", // [DateTime]
"2023-03-08T00:00:00",
"2023-05-01T00:00:00",
"2023-05-09T00:00:00",
"2023-06-12T00:00:00",
"2023-11-04T00:00:00"
],
"items": [ // Расчёт услуги вынужденное хранение [Array]
{
"startDate": "2022-09-29T16:27:23", // Дата начисления [DateTime]
"endDate": "2022-10-05T00:00:00", // Дата окончания начисления [DateTime]
"rate": 0, // Ставка [Number]
"minStorageCost": 0, // Минимальная стоимость хранения [Number]
"costStorage": 0, // Стоимость хранения [Number]
"startDataNumber": 0, // Количество дней с начала действия тарифа [Number]
"endDataNumber": 0, // Количество дней по окончанию действия тарифа [Number]
"cargoStatus": "Бесплатное хранение" // Статус груза Бесплатное хранение, Вынужденное хранение, Праздничные дни, В пути, Корректировка долга [String]
},
{
"startDate": "2023-01-20T00:00:00",
"endDate": "2023-01-24T00:00:00",
"rate": 300,
"minStorageCost": 100,
"costStorage": 300,
"startDataNumber": 1,
"endDataNumber": 5,
"cargoStatus": "Вынужденное хранение"
},
{
"startDate": "2023-01-25T00:00:00",
"endDate": "2024-01-19T00:00:00",
"rate": 500,
"minStorageCost": 300,
"costStorage": 500,
"startDataNumber": 6,
"endDataNumber": 365,
"cargoStatus": "Вынужденное хранение"
}
]
}
]
Метод /cargos/cancelandreturncargo/
— оформление возврата груза отправителю после передачи груза в ПЭК
Доступ
- Зарегистрированные пользователи с подтвержденным, расширенным личным кабинетом
- Подключен сервис «Возврат груза отправителю»
Комментарии
- Метод позволяет автоматически перенаправить груз отправителю с момента оформления груза на складе в городе отправления и до момента выдачи получателю
- Выполняется по одному конкретному грузу
- В процессе движения груза в ПЭК существуют интервалы времени, когда возврат отправителю оформить не возможно. Например: до того как груз принят на склад ПЭК и оформлен к перевозке или если груз уже на последней миле при доставке получателю, в этом случае метод будет сообщать о неуспешной попытке оформления возврата
Формат запроса
{
"code": "9999366661603", // Код груза [String]
}
Формат ответа
{
"success": true, // Результат [Boolean]. true - возврат успешно оформлен при текущем вызове метода
// или ранее (любым из способов), false - не удалось оформить возврат
"description": "Возврат заказа/ груза отправителю успешно оформлен"// Описание результата [String]
// Перечень возможных комментариев на текущий момент:
// 1. "Возврат заказа/ груза отправителю успешно оформлен" -
// операция выполнена успешно
// 2. Невозможно оформить возврат груза по API. Груз не принят на склад ПЭК
// или не Оформлен к перевозке. Обратитесь к менеджеру ПЭК" - в настоящее
// время невозможно оформить возврат отправителю, необходимо дождаться
// оформления перевозки в ПЭК (статус "Оформлен") и попробовать еще раз
// или запросить возврат через менеджера ПЭК/службу поддержки клиентов ПЭК
// 3. "По грузу уже оформлен Возврат отправителю"
// 4. "Невозможно оформить возврат груза по API/ Узнать статус оформления
// возврата. Обратитесь к менеджеру ПЭК" - Операция не выполнена по
// внутренним причинам ПЭК, можно пробовать вызвать метод позднее
// 5. "Отказ от груза не возможен. Груз передан грузополучателю"
// 6. "Груз не найден" - груз с указанным индексом не найден в ПЭК
// 7. "Для Вашего логина операция недоступна. Выполнение операции доступно
// только для подтвержденного/расширенного кабинета от имени Отправителя
// возвращаемого груза" - не пройдена проверка прав доступа к операции с грузом
// 8. "Для отправителя не заключено соглашение на возможность возврата груза
// без оригинала заявления на перенаправку. Оформление через API невозможно"
// - отсутствует доп.соглашение на упрощенное оформление возвратов грузов
//(технически не подключен сервис/спец.условие: "Возврат груза отправителю")
// 9. "Время ожидания окончания оформления возврата груза отправителю
// истекло. Запрос принят в очередь обработки" - оформление возврата
// груза не удалось выполнить в синхронном режиме. Запрос на возврат
// принят и будет обработан позднее. Результат обработки можно узнать
// через 15-30 минут, вызвав этот метод повторно
// 10. "При обработке произошла исключительная ситуация. Обратитесь
// в службу поддержки приложений интеграции ПЭК" - произошла ошибка
// регламентного выполнения метода, можно попробовать вызвать позднее.
// Если ошибка повторится, то необходимо обратиться в службу поддержки
// интеграционных приложений ПЭК.
}