Получение информации о месте

HTTP-запрос

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

Структура запроса

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

Параметры запроса

Параметр Тип Значение Обязательный
externalId string Идентификатор места из метода api/order — параметр externalId, вложенный в массив places Да
id string Идентификатор заказа из метода api/order — параметр id Да

Ответы

Код 200

В ответе возвращается результат с кодом 200 OK и телом в формате JSON.


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

Параметры ответа

Параметр Тип Значение
isSuccess boolean Успешный ли запрос
message string Информация об ошибке
entity object Информация о месте

Параметры, вложенные в entity

Параметр Тип Значение
id string Идентификатор места заказчика
managerId string Идентификатор менеджера, который разместил заявку
dimensions object Информация о габаритах груза
loading object Информация о погрузке
unloading object Информация о выгрузке
comment string Комментарий
statuses array of objects История изменения статусов места
flights array of objects Список рейсов
contracts array of objects Список разовых договоров
acceptanceConditionsSpecial array of strings Список особых условий

Параметры, вложенные в dimensions

Параметр Тип Значение
length decimal Длина, см
height decimal Высота, см
width decimal Ширина, см
volume decimal Объем, м3
weight decimal Вес, кг

Параметры, вложенные в loading или unloading

Параметр Тип Значение
inn string ИНН компании , которая проводит выгрузки/погрузки
fullAddress string Адрес организации
date string Дата выгрузки/погрузки в формате dd.MM.yyyy HH:mm
range int Окно выгрузки/погрузки в часах

Параметры, вложенные в statuses

Параметр Тип Значение
date string Дата в формате dd.MM.yyyy HH:mm:ss
status string Статус в виде текста

Параметры, вложенные в flights

Параметр Тип Значение
id string Идентификатор рейса
statuses array of objects Истории изменений статусов места
drivers array of strings Фамилия, имя и отчество водителей
transports array of objects Список транспортных средств перевозчика

Параметры, вложенные в contracts

Параметр Тип Значение
number string Номер разового договора
createDate string Дата разового договора в формате dd.MM.yyyy
payDate string Дата платежа по договору в формате dd.MM.yyyy
act string Номер накладной
payments array of objects Список реквизитов счета на оплату и данные получателя
carrier object Перевозчик
сustomer object Заказчик

Параметры, вложенные в 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 Cтавка НДС

Параметры, вложенные в carrier или сustomer

Параметр Тип Значение
contactPersonName string Фамилия, имя и отчество контактного лица
contactPersonPhone string Номер телефона контактного лица
inn string ИНН
name string Название юридического лица.

Параметры, вложенные в transports

Параметр Тип Значение
mark string Марка ТС
model string Модель ТС
regNumber string Регистрационный номер

Пример ответа

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

Код 400

Возвращается, если введены неверные данные или возникла ошибка.

Параметры ответа

Параметр Тип Значение
type string Ссылка на описание статуса ответа от сервиса
title string Описание ответа от сервиса
status int Статус ответа от сервиса
traceId string Идентификатор ошибок
errors object Список ошибок, возникших в результате выполнения метода

Параметры, вложенные в errors

Параметр Тип Значение
$.customer.type array of strings Массив строк, описывающих ошибки

Пример ответа

{
    "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."
        ]
    }
}

Служба поддержки
Предыдущая
Отправка формы создания заказа
Следующая
Получение справочников