Getting information about the place

HTTP request

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

Request structure

{
  "externalId": string,
  "id": string
}

Request parameters

Parameter Type Value Mandatory
externalId string The place ID from the api/order method is the externalId parameter nested in the places array Yes
id string The order ID from the api/order method is the id parameter Yes

Responses

Code 200

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


{
   "isSuccess": boolean,
   "message": string,
   "entity": {
       "id": string,
       "managerId": string,
       "dimensions": {
           "length": decimal,
           “height": decimal,
           “width": decimal,
           “volume": decimal,
           "weight": decimal
       },
       "comment": string,
       "statuses": [
           {
               "date": string,
               "status": string
           }
       ],
       "loading": {
           "inn": string,
           "fullAddress": string,
           “date”: string,
           "range": int
       },
       "unloading": {
           "inn": string,
           "fullAddress": string,
           “date”: string,
           "range": int
       },
       "flights": {
           "id": string,
           "statuses": [
               {
                   "date": string,
                   "status": string
               }
           ],
           "transports": {
               "mark": string,
               "model": string,
               "regNumber": string
           },
           "drivers": [
               string
           ]
       },
       "contracts": {
           "number": string,
           "createDate": string,
           "payDate": string,
           "act": string,
           "сustomer": {
               "contactPersonName": string,
               "contactPersonPhone": string,
               "inn": string,
               "name": string
           },
           "carrier": {
               "contactPersonName": string,
               "contactPersonPhone": string,
               "inn": string,
               "name": string
           },
           "payments": [
               {
                   "purpose": string,
                   "mainBankAccount": string,
                   "inn": string,
                   "kpp": string,
                   "checkingAccount": string,
                   "correspondentAccount": string,
                   "bik": string,
                   "companyName": string,
                   “vatSum": decimal,
                   “sum": decimal,
                   “factSum": decimal,
                   “tax”: decimal
               }
           ]
       },
       "acceptanceConditionsSpecial": [
           string
       ]
   }
}

Response parameters

Parameter Type Value
isSuccess boolean Whether the request is successful
message string Error information
entity object Information about the place

Parameters nested in entity

Parameter Type Value
id string ID of the customer's place
managerId string ID of the manager who placed the application
dimensions object Information about the freight dimensions
loading object Information about loading
unloading object Information about unloading
comment string Comment
statuses array of objects Place status change history
flights array of objects List of trips
contracts array of objects List of one-time contracts
acceptanceConditionsSpecial array of strings List of special conditions

Parameters nested in dimensions

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

Parameters nested in loading or unloading

Parameter Type Value
inn string TIN (Taxpayer Identification Number) of the company that performs unloading/loading
fullAddress string Address of the organization
date string Unloading/loading date in dd.MM.yyyy HH:mm format
range int Unloading/loading time window in hours

Parameters nested in statuses

Parameter Type Value
date string Date in dd.MM.yyyy HH:mm:ss format
status string Status in text form

Parameters nested in flights

Parameter Type Value
id string Trip ID
statuses array of objects Place status change history
drivers array of strings Last name, first name, and patronymic of the driver
transports array of objects List of the carrier's vehicles

Parameters nested in contracts

Parameter Type Value
number string One-time contract number
createDate string One-time contract date in dd.MM.yyyy format
payDate string Date of payment under the contract in dd.MM.yyyy format
act string Invoice number
payments array of objects List of payment invoice details and recipient details
carrier object Carrier
сustomer object Customer

Parameters nested in payments

Parameter Type Value
purpose string Payment purpose
mainBankAccount string Name of the recipient bank
inn string TIN (Taxpayer Identification Number) of the recipient
kpp string KPP (Tax Registration Reason Code) of the recipient
checkingAccount string Settlement account of the recipient
correspondentAccount string Correspondent account of the recipient
bik string BIC (Bank Identification Code) of the recipient bank
companyName string Name of the recipient company
vatSum decimal VAT amount in the cost of transport
sum decimal Cost of transport
factSum decimal Final cost of transport
tax decimal VAT rate

Parameters nested in carrier or сustomer

Parameter Type Value
contactPersonName string Last name, first name, and patronymic of the contact person
contactPersonPhone string Phone number of the contact person
inn string TIN (Taxpayer Identification Number)
name string Name of the legal entity.

Parameters nested in transports

Parameter Type Value
mark string Vehicle brand
model string Vehicle model
regNumber string Registration number

Response example

{
   "isSuccess": true,
   "message": "string",
   "entity": {
       "id": "string",
       "managerId": “string",
       "dimensions": {
           "length": 0,
           “height": 0,
           “width": 0,
           “volume": 0,
           "weight":0
       },
       "comment": "string",
       "statuses": [
           {
               "date": ”01.01.2022 10:00:33",
               "status": "string"
           }
       ],
       "loading": {
           "inn": "string",
           "fullAddress": "string",
           “date”: ”01.01.2022 10:00",
           "range": 0
       },
       "unloading": {
           "inn": "string",
           "fullAddress": "string",
           "date": ”01.01.2022 10:00",
           "range": 0
       },
       "flights": {
           "id": "string",
           "statuses": [
               {
                   "date": ”01.01.2022 10:00:33”,
                   "status": "string"
               }
           ],
           "transports": {
               "mark": "string",
               "model": "string",
               "regNumber": "string"
           },
           "drivers": [
               "string"
           ]
       },
       "contracts": {
           "number": "string",
           "createDate": ”01.01.2022",
           "payDate": ”01.01.2022",
           "act": "string",
           "сustomer": {
               "contactPersonName": "string",
               "contactPersonPhone": "string",
               "inn": "string",
               "name": "string"
           },
           "carrier": {
               "contactPersonName": "string",
               "contactPersonPhone": "string",
               "inn": "string",
               "name": "string"
           },
           "payments": [
               {
                   "purpose": "string",
                   "mainBankAccount": "string",
                   "inn": "string",
                   "kpp": "string",
                   "checkingAccount": "string",
                   "correspondentAccount": "string",
                   "bik": "string",
                   "companyName": "string",
                   “vatSum": 0,
                   “sum": 0,
                   “factSum": 0,
                   “tax”: 0
               }
           ]
       },
       "acceptanceConditionsSpecial": [
           "string"
       ]
   }
}

Code 400

Returned if invalid data was entered or an error occurred.

Response parameters

Parameter Type Value
type string Link to the service response status description
title string Service response description
status int Service response status
traceId string Error ID
errors object List of errors that occurred as a result of method execution

Parameters nested in errors

Parameter Type Value
$.customer.type array of strings Array of strings describing errors

Response example

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-1ffa33abdc5f684b9332a2a598c1872e-9f2f50423ae64d4f-00",
    "errors": {
        "$.customer.type": [
            "The JSON value could not be converted to Y.Magistral.DataModel.DTO.Order.SenderType. Path: $.customer.type | LineNumber: 0 | BytePositionInLine: 242."
        ]
    }
}

Support service
Previous
Send a creation form
Next
Get directories