Группа /cargopickupnetwork/ — операции с сетевыми заявками

Метод /cargopickupnetwork/submit/ — оформление заявки

Метод не рекомендуется к использованию, корректная работа метода не гарантируется

Доступ

• Зарегистрированные пользователи

Комментарии

• Максимальное количество грузов в одной заявке (и объектов с информацией о грузах в ответе) — 50
• Общие рекомендации по передаче адреса забора/доставки в запрос при интеграции с транспортной компанией
• В элементах массива cargos.items[] с данными о грузах необходимо указывать данные получателя в объекте cargos.items[].receiver.
• У объекта cargos.items[].services.(услуга).payer.other для услуг pickUp (забор), transporting (перевозка), delivery (доставка), insurance (страховка) добавилось поле paymentCity.
• Реквизит "paymentCity" рекомендуется передавать только в некоторых случаях, описанных ниже. При передаче "paymentCity" в нём ожидается указание наименования филиала оплаты. "Филиал оплаты" - филиал ПЭК, в котором плательщик за услугу ПЭК будет получать оригиналы закрывающих бухгалтерских документов: УПД, отчёт по страхованию и т.п. Филиал оплаты также определяет возможность применения к грузу некоторых назначенных контрагенту скидок и сервисов.
  "paymentCity" обязателен только при указании плательщиком "третьего лица" (type=3)!
  Если плательщиками указаны Отправитель (type=1) или Получатель (type=2), то "paymentCity" следует передавать ТОЛЬКО в следующих случаях:
  • плательщиком за услугу указан Отправитель (type=1) и Филиал оплаты, отличается от филиала отправления,
  • плательщиком за услугу указан Получатель (type=2) и Филиал оплаты, отличается от филиала получения.
  По умолчанию, если Плательщик - отправитель, то Филиалом оплаты будет указан Филиал отправления; если Плательщик - получатель, то Филиал получения.
  Наименование филиала можно получить в ответе методов /branches/all/ в поле branches[].title или /branches/findzonebyaddress/ в поле branchTitle
• Можно указать штрих-коды для позиций грузов. Для этого надо во-первых для всей заявки в поле cargos.common.typeClientBarcode указать тип штрих-кода, регистр при указании типа штрих-кода не важен. Список допустимых типов штрих-кодов можно получить с помощью метода /cargopickupnetwork/availabletypebarcode. Для каждого груза нужно указать массив со штрих-кодами позиций груза в поле cargos.items[].cargo.clientPositionsBarcode. Штрих-кодов не должно быть указано больше, чем позиций груза (cargos.items[].cargo.positionsCount).
• Для подачи заявки с наложенным платежом, следует использовать другие методы API. Свяжитесь с нами, если у Вас есть такая потребность.
• cargos.items[].receiver.identityCard.type в значении 0 (Без предоставления документа) подразумевает, что идентификация получателя (доступна по договору оферты) будет произведена с использованием кода СМС. Ограничения на использование данного способа идентификации описаны здесь
• Данные по наименованию филиала отправления и получения для реквизитов sender.city и receiver.city можно получить используя метод /branches/findzonebyaddress/. На вход в метод передавать адрес забора и/или доставки, в ответе метода брать значение реквизита branchTitle и подставлять в реквизит city соответствующего блока.
• Возможность забора груза "день в день" в соответствии с Вашим договором уточняйте у своего закрепленного менеджера или в филиале отправления. Есть ограничения по времени забора и по габаритам, которые зависят от конкретных филиалов. Подача заявок по API на забор груза "день в день" за административными чертами города, а также на праздничные и выходные дни невозможна.

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

{
  "common":{ // Общие данные по заявке [Object]
    "applicationDate":"2012-05-15", // Планируемая дата забора груза [Date]. Обязательно. (см. комментарии)
    "responsiblePerson":"Коновалов Г.В", // ФИО ответственного за оформление заявки [String]
    "description":"Тестовый груз" // Описание груза [String]
                                  // поле обязательно для заполнения, если не во всех грузах заявки
                                  // проставлено описание груза (cargos.items[].cargo.description)
                                  // Значение необходимо выбрать из ответа метода /cargocontent/all/
  },
  "sender":{ // Данные об отправителе [Object]
    "inn":"7716542310", // ИНН [String], обязательно для Юридических лиц и ИП (для физических лиц не передавать)
    "city":"Омск", // Наименование филиала отправителя [City]
    "title":"Наименование организации", // Наименование отправителя [String]
    "person":"Иванов Иван Иванович", // Контактное лицо [String]
    "phone":"22-33-44", // Телефон [String]
    "email":"example@example.com", // E-mail [String], поле необязательно
    "addressOffice":"Россия, г. Омск, улица Антонова, д. 2", // Адрес офиса, по которому находятся документы на получения грузов [String].
    "addressStock":"Россия, г. Омск, улица Боровиковского, 17, строение 5", // Адрес, по которому необходимо забрать груз [String].
    "workTimeFrom":"10:15", // Время начала рабочего дня [Time], поле необязательно
    "workTimeTo":"18:00", // Время окончания рабочего дня [Time], поле необязательно
    "lunchBreakFrom":"14:00", // Время начала обеденного перерыва [Time], поле необязательно
    "lunchBreakTo":"15:00" // Время окончания обеденного перерыва [Time], поле необязательно
    "identityCard":{ // Документ удостоверяющий личность  [Object], обязательно для Физических лиц (для юр.лиц и ИП не передавать)
        "type": 10, // тип документа [Number] (1 - ПАСПОРТ ИНОСТРАННОГО ГРАЖДАНИНА,
                    // 2 - РАЗРЕШЕННИЕ НА ВРЕМЕННОЕ ПРОЖИВАНИЕ, 3 - ВОДИТЕЛЬСКОЕ УДОСТОВЕРЕНИЕ,
                    // 4 - ВИД НА ЖИТЕЛЬСТВО, 5 - ЗАГРАНИЧНЫЙ ПАСПОРТ, 6 - УДОСТОВЕРЕНИЕ БЕЖЕНЦА,
                    // 7 - ВРЕМЕННОЕ УДОСТОВЕРЕНИЕ ЛИЧНОСТИ ГРАЖДАНИНА РФ, 
                    // 8 - СВИДЕТЕЛЬСТВО О ПРЕДОСТАВЛЕНИИ ВРЕМЕННОГО УБЕЖИЩА НА ТЕРРИТОРИИ РФ,
                    // 9 - ПАСПОРТ МОРЯКА, 10 - ПАСПОРТ ГРАЖДАНИНА РФ, 
                    // 11 - СВИДЕТЕЛЬСТВО О РАССМОТРЕНИИ ХОДАТАЙСТВА О ПРИЗНАНИИ БЕЖЕНЦЕМ,
                    // 12 - ВОЕННЫЙ  БИЛЕТ)
        "series":"1234", // Серия [String]
        "number":"56789", // Номер [String]
        "date":"1985-01-01", // Дата выдачи документа, удостоверяющего личность [Date]
        "note":"" // служебное поле для других документов [String]
    }
  },
  "cargos":{ // Данные о позициях [Object]
    "common":{ // Общие данные для всех позиций [Object], поле необязательно

      /*
        Если этот объект определён, указывать размеры для каждого груза необязательно
      */
      "cargoTotals": { // Общие размеры, объём и весь груза [Object], 
                       // поле необязательно                       
        "volume":10, // Общий объём, м3 [Number]
        "weight":200, // Общий вес, кг [Number]
        "maxDimension":10, // Максимальный габарит, м [Number]
        "positionsCount":5 // Общее количество мест, шт [Number]
      },

      /*
        Структура объектов "payer" одинакова для всех случаев и описывается один раз
      */

      /*
        Если определены элементы этого объекта, указывать плательщиков
        для каждого груза необязательно (детальнее см. ниже)

        Это можно использовать для реализации сценариев "за доставку всех грузов платит получатель"
        или "за перевозку грузов платит отправитель"
      */
      "services":{ // Определение плательщиков для всех грузов [Object], необязательно 
                   // Правила заполнения "paymentCity" для любой услуги см. комментарии
        "pickUp":{ // Плательщик за услугу забора груза [Object], поле необязательно
           "payer": { // Плательщик [Object]
             "type":3, // Плательщик (1 - отправитель, 2 - получатель, 3 - третье лицо) [Number]
             "other":{ // Данные о плательщике-третьем лице [Object], поле обязательно если "type":3
                "inn":"7716542310", // ИНН третьего лица [String], обязательно для Юридических лиц и ИП (для физических лиц не передавать)
                "title":"Тестовая компания", // Наименование третьего лица [String], обязательно, если type=3
                "paymentCity":"Омск", // Наименование филиала оплаты за услугу [String]. См. комментарий
                                      // Обязательно в этом примере, т.к. за услугу pickUp плательщик указан третье лицо type=3.
                "phone":"22-33-44" // Телефон [String], обязательно
                "identityCard":{   // Документ удостоверяющий личность третьего лица [Object]. Обязательно, если
                                   // плательщик 3-е лицо (type=3) является Физическом лицом  (для юр.лиц и ИП не передавать)
                    "type": 10, // тип документа [Number] (1 - ПАСПОРТ ИНОСТРАННОГО ГРАЖДАНИНА,
                                // 2 - РАЗРЕШЕННИЕ НА ВРЕМЕННОЕ ПРОЖИВАНИЕ, 3 - ВОДИТЕЛЬСКОЕ УДОСТОВЕРЕНИЕ,
                                // 4 - ВИД НА ЖИТЕЛЬСТВО, 5 - ЗАГРАНИЧНЫЙ ПАСПОРТ, 6 - УДОСТОВЕРЕНИЕ БЕЖЕНЦА,
                                // 7 - ВРЕМЕННОЕ УДОСТОВЕРЕНИЕ ЛИЧНОСТИ ГРАЖДАНИНА РФ, 
                                // 8 - СВИДЕТЕЛЬСТВО О ПРЕДОСТАВЛЕНИИ ВРЕМЕННОГО УБЕЖИЩА НА ТЕРРИТОРИИ РФ,
                                // 9 - ПАСПОРТ МОРЯКА, 10 - ПАСПОРТ ГРАЖДАНИНА РФ, 
                                // 11 - СВИДЕТЕЛЬСТВО О РАССМОТРЕНИИ ХОДАТАЙСТВА О ПРИЗНАНИИ БЕЖЕНЦЕМ,
                                // 12 - ВОЕННЫЙ  БИЛЕТ)
                    "series":"1234", // Серия [String]
                    "number":"56789", // Номер [String]
                    "date":"1985-01-01", // Дата выдачи документа, удостоверяющего личность [Date]
                    "note":"" // служебное поле для других документов [String]
                    }
                }
            }
        },

        "transporting":{ // Плательщик за услугу перевозки [Object], поле необязательно
          "payer":{ // Плательщик [Object] (детальное описание см. выше)
            "type":1
          }
        },

        "delivery":{ // Плательщик за услугу доставки [Object], поле необязательно
          "payer":{ // Плательщик [Object] (детальное описание см. выше)
            "type":1
          }
        },

        "insurance":{ // Плательщик за услугу страхования [Object], поле необязательно
          "payer":{ // Плательщик [Object] (детальное описание см. выше)
            "type":1
          }
        }

      },
      "typeClientBarcode": "EAN13" // Тип штрих-кодов, указанных для мест грузов заявки [String]
      // список допустимых типов штрих-кодов можно получить с помощью метода availabletypebarcode
      // тип штрих-кода можно набирать символами любого регистра
    },
    "items":[ // Данные о грузах [Array]
      { // Информация об одном грузе [Object]

        "receiver":{ // Получатель [Object]
          "inn":"7716542310", // ИНН [String], обязательно для Юридических лиц и ИП  (для физических лиц не передавать)
          "city":"Санкт-Петербург", // Наименование филиала получателя [City]
          "title":"Наименование организации", // Наименование получателя [String], обязательно
          "person":"Петров Петр Васильевич", // Контактное лицо [String]
          "phone":"33-44-55"  // Телефон [String], обязательно
          "identityCard":{ // Документ удостоверяющий личность  [Object], обязательно для Физических лиц (для юр.лиц и ИП не передавать)
            "type": 10, // тип документа [Number] (// 0 - БЕЗ ПРЕДОСТАВЛЕНИЯ ДОКУМЕНТА (серию\номер можно оставить пустыми) - см. комментарии,
                        // 1 - ПАСПОРТ ИНОСТРАННОГО ГРАЖДАНИНА,
                        // 2 - РАЗРЕШЕННИЕ НА ВРЕМЕННОЕ ПРОЖИВАНИЕ, 3 - ВОДИТЕЛЬСКОЕ УДОСТОВЕРЕНИЕ,
                        // 4 - ВИД НА ЖИТЕЛЬСТВО, 5 - ЗАГРАНИЧНЫЙ ПАСПОРТ, 6 - УДОСТОВЕРЕНИЕ БЕЖЕНЦА,
                        // 7 - ВРЕМЕННОЕ УДОСТОВЕРЕНИЕ ЛИЧНОСТИ ГРАЖДАНИНА РФ, 
                        // 8 - СВИДЕТЕЛЬСТВО О ПРЕДОСТАВЛЕНИИ ВРЕМЕННОГО УБЕЖИЩА НА ТЕРРИТОРИИ РФ,
                        // 9 - ПАСПОРТ МОРЯКА, 10 - ПАСПОРТ ГРАЖДАНИНА РФ, 
                        // 11 - СВИДЕТЕЛЬСТВО О РАССМОТРЕНИИ ХОДАТАЙСТВА О ПРИЗНАНИИ БЕЖЕНЦЕМ,
                        // 12 - ВОЕННЫЙ  БИЛЕТ)
            "series":"1234", // Серия [String]
            "number":"56789", // Номер [String]
            "date":"1985-01-01", // Дата выдачи документа, удостоверяющего личность [Date]
            "note":"" // служебное поле для других документов [String]
            }
        },

        "cargo":{ // Параметры груза [Object]
          
          "customerCorrelation":"№23434-АБ", // Произвольное значение для синхронизации на стороне клиента [String], поле необязательно
          "type":  3,  // Идентификатор продукта/тарифа ПЭК с которым должно работать отделение [Number]. Обязательно.
                       // ВАЖНО! Данный метод поддерживает только 2 продукта: type = 3 "ПЭК:LTL Авто" и type = 1 "ПЭК:Express Авиа"

          "description": "обувь", // Описание груза [String]
                                  // поле обязательно для всех грузов если не заполнено
                                  // общее описание для заявки (common.description)
                                  // Значение необходимо выбрать из ответа метода /cargocontent/all/

          "orderNumber":"№23434-АБ", // Номер заказа клиента [String], поле необязательно
          "weight":2.5, // Вес, кг [Number], поле необязательно, если указаны общие данные
          "volume":0.1, // Объём, м3 [Number], поле необязательно, если указаны общие данные
          "width":0.12, // Ширина, м [Number], поле необязательно, если указаны общие данные
          "length":0.3, // Длина, м [Number], поле необязательно, если указаны общие данные
          "height":0.4, // Высота, м [Number], поле необязательно, если указаны общие данные
          "positionsCount":2 // Количество мест, шт [Number],
                             // поле необязательно, если указаны общие данные
          "clientPositionsBarcode": [ // Штрих-коды мест груза [Array]
                                      // Если для груза заданы штрих-коды для заявки, обязательно
                                      // указать тип используемых штрих-кодов
                                      // cargos.common.typeClientBarcode
                                      // список допустимых типов штрих-кодов можно получить с помощью метода availabletypebarcode
                "123654789", // Штрих-код клиента [String]
                ...
            ]
        },
        "conditions":{ // Условия перевозки [Object]
          "isOpenCar":false, // Необходима открытая машина при заборе у отправителя [Boolean] 
          "isSideLoad":true, // Необходима боковая погрузка при заборе у отправителя [Boolean]
          "isSpecialEquipment":false, // Необходима машина со специальным оборудованием при заборе у отправителя [Boolean], 
                                      // поле необязательно, если не указано считается равным false
          "isUncovered":false, // Необходима растентовка при заборе у отправителя [Boolean], 
                               // поле необязательно, если не указано считается равным false
                              // В актуальной версии протокола не используется
          "isFast":false, // Необходима скоростная перевозка [Boolean]
                          // В актуальной версии протокола не используется
          "isLoading":false // Необходима разгрузка силами «ПЭК» при доставке получателю [Boolean]  
        },
        "services":{ // Услуги [Object]
          "pickUp":{ // Услуга забора груза [Object], 
                     // поле необязательно, если указан плательщик за эту услугу
                     // для всех грузов
            "payer":{  // Плательщик [Object] (детальное описание см. выше)
              "type":2
            }
          },
          "transporting":{ // Перевозка [Object]
                           // поле необязательно, если указан плательщик за эту услугу
                           // для всех грузов
            "payer":{ // Плательщик [Object] (детальное описание см. выше)
             "type":1
            }
          },

          /* 
            Услуги, заказ которых необязателен имеют поле enabled [Boolean]
			
            Для услуг доставки и страхования поле "payer" необязательно, если выполняется одно 
            из двух условий:
              а) "enabled":false (т.е. услуга не заказана)
              б) "enabled":true и данные о плательщике определены в объекте cargos.common.services
                 (т.е. услуга заказана и данные о плательщике указаны для всех позиций сразу)

            Для остальных услуг поле "payer" обязательно, если услуга заказана ("enabled":true)

            Допустимо переопределять плательщиков, к примеру: в наборе из 10 грузов за перевозку 9
            платит отправитель, а за перевозку одного — получатель. В этом случае в объекте
            cargos.common.services можно указать плательщиком за услугу перевозки для всех грузов
            отправителя (и не указывать отдельно для каждого из них), а для единственного груза 
            за перевозку которого платит получатель указать плательщика в этом объекте.
          */

          "delivery":{ // Доставка [Object]
            "enabled":true, // Заказана ли услуга [Boolean]
            "avisationDateTime": "2013-04-02", // Дата авизации [Date], поле необязательно
            "address":"Россия, г. Санкт-Петербург, улица Садовая 2, кв. 5", // Адрес доставки [String],
                                                                            // поле обязательно, если "enabled":true
            "payer":{ // Плательщик [Object] (детальное описание см. выше),
                      // поле необязательно при определённых условиях (см. выше)
              "type":1
            }
          },

          "insurance":{ // Страховка [Object]
            "enabled":true, // Заказана ли услуга [Boolean]
            "cost":20000.25, // Оценочная стоимость, руб [Number], 
                            // поле обязательно, если "enabled":true
            "payer":{ // Плательщик [Object] (детальное описание см. выше),
                      // поле необязательно при определённых условиях (см. выше)
              "type":1
            }
          },

          "documentsReturning":{ // Возврат документов [Object]
            "enabled":true, // Заказана ли услуга [Boolean]
            "payer":{ // Плательщик [Object] (детальное описание см. выше),
                      // поле необязательно при определённых условиях (см. выше)
              "type":1 
            }
          },
          
          "strapping":{ // Упаковка стреппинг-лентой [Object]
            "enabled":false // Заказана ли услуга [Boolean]
          },
        
          "sealing":{ // Пломбировка [Object]
            "enabled":true, // Заказана ли услуга (обязательна только до 3 кг) [Boolean]
            "positionsCount":12, // Количество мест для пломбировки [Number]
            "payer":{ // Плательщик [Object] (детальное описание см. выше),
                      // поле необязательно при определённых условиях (см. выше)
              "type":3,
              "other":{
                "inn":"7716542310",
                "title":"Тестовая компания",
                "phone":"22-33-44"
              }
            }
          },

          "hardPacking":{ // Защитная транспортировочная упаковка [Object]
            "enabled":true, // Заказана ли услуга [Boolean]
            "positionsCount":5, // Количество мест в ЗТУ [Number]
            "payer":{ // Плательщик [Object] (детальное описание см. выше),
                      // поле необязательно при определённых условиях (см. выше)
              "type":1
            }
          },
    
          
        }
      },
    	 
      {  // Информация об одном грузе [Object]
        ... 
      }

      ... 

    ] // items
  }
}

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

{
  "documentId": 16, // Номер заявки [Number]
  "cargos":[ // Информация о принятии данных грузов, описанных в заявках [Array]
    { // Объект с информацией о приёме одной заявки [Object]
        "customerCorrelation":"№23434-АБ", // Произвольное значение для синхронизации на стороне клиента [String]
        "cargoCode": "780339690775", // Код груза [String]
        "barсode": "780339690775" // Значение для штрих-кода в формате EAN-13 [String]
        "orderNumber": "12345" // Номер заказа [String]
        "positions": [ // Информация о местах [Array]
          { // Информация об одном месте [Object]
            "barcode": "7803396907750001" // Значение для штрих-кода 
                                           // в формате CODE-128/EAN-128 [String]
          },
          ...
        ],
        "typeClientBarcode": "EAN13", // Тип штрих-кода [String]
        "clientPositionsBarcode": [ // Штрих-коды клиента [Array]
            "123654789", // штрих-код клиента [String]
            ...
        ]
    }, 
    ...
  ]
}