Sending an order creation form

The response returns a result with the 200 OK code and the JSON body.

HTTP request

POST https://exp.tdsd.pro/api/Order

Request structure

{
   "comment": string,
   "customer": {
       "firstName": string,
       "fullName": string,
       "id": 0,
       "inn": string,
       "lastName": string,
       "middleName": string,
       "name": string,
       "type": int,
       "address": string
   },
   "tax": string,
   "type": string,
   "cost": {
       "assessedValue": double
   },
   "options": {
     "bodyType": string,
     "cargoCategory": string,
     "loadingType": string,
     "temperatureRegime": string,
     "wouldBeLoaded": boolean,
     "allInSingleTransport": boolean
   },
   "id": string,
   "price": double,
   "places": [
       {
           "externalId": string,
           "name": string,
           "barcode": "",
           "tax": string,
           "options": {
               "bodyType": string,
               "cargoCategory": string,
               "loadingType": string,
               "temperatureRegime": string,
               "wouldBeLoaded": boolean,
               "allInSingleTransport": boolean
           },
           "comment": string,
           "items": [],
           "isFragile": false,
           "loadingAddress": {
               "postalCode": string,
               "fullAddress": string,
               "country": string,
               "geoId": 0,
               "apartment": string,
               "building": string,
               "house": string,
               "housing": string,
               "locality": string,
               "region": string,
               "street": string,
               "kladr": string,
               "kladrRegion": string,
               "latitude": string,
               "longitude": string

           },
           "unloadingAddress": {
               "postalCode": string,
               "fullAddress": string,
               "country": string,
               "geoId": 0,
               "apartment": string,
               "building": string,
               "house": string,
               "housing": string,
               "locality": string,
               "region": string,
               "street": string,
               "kladr": string,
               "kladrRegion": string,
               "latitude": string,
               "longitude": string
           },
           "dimensions": {
               "length": decimal,
               "height": decimal,
               "width": decimal,
               "volume": decimal,
               "weight": decimal
           },
           "assessedValue": double,
           "deliveryPrice": double,
           "shipment": {
               "date": string,
               "hourFrom": string,
               "range": int
           },
           "delivery": {
               "date": string,
               "hourFrom": string,
               "range": int
           },
           "sender": {
               "firstName": string,
               "fullName": string,
               "id": 0,
               "inn": string,
               "lastName": string,
               "middleName": string,
               "name": string,
               "type": int,
               "address": string
           },
           "recipient": {
               "firstName": string,
               "fullName": string,
               "id": 0,
               "inn": string,
               "lastName": string,
               "middleName": string,
               "name": string,
               "type": int,
               "address": string,
               "email": ""
           },
           "senderContacts": [
               {
                   "fullName": string,
                   "phone": string,
                   "firstName": string,
                   "lastName": string,
                   "middleName": string,
                   "additional": ""
               },
               {
                   "fullName": string,
                   "phone": string,
                   "firstName": string,
                   "lastName": string,
                   "middleName": string,
                   "additional": ""
               }
           ],
           "recipientContacts": [
               {
                   "fullName": string,
                   "phone": string,
                   "firstName": string,
                   "lastName": string,
                   "middleName": string,
                   "additional": ""
               }
           ]
       }
   ],
   "contractData": {
       "startDate": string,
       "createDate": string,
       "endDate": string,
       "payDate": string
   },
   "isForwarded": boolean,
   "forwardToOrganizationIds": [
       string
   ],
   "forwardedPrice": number,
   "executorLineClientId": string,
   "cancellationFreeOfChargeFeeForDelay": string,
   "cancellationFreeOfChargeHours": string,
   "idleHoursForOrder": string,
   "pricePerHourForExcessTime": string,
   "daysAfterDocumentsReceiveForPayment": string
}

Request Parameters

Parameter Type Value Mandatory
executorLineClientId string ID of the organization on behalf of which the order is created Yes
customer object Customer information Yes
type string Order type: Ftl — full vehicle load, Ltl — partial vehicle load Yes
id string ID of the new order Yes
price double Cost of transport without VAT No
places array of objects Information about loading and unloading places Yes
contractData object Information about contract creation, payment, start, and end dates Yes
comment string Comment No
tax string VAT rate No
cost object Information about the cost and payment method No
options object Freight parameters No
isForwarded boolean To the hub or to the contractor No
executorRoleType string Role of the order contractor: 0 — any, 1 — forwarder, 2 — carrier No
forwardToOrganizationIds array of strings IDs of organizations for forwarding No
forwardedPrice number Cost of transport for forwarding No
documentExchangeDaysAfterFreightUnloading string Delay in providing closing documents in calendar days No
daysAfterDocumentsReceiveForPayment string The number of days of deferral No
documentsFormat string Format of documents: "Original", "Copy", "Certified copy" No
otherConditionsText string Special conditions No
auctionTime string Duration of the auction in HH:mm format No
auctionBidStep number Auction bid increment. Must be > 0. Optional if the order is assigned to a single contractor or without forwarding No, with condition
isAuctionAutoComplete boolean Auto-selection at closed auctions No

Parameters nested in customer

Parameter Type Value Mandatory
firstName string First name of the customer Yes
lastName string Last name of the customer Yes
middleName string Patronymic of the customer Yes
inn string TIN (Taxpayer Identification Number) Yes
name string Name of the legal entity Yes
type int Customer type: 0 — legal entity, 1 — individual entrepreneur, 2 — individual Yes
address string Address of the customer No
id int Organization ID. The default value is 0 No

Parameters nested in places

Parameter Type Value Mandatory
loadingAddress object Information about the loading address Yes
unloadingAddress object Information about the unloading address Yes
shipment object Shipment information Yes
delivery object Receipt information Yes
sender object Information about the shipper Yes
recipient object Information about the recipient Yes
dimensions object Information about the freight dimensions Yes
externalId string Place ID Yes
deliveryPrice double Cost of transport without VAT No
name string Freight name No
tax string VAT rate No
options object Freight parameters No
comment string Comment No
assessedValue double Declared value of the freight No
senderContacts array Shipper's contact details No
recipientContacts array Recipient's contact details No
isFragile boolean Fragile commodity No
barcode string Place barcode No

Parameters nested in contractData

Parameter Type Value Mandatory
startDate string Date of the first loading Yes
createDate string Order creation date Yes
endDate string Order end date Yes
payDate string Payment date Yes

Parameters nested in cost

Parameter Type Value Mandatory
assessedValue double Declared value of the freight No

Parameters nested in options

Parameter Type Value Mandatory
cargoCategory string ID of the selected product category No
bodyType string ID of the selected body type No
loadingType string ID of the selected loading type No
temperatureRegime string ID of the selected temperature regime No
wouldBeLoaded boolean Whether extra loading is possible No
allInSingleTransport boolean Send all items in one vehicle No

Parameters nested in loadingAddress or unloadingAddress

Parameter Type Value Mandatory
fullAddress string Address Yes
country string Country Yes
locality string Locality Yes
kladr string KLADR (Russian address classifier) No
postalCode string Postal code No
apartment string Apartment No
building string Building No
house string House No
housing string Land plot No
region string Region No
street string Street No
kladrRegion string KLADR region No
geoId int Address ID. The default value is 0 No

Parameters nested in shipment or delivery

Parameter Type Value Mandatory
date string Date Yes
hourFrom string Time Yes
range int Interval in hours Yes

Parameters nested in sender

Parameter Type Value Mandatory
firstName string First name of the customer Yes
lastName string Last name of the customer Yes
middleName string Patronymic of the customer Yes
inn string TIN (Taxpayer Identification Number) Yes
name string Name of the legal entity Yes
type int Customer type: 0 — legal entity, 1 — individual entrepreneur, 2 — individual Yes
address string Address of the customer No
id int Organization ID. The default value is 0 No

Parameters nested in recipient

Parameter Type Value Mandatory
firstName string First name of the customer Yes
lastName string Last name of the customer Yes
middleName string Patronymic of the customer Yes
inn string TIN (Taxpayer Identification Number) Yes
name string Name of the legal entity Yes
type int Customer type: 0 — legal entity, 1 — individual entrepreneur, 2 — individual Yes
address string Address of the customer No
email string Email of the recipient No
id int Organization ID. The default value is 0 No

Parameters nested in dimensions

Parameter Type Value Mandatory
volume decimal Volume, m3 Yes
weight decimal Weight, kg Yes
length decimal Length, cm No
height decimal Height, cm No
width decimal Width, cm No

Parameters nested in senderContacts or recipientContacts

Parameter Type Value Mandatory
phone string Phone number Yes
firstName string First name Yes
lastName string Last name Yes
middleName string Patronymic Yes
additional string Additional phone number No

Request example

{
   "comment": "Freight",
   "customer": {
       "firstName": "",
       "fullName": "",
       "id": 0,
       "inn": "1234567890",
       "lastName": "",
       "middleName": "",
       "name": "ROMASHKA LLC",
       "type": 0,
       "address": " Moscow, 10A Leninsky Avenue"
   },
   "tax": "91fd0716-736e-48eb-b944-6eb7a0df1474",
   "type": "Ftl",
   "cost": {
       "assessedValue": 350000
   },
   "options": {
     "bodyType": "daedf841-9d05-4a02-bc50-09a3cdddcf3c",
     "cargoCategory": "5b699787-d816-4d23-9ceb-83fd9b46416e",
     "loadingType": "540fa155-4ae4-4d97-bf01-00682b3d6944",
     "temperatureRegime": "5 — 25 °C",
     "wouldBeLoaded": false,
     "allInSingleTransport": false
   },
   "id": "e5112ea5-0dc7-44d8-8565-633258a48108",
   "price": 25000,
   "places": [
       {
           "externalId": "ede96dfe-24fe-4ef9-8b3f-c77e1997d93a",
           "name": "[Ftl] Boxes",
           "barcode": "",
           "tax": "91fd0716-736e-48eb-b944-6eb7a0df1474",
           "options": {
               "bodyType": "daedf841-9d05-4a02-bc50-09a3cdddcf3c",
               "cargoCategory": "5b699787-d816-4d23-9ceb-83fd9b46416e",
               "loadingType": "540fa155-4ae4-4d97-bf01-00682b3d6944",
               "temperatureRegime": "5 — 25 °C",
               "wouldBeLoaded": false,
               "allInSingleTransport": false
           },
           "comment": "Freight",
           "items": [],
           "isFragile": false,
           "loadingAddress": {
                "postalCode": "",
                "fullAddress": "32 Bolshaya Yakimanka Street, bld. 2, Moscow, Russia",
                "country": "Russia",
                "geoId": 0,
                "apartment": "",
                "building": "",
                "house": "32 bld. 2",
                "housing": "",
                "locality": "Moscow",
                "region": "Central Federal District; Moscow",
                "street": "Bolshaya Yakimanka Street",
                "kladr": "",
                "kladrRegion": "",
                "latitude": "55.735155",
                "longitude": "37.61159"
            },
            "unloadingAddress": {
                "postalCode": "",
                "fullAddress": "2A 3rd Zemsky Lane, Repnoye Microdistrict, Belgorod, Russia",
                "country": "Russia",
                "geoId": 0,
                "apartment": "",
                "building": "",
                "house": "2A",
                "housing": "",
                "locality": "Belgorod",
                "region": "Central Federal District; Belgorod Region",
                "street": "3rd Zemsky Lane",
                "kladr": "",
                "kladrRegion": "",
                "latitude": "50.562193",
                "longitude": "36.518322"
            },
           "dimensions": {
               "length": 500,
               "height": 90,
               "width": 115,
               "volume": 20.7,
               "weight": 4000
           },
           "assessedValue": 175000,
           "deliveryPrice": 12500,
           "shipment": {
               "date": "2022-03-04",
               "hourFrom": "12:00",
               "range": 15
           },
           "delivery": {
               "date": "2022-03-07",
               "hourFrom": "15:00",
               "range": 12
           },
           "sender": {
               "firstName": "",
               "fullName": "",
               "id": 0,
               "inn": "2222222222",
               "lastName": "",
               "middleName": "",
               "name": "POGRUZKA LLC",
               "type": 0,
               "address": "1 Ligovsky Avenue, Saint Petersburg"
           },
           "recipient": {
               "firstName": "",
               "fullName": "",
               "id": 0,
               "inn": "1111111111",
               "lastName": "",
               "middleName": "",
               "name": "VYGRUZKA LLC",
               "type": 0,
               "address": "1 Kutuzovsky Avenue, Moscow",
               "email": ""
           },
           "senderContacts": [
               {
                   "phone": "+79000000001",
                   "firstName": "Ivan",
                   "lastName": "Ivanov",
                   "middleName": "Ivanovich",
                   "additional": ""
               },
               {
                   "phone": "+79000000003",
                   "firstName": "Ivan",
                   "lastName": "Petrov",
                   "middleName": "Ivanovich",
                   "additional": ""
               }
           ],
           "recipientContacts": [
               {
                   "fullName": "Ivan Ivanovich Sidorov",
                   "phone": "+79260000002",
                   "firstName": "Ivan",
                   "lastName": "Sidorov",
                   "middleName": "Ivanovich",
                   "additional": ""
               }
           ]
       },
       {
           "externalId": "f8404cb2-b89a-4615-9a74-31355a0de4ba",
           "name": "[Ftl] Granulated sugar",
           "barcode": "",
           "tax": "91fd0716-736e-48eb-b944-6eb7a0df1474",
           "options": {
               "bodyType": "daedf841-9d05-4a02-bc50-09a3cdddcf3c",
               "cargoCategory": "5b699787-d816-4d23-9ceb-83fd9b46416e",
               "loadingType": "540fa155-4ae4-4d97-bf01-00682b3d6944",
               "temperatureRegime": "5 — 25 °C",
               "wouldBeLoaded": false,
               "allInSingleTransport": false
           },
           "comment": "Freight ",
           "items": [],
           "isFragile": false,
           "loadingAddress": {
               "postalCode": "333333",
               "fullAddress": "10 Lenina Street, Voronezh",
               "country": "Russia",
               "geoId": 0,
               "apartment": null,
               "building": null,
               "house": "1",
               "housing": "",
               "locality": "Voronezh",
               "region": "Voronezh",
               "street": "Lenina",
               "kladr": "4801200002400090001",
               "kladrRegion": "4800000000000"
           },
           "unloadingAddress": {
               "postalCode": "222222",
               "fullAddress": "1A Selmash Avenue, Rostov-on-Don",
               "country": "Russia",
               "geoId": 0,
               "apartment": null,
               "building": null,
               "house": "41",
               "housing": "",
               "locality": "Rostov-on-Don",
               "region": "Rostov",
               "street": "Selmash",
               "kladr": "6100000100011410081",
               "kladrRegion": "6100000000000"
           },
           "dimensions": {
               "length": 500,
               "height": 90,
               "width": 115,
               "volume": 20.7,
               "weight": 4000
           },
           "assessedValue": 175000,
           "deliveryPrice": 12500,
           "shipment": {
               "date": "2022-03-07",
               "hourFrom": "18:00",
               "range": 15
           },
           "delivery": {
               "date": "2022-03-09",
               "hourFrom": "13:00",
               "range": 13
           },
           "sender": {
               "firstName": "",
               "fullName": "",
               "id": 0,
               "inn": "2222222222",
               "lastName": "",
               "middleName": "",
               "name": "POGRUZKA LLC",
               "type": 0,
               "address": " 1 Ligovsky Avenue, Saint Petersburg"
           },
           "recipient": {
               "firstName": "",
               "fullName": "",
               "id": 0,
               "inn": "1111111111",
               "lastName": "",
               "middleName": "",
               "name": "VYGRUZKA LLC",
               "type": 0,
               "address": " 10 Kutuzovsky Avenue, Moscow",
               "email": ""
           },
           "senderContacts": [
               {
                   "fullName": "Ivan Ivanovich Sidorov",
                   "phone": "+79000000004",
                   "firstName": "Ivan",
                   "lastName": "Sidorov",
                   "middleName": "Ivanovich",
                   "additional": ""
               }
           ],
           "recipientContacts": [
               {
                   "fullName": "Ivan Ivanovich Smirnov",
                   "phone": "+79000000008",
                   "firstName": "Ivan",
                   "lastName": "Smirnov",
                   "middleName": "Ivanovich",
                   "additional": ""
               }
           ]
       }
   ],
   "contractData": {
       "startDate": "2022-03-04",
       "createDate": "2022-03-04",
       "endDate": "2022-05-18",
       "payDate": "2022-04-18"
   },
   "isForwarded": true,
   "executorRoleType": "0",
   "forwardToOrganizationIds": [
       "3fa85f64-5717-4562-b3fc-2c963f66afa6"
   ],
   "forwardedPrice": 1000,
   "executorLineClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "documentExchangeDaysAfterFreightUnloading": "30",
   "daysAfterDocumentsReceiveForPayment": "30",
   "documentsFormat": "Original",
   "otherConditionsText": "Special conditions",
   "auctionTime": "24:00",
   "auctionBidStep": 500,
   "isAuctionAutoComplete": false
}

Response

{
  "isSuccess": boolean,
  "message": string
}

Response parameters

Parameter Type Value
isSuccess boolean Whether the request is successful
message string Message

Support service
Previous
Status model
Next
Get info about the place