Pre-Alert batch order

Обновлено 22.01.2024

171 кб

General information

Combining several existing orders for shipping from the terminal into a batch order allows to speed up the cargo processing at the terminal.

The service allows creating/cancelling a batch order, passing the data of the driver who is going to hand over the cargo at the terminal and of a car that he will be using as well as the information on cargo places of the combined orders.

To use the method please contact the company manager and inform them that you would like to use Pre-Alert solution.

The present method allows combining the orders for shipping from the terminal ("pre-orders") into a batch order. Combined orders must be created with "cargoCode" parameter (see "Placing LTL orders").To combine several orders for shipping from the sender's address use "Multi-request" method.

Placing a batch order

Method request

Method address: 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":"Текст комментария"
}

Method address: 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>

Description of parameters

Request

Request
Parameter	Required	Type	Description
appkey	Yes	string	Application key. To get the key, register
sessionID	Yes	string	To get the session ID, use the User Authorization method
requestIDs	Yes	array of strings	IDs of the orders that need to be combined into a batch order (to place an order use "Placing LTL orders" method) Note! The order must be a pre-order (that is the order for shipping from the terminal). The order must be created by the current user. Allowable order statuses: "В обработке" - processing. "Ожидает сдачи на терминал" - waiting to be handed over at the terminal. "Груз принят к перевозке" - the cargo has been received at the terminal. "Груз принят к перевозке. Платное хранение" - the cargo has been received at the terminal, the paid storage period has started. "Груз в пути" - in transit
comment	No	string	Comment. Maximum 300 symbols

Method response

Response structure

JSON
XML

{  
   "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>

Description of parameters

Response

Response
Parameter	Type	Description
metadata	object	System information
metadata.status	integer	Emulated status http-code. If successful, code 200 (Success) is returned
metadata.generated_at	string	Server response date and time. Format: YYYY-MM-DD HH:MM:SS
data	object	Information on created batch order
data.batchRequestID	integer	ID of the created batch order
data.state	string	Status. Possible value - "success"

Error handling

Except for common API errors the method response may contain the following errors:

Error number	http-code	Error title
Error number	http-code	Title	Translation
616001	400	Указанные заказы не соответствуют условиям группировки в мультизаявку	The selected orders do not meet the requirements for combining into a batch order

Canceling a batch order

Method request

Request structure

JSON
XML

Method address: https://api.dellin.ru/v2/batch_request/cancel.json

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

Method address: 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>

Description of parameters

Request

Request
Parameter	Required	Type	Description
appkey	Yes	string	The application key. To get the key, register
sessionID	Yes	string	To get the session ID, use the User Authorization method
batchRequestID	Yes	integer	ID of the batch order that need to be cancelled The batch order must be created by the current user

Method response

Response structure

JSON
XML

{  
   "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>

Description of parameters

Response

Response
Parameter	Type	Description
metadata	object	System information
metadata.status	integer	Emulated status http-code. If successful, code 200 (Success) is returned
metadata.generated_at	string	Server response date and time. Format: YYYY-MM-DD HH:MM:SS
data	object	Information on the operation completion
data.state	string	Status. Possible value - "success"

Error handling

Except for common API errors the method response may contain the following errors:

Error number	http-code	Error title
Error number	http-code	Title	Translation
617001	400	Невозможно отменить данную мультизаявку	Impossible to cancel the batch order

Passing the car and the driver data

Method request

Request structure

JSON
XML

Method address: 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": "Иванов Петр Викторович" 
}

Method address: 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>

Description of parameters

Request

Request
Parameter	Required	Type	Description
appkey	Yes	string	Application key. To get the key, register
sessionID	Yes	string	To get the session ID, use the User Authorization method
batchRequestID	Yes	integer	ID of the batch order The batch order must be created by the current user
carNumber	No	string	Number of the car that will be used to deliver the cargo to the terminal (1)
driverName	No	string	Name of the driver who is going to deliver the cargo to the terminal (1)
Notes: If an empty value is passed, the previously passed value will be voided (if the parameter is not passed in the request - the previously passed value remain unchanged)

Method response

Response of the method "Passing the car and the driver data" is similar to the response of the method "Cancelling a batch order"

Error handling

Except for common API errors the method response may contain the following errors:

Error number	http-code	Error title
Error number	http-code	Title	Translation
618001	400	Невозможно обновить данные по этой мультизаявке	Impossible to update the batch order details

Passing the cargo places information

Method request

Request structure

JSON
XML

Method address: 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
      }
   ]
}

Method address: 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>

Description of parameters

Request

Request
Parameter	Required	Type	Description
appkey	Yes	string	Application key. To get the key, register
sessionID	Yes	string	To get the session ID, use the User Authorization method
requestID	Yes	string	Oder ID (to place an order use "Placing LTL orders" method) The order must be created by the current user
cargoPlaces	Yes	array of CargoPlaces	Cargo places data
cargoPlaces.cargoPlace	Yes	string	Cargo place number (cargo places to be marked by the client)
cargoPlaces.amount	Yes	integer	Number of the cargo places with the same mark
cargoPlaces.volume	No	float	Cargo place volume, m3 (1)
cargoPlaces.weight	No	float	Cargo place weight, kg (1)
cargoPlaces.length	No	float	Cargo place length, m (1)
cargoPlaces.width	No	float	Cargo place width, m (1)
cargoPlaces.height	No	float	Cargo place height, m (1)
Notes: The default value - 0.1

Method response

Response of the method "Passing the cargo places information" is similar to the response of the method "Cancelling a batch order"

Error handling

Except for common API errors the method response may contain the following errors:

Error number	http-code	Error title
Error number	http-code	Title	Translation
619001	400	Невозможно внести данные по грузоместам в предзаказ	Not possible to update pre-order with the cargo places details

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

Pre-Alert batch order

General information

Placing a batch order

Method request

Request structure

Description of parameters

Request

Method response

Response structure

Description of parameters

Response

Error handling

Canceling a batch order

Method request

Request structure

Description of parameters

Request

Method response

Response structure

Description of parameters

Response

Error handling

Passing the car and the driver data

Method request

Request structure

Description of parameters

Request

Method response

Error handling

Passing the cargo places information

Method request

Request structure

Description of parameters

Request

Method response

Error handling