Группа /cargosdocuments/ — предоставление экспедиторских документов по грузам

Метод /cargosdocuments/order/ — запрос на предоставление документа

Доступ

• Зарегистрированные пользователи с подтвержденным и расширенным личным кабинетом, являющиеся грузоотправителем, автором заявки или плательщиком.

Комментарии

• Метод на данный момент позволяет запросить документы "Поручение экспедитора/ Экспедиторская расписка" и "Счет на оплату" по оформленным грузам.
• При первом успешном вызове метода по конкретному грузу в ответе будет статус 0 - "Документ запрошен". При повторном вызове и после получения статуса 1 - "Документ готов к скачиванию", получите документ методом /CARGOSDOCUMENTS/GETCONTENT/
• Для получения "Счета на оплату" необходимо передать идентификатор контрагента-плательщика "counterpartGuid" в системах ПЭК, связанный с ЛК. По грузу должна быть задолженность для этого контрагента-плательщика. "counterpartGuid" можно получить методом /COUNTERPARTS/CONFIRMEDACCESSTOCOUNTERPARTIES/.
• Для получения "Счета на оплату" в формате "xml", необходимо передать уточняющий параметр "docFormat" в запросе. Данные счета вернутся в формате CommerseML редакции 2.
• Есть ограничение на число запросов в сутки для одного логина

Формат запроса

{
    "cargoCode": "999950869351",//Код груза [String]], обязательно.
    "docType": "CargoInvoice",  //Тип документа [String], обязательно. Возможные значения:
                                //"CargoAssignment" - Поручение экспедитора/ Экспедиторская расписка
                                //"CargoInvoice" - Счет на оплату 
    "docFormat": "xml",//Формат документа [String], необязательно. Если не передан, вернется документ в формате "pdf"
                       //Формат "xml" можно указать только для счета на оплату "CargoInvoice"
    "counterpartGuid": "3f55ea95-59ca-4f7a-868d-65fd5678391e"//Идентификатор контрагента-плательщика в системах ПЭК,
                                                             //связанный с ЛК, обязателен для "docType" = "CargoInvoice".
                                                             //Можно получить методом /COUNTERPARTS/CONFIRMEDACCESSTOCOUNTERPARTIES/
}

Формат ответа

{
    "result": {
        "docStatus": 1, //Статус документа [Number]
                        //0 - запрошен; 1 - готов к выдаче; -1 - ошибка; 2 - документ не может быть предоставлен
        "description": "Документ готов к скачиванию" //Описание статуса [String]
    }
}

Метод /cargosdocuments/getcontent/ — получение документа

Доступ

• Зарегистрированные пользователи с подтвержденным и расширенным личным кабинетом, являющиеся грузоотправителем, автором заявки или плательщиком.

Комментарии

• Метод на данный момент позволяет получить документы "Поручение экспедитора/ Экспедиторская расписка" и "Счет на оплату" по оформленным грузам.
• Сначала необходимо запросить документ методом /CARGOSDOCUMENTS/ORDER/ и дождаться готовности документа
• Для получения "Счета на оплату" необходимо передать идентификатор контрагента-плательщика "counterpartGuid" в системах ПЭК, связанный с ЛК. "counterpartGuid" можно получить методом /COUNTERPARTS/CONFIRMEDACCESSTOCOUNTERPARTIES/.
• Для получения "Счета на оплату" в формате "xml", необходимо передать уточняющий параметр "docFormat" в запросе. Данные счета вернутся в формате CommerseML редакции 2.
• Счета на оплату возвращаются в "zip" архиве (в архиве может быть несколько счетов по грузу)
• XSD схема Commerce ML 4.02

Формат запроса

{
    "cargoCode": "999950869351",//Код груза [String]], обязательно.
    "docType": "CargoInvoice",  //Тип документа [String], обязательно. Возможные значения:
                                //"CargoAssignment" - Поручение экспедитора/ Экспедиторская расписка
                                //"CargoInvoice" - Счет на оплату 
    "docFormat": "xml",//Формат документа [String], необязательно. Если не передан, вернется документ в формате "pdf"
                       //Формат "xml" можно указать только для счета на оплату "CargoInvoice"
    "counterpartGuid": "3f55ea95-59ca-4f7a-868d-65fd5678391e"//Идентификатор контрагента-плательщика в системах ПЭК,
                                                              //связанный с ЛК, обязателен для "docType" = "CargoInvoice".
                                                              //Можно получить методом /COUNTERPARTS/CONFIRMEDACCESSTOCOUNTERPARTIES/
}

Формат ответа

// Успешный ответ
{
    "docName": "999950869351 - Поручение экспедитора.pdf", // Наименование документа [String]
    "docFormat": "xml",            // Если был указан входящий параметр docFormat
    "docBody": "JVBERi0xLjQKJe..." // Тело документа в стандарте - base64 [String]
}
 
// Ответ с ошибкой
{
    "error": {
        "title": "Документ не был запрошен",
        "message": "",
        "error": null,
        "status": 200
    }
}

Метод /cargosdocuments/cargoinvoicebyperiod/ — получение идентификаторов грузов за период, по которым есть задолженность по запрашиваемому плательщику

Доступ

• Зарегистрированные пользователи с подтвержденным и расширенным личным кабинетом, являющиеся плательщиком.
• Сторонние неперсонифицированные приложения

Комментарии

• Для получения неоплаченных идентификаторов грузов необходимо передать идентификатор плательщика "counterpartGuid". "counterpartGuid" можно получить методом /COUNTERPARTS/CONFIRMEDACCESSTOCOUNTERPARTIES/
• Запрошенный период не может превышать 31 день.
• По полученным идентификаторам грузов можно запросить Счет на оплату методом /CARGOSDOCUMENTS/ORDER/

Формат запроса

{
    "counterpartGuid": "d02fedd7-93de-4c9e-9b2f-d9239d26a3b7",//Идентификатор контрагента-плательщика в системах ПЭК, связанный с ЛК.                                      
                                                              //Получается методом /COUNTERPARTS/CONFIRMEDACCESSTOCOUNTERPARTIES/
    "dateFrom": "2025-07-01",//Начальная дата периода запроса, дата берется по оформлению груза
    "dateTo": "2025-07-31"   //Конечная дата периода запроса, дата берется по оформлению груза
}

Формат ответа

[   
    "630179620731", // Идентификатор груза 1 [cargoCode]
    "369962416102", // Идентификатор груза 2 [cargoCode]
    ...   
    "999969221871"  // Идентификатор груза n [cargoCode]
]