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

API
Главная / API - Orders search

Orders search

Обновлено 17.02.2020
255 кб

General information

The service allows you to track orders as well as to receive detailed order information.

The request parameter request.sessionID is used to differentiate whether to provide short or detailed information. If а request contains the parameter, then detailed information will be provided, if not - short. Thus, only authorized users have access to detailed orders information. 

Orders search

Method request

Request example

Method address: https://api.dellin.ru/v3/orders.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "docIds":[
      "19-00085281151",
      "19-00085281152"
   ],
   "orderNumber":"1234567889",
   "orderDate":"2019-11-02",
   "barcode":"1345678",
   "dateStart":"2019-11-11 10:10",
   "dateEnd":"2019-11-12 10:10",
   "states":"pickup",
   "page":1,
   "lastUpdate":"2019-11-12 10:10",
   "orderDatesExtended":true,
   "orderBy":"ordered_at"
}

Method address: https://api.dellin.ru/v3/orders.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>A00000000-0000-0000-0000-000000000000</sessionID>
   <docIds>19-00085281151</docIds>
   <docIds>19-00085281152</docIds>
   <orderNumber>1234567889</orderNumber>
   <orderDate>2019-11-02</orderDate>
   <barcode>1345678</barcode>
   <dateStart>2019-11-11 10:10</dateStart>
   <dateEnd>2019-11-12 10:10</dateEnd>
   <states>pickup</states>
   <page>1</page>
   <lastUpdate>2019-11-12 10:10</lastUpdate>
   <orderDatesExtended>true</orderDatesExtended>
   <orderBy>ordered_at</orderBy>
</request>

Description of parameters

Request
Request
ParameterRequiredTypeDescription
appKeyYesstringApplication key. To get the key, register

sessionID

No*string

Session ID. To get the session ID, use User authorization service.

*If sessionID parameter is passed in a request, then detailed information will be provided, if not - short

docIdsNo*array of string

Number of order, waybill or order for shipping from address/delivery to address. More than one parameter can be passed (5 parameters maximum).

*The parameter is used to search for orders. If sessionID parameter is not passed in a request, then one of the following parameters must be passed: docid, barcode or orderNumber

Only one of the following parameters can be passed in a request: docid, barcode, orderNumber
orderNumberNo*string

Online store order number (internal order number).

*The parameter is used to search for orders. If sessionID parameter is not passed in the request, then one of the following parameters must be passed: docid, barcode or orderNumber

Only one of the following parameters can be passed in a request: docid, barcode, orderNumber
orderDateNostring

Online store order date.

Format: YYYY-MM-DD

barcode

No*string

Barcode of document read by a barcode scanner.

The field length is 25 characters. The first 3 characters determine the type of document:

  • 128 - waybill;
  • 415 - order for shipping from the address/delivery to the address (pre-order only).

*The parameter is used to search for orders. If sessionID parameter is not passed in a request, then one of the following parameters must be passed: docid, barcode or orderNumber

Only one of the following parameters can be passed in a request: docid, barcode, orderNumber
dateStartNostring

Period start date and time (the parameter is used to filter search results by order creation period).

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

The parameter is ignored if the request does not contain sessionID parameter or contains one of the following parameters: docid, barcode or orderNumber

dateEndNostring

Period end date and time (the parameter is used to filter search results by the period of order creation, the parameter is ignored if a request does not contain dateStart).

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

The parameter is ignored if a request does not contain sessionID parameter or contains one of the following parameters: docid, barcode or orderNumber

statesNoarray of string

Array of the requested order statutes. For the complete list of statuses, see Directory of order statuses.

The parameter is ignored if a request does not contain sessionID parameter or contains one of the following parameters: docid, barcode or orderNumber

pageNointegerNumber of the requested page
lastUpdateNostring

The parameter is used to filter orders updated after the indicated date.

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

The parameter is ignored if а request does not contain sessionID parameter or contains one of the following parameters: docid, barcode or orderNumber

orderByNostring

Orders sorting.

Possible values:

  • ordered_at - by order date;
  • updated_at - by update.

The parameter is ignored if а request does not contain sessionID parameter or contains one of the following parameters: docid, barcode or orderNumber

Method respose

Response example

{
   "metadata":{
      "status":200,
      "currentPage":1,
      "nextPage":null,
      "prevPage":null,
      "totalPages":1,
      "generatedAt":"2019-11-11 12:50:20"
   },
   "orders":[
      {
         "orderNumber":null,
         "orderDate":null,
         "orderId":"39513109",
         "orderedAt":"2019-11-11 08:16:36",
         "state":"processing",
         "stateName":"В обработке",
         "stateDate":null,
         "derival":{
            "city":"г. Москва",
            "cityId":3,
            "cityCode":"7700000000000000000000000",
            "address":"г. Москва, Загорьевский проезд, д. 4",
            "addressCode":null,
            "terminalName":"Москва Север 2",
            "terminalAddress":"127411, Москва г, Лобненская ул, дом № 18, стр 2",
            "terminalId":36
         },
         "arrival":{
            "city":"Омск г (Омская обл.)",
            "cityId":43,
            "cityCode":"5500000100000000000000000",
            "address":"Омск г (Омская обл.), 22 Партсъезда ул, д. 4",
            "addressCode":null,
            "terminalName":"Омск",
            "terminalAddress":"644031, Омская обл, Омск г, Омская ул, дом № 221",
            "terminalId":53,
            "terminalCity":"Омск",
            "terminalCoordinates":[
               73.4417,
               54.9939
            ],
            "terminalEmail":"pismo@dellin.ru ",
            "terminalPhones":"7 (3812) 45-45-45",
            "callCenterPhones":"8-800-100-8000",
            "terminalWorktables":{
               "sun":"24 ч",
               "mon":"24 ч",
               "tue":"24 ч",
               "wed":"24 ч",
               "thu":"24 ч",
               "fri":"24 ч",
               "sat":"24 ч"
            }
         },
         "sender":{
            "opf":null,
            "opfUid":null,
            "name":"APIRequestPositiveSender",
            "address":"г. Москва, Загорьевский проезд, д. 4",
            "isPhysical":null,
            "inn":null,
            "documentType":null,
            "documentSeries":null,
            "documentNumber":null,
            "counteragentUid":null,
            "contacts":"contact",
            "phones":"89136665588"
         },
         "receiver":{
            "opf":null,
            "opfUid":null,
            "name":"APIRequestPositiveReceiver",
            "address":"Омск г (Омская обл.), 22 Партсъезда ул, д. 4",
            "isPhysical":null,
            "inn":null,
            "documentType":null,
            "documentSeries":null,
            "documentNumber":null,
            "counteragentUid":null,
            "anonym":false,
            "anonymPhone":null,
            "anonymEmail":null
         },
         "payer":{
            "opf":null,
            "opfUid":null,
            "name":"APIRequestPositiveSender",
            "isPhysical":null,
            "inn":null,
            "documentType":null,
            "documentSeries":null,
            "documentNumber":null,
            "counteragentUid":null
         },
         "freight":{
            "name":"Мебельная фурнитура",
            "weight":"0.1",
            "oversizedWeight":null,
            "volume":"0.1",
            "oversizedVolume":null,
            "places":1,
            "oversizedPlaces":null,
            "length":"0.1",
            "width":"0.1",
            "height":"0.1"
         },
         "isAir":false,
         "air":{

         },
         "locks":[

         ],
         "totalSum":0.0,
         "isPaid":true,
         "isPreorder":false,
         "produceDate":"2019-11-20",
         "declineReason":null,
         "orderDates":{
            "arrivalToOspReceiver":"2019-11-27",
            "arrivalToOspReceiverMax":null,
            "arrivalToOspReceiverAccdoc":null,
            "arrivalToOspSender":null,
            "arrivalToReceiver":null,
            "declineDate":null,
            "derivalFromOspReceiver":"2019-11-27 00:00:00",
            "derivalFromOspReceiverMax":null,
            "derivalFromOspReceiverAccdoc":null,
            "giveoutFromOspReceiver":null,
            "giveoutFromOspReceiverMax":null,
            "derivalFromOspSender":"2019-11-22 00:00:00",
            "draftLastUpdate":null,
            "finish":null,
            "firstDocumentCreatedDate":null,
            "pickup":"2019-11-20 00:00:00",
            "processingDate":"2019-11-11",
            "warehousing":null
         },
         "orderTimeInDays":{
            "delivery":null,
            "deliveryAccdoc":null
         },
         "orderedDeliveryFromAddress":true,
         "availableDeliveryFromAddress":false,
         "orderedDeliveryToAddress":true,
         "availableDeliveryToAddress":false,
         "isFavorite":false,
         "isContainer":false,
         "sfrequest":null,
         "documents":[
            {
               "id":39513109,
               "uid":null,
               "type":"request",
               "createDate":"2019-11-11 11:16:36",
               "state":"ordered",
               "sender":{
                  "opf":"ОАО",
                  "opfUid":"0x8390b2048d37e0154b845fb22793e865",
                  "name":"APIRequestPositiveSender",
                  "isPhysical":false,
                  "inn":"1234567890",
                  "documentType":null,
                  "documentSeries":null,
                  "documentNumber":null,
                  "counteragentUid":null
               },
               "receiver":{
                  "opf":"ОАО",
                  "opfUid":"0x8390b2048d37e0154b845fb22793e865",
                  "name":"APIRequestPositiveReceiver",
                  "isPhysical":false,
                  "inn":"1234567890",
                  "documentType":null,
                  "documentSeries":null,
                  "documentNumber":null,
                  "counteragentUid":null
               },
               "payer":{
                  "opf":null,
                  "opfUid":"",
                  "name":"APIRequestPositiveSender",
                  "isPhysical":null,
                  "inn":"1234567890",
                  "documentType":null,
                  "documentSeries":null,
                  "documentNumber":null,
                  "counteragentUid":null
               },
               "produceDate":"2019-11-20",
               "forwarderId":null,
               "comment":"Comment",
               "fullDocumentId":"K-39513109",
               "freight":{
                  "name":"Мебельная фурнитура",
                  "weight":0.1,
                  "oversizedWeight":null,
                  "volume":0.1,
                  "oversizedVolume":null,
                  "maxLength":0.1,
                  "maxWidth":0.1,
                  "maxHeight":0.1
               },
               "derival":{
                  "name":"Москва",
                  "code":"7700000000000000000000000"
               },
               "arrival":{
                  "name":"Омск",
                  "code":"5500000100000000000000000"
               },
               "barcode":null,
               "payment":null,
               "totalSum":null,
               "serviceKind":null,
               "organization":null,
               "services":[

               ],
               "accompanyingDocuments":[

               ],
               "availableDocs":[

               ],
               "paymentState":"paid"
            }
         ],
         "paymentState":"paid",
         "note":null,
         "documentsReturnDate":null
      }
   ],
   "deleted":null
}
<response>
   <metadata>
      <status>200</status>
      <currentPage>1</currentPage>
      <nextPage />
      <prevPage />
      <totalPages>1</totalPages>
      <generatedAt>2019-11-11 12:50:20</generatedAt>
   </metadata>
   <orders>
      <orderNumber />
      <orderDate />
      <orderId>39513109</orderId>
      <orderedAt>2019-11-11 08:16:36</orderedAt>
      <state>processing</state>
      <stateName>В обработке</stateName>
      <stateDate />
      <derival>
         <city>г. Москва</city>
         <cityId>3</cityId>
         <cityCode>7700000000000000000000000</cityCode>
         <address>г. Москва, Загорьевский проезд, д. 4</address>
         <addressCode />
         <terminalName>Москва Север 2</terminalName>
         <terminalAddress>127411, Москва г, Лобненская ул, дом № 18, стр 2</terminalAddress>
         <terminalId>36</terminalId>
      </derival>
      <arrival>
         <city>Омск г (Омская обл.)</city>
         <cityId>43</cityId>
         <cityCode>5500000100000000000000000</cityCode>
         <address>Омск г (Омская обл.), 22 Партсъезда ул, д. 4</address>
         <addressCode />
         <terminalName>Омск</terminalName>
         <terminalAddress>644031, Омская обл, Омск г, Омская ул, дом № 221</terminalAddress>
         <terminalId>53</terminalId>
         <terminalCity>Омск</terminalCity>
         <terminalCoordinates>73.4417</terminalCoordinates>
         <terminalCoordinates>54.9939</terminalCoordinates>
         <terminalEmail>pismo@dellin.ru </terminalEmail>
         <terminalPhones>7 (3812) 45-45-45</terminalPhones>
         <callCenterPhones>8-800-100-8000</callCenterPhones>
         <terminalWorktables>
            <sun>24 ч</sun>
            <mon>24 ч</mon>
            <tue>24 ч</tue>
            <wed>24 ч</wed>
            <thu>24 ч</thu>
            <fri>24 ч</fri>
            <sat>24 ч</sat>
         </terminalWorktables>
      </arrival>
      <sender>
         <opf />
         <opfUid />
         <name>APIRequestPositiveSender</name>
         <address>г. Москва, Загорьевский проезд, д. 4</address>
         <isPhysical />
         <inn />
         <documentType />
         <documentSeries />
         <documentNumber />
         <counteragentUid />
         <contacts>contact</contacts>
         <phones>89136665588</phones>
      </sender>
      <receiver>
         <opf />
         <opfUid />
         <name>APIRequestPositiveReceiver</name>
         <address>Омск г (Омская обл.), 22 Партсъезда ул, д. 4</address>
         <isPhysical />
         <inn />
         <documentType />
         <documentSeries />
         <documentNumber />
         <counteragentUid />
         <anonym>false</anonym>
         <anonymPhone />
         <anonymEmail />
      </receiver>
      <payer>
         <opf />
         <opfUid />
         <name>APIRequestPositiveSender</name>
         <isPhysical />
         <inn />
         <documentType />
         <documentSeries />
         <documentNumber />
         <counteragentUid />
      </payer>
      <freight>
         <name>Мебельная фурнитура</name>
         <weight>0.1</weight>
         <oversizedWeight />
         <volume>0.1</volume>
         <oversizedVolume />
         <places>1</places>
         <oversizedPlaces />
         <length>0.1</length>
         <width>0.1</width>
         <height>0.1</height>
      </freight>
      <isAir>false</isAir>
      <air />
      <totalSum>0</totalSum>
      <isPaid>true</isPaid>
      <isPreorder>false</isPreorder>
      <produceDate>2019-11-20</produceDate>
      <declineReason />
      <orderDates>
         <arrivalToOspReceiver>2019-11-27</arrivalToOspReceiver>
         <arrivalToOspReceiverMax />
         <arrivalToOspReceiverAccdoc />
         <arrivalToOspSender />
         <arrivalToReceiver />
         <declineDate />
         <derivalFromOspReceiver>2019-11-27 00:00:00</derivalFromOspReceiver>
         <derivalFromOspReceiverMax />
         <derivalFromOspReceiverAccdoc />
         <giveoutFromOspReceiver />
         <giveoutFromOspReceiverMax />
         <derivalFromOspSender>2019-11-22 00:00:00</derivalFromOspSender>
         <draftLastUpdate />
         <finish />
         <firstDocumentCreatedDate />
         <pickup>2019-11-20 00:00:00</pickup>
         <processingDate>2019-11-11</processingDate>
         <warehousing />
      </orderDates>
      <orderTimeInDays>
         <delivery />
         <deliveryAccdoc />
      </orderTimeInDays>
      <orderedDeliveryFromAddress>true</orderedDeliveryFromAddress>
      <availableDeliveryFromAddress>false</availableDeliveryFromAddress>
      <orderedDeliveryToAddress>true</orderedDeliveryToAddress>
      <availableDeliveryToAddress>false</availableDeliveryToAddress>
      <hasAccess>true</hasAccess>
      <isFavorite>false</isFavorite>
      <isContainer>false</isContainer>
      <sfrequest />
      <documents>
         <id>39513109</id>
         <uid />
         <type>request</type>
         <createDate>2019-11-11 11:16:36</createDate>
         <state>ordered</state>
         <sender>
            <opf>ОАО</opf>
            <opfUid>0x8390b2048d37e0154b845fb22793e865</opfUid>
            <name>APIRequestPositiveSender</name>
            <isPhysical>false</isPhysical>
            <inn>1234567890</inn>
            <documentType />
            <documentSeries />
            <documentNumber />
            <counteragentUid />
         </sender>
         <receiver>
            <opf>ОАО</opf>
            <opfUid>0x8390b2048d37e0154b845fb22793e865</opfUid>
            <name>APIRequestPositiveReceiver</name>
            <isPhysical>false</isPhysical>
            <inn>1234567890</inn>
            <documentType />
            <documentSeries />
            <documentNumber />
            <counteragentUid />
         </receiver>
         <payer>
            <opf />
            <opfUid></opfUid>
            <name>APIRequestPositiveSender</name>
            <isPhysical />
            <inn>1234567890</inn>
            <documentType />
            <documentSeries />
            <documentNumber />
            <counteragentUid />
         </payer>
         <produceDate>2019-11-20</produceDate>
         <forwarderId />
         <comment>Comment</comment>
         <fullDocumentId>K-39513109</fullDocumentId>
         <freight>
            <name>Мебельная фурнитура</name>
            <weight>0.1</weight>
            <oversizedWeight />
            <volume>0.1</volume>
            <oversizedVolume />
            <maxLength>0.1</maxLength>
            <maxWidth>0.1</maxWidth>
            <maxHeight>0.1</maxHeight>
         </freight>
         <derival>
            <name>Москва</name>
            <code>7.7e+24</code>
         </derival>
         <arrival>
            <name>Омск</name>
            <code>5.5000001e+24</code>
         </arrival>
         <barcode />
         <payment />
         <totalSum />
         <serviceKind />
         <organization />
      </documents>
      <paymentState>paid</paymentState>
      <note />
      <documentsReturnDate />
   </orders>
   <deleted />
</response>

Description of parameters

If the data is not available (for example request.sessionID parameter is not passed in a request or the information is not available for the transportation type or the document type, etc.), then the response parameter value is null
Response
Response
ParameterTypeData available to unathorised usersDescription
metadataobjectYesSystem information
metadata.statusintegerYes

Emulated status http-code. If successful, code 200 is returned

metadata.currentPageintegerYesNumber of the current page of the response
metadata.nextPageintegerYes

Number of the next page of the response

metadata.prevPageintegerYes

Number of the previous page of the response.

If the current page number is 1, then the parameter value is null

metadata.totalPagesintegerYesTotal amount of pages
metadata.generatedAtstringYes

Server response date and time.

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

ordersarray of OrdersYesArray of orders found
deletedarray of stringsYes

Array of deleted orders (the data is available if request.lastUpdate parameter is passed in a request)

Orders

Orders

ParameterType
Data available to unathorised users
Description
orderNumberstringYesOnline store order number (internal order number)
orderDatestringYesOnline store order date
orderIDstringYesOrder number
orderedAtstringYesDate of order creation
statestringYes

Order status in English, see Directory of order statuses

stateNamestringYesOrder status in Russian, see Directory of order statuses
derivalDerivalArrivalPartially

Departure details

arrivalDerivalArrivalPartially

Arrival details

senderMemberNoSender details
receiverMemberNo

Receiver details

payerMemberNo

Payer details

freightFreightNo

Cargo details

isAirbooleanYesAir freight indicator
airobjectYes

Air freight details

If isAir parameter value is false, then the object parameters will not be passed in the response
air.arrivalDatestringYes

Cargo arrival date for air freight

air.giveoutDatestringYes

Cargo release date for air freight

air.warehousingDatestringYes

Paid storage start date for air freight

air.deliveryDatestringYes

Estimated cargo arrival date for air freight

air.commentstringNoAdditional information
air.orderIdstringYesAirway bill number
locksarray of LocksNoArray of lockouts
totalSumfloatYesTotal amount
isPaidbooleanYesOrder payment status
isPreorderbooleanNoPre-order indicator
produceDatestringYes

Order completion date

The data is not available for Multishipping
declineReasonstringYes

Rejection reason

The data is available only if the order has been declined
oderDatesobjectYesEstimated cargo transportation schedule
oderDates.arrivalToOspReceiverstringYes

Date of cargo arrival at the terminal of arrival

oderDates.arrivalToOspReceiverMaxstringYes

The latest possible date of cargo arrival at the terminal of arrival (if cargo arrival can be delayed)

oderDates.arrivalToOspReceiverMaxAccdocstringYes

Date of shipping documents arrival at the terminal of arrival

oderDates.arrivalToOspSenderstringYesDate of cargo arrival at the terminal of departure
oderDates.arrivalToReceiverstringYesDate of cargo delivery to the receiver's address
oderDates.declineDatestringYesRejection date
oderDates.derivalFromOspReceiverstringYesDate of cargo departure from the terminal of arrival
oderDates.derivalFromOspReceiverMaxstringYesThe latest possible date of cargo departure from the terminal of arrival (if cargo departure can be delayed)
oderDates.derivalFromOspReceiverMaxAccdocstringYesDate of shipping documents departure from the terminal of arrival
oderDates.giveoutFromOspReceiverstringYes

Date when cargo is ready to be handed out at the terminal of arrival

oderDates.giveoutFromOspReceiverMaxstringYesThe latest possible date when cargo is ready to be handed out at the terminal of arrival (if the date can be delayed)
oderDates.derivalFromOspSenderstringYesDate of cargo departure from the terminal of departure
oderDates.draftLastUpdatestringYesDate of draft last update
oderDates.finishstringYesOrder completion date
oderDates.firstDocumentCreatedDatestringYes

Date when the first document was created

oderDates.pickupstringYes

Date of cargo pickup from the sender's address

oderDates.processingDatestringYes

Order processing start date

oderDates.warehousingstringYes

Paid storage start date

orderTimeInDaysobjectYes

Estimated delivery time (in days)

The data is available only if is_air parameter value is false. Otherwise, values of all the object parameters is null
orderTimeInDays.deliveryintegerYes

Estimated time of cargo delivery to the address (in days)

orderTimeInDays.deliveryAccdocintegerYes

Estimated time of shipping documents delivery to the address (in days)

orderedDeliveryFromAddressbooleanYes

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

availableDeliveryFromAddressbooleanNoFlag indicating that shipping from the sender's address is available
orderedDeliveryToAddressbooleanYesFlag indicating that delivery to the receiver's address is ordered
availableDeliveryToAddressbooleanNoFlag indicating that delivery to the receiver's address is available
isFavoritebooleanNoFlag indicating that order is added to favorites
isContainerbooleanYesFlag indicating container shipping
sfrequestobjectYes

Details of order for delivery to the receiver's address

sfrequest.cityIDintegerYes

City ID, see Terminals directory

sfrequest.docNumberstringYesWaybill number
sfrequest.pricestringYesShipping cost
documentsDocumentsЧастичноArray of order documents
paymentStatestringYes

Payment status

Possible values:

  • paid;
  • not_paid;
  • in_process
notestringNoAdditional infromation
documentsReturnDatestringNoEstimated date of shipping documents return

DerivalArrival

DerivalArrival

ParameterTypeData available to unathorised users
Description
response.oders.derivalresponse.orders.arrival
citystringNoYes

City of cargo departure/arrival

cityIdintegerYesYesID of the city of departure/arrival
cityСodestringNoNo

City CLADR code (CLADR - Classifier of Addresses of the Russian Federation), see Places directory

addressstringNoNo

Address of the city of departure/arrival

addressCodestringNoNo

Street CLADR code, see Streets directory

terminalNamestringNoYes

Terminal name

terminalAddressstringNoYes

Terminal address

terminalIdintegerYesNoTerminal ID, see Terminals directory
terminalCitystring-Yes

City of storage terminal

The parameter is used only for response.orders.arrival object
terminalCoordinatesarray of float-Yes

Longitude and latitude of the storage terminal

The parameter is used only for response.orders.arrival object
terminalEmailstring-Yes

E-mail of the storage terminal

The parameter is used only for response.orders.arrival object
terminalPhonesstring-Yes

Storage terminal phone number

The parameter is used only for response.orders.arrival object
callCenterPhonesstring-Yes

Call center phone number

The parameter is used only for response.orders.arrival object
terminalWorktablesobject-






Yes






Storage terminal workhours

The parameter is used for response.orders.arrival object only
terminalWorktables.sunstringSunday workhours
terminalWorktables.monstringMonday workhours   
terminalWorktables.tuestringTuesday workhours
terminalWorktables.wedstringWednesday workhours
terminalWorktables.thustringThursday workhours
terminalWorktables.fristringFriday workhours 
terminalWorktables.satstringSaturday workhours

Member
The data is available only if sessionID parameter is passed in a request

Member

Parameter
Type
Description
opfstring

Organization legal form

Note for response.orders.documents.payer object: data is available only for orders for intercity transportation by dedicated truck (response.orders.documents.type parameter value is request_ftl)
opfUidstring

UID of legal form of organization form, see Directory of legal forms of organization

Note for response.orders.documents.payer object: data is available only for orders for intercity transportation by dedicated truck (response.orders.documents.type parameter value is request_ftl)
namestringCounterparty name 
addressstring

Counterparty address 

The parameter is used only for response.orders.sender, response.orders.receiver objects
isPhysicalboolean

Flag indicating individual

Note for response.orders.documents.payer object: data is available only for orders for intercity transportation by dedicated truck (response.orders.documents.type parameter value is request_ftl)
innstring

TIN - taxpayer identification number

Note for response.orders.documents.payer object: data is available only for orders for intercity transportation by dedicated truck (response.orders.documents.type parameter value is request_ftl)
documentTypestring

Personal ID for the individuals.

Possible values:

  • "Паспорт РФ" - passport of the Russian Federation;
  • "Загранпаспорт" - international passport;
  • "Водительское удостоверение" - driving license
Note for response.orders.documents.payer object: data is available only for orders for intercity transportation by dedicated truck (response.orders.documents.type parameter value is request_ftl)
documentSeriesstring

Individuals personal ID series

Note for response.orders.documents.payer object: data is available only for orders for intercity transportation by dedicated truck (response.orders.documents.type parameter value is request_ftl)
documentNumberstring

Individuals personal ID number

Note for response.orders.documents.payer object: data is available only for orders for intercity transportation by dedicated truck (response.orders.documents.type parameter value is request_ftl)
сounteragentUidstring

Counterparty UID

For response.orders.documents.sender, response.orders.documents.receiver, response.orders.documents.payer objects: the data is available only for waybills (response.orders.documents.type parameter value is shipping)
contactsstring

Sender's contact person name

The parameter is used only for response.orders.sender and response.orders.documents.sender objects.Note for response.orders.documents.sender object: data is available only for orders for shipping from the sender's address (response.orders.documents.type parameter value is request) and only in case of pre-order
phonesstring

Counterparty phone number

The parameter is used only for response.orders.sender object
anonymboolean

Indicator of an anonymous receiver for Simplified Shipping (with minimum set of data)

The parameter is used only for response.orders.receiver object
anonymEmailstring

Anonymous receiver e-mail

The parameter is used only for response.orders.receiver object
anonymPhonestring

Anonymous receiver phone number

The parameter is used only for response.orders.receiver object

Freight
The data is available only if sessionID parameter is passed in a request

Freight

ParameterTypeDescription
response.orders.freightresponse.orders.documents.freightresponse.orders.freightresponse.orders.documents.freight
namenamestringstringCargo name
weightweight

string

floatCargo weight, kg
oversizedWeightoversizedWeight

string

float
Overweight, kg
volumevolume

string

floatCargo volume, m3
oversizedVolumeoversizedVolume

string

floatOversize cargo volume, m3
places-integer-

Qantity of cargo items

oversizedPlaces-integer-

Qantity of oversize cargo items

lengthmaxLengthstringfloat

Cargo length, m

widthmaxWidthstringfloat

Cargo width, m

heightmaxHeightstringfloat

Cargo height, m

Locks
The data is available only if sessionID parameter is passed in a request

Locks

Parameter
Type
Description
namestringLockout name
typestringLockout name
setDatestringLockout start date
endDatestringLockout end date

Documents

Documents

Parameter
Type
Data available to unathorised users
Description
idintegerYesDocument number
uidstringYes

Waybill UID

The data is available only for waybills (response.orders.documents.type parameter value is shipping)
typestringYes

Document type

Possible values:

  • shipping - waybill;
  • request - order for shipping from the sender's address;
  • request_sf - order for delivery to the receiver's address;
  • "request_ftl" - order for intercity transportation by dedicated truck
createDatestringYes

Date of document creation

statestringYes

Document status

Order for shipping from the sender's address/delivery to the receiver's address/intercity transportation by dedicated truck (response.orders.documents.type parameter value is request/request_sf/request_ftl) statuses:

  • "temporary" - the document is not filled;
  • "saved" - draft;
  • "ordered" - the order is in queue for processing;
  • "loaded" - the order is being processed;
  • "processed" - the order has been processed;
  • "declined" - the order has been declined;
  • "accepted" - the order has been accepted;
  • "canceled" - the order has been accepted.

Waybill (response.orders.documents.type parameter value is shipping) statuses:

  • "in_way" - the cargo is on the way;
  • "arrival" - the cargo is has arrived;
  • "give_out" - the cargo is given out
senderMemberNo

Sender details

The data is not available for orders for intercity transportation by dedicated truck (response.orders.documents.type parameter value is request_ftl)
receiverMemberNo

Receiver details

The data is not available for orders for intercity transportation by dedicated truck (response.orders.documents.type parameter value is request_ftl)
payerMemberNoPayer details
produceDatestringYes

Order completion date

The data is available only for orders for shipping from the sender's address/delivery to the receiver's address (response.orders.documents.type parameter value is request/request_sf)
forwarderIDstringNo

Forwarding agent order number

The data is available only for orders for shipping from the sender's address/orders for delivery to the receiver's address (response.orders.documents.type parameter value is request/request_sf)
commentstringNo

Additional information on the documents

The data is available only for orders for shipping from the sender's address/orders for delivery to the receiver's address (response.orders.documents.type parameter value is request/request_sf)
fullDocumentIdstringYes

Full document number

The data is available only for orders for shipping from the sender's address/orders for delivery to the receiver's address (response.orders.documents.type parameter value is request/request_sf)
freightFreightNo

Cargo details

The data is available only for orders for shipping from the sender's address/waybills (response.orders.documents.type parameter value is request/shipping)
derivalobjectYes

Information about the place of departure

The data is available only for orders for shipping from the sender's address/waybills (response.orders.documents.type parameter value is request/shipping)
derival.namestringYes

City

The data is available only for orders for shipping from the sender's address/waybills (response.orders.documents.type parameter value is request/shipping)
derival.codestringYes

City CLADR code, see Places directory

The data is available only for orders for shipping from the sender's address/waybills (response.orders.documents.type parameter value is request/shipping)
arrivalobjectYes

Information about the place of arrival

The data is available only for orders for shipping from the sender's address/waybills (response.orders.documents.type parameter value is request/shipping)
arrival.namestringYes

City

The data is available only for orders for shipping from the sender's address/waybills (response.orders.documents.type parameter value is request/shipping)
arrival.codestringYes

City CLADR code, see Places directory

The data is available only for orders for shipping from the sender's address/waybills (response.orders.documents.type parameter value is request/shipping)
barcodestringNo

Barcode according to Code 128 algorithm (for pre-order)

paymentbooleanYes

Payment status

The data is available only for waybills (response.orders.documents.type parameter value is shipping)
totalSumintegerYes

Total amount on the waybill

The data is available only for waybills (response.orders.documents.type parameter value is shipping)
serviceKindstringYes

Transportation type

The data is available only for waybills (response.orders.documents.type parameter value is shipping)
organizationstringNo

Organization ID

The data is available only for waybills (response.orders.documents.type parameter value is shipping)
servicesarray of ServicesPartially

List of services as per the waybill

The data is available only for waybills (response.orders.documents.type parameter value is shipping)
accompanyingDocumentsarray of AcDocNo

List of the shipping documents

The data is available only for waybills (response.orders.documents.type parameter value is shipping)
availableDocsarray of stringNo

List of the documents for which printable versions are available

The parameter is used only for waybills (response.orders.documents.type parameter value is shipping)
paymentStatestringYes

Shipping documents payment status in English

Possible values:

  • paid;
  • not_paid;
  • in_process
The parameter is used only for waybills (response.orders.documents.type parameter value is shipping)

Services
All the data except for the response.orders.documents.services.name parameter is available only if sessionID parameter is passed in a request
Services
Parameter
Type
Description
namestringService name
serviceUidstringService UID
createdAtstringCreation date
quantityintegerQuantity
sumstringAmount
totalSumstringTotal amount
discountSumstringDiscount

AcDoc
AcDoc
ParameterType
Description
documentDatestringShipping document creation date
documentNumberstringShipping document number
documentKindstringComment (document type)

Error handling

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

Error numberhttp-codeError titleError description
TitleTranslationDescriptionTranslation

718001

400Найдено более одного заказаMore than one order foundВоспользуйтесь расширенным поискомUse advanced search

717001

400Заказ не найденOrder not foundЗаказ [номер заказа] не найденOrder [order number] not found

717002

400Неизвестный статус заказаUnknown order statusДетальное описание ошибки содержит номера заказов с неизвестным статусомDetailed error description contains the list of numbers of orders with unknown status