Поиск по сайту

API
Главная / API - Пакетный заказ

Пакетный заказ

Обновлено 13.08.2020
141 кб

Общие сведения

Пакетный заказ - объединение нескольких существующих заказов на доставку от терминала с целью ускорения процедуры обработки груза на терминале.  

Сервис позволяет сформировать/расформировать пакетный заказ, передать данные водителя, который будет сдавать груз, автомобиля, на котором он прибудет на терминал, а также данные по грузовым местам объединяемых заказов. 

Для использования метода необходимо связаться с менеджером Компании и сообщить о желании использовать решение Pre-Alert.

Настоящий сервис позволяет объединить заказы на доставку от терминала ("предзаказы") в пакетный заказ, для объединения нескольких заказов на доставку от адреса отправителя следует использовать метод "Создание мультизаявки

Создание пакетного заказа

Запрос метода

Пример запроса

Адрес метода: https://api.dellin.ru/v2/batch_request.json

{  
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "requestIDs":["1111","2222","3333"],
   "comment":"Текст комментария"
}

Адрес метода: https://api.dellin.ru/v2/batch_request.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <requestIDs>1111</requestIDs>
   <requestIDs>2222</requestIDs>
   <requestIDs>3333</requestIDs>
   <comment>Текст комментария</comment>
</request>

Описание параметров

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"
requestIDsДаarray of strings

ID заказов, которые необходимо объединить в пакетный заказ (для оформления заказа следует использовать метод "Оформление заявок на перевозку из Личного Кабинета")

Примечания:

  1. Заказ должен являться предзаказом (то есть предполагается доставка от терминала).
  2. При создании заказа был передан параметр "cargoCode" (см. метод "Оформление заявок на перевозку из Личного Кабинета").
  3. Заказ должен быть создан текущим пользователем.
  4. Заказ должен иметь один из следующих статусов:
    1. В обработке.
    2. Ожидает сдачи на терминал.
    3. Груз принят к перевозке.
    4. Груз принят к перевозке. Платное хранение.
    5. Груз в пути
commentНетstringКомментарий. Максимум 300 символов

Ответ метода

Пример ответа

{  
   "metadata":{
      "status":200,
      "generated_at":"2020-06-17 15:15:58"
   },
   "data":{
      "batchRequestID":12345,
      "state":"success"
   }
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2020-06-17 15:15:58</generated_at>
   </metadata>
   <data>
      <batchRequestID>12345</batchRequestID>
      <state>success</state>
   </data>
</response>

Описание параметров

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusinteger

Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (Success)

metadata.generated_atstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataobjectИнформация по итогу формирования пакетного заказа
data.batchRequestIDintegerID созданного пакетного заказа
data.statestringСтатус. Возможное значение - "success" (операция успешно завершена)

Обработка ошибок

Помимо общих ошибок API, в ответе метода могут присутствовать следующие ошибки:

Номер ошибки

http-код

Краткое описание ошибки

616001

400

Указанные заказы не соответствуют условиям группировки в мультизаявку

Отмена пакетного заказа

Запрос метода

Пример запроса

Адрес метода: https://api.dellin.ru/v2/batch_request/cancel.json

{  
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "batchRequestID":12345
}

Адрес метода: https://api.dellin.ru/v2/batch_request/cancel.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <batchRequestID>12345</batchRequestID>
</request>

Описание параметров

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"
batchRequestIDДаinteger

ID пакетного заказа, который необходимо расформировать

Пакетный заказ должен быть создан текущим пользователем

Ответ метода

Пример ответа

{  
   "metadata":{
      "status":200,
      "generated_at":"2020-06-17 15:15:58"
   },
   "data":{
      "state":"success"
   }
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2020-06-17 15:15:58</generated_at>
   </metadata>
   <data>
      <state>success</state>
   </data>
</response>

Описание параметров

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusinteger

Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (Success)

metadata.generated_atstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataobjectИнформация о выполнении операции
data.statestringСтатус. Возможное значение - "success" (операция успешно завершена)

Обработка ошибок

Помимо общих ошибок API, в ответе метода могут присутствовать следующие ошибки:

Номер ошибки

http-код

Краткое описание ошибки

617001

400

Невозможно отменить данную мультизаявку

Передача данных водителя и машины

Запрос метода

Пример запроса

Адрес метода: https://api.dellin.ru/v2/batch_request/update.json

{  
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "batchRequestID":12345,
   "carNumber": "С690ТН55", 
   "driverName": "Иванов Петр Викторович" 
}

Адрес метода: https://api.dellin.ru/v2/batch_request/update.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <batchRequestID>12345</batchRequestID>
   <carNumber>С690ТН55</carNumber>
   <driverName>Иванов Петр Викторович</driverName>
</request>

Описание параметров

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"
batchRequestIDДаinteger

ID пакетного заказа

Пакетный заказ должен быть создан текущим пользователем
carNumberНетstringНомер машины, на которой груз будет доставлен на терминал (1)
driverNameНетstringФИО водителя, который доставит груз на терминал (1)

Примечания:

  1. При передаче пустого значения переданные ранее значения удаляются (при отсутствии параметра в запросе - не меняются) 

Ответ метода

Ответ метода "Передача данных водителя и машины" аналогичен ответу метода "Отмена пакетного заказа"

Обработка ошибок

Помимо общих ошибок API, в ответе метода могут присутствовать следующие ошибки:

Номер ошибки

http-код

Краткое описание ошибки

618001

400

Невозможно обновить данные по этой мультизаявке

Передача данных по грузовым местам

Запрос метода

Пример запроса

Адрес метода: https://api.dellin.ru/v2/request/cargo.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "requestID":"111111",
   "cargoPlaces":[
      {
         "cargoPlace":"123123",
         "amount":1,
         "volume":1,
         "weight":2.3,
         "length":1,
         "width":1,
         "height":1
      },
      {
         "cargoPlace":"22222",
         "amount":1,
         "volume":1,
         "weight":2.3,
         "length":1,
         "width":1,
         "height":1
      }
   ]
}

Адрес метода: https://api.dellin.ru/v2/request/cargo.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <requestID>111111</requestID>
   <cargoPlaces>
      <cargoPlace>123123</cargoPlace>
      <amount>1</amount>
      <volume>1</volume>
      <weight>2.3</weight>
      <length>1</length>
      <width>1</width>
      <height>1</height>
   </cargoPlaces>
   <cargoPlaces>
      <cargoPlace>22222</cargoPlace>
      <amount>1</amount>
      <volume>1</volume>
      <weight>2.3</weight>
      <length>1</length>
      <width>1</width>
      <height>1</height>
   </cargoPlaces>
</request>

Описание параметров

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"
requestIDДаstring

ID заказа (для оформления заказа следует использовать метод "Оформление заявок на перевозку из Личного Кабинета")

Заказ должен быть создан текущим пользователем.

cargoPlaces

Даarray of CargoPlacesДанные по грузовым местам

cargoPlaces.cargoPlace

ДаstringНомер грузового места (грузовые места маркируются заказчиком)

cargoPlaces.amount

ДаintegerКоличество грузовых мест с одинаковой маркировкой

cargoPlaces.volume

НетfloatОбъём грузового места, м3 (1)

cargoPlaces.weight

НетfloatВес грузового места, кг (1)

cargoPlaces.length

НетfloatДлина грузового места, м (1)

cargoPlaces.width

НетfloatШирина грузового места, м (1)

cargoPlaces.height

НетfloatВысота грузового места, м (1)

Примечания:

  1. Значение по умолчание - 0,1

Ответ метода

Ответ метода "Передача данных по грузовым местам" аналогичен ответу метода "Отмена пакетного заказа"

Обработка ошибок

Помимо общих ошибок API, в ответе метода могут присутствовать следующие ошибки:

Номер ошибки

http-код

Краткое описание ошибки

619001

400

Невозможно внести данные по грузоместам в предзаказ