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

API
Главная / API - Order book

Order book

Обновлено 24.05.2018
206 кб

General information

This service allows you to get the list of orders that have been created in the personal account including information about the actual statuses of your orders, claims and waybills.

Information is provided simultaneously about all counterparties to which your personal account has access (see about the access). This service also provides information about the orders that you have created using the web site and about the favourite orders. If you don't have access to any counterparty, it's possible for you to get information only about the orders that you have created using the web site and about the favourite orders.

Order book

Method request

Request example

Method address: https://api.dellin.ru/v2/customers/orders.json

{   
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "docid":"53654635",
   "date_start":"2015-05-01 10:23:58",
   "date_end":"2015-05-05 23:15:18",
   "lastupdate":"2015-06-10 16:31:23",
   "states":[  
      "inway",
      "arrived"
   ],
   "page":3,
   "response_format":"default"
}

Method address: https://api.dellin.ru/v2/customers/orders.xml

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <docid>53654635</docid>
   <date_start>2015-05-01 10:23:58</date_start>
   <date_end>2015-05-05 23:15:18</date_end>
   <lastupdate>2015-06-10 16:31:23</lastupdate>
   <states>inway</states>
   <states>arrived</states>
   <page>3</page>
   <response_format>default</response_format>
</request>

Description of parameters

Request

Parameter

R*

Type

Description

appkeyYesstringApplication key. To get the key, register

sessionID

YesstringTo get the session ID, use the User Authorization method

docid

Nostring

Document number. If parameter is present in the request then search is performed only by the number of the order, claim or waybill (other filters are ignored)

date_startNo
string

Period start date and time (for filtering the search results by the period of the order creation).

Format: "YYYY-MM-DD HH:MM:SS"

date_endNo
string

Period end date and time (for filtering the search results by the period of the order creation. It is taken into account in case of presence of the parameter "date_start").

Format: "YYYY-MM-DD HH:MM:SS"

lastupdateNo
string

Parameter for filtering the search results by the date of last update. Method searches the documents that have the date of last update exceeding the date that is specified in this parameter).

Format: "YYYY-MM-DD HH:MM:SS"

statesNo
array of stringArray of needed statuses of the orders. Complete list of statuses is specified in the "Orders statuses" directory
pageNo
integer

Number of the requested page of the response

response_formatNo
string

Format of the response.

Available options:

  • "default" - text format
  • "idly" - data representation in the form of codes (where it is possible)
  • "full" - all available fields

Default value: "default"

Method response

Set of parameters of the object "Respone.Orders.Receiver" depends on whether the receiver is anonymous receiver (with minimum set of data) or not. The following is an example of the response in case when receiver is not an anonymous receiver:

Response example

{  
   "orders":[  
      {  
         "id":"53654635",
         "ordered_at":"2015-05-13 11:20:05",
         "state":"received",
         "state_date":"2015-05-13",
         "derival":{  
            "city":"Москва",
            "address":"129345, Москва г, Магаданская ул, дом № 1",
            "city_code":"7700000000000000000000000",
            "address_code":"7700000000017620000000000",
            "terminal_name":"Москва-Запад",
            "terminal_address":"119361, Москва г, Очаковская М. ул, дом № 4",
            "terminal_id":18
         },
         "arrival":{  
            "city":"Омск",
            "address":"644027, Омская обл, Омск г, 20 лет РККА ул, дом № 302, литера А",
            "city_code":"5500000100000000000000000",
            "address_code":"5500000100006380000000000",
            "terminal_name":"Омск",
            "terminal_address":"644027, Омская обл, Омск г, 20 лет РККА ул, дом № 302, литера А",
            "terminal_id":53
         },
         "sender":{  
            "opf":"ООО",
            "opf_uid":"0x92ee033543fsdff9910cd87ca9ca",
            "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
            "address":"109382, Москва г, Армавирская ул, дом № 1",
            "is_physical":false,
            "inn":"7842463725",
            "document_type":null,
            "document_series":null,
            "document_number":null,
            "counteragent_uid":"345abec97-f62b-f6f5-dc4a-d2d283451d78fa4"
         },
         "receiver":{  
            "opf":"ООО",
            "opf_uid":"0x92ee03691543sdfs9910cd87ca9ca",
            "name":"ИП \"Пушкин Юрий Геннадьевич\"",
            "address":"Омская обл, Омск г, 10 лет Октября ул, дом № 180",
            "is_physical":true,
            "inn":"",
            "document_type":"Паспорт РФ",
            "document_series":null,
            "document_number":null,
            "counteragent_uid":"345abec97-f62b-f6f5-dc4a-d2d283451d78fa4"
         },
         "payer":{  
            "opf":"ООО",
            "opf_uid":"0x92ee0534sdfdfdsfcd87ca9ca",
            "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
            "is_physical":false,
            "inn":"7842463725",
            "document_type":null,
            "document_series":null,
            "document_number":null,
            "counteragent_uid":"345abec97-f62b-f6f5-dc4a-d2d283451d78fa4"
         },
         "freight":{  
            "name":"МЕБЕЛЬ",
            "weight":"1.0",
            "oversized_weight":"0.0",
            "volume":"1.0",
            "oversized_volume":"0.0",
            "places":1,
            "oversized_places":0,
            "length":"0.0",
            "width":"0.0",
            "height":"0.0"
         },
         "air":{  
            "order_id":null,
            "comment":null,
            "delivery_date":null
         },
         "locks":[  
            {  
               "name":"Долг",
               "type":"by_payment",
               "set_date":"2015-05-12 16:38:38",
               "end_date":null
            }
         ],
         "documents":[],
         "total_sum":"3480.0",
         "is_paid":false,
         "is_preorder":true,
         "ordered_delivery_from_address":true,
         "available_delivery_from_address":false,
         "ordered_delivery_to_address":true,
         "available_delivery_to_address":false,
         "is_favorite":false,
         "is_air":false,
         "estimated_delivery_date":null,
         "arrival_date":null,
         "giveout_date":null,
         "warehousing_date":null,
         "produce_date":"2015-05-14",
         "order_dates":{  
            "arrival_to_receiver":"2016-04-01",
            "arrival_to_osp_sender":"2016-04-01",
            "arrival_to_osp_receiver_accdoc":"2016-04-01",
            "first_document_created_date":"2016-04-01",
            "draft_last_update":"2016-04-01",
            "arrival_to_osp_receiver":"2016-04-01",
            "processing_date":"2016-06-27",
            "derival_from_osp_receiver_accdoc":"2016-04-01",
            "derival_from_osp_receiver":"2016-04-01",
            "warehousing":"2016-04-01",
            "decline_date":"2016-04-01",
            "pickup":"2016-04-01",
            "finish":"2016-04-01"
         },
         "order_time_in_days":{  
            "delivery":2,
            "delivery_accdoc":2
         }
      }
   ],
   "deleted":[  
      "3956984",
      "3956289",
      "3955733"
   ],
   "metadata":{  
      "next_page":2,
      "current_page":1,
      "total_pages":74,
      "prev_page":null,
      "generated_at":"2015-06-18 12:37:28"
   }
}
<response>
   <orders>
      <id>53654635</id>
      <ordered_at>2015-05-13 11:20:05</ordered_at>
      <state>received</state>
      <state_date>2015-05-13</state_date>
      <derival>
         <city>Москва</city>
         <address>129345, Москва г, Магаданская ул, дом № 1</address>
         <city_code>7700000000000000000000000</city_code>
         <address_code>7700000000017620000000000</address_code>
         <terminal_name>Москва-Запад</terminal_name>
         <terminal_address>119361, Москва г, Очаковская М. ул, дом № 4</terminal_address>
         <terminal_id>18</terminal_id>
      </derival>
      <arrival>
         <city>Омск</city>
         <address>644027, Омская обл, Омск г, 20 лет РККА ул, дом № 302, литера А</address>
         <city_code>5500000100000000000000000</city_code>
         <address_code>5500000100006380000000000</address_code>
         <terminal_name>Омск</terminal_name>
         <terminal_address>644027, Омская обл, Омск г, 20 лет РККА ул, дом № 302, литера А</terminal_address>
         <terminal_id>53</terminal_id>
      </arrival>
      <sender>
         <opf>ООО</opf>
         <opf_uid>0x92ee033543fsdff9910cd87ca9ca</opf_uid>
         <name>ООО "АНТИЧНЫЙ ДВОР"</name>
         <address>109382, Москва г, Армавирская ул, дом № 1</address>
         <is_physical>false</is_physical>
         <inn>7842463725</inn>
         <document_type />
         <document_series />
         <document_number />
         <counteragent_uid>345abec97-f62b-f6f5-dc4a-d2d283451d78fa4</counteragent_uid>
      </sender>
      <receiver>
         <opf>ООО</opf>
         <opf_uid>0x92ee03691543sdfs9910cd87ca9ca</opf_uid>
         <name>ИП "Пушкин Юрий Геннадьевич"</name>
         <address>Омская обл, Омск г, 10 лет Октября ул, дом № 180</address>
         <is_physical>true</is_physical>
         <inn></inn>
         <document_type>Паспорт РФ</document_type>
         <document_series />
         <document_number />
         <counteragent_uid>345abec97-f62b-f6f5-dc4a-d2d283451d78fa4</counteragent_uid>
      </receiver>
      <payer>
         <opf>ООО</opf>
         <opf_uid>0x92ee0534sdfdfdsfcd87ca9ca</opf_uid>
         <name>ООО "АНТИЧНЫЙ ДВОР"</name>
         <is_physical>false</is_physical>
         <inn>7842463725</inn>
         <document_type />
         <document_series />
         <document_number />
         <counteragent_uid>345abec97-f62b-f6f5-dc4a-d2d283451d78fa4</counteragent_uid>
      </payer>
      <freight>
         <name>МЕБЕЛЬ</name>
         <weight>1.0</weight>
         <oversized_weight>0.0</oversized_weight>
         <volume>1.0</volume>
         <oversized_volume>0.0</oversized_volume>
         <places>1</places>
         <oversized_places>0</oversized_places>
         <length>0.0</length>
         <width>0.0</width>
         <height>0.0</height>
      </freight>
      <air>
         <order_id />
         <comment />
         <delivery_date />
      </air>
      <locks>
         <name>Долг</name>
         <type>by_payment</type>
         <set_date>2015-05-12 16:38:38</set_date>
         <end_date />
      </locks>
      <total_sum>3480.0</total_sum>
      <is_paid>false</is_paid>
      <is_preorder>true</is_preorder>
      <ordered_delivery_from_address>true</ordered_delivery_from_address>
      <available_delivery_from_address>false</available_delivery_from_address>
      <ordered_delivery_to_address>true</ordered_delivery_to_address>
      <available_delivery_to_address>false</available_delivery_to_address>
      <is_favorite>false</is_favorite>
      <is_air>false</is_air>
      <estimated_delivery_date />
      <arrival_date />
      <giveout_date />
      <warehousing_date />
      <produce_date>2015-05-14</produce_date>
      <order_dates>
         <arrival_to_receiver>2016-04-01</arrival_to_receiver>
         <arrival_to_osp_sender>2016-04-01</arrival_to_osp_sender>
         <arrival_to_osp_receiver_accdoc>2016-04-01</arrival_to_osp_receiver_accdoc>
         <first_document_created_date>2016-04-01</first_document_created_date>
         <draft_last_update>2016-04-01</draft_last_update>
         <arrival_to_osp_receiver>2016-04-01</arrival_to_osp_receiver>
         <processing_date>2016-06-27</processing_date>
         <derival_from_osp_receiver_accdoc>2016-04-01</derival_from_osp_receiver_accdoc>
         <derival_from_osp_receiver>2016-04-01</derival_from_osp_receiver>
         <warehousing>2016-04-01</warehousing>
         <decline_date>2016-04-01</decline_date>
         <pickup>2016-04-01</pickup>
         <finish>2016-04-01</finish>
      </order_dates>
      <order_time_in_days>
         <delivery>2</delivery>
         <delivery_accdoc>2</delivery_accdoc>
      </order_time_in_days>
   </orders>
   <deleted>3956984</deleted>
   <deleted>3956289</deleted>
   <deleted>3955733</deleted>
   <metadata>
      <next_page>2</next_page>
      <current_page>1</current_page>
      <total_pages>74</total_pages>
      <prev_page />
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
</response>

Description of parameters

Response

Parameter

Type

Description

ordersarray of Response.OrdersArray of found orders
deletedarray of stringArray of deleted orders when the parameter "lastupdate" was passed
metadataobjectMetadata of the API response
metadata.next_pageinteger

Number of the response next page

metadata.current_pageintegerNumber of the response current page
metadata.total_pagesintegerQuantity of pages in the response
metadata.prev_pageintegerNumber of the response previous page (If the current page number is "1" then the value of this parameter is "null")
metadata.generated_atstringDate and time of the response generation

Response.Orders
Parameter

Type

Description

idstringOrder number
ordered_atstringDate of order creation
statestringOrder status from the "Orders statuses" directory
state_datestring

Date of applying the current status

derival
objectInformation about the place of departure
derival.citystringCity (returns when format is "default" or "full")
derival.addressstringAddress (returns when format is "default" or "full")
derival.city_codestring

CLADR* code of the city (returns when format is "idly" or "full")

*CLADR - Classifier of Addresses of Russian Federation

derival.address_codestringCLADR code of the street (returns when format is "idly" or "full")
derival.terminal_namestringTerminal name (returns when format is "default" or "full")
derival.terminal_addressstringTerminal address (returns when format is "default" or "full")
derival.terminal_idintegerTerminal ID from the "Terminals" directory (returns when format is "idly" or "full")
arrivalobject

Information about the place of arrival

Parameters of the object "arrival" are similar to the parameters of the object "derival".
sender
objectInformation about the sender
sender.opfstringLegal form of organization (returns when format is "default" or "full")
sender.opf_uidstringUID of legal form of organization from the "Legal forms of organization" directory (returns when format is "idly" or "full")
sender.namestringCounterparty name (returns when format is "default" or "full")
sender.addressstringCounterparty address (returns when format is "default" or "full")
sender.is_physicalbooleanIndicator "Physical party" (returns when format is "default" or "full")
sender.innstringTIN of the juridical party (returns when format is "default" or "full")
sender.document_typestring

Document type of the physical party (returns when format is "default" or "full")

Possible values:

  • "Паспорт РФ" - passport of Russian Federation
  • "Загранпаспорт" - foreign passport
  • "Водительское удостоверение" - driving licence
sender.document_seriesstringSeries of the document of the physical party (returns when format is "default" or "full")
sender.document_numberstringNumber of the document of the physical party (returns when format is "default" or "full")
sender.counteragent_uidstringCounterparty UID (returns when format is "idly" or "full")
receiverobject

Information about the receiver

Parameters of the object "receiver" are similar to the parameters of the object "sender".
payerobject

Information about the payer

Parameters of the object "payer" are similar to the parameters of the object "sender".
freight
objectInformation about the cargo
freight.namestringCargo name
freight.weightstringCargo weight, kg
freight.oversized_weightstringOutsize cargo weight, kg
freight.volumestringCargo volume, m3
freight.oversized_volumestringOutsize cargo volume, m3
freight.placesintegerQantity of cargo items
freight.oversized_placesintegerQantity of outsize cargo items
freight.lengthstringCargo length, m
freight.widthstringCargo width, m
freight.heightstringCargo height, m
airobjectInformation about delivery by air transport (in case of absence of information the empty object returns)
air.order_idstringAir waybill number
air.commentstringComment
air.delivery_datestringDelivery date
locksarray of Response.Orders.LocksInformation about the blocked orders
documents
array of Response.Orders.Documents

Array of order documents (in case of absence the empty array returns). Examples of this block for different documents are given in the section ""

total_sumstringTotal sum by the order
is_paidbooleanOrder payment status
is_preorderbooleanIndicator of pre-order
ordered_delivery_from_addressboolean

Flag meaning that the shipping from the sender's address is ordered

available_delivery_from_addressbooleanFlag meaning that the shipping from the sender's address is available
ordered_delivery_to_addressbooleanFlag meaning that delivery to the receiver's address is ordered
available_delivery_to_addressbooleanFlag meaning that delivery to the receiver's address is available
is_favoritebooleanIndicator of a favourite order
is_airbooleanIndicator of delivery by air transport
estimated_delivery_datestringEstimated delivery date (only if parameter "state" = "inway" and "is_air" = "true". Otherwise, the value of this parameter is "null")
arrival_datestringCargo arrival date (only if parameter "is_air" = "true". Otherwise, the value of this parameter is "null")
giveout_datestringCargo delivery date (only if parameter "is_air" = "true". Otherwise, the value of this parameter is "null")
warehousing_datestringPaid storage start date
produce_datestringOrder execution date (only if parameter "is_air" = "true")
order_datesobjectThe estimated schedule of cargo movement (only if parameter "is_air" = "false". Otherwise, values of all parameters of this object will contain "null")
order_dates.arrival_to_receiverstringDate of the cargo delivery to the address
order_dates.arrival_to_osp_senderstring

Date of the cargo arrival at the terminal of departure

order_dates.arrival_to_osp_receiver_accdocstring

Date of the shipping documents arrival at the terminal of arrival

order_dates.first_document_created_datestring

Date of creation of the first document by the order

order_dates.draft_last_updatestringDate of the draft last update
order_dates.arrival_to_osp_receiverstring

Date of the cargo arrival at the terminal of arrival

order_dates.processing_datestringOrder processing start date
order_dates.derival_from_osp_receiver_accdocstring

Date of the shipping documents departure from the terminal of arrival

order_dates.derival_from_osp_receiverstringDate of the cargo departure from the terminal of arrival
order_dates.warehousingstringPaid storage start date
order_dates.decline_datestringRejection date
order_dates.pickupstringDate of cargo pickup from the sender's address
order_dates.finishstringDate of order execution
order_time_in_daysobjectEstimated delivery time (in days) (only if parameter "is_air" = "false". Otherwise, values of all parameters of this object will contain "null")
order_time_in_days.deliveryintegerEstimated time of delivery cargo to the adress (in days)
order_time_in_days.delivery_accdocintegerEstimated time of delivery shipping documents to the adress (in days)

Response.Orders.Locks
ParameterType

Description

namestringBlocking name
typestringBlocking type
set_datestringSetting date of blocking
end_datestringEnd date of blocking

If cargo receiver is an anonymous receiver then object "Respone.Orders.Receiver" will contain the following parameters:

Response example

{  
   "opf":"ЧЛ",
   "opf_uid":"0xAB91FEEA04F6D4AD48DF42161B6C2E7A",
   "name":"Петрович",
   "address":"Омская обл, Омск г, 10 лет Октября ул, дом № 180",
   "is_physical":true,
   "is_anonym":true,
   "Phone":"+7 (900) 000-00-00",
   "Email":"petro@mail.com",
   "counteragent_uid":"345abec97-f62b-f6f5-dc4a-d2d283451d78fa4"
}
<receiver>
   <opf>ЧЛ</opf>
   <opf_uid>0xAB91FEEA04F6D4AD48DF42161B6C2E7A</opf_uid>
   <name>Петрович</name>
   <address>Омская обл, Омск г, 10 лет Октября ул, дом № 180</address>
   <is_physical>true</is_physical>
   <is_anonym>true</is_anonym>
   <phone>+7 (900) 000-00-00</phone>
   <email>petro@mail.com</email>
   <counteragent_uid>345abec97-f62b-f6f5-dc4a-d2d283451d78fa4</counteragent_uid>
</receiver>

Description of parameters

Response.Orders.Receiver
ParameterType

Description

opfstringLegal form of organization (returns when format is "default" or "full")
opf_uidstringUID of legal form of organization from the "Legal forms of organization" directory (returns when format is "idly" or "full")
namestringReceiver name (returns when format is "default" or "full")
addressstringReceiver address (returns when format is "default" or "full")
is_physicalbooleanIndicator "Physical party" (returns when format is "default" or "full")
is_anonymboolean

Indicator of an anonymous receiver for simplified shipping (with minimum set of data)

phonestringAnonymous receiver phone number
emailstringAnonymous receiver e-mail
counteragent_uidstringCounterparty UID (returns when format is "idly" or "full")

Order documents

Documents by the order are returned in the block "documents". The following are examples of that block for possible types of documents:

  •  Order of the shipping from the address / pre-order:

Response example

{  
   "document_type":"request",
   "document_id":3956403,
   "sender":{  
      "opf":"ООО",
      "opf_uid":"0x92ee03691f25a9fe4be9910cd87ca9ca",
      "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
      "is_physical":false,
      "inn":"7842463725",
      "document_type":null,
      "document_series":null,
      "document_number":null
   },
   "receiver":{  
      "opf":"ООО",
      "opf_uid":"0x92ee03691f25a9fe4be9910cd87ca9ca",
      "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
      "is_physical":false,
      "inn":"7842463725",
      "document_type":null,
      "document_series":null,
      "document_number":null
   },
   "payer":{  
      "opf":null,
      "opf_uid":"",
      "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
      "is_physical":null,
      "inn":"7842463725",
      "document_type":null,
      "document_series":null,
      "document_number":null
   },
   "derival":{  
      "name":"Москва",
      "code":7700000000000000000000000
   },
   "arrival":{  
      "name":"Омск",
      "code":5500000100000000000000000
   },
   "state":"accepted",
   "freight":{  
      "name":"мебель",
      "weight":1.0,
      "oversized_weight":null,
      "volume":1.0,
      "oversized_volume":null,
      "max_length":1.0,
      "max_width":1.0,
      "max_height":1.0
   },
   "create_date":"2015-05-13 14:20:05",
   "produce_date":"2015-05-14",
   "forwarder_id":"00083199252",
   "barcode":"4150846040100012600000015"
}
<documents>
   <document_type>request</document_type>
   <document_id>3956403</document_id>
   <sender>
      <opf>ООО</opf>
      <opf_uid>0x92ee03691f25a9fe4be9910cd87ca9ca</opf_uid>
      <name>ООО "АНТИЧНЫЙ ДВОР"</name>
      <is_physical>false</is_physical>
      <inn>7842463725</inn>
      <document_type />
      <document_series />
      <document_number />
   </sender>
   <receiver>
      <opf>ООО</opf>
      <opf_uid>0x92ee03691f25a9fe4be9910cd87ca9ca</opf_uid>
      <name>ООО "АНТИЧНЫЙ ДВОР"</name>
      <is_physical>false</is_physical>
      <inn>7842463725</inn>
      <document_type />
      <document_series />
      <document_number />
   </receiver>
   <payer>
      <opf />
      <opf_uid></opf_uid>
      <name>ООО "АНТИЧНЫЙ ДВОР"</name>
      <is_physical />
      <inn>7842463725</inn>
      <document_type />
      <document_series />
      <document_number />
   </payer>
   <derival>
      <name>Москва</name>
      <code>7.7e+24</code>
   </derival>
   <arrival>
      <name>Омск</name>
      <code>5.5000001e+24</code>
   </arrival>
   <state>accepted</state>
   <freight>
      <name>мебель</name>
      <weight>1</weight>
      <oversized_weight />
      <volume>1</volume>
      <oversized_volume />
      <max_length>1</max_length>
      <max_width>1</max_width>
      <max_height>1</max_height>
   </freight>
   <create_date>2015-05-13 14:20:05</create_date>
   <produce_date>2015-05-14</produce_date>
   <forwarder_id>00083199252</forwarder_id>
   <barcode>4150846040100012600000015</barcode>
</documents>

Description of parameters

Response.Orders.Documents
ParameterType

Description

document_typestring

Document type ("request" - order of the shipping from the sender's address; "request_sf" - order of delivery to the receiver's address)

document_idintegerDocument (order) number
senderobject

Information about the sender

Parameters of the object "sender" are described in the table of parameters of the object Response.Orders.
receiverobject

Information about the receiver

Parameters of the object "receiver" are similar to the parameters of the object "sender", that are described in the table of parameters of the object Response.Orders.
payerobject

Information about the payer

Parameters of the object "payer" are similar to the parameters of the object "sender", that are described in the table of parameters of the object Response.Orders.
derival
objectInformation about the place of departure
derival.namestringCity
derival.codeintegerCLADR code of the city
arrivalobject

Information about the place of arrival

Parameters of the object "arrival" are similar to the parameters of the object "derival".
statestring

Order status.

Possible values:

  • "saved" - draft
  • "processed" - in process
  • "loaded" - in the queue
  • "ordered" - in the queue
  • "accepted" - accepted
  • "declined" - rejected
  • "canceled" - canceled
freightobject

Information about the cargo

freight.namestringCargo name
freight.weightfloatCargo weight, kg
freight.oversized_weightfloatOutsize cargo weight, kg
freight.volumefloatCargo volume, m3
freight.oversized_volumefloatOutsize cargo volume, m3
freight.max_lengthfloatCargo length, m
freight.max_widthfloatCargo width, m
freight.max_heightfloatCargo height, m
create_datestringDate of order creation
produce_datestringDate of order execution
forwarder_idstringNumber of the forwarder claim
barcodestringBarcode according to algorithm Code 128 (for pre-order)
  • Order of delivery to the address:

Response example

{  
   "document_type":"request_sf",
   "document_id":3000653,
   "sender":{  
      "opf":"ООО",
      "opf_uid":"0x92ee03691f25a9fe4be9910cd87ca9ca",
      "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
      "is_physical":false,
      "inn":"7842463725",
      "document_type":null,
      "document_series":null,
      "document_number":null,
      "counteragent_uid":null
   },
   "receiver":{  
      "opf":"ООО",
      "opf_uid":"0x92ee03691f25a9fe4be9910cd87ca9ca",
      "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
      "is_physical":false,
      "inn":"7842463725",
      "document_type":null,
      "document_series":null,
      "document_number":null,
      "counteragent_uid":null
   },
   "payer":{  
      "opf":"ООО",
      "opf_uid":"0x92ee03691f25a9fe4be9910cd87ca9ca",
      "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
      "is_physical":false,
      "inn":"7842463725",
      "document_type":null,
      "document_series":null,
      "document_number":null,
      "counteragent_uid":null
   },
   "state":"loaded",
   "create_date":"2015-05-13 14:28:02",
   "produce_date":"2015-05-15",
   "forwarder_id":"00393009651"
}
<documents>
   <document_type>request_sf</document_type>
   <document_id>3000653</document_id>
   <sender>
      <opf>ООО</opf>
      <opf_uid>0x92ee03691f25a9fe4be9910cd87ca9ca</opf_uid>
      <name>ООО "АНТИЧНЫЙ ДВОР"</name>
      <is_physical>false</is_physical>
      <inn>7842463725</inn>
      <document_type />
      <document_series />
      <document_number />
      <counteragent_uid />
   </sender>
   <receiver>
      <opf>ООО</opf>
      <opf_uid>0x92ee03691f25a9fe4be9910cd87ca9ca</opf_uid>
      <name>ООО "АНТИЧНЫЙ ДВОР"</name>
      <is_physical>false</is_physical>
      <inn>7842463725</inn>
      <document_type />
      <document_series />
      <document_number />
      <counteragent_uid />
   </receiver>
   <payer>
      <opf>ООО</opf>
      <opf_uid>0x92ee03691f25a9fe4be9910cd87ca9ca</opf_uid>
      <name>ООО "АНТИЧНЫЙ ДВОР"</name>
      <is_physical>false</is_physical>
      <inn>7842463725</inn>
      <document_type />
      <document_series />
      <document_number />
      <counteragent_uid />
   </payer>
   <state>loaded</state>
   <create_date>2015-05-13 14:28:02</create_date>
   <produce_date>2015-05-15</produce_date>
   <forwarder_id>00393009651</forwarder_id>
</documents>
Parameters of the document "Order of delivery to the address" corresponds to the similar parameters of the document "Order of the shipping from the address / pre-order".
  • waybill (terminal-to-terminal shipping): 

Response example

{  
   "document_type":"shipping",
   "document_id":"15-00025043954",
   "document_uid":"0x80caf72943b434fc4e2e302561ac1dec",
   "sender":{  
      "opf":"ООО",
      "opf_uid":"0x92ee03691f25a9fe4be9910cd87ca9ca",
      "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
      "is_physical":false,
      "inn":"7842463725",
      "document_type":null,
      "document_series":null,
      "document_number":null,
      "counteragent_uid":"345abec97-f62b-f6f5-dc4a-d2d283451d78fa4"
   },
   "receiver":{  
      "opf":"ООО",
      "opf_uid":"0x92ee03691f25a9fe4be9910cd87ca9ca",
      "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
      "is_physical":false,
      "inn":"7842463725",
      "document_type":null,
      "document_series":null,
      "document_number":null,
      "counteragent_uid":"345abec97-f62b-f6f5-dc4a-d2d283451d78fa4"
   },
   "payer":{  
      "opf":"ООО",
      "opf_uid":"0x92ee03691f25a9fe4be9910cd87ca9ca",
      "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
      "is_physical":false,
      "inn":"7842463725",
      "document_type":null,
      "document_series":null,
      "document_number":null,
      "counteragent_uid":"345abec97-f62b-f6f5-dc4a-d2d283451d78fa4"
   },
   "derival":{  
      "name":"Москва",
      "code":7700000000000000000000000
   },
   "arrival":{  
      "name":"Омск",
      "code":5500000100000000000000000
   },
   "freight":{  
      "name":"МЕБЕЛЬ",
      "weight":1,
      "oversized_weight":0,
      "volume":1.0,
      "oversized_volume":0.0,
      "max_length":0.0,
      "max_width":0.0,
      "max_height":0.0
   },
   "state":"in_way",
   "payment":false,
   "total_sum":3480.0,
   "debt_sum":"3480.0",
   "create_date":"2015-05-13 17:21:56",
   "service_kind":"Авто",
   "services":[  
      {  
         "name":"Перевозка автотранспортная",
         "service_uid":"0xa8e38733915fd9844f1cd8de0a9beb4e",
         "created_at":"2015-05-13 11:23:21",
         "quantity":1,
         "sum":"3380.0",
         "discount_sum":"0.0",
         "total_sum":"3380.0"
      },
      {  
         "name":"Въезд на наш терминал-отправитель",
         "service_uid":"0xb1da8f1ec1b774ec45152fc5643aa598",
         "created_at":"2015-05-13 11:23:21",
         "quantity":1,
         "sum":"100.0",
         "discount_sum":"0.0",
         "total_sum":"100.0"
      }
   ],
   "accompanying_documents":[  
      {  
         "document_date":"2015-08-21",
         "document_number":"11111",
         "document_kind":"Текст комментария"
      }
   ],
   "available_docs":[  
      "order",
      "bill"
   ]
}
<documents>
   <document_type>shipping</document_type>
   <document_id>15-00025043954</document_id>
   <document_uid>0x80caf72943b434fc4e2e302561ac1dec</document_uid>
   <sender>
      <opf>ООО</opf>
      <opf_uid>0x92ee03691f25a9fe4be9910cd87ca9ca</opf_uid>
      <name>ООО "АНТИЧНЫЙ ДВОР"</name>
      <is_physical>false</is_physical>
      <inn>7842463725</inn>
      <document_type />
      <document_series />
      <document_number />
      <counteragent_uid>345abec97-f62b-f6f5-dc4a-d2d283451d78fa4</counteragent_uid>
   </sender>
   <receiver>
      <opf>ООО</opf>
      <opf_uid>0x92ee03691f25a9fe4be9910cd87ca9ca</opf_uid>
      <name>ООО "АНТИЧНЫЙ ДВОР"</name>
      <is_physical>false</is_physical>
      <inn>7842463725</inn>
      <document_type />
      <document_series />
      <document_number />
      <counteragent_uid>345abec97-f62b-f6f5-dc4a-d2d283451d78fa4</counteragent_uid>
   </receiver>
   <payer>
      <opf>ООО</opf>
      <opf_uid>0x92ee03691f25a9fe4be9910cd87ca9ca</opf_uid>
      <name>ООО "АНТИЧНЫЙ ДВОР"</name>
      <is_physical>false</is_physical>
      <inn>7842463725</inn>
      <document_type />
      <document_series />
      <document_number />
      <counteragent_uid>345abec97-f62b-f6f5-dc4a-d2d283451d78fa4</counteragent_uid>
   </payer>
   <derival>
      <name>Москва</name>
      <code>7.7e+24</code>
   </derival>
   <arrival>
      <name>Омск</name>
      <code>5.5000001e+24</code>
   </arrival>
   <freight>
      <name>МЕБЕЛЬ</name>
      <weight>1</weight>
      <oversized_weight>0</oversized_weight>
      <volume>1</volume>
      <oversized_volume>0</oversized_volume>
      <max_length>0</max_length>
      <max_width>0</max_width>
      <max_height>0</max_height>
   </freight>
   <state>in_way</state>
   <payment>false</payment>
   <total_sum>3480</total_sum>
   <debt_sum>3480.0</debt_sum>
   <create_date>2015-05-13 17:21:56</create_date>
   <service_kind>Авто</service_kind>
   <services>
      <name>Перевозка автотранспортная</name>
      <service_uid>0xa8e38733915fd9844f1cd8de0a9beb4e</service_uid>
      <created_at>2015-05-13 11:23:21</created_at>
      <quantity>1</quantity>
      <sum>3380.0</sum>
      <discount_sum>0.0</discount_sum>
      <total_sum>3380.0</total_sum>
   </services>
   <services>
      <name>Въезд на наш терминал-отправитель</name>
      <service_uid>0xb1da8f1ec1b774ec45152fc5643aa598</service_uid>
      <created_at>2015-05-13 11:23:21</created_at>
      <quantity>1</quantity>
      <sum>100.0</sum>
      <discount_sum>0.0</discount_sum>
      <total_sum>100.0</total_sum>
   </services>
   <accompanying_documents>
      <document_date>2015-08-21</document_date>
      <document_number>11111</document_number>
      <document_kind>Текст комментария</document_kind>
   </accompanying_documents>
   <available_docs>order</available_docs>
   <available_docs>bill</available_docs>
</documents>

Description of parameters 

Response.Orders.Documents
ParameterType

Description

document_typestring

Document type ("shipping" - waybill)

document_idstringDocument (waybill) number
document_uidstringWaybill UID
senderobject

Information about the sender

Parameters of the object "sender" are described in the table of parameters of the object Response.Orders.
receiverobject

Information about the receiver

Parameters of the object "receiver" are similar to the parameters of the object "sender", that are described in the table of parameters of the object Response.Orders.
payerobject

Information about the payer

Parameters of the object "payer" are similar to the parameters of the object "sender", that are described in the table of parameters of the object Response.Orders.
derivalobject

Information about the place of departure

Parameters of the object "derival" are described in the table of parameters of the object Response.Orders.
arrivalobject

Information about the place of arrival

Parameters of the object "arrival" are similar to the parameters of the object "derival", that are described in the table of parameters of the object Response.Orders.
freightobject

Information about the cargo

freight.namestringCargo name
freight.weightfloatCargo weight, kg
freight.oversized_weightfloatOutsize cargo weight, kg
freight.volumefloatCargo volume, m3
freight.oversized_volumefloatOutsize cargo volume, m3
freight.max_lengthfloatCargo length, m
freight.max_widthfloatCargo width, m
freight.max_heightfloatCargo height, m
statestring

Waybill status.

Possible values:

  • "in_way" - on the way
  • "arrival" - arrived
  • "give_out" - delivered
paymentbooleanPayment status
total_sumfloatTotal amount by the waybill
debt_sumstringAmount of debt
create_datestringDate of the waybill creation
service_kindstringDelivery type
servicesarray of Response.Orders.Documents.ServicesList of services according to the waybill

accompanying_documents

array of Response.Orders.Documents.Accompanying_documentsList of shipping documents
available_docsarray of string

List of documents for which the printable versions are available

 

Response.Orders.Documents.Services
ParameterType

Description

namestringService name
service_uidstringService UID
created_atstringDate of creation
quantityintegerQuantity
sumstringAmount
discount_sumstringDiscount
total_sumstringTotal amount

 

Response.Orders.Documents.Accompanying_documents
ParameterType

Description

document_datestringDate of creation of the shipping document
document_numberstringNumber of the shipping document
document_kindstringComment (document type)

Favourite orders 

Responses for your favourite orders contain only part of the information:

Response example 

{  
   "orders":[  
      {  
         "id":"1505345323345",
         "state":"inway",
         "derival":{  
            "city":"Санкт-Петербург",
            "city_code":"7700000000000000000000000"
         },
         "arrival":{  
            "city":"Москва",
            "city_code":"5500000100000000000000000"
         },
         "sender":{  
            "access":false
         },
         "receiver":{  
            "access":false
         },
         "freight":{  
            "access":false
         },
         "documents":[  
            {  
               "state":"in_way",
               "produce_date":null,
               "payer":{  
                  "access":false
               },
               "total_sum":3060.0,
               "services":[  
                  {  
                     "name":"Перевозка автотранспортная"
                  },
                  {  
                     "name":"Въезд на терминал-получатель"
                  }
               ],
               "document_type":"shipping",
               "document_id":"15-01905000217"
            }
         ],
         "locks":[  
            {  
               "type":"by_payment",
               "name":"Долг"
            }
         ],
         "produce_date":null,
         "state_date":"2015-07-24",
         "arrival_date":null,
         "giveout_date":null,
         "warehousing_date":null,
         "is_favorite":true
      }
   ],
   "metadata":{  
      "generated_at":"2015-07-24 12:10:34",
      "next_page":null,
      "current_page":1,
      "total_pages":1,
      "prev_page":null
   }
}
<response>
   <orders>
      <id>1505345323345</id>
      <state>inway</state>
      <derival>
         <city>Санкт-Петербург</city>
         <city_code>7700000000000000000000000</city_code>
      </derival>
      <arrival>
         <city>Москва</city>
         <city_code>5500000100000000000000000</city_code>
      </arrival>
      <sender>
         <access>false</access>
      </sender>
      <receiver>
         <access>false</access>
      </receiver>
      <freight>
         <access>false</access>
      </freight>
      <documents>
         <state>in_way</state>
         <produce_date />
         <payer>
            <access>false</access>
         </payer>
         <total_sum>3060</total_sum>
         <services>
            <name>Перевозка автотранспортная</name>
         </services>
         <services>
            <name>Въезд на терминал-получатель</name>
         </services>
         <document_type>shipping</document_type>
         <document_id>15-01905000217</document_id>
      </documents>
      <locks>
         <type>by_payment</type>
         <name>Долг</name>
      </locks>
      <produce_date />
      <state_date>2015-07-24</state_date>
      <arrival_date />
      <giveout_date />
      <warehousing_date />
      <is_favorite>true</is_favorite>
   </orders>
   <metadata>
      <generated_at>2015-07-24 12:10:34</generated_at>
      <next_page />
      <current_page>1</current_page>
      <total_pages>1</total_pages>
      <prev_page />
   </metadata>
</response>
Parameter "access" (type - "boolean") - flag "Access to the information in this block is denied".Other parameters of responses for favourite orders are similar to the parameters of responses for other orders (see description in corresponging section).Parameters of the block "documents" are described in the section "Order documents".