Отправка формы создания заказа

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

HTTP-запрос

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

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

{
  "auctionBidStep": number,
  "auctionExtendActivationTime": string,
  "auctionExtendTime": string,
  "auctionTime": string,
  "comment": string,
  "documentExchangeDaysAfterFreightUnloading": string,
  "documentsFormat": string,
  "executorRoleType": string,
  "extendTimeLimit": string,
  "externalId": string,
  "isAuction": boolean,
  "isAuctionAutoComplete": boolean,
  "isAuctionAutoExtend": boolean,
  "isPriceOnlyDescend": boolean,
  "otherConditionsText": string,
  "id": string,
  "price": double,
  "isForwarded": boolean,
  "forwardToOrganizationIds": [
       string
   ],
  "forwardedPrice": number,
  "executorLineClientId": string,
  "daysAfterDocumentsReceiveForPayment": string
  "customer": {
       "firstName": string,
       "countryCode": string,
       "id": 0,
       "inn": string,
       "lastName": string,
       "middleName": string,
       "name": string,
       "type": int,
       "address": string
   },
   "cost": {
       "assessedValue": double,
   },
   "options": {
     "bodyTypes": [string],
     "cargoCategories": [string],
     "cargoSubCategory": string,
     "loadingTypes": [string],
     "temperatureRegimes": [string],
     "bodyTypeComment": string,
   },
   "places": [
       {
           "externalId": string,
           "name": string,
           "assessedValue": double,
           "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
           },
           "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
           },
           "dimensions": {
               "length": decimal,
               "height": decimal,
               "width": decimal,
               "volume": decimal,
               "weight": decimal
           },
           "shipment": {
               "date": string,
               "hourFrom": string,
               "range": int
           },
           "delivery": {
               "date": string,
               "dateFrom": string,
               "dateTo": string,
               "hourFrom": string,
               "hourTo": string,
               "range": int
           },
         "shipment": {
               "date": string,
               "dateFrom": string,
               "dateTo": string,
               "hourFrom": string,
               "hourTo": string,
               "range": int
           },
           "sender": {
               "firstName": string,
               "id": 0,
               "inn": string,
               "lastName": string,
               "middleName": string,
               "name": string,
               "type": int,
               "address": string
           },
           "recipient": {
               "firstName": string,
               "id": 0,
               "inn": string,
               "lastName": string,
               "middleName": string,
               "name": string,
               "type": int,
               "address": string
           },
           "senderContacts": [
               {
                   "phone": string,
                   "firstName": string,
                   "lastName": string,
                   "middleName": string,
               },
               {
                   "phone": string,
                   "firstName": string,
                   "lastName": string,
                   "middleName": string,
               }
           ],
           "recipientContacts": [
               {
                   "phone": string,
                   "firstName": string,
                   "lastName": string,
                   "middleName": string,
               }
           ]
       }
   ]
}

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

Параметр Тип Значение Обязательный
executorLineClientId string Идентификатор организации, от лица которой создается заказ Да
id string (uuid4) Идентификатор нового заказа (Уникален для каждого заказа) Да
type string Тип перевозки. Возможные значения: ["Ftl", ""] Да
customer object Информация о заказчике Да
places array of objects Информация о местах погрузки и выгрузки Да
options object Параметры заказа Да
forwardToOrganizationIds array of strings Идентификаторы организаций для проброса. Список организаций можно получить с помощью метода GET /api/Info/organizations-to-forward-order Да, если проброс прямой или в закрытый хаб
documentExchangeDaysAfterFreightUnloading string Отсрочка предоставления закрывающих документов в календарных днях Да, если isForwarded = true
daysAfterDocumentsReceiveForPayment string Количество дней отсрочки платежа после передачи документов для оплаты Да, если isForwarded = true
documentsFormat string Формат документов: "Оригинал", "Копия", "Заверенная копия" Да, если isForwarded = true
auctionTime string Длительность торгов в формате HH:mm. Если значение не указано, окончание торгов произойдет в момент самой ранней погрузки Да, если isAuctionAutoComplete = true
auctionBidStep number Шаг торгов. Обязательно > 0. Да, если проброс в закрытый хаб
isAuctionAutoComplete boolean Автовыбор при закрытых торгах Да, если проброс в закрытый хаб
isAuction boolean Необходимо проведение торгов Да, проброс в открытый/закрытый хаб
isAuctionAutoExtend boolean Автопродление торгов Да, если isAuctionAutoComplete = true
isPriceOnlyDescend boolean Цена на понижение Да, если проброс в закрытый хаб
auctionExtendActivationTime string Время активации автопродления, мин (максимальное значение 59 мин) Да, если isAuctionAutoExtend = true
auctionExtendTime string Время продления торгов, мин (максимальное значение 59 мин) Да, если isAuctionAutoExtend = true
extendTimeLimit string Максимальная длительность автопродления, HH:mm (максимальное значение 23 ч 59 мин) Да, если isAuctionAutoExtend = true
isForwarded boolean В хаб или на исполнителя (В черновики - false; На открытый/закрытый хаб - true) Нет
comment string Комментарий Нет
executorRoleType string Роль исполнителя заказа: 0 — любая, 1 — экспедитор, 2 — перевозчик (На открытый хаб - не указывать поле) Нет
forwardedPrice number Стоимость перевозки для проброса Да, если прямой проброс или isPriceOnlyDescend = true
externalId string Внешний идентификатор клиента Нет
otherConditionsText string Особые условия Нет
cost object Информация о стоимости и способе оплаты Нет

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

Параметр Тип Значение Обязательный
externalId string Внешний идентификатор места Да
loadingAddress object Информация об адресе погрузки Да
unloadingAddress object Информация об адресе выгрузки Да
shipment object Информация об отправлении Да
delivery object Информация о получении Да
sender object Информация о грузоотправителе Да
recipient object Информация о грузополучателе Да
dimensions object Информация о габаритах груза Да
options object Опции заказа Да
name string Название груза Нет
assessedValue double Объявленная стоимость груза Нет
senderContacts array of objects Контакты при погрузке Нет
recipientContacts array of objects Контакты при выгрузке Нет

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

Параметр Тип Значение Обязательный
assessedValue double Объявленная стоимость груза Нет

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

Параметр Тип Значение Обязательный
bodyTypes array of strings Типы кузова Да
cargoCategories array of strings Идентификаторы выбранных категорий товара Нет
loadingTypes array of strings Идентификаторы выбранных типов загрузки Нет
temperatureRegimes array of strings Идентификаторы выбранных температурных режимов Нет
bodyTypeComment string Комментарий к типу кузова Нет
cargoSubCategory string Подкатегория Нет

Параметры, вложенные в loadingAddress или unloadingAddress

Параметр Тип Значение Обязательный
fullAddress string Адрес Да
country string Страна Да
locality string Город Да
region string Регион Да
postalCode string Почтовый код Нет
apartment string Квартира Нет
building string Строение Нет
house string Дом Нет
housing string Владение Нет
street string Улица Нет
kladr string КЛАДР Нет
kladrRegion string Регион КЛАДР Нет

Параметры, вложенные в customer, sender или recipient

Параметр Тип Значение Обязательный
inn string ИНН Да
type int Тип заказчика: 0 — юридическое лицо, 1 — ИП, 2 — физическое лицо Да
name string Название юридического лица Да, если type=0
firstName string Имя заказчика Да, если type=1 или type=2
lastName string Фамилия заказчика Да, если type=1 или type=2
middleName string Отчество заказчика Нет
address string Адрес заказчика Нет

Параметры, вложенные в shipment или delivery

Параметр Тип Значение Обязательный
dateFrom string Начало интервала подачи ТС (в формате YYYY-MM-DD) Да
dateTo string Конец интервала подачи ТС (в формате YYYY-MM-DD) Да
hourFrom string Время начала интервала подачи ТС (в формате HH:mm) Да
hourTo string Время начала интервала подачи ТС (в формате HH:mm) Да
range int Интервал погрузочно-разгрузочных работ в часах Да

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

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

Параметры, вложенные в senderContacts или recipientContacts

Параметр Тип Значение Обязательный
phone string Телефон Нет
firstName string Имя Нет
lastName string Фамилия Нет
middleName string Отчество Нет
countryCode string Страна Нет

Пример запроса

{
   "comment": "Груз",
   "externalId": "91fd0716-736e-48eb-b944-6eb7a0df1474",
   "customer": {
       "firstName": "",
       "id": 0,
       "inn": "1234567890",
       "countryCode": "",
       "lastName": "",
       "middleName": "",
       "name": "ООО РОМАШКА",
       "type": 0,
       "address": " г Москва, Ленинский пр-кт, д 10А"
   },
   "cost": {
       "assessedValue": 350000
   },
   "options": {
     "bodyTypes": ["daedf841-9d05-4a02-bc50-09a3cdddcf3c"],
     "cargoCategories": ["5b699787-d816-4d23-9ceb-83fd9b46416e"],
     "cargoSubCategories": ["Фрукты"],
     "loadingTypes": ["540fa155-4ae4-4d97-bf01-00682b3d6944"],
     "temperatureRegimes": ["5 — 25 °C"],
     "bodyTypeComment": "Чистый кузов",
   },
   "id": "e5112ea5-0dc7-44d8-8565-633258a48108",
   "price": 25000,
   "places": [
       {
           "externalId": "ede96dfe-24fe-4ef9-8b3f-c77e1997d93a",
           "name": "[Ftl] Коробки",
           "loadingAddress": {
                "postalCode": "",
                "fullAddress": "Россия, Москва, улица Большая Якиманка, 32с2",
                "country": "Россия",
                "geoId": 0,
                "apartment": "",
                "building": "",
                "house": "32с2",
                "housing": "",
                "locality": "Москва",
                "region": "Центральный федеральный округ;Москва",
                "street": "улица Большая Якиманка",
                "kladr": "",
                "kladrRegion": ""
            },
            "unloadingAddress": {
                "postalCode": "",
                "fullAddress": "Россия, Белгород, микрорайон Репное, 3-й Земский переулок, 2А",
                "country": "Россия",
                "geoId": 0,
                "apartment": "",
                "building": "",
                "house": "2А",
                "housing": "",
                "locality": "Белгород",
                "region": "Центральный федеральный округ;Белгородская область",
                "street": "3-й Земский переулок",
                "kladr": "",
                "kladrRegion": ""
            },
           "dimensions": {
               "length": 500,
               "height": 90,
               "width": 115,
               "volume": 20.7,
               "weight": 4000
           },
           "assessedValue": 175000,
           "shipment": {
               "date": "2022-03-04",
               "hourFrom": "12:00",
               "range": 15
           },
           "delivery": {
               "date": "2022-03-07",
               "hourFrom": "15:00",
               "range": 12
           },
           "sender": {
               "firstName": "",
               "id": 0,
               "inn": "2222222222",
               "lastName": "",
               "middleName": "",
               "name": "ООО ПОГРУЗКА",
               "type": 0,
               "address": " г Санкт-Петербург, Лиговский пр-кт, д 1"
           },
           "recipient": {
               "firstName": "",
               "id": 0,
               "inn": "1111111111",
               "lastName": "",
               "middleName": "",
               "name": "ООО ВЫГРУЗКА",
               "type": 0,
               "address": " г Москва, Кутузовский пр-кт, д 10"
           },
           "senderContacts": [
               {
                   "phone": "+79000000001",
                   "firstName": "Иван",
                   "lastName": "Иванов",
                   "middleName": "Иванович",
               },
               {
                   "phone": "+79000000003",
                   "firstName": "Иван",
                   "lastName": "Петров",
                   "middleName": "Иванович",
               }
           ],
           "recipientContacts": [
               {
                   "phone": "+79260000002",
                   "firstName": "Иван",
                   "lastName": "Сидоров",
                   "middleName": "Иванович",
               }
           ]
       },
       {
           "externalId": "f8404cb2-b89a-4615-9a74-31355a0de4ba",
           "name": "[Ftl] Сахар песок",
           "loadingAddress": {
               "postalCode": "333333",
               "fullAddress": " г Воронеж, ул Ленина, д 10",
               "country": "Россия",
               "geoId": 0,
               "apartment": null,
               "building": null,
               "house": "1",
               "housing": "",
               "locality": "Воронеж",
               "region": "Воронежская",
               "street": "Ленина",
               "kladr": "4801200002400090001",
               "kladrRegion": "4800000000000"
           },
           "unloadingAddress": {
               "postalCode": "222222",
               "fullAddress": "г Ростов-на-Дону, пр-кт Сельмаш, д 1а",
               "country": "Россия",
               "geoId": 0,
               "apartment": null,
               "building": null,
               "house": "41",
               "housing": "",
               "locality": "Ростов-на-Дону",
               "region": "Ростовская",
               "street": "Сельмаш",
               "kladr": "6100000100011410081",
               "kladrRegion": "6100000000000"
           },
           "dimensions": {
               "length": 500,
               "height": 90,
               "width": 115,
               "volume": 20.7,
               "weight": 4000
           },
           "assessedValue": 175000,
           "shipment": {
               "date": "2022-03-07",
               "hourFrom": "18:00",
               "range": 15
           },
           "delivery": {
               "date": "2022-03-09",
               "hourFrom": "13:00",
               "range": 13
           },
           "sender": {
               "firstName": "",
               "id": 0,
               "inn": "2222222222",
               "lastName": "",
               "middleName": "",
               "name": "ООО ПОГРУЗКА",
               "type": 0,
               "address": " г Санкт-Петербург, Лиговский пр-кт, д 1"
           },
           "recipient": {
               "firstName": "",
               "id": 0,
               "inn": "1111111111",
               "lastName": "",
               "middleName": "",
               "name": "ООО ВЫГРУЗКА",
               "type": 0,
               "address": " г Москва, Кутузовский пр-кт, д 10"
           },
           "senderContacts": [
               {
                   "phone": "+79000000004",
                   "firstName": "Иван",
                   "lastName": "Сидоров",
                   "middleName": "Иванович",
               }
           ],
           "recipientContacts": [
               {
                   "phone": "+79000000008",
                   "firstName": "Иван",
                   "lastName": "Смирнов",
                   "middleName": "Иванович",
               }
           ]
       }
   ],
   "isForwarded": true,
   "executorRoleType": "0",
   "forwardToOrganizationIds": [
       "3fa85f64-5717-4562-b3fc-2c963f66afa6"
   ],
   "forwardedPrice": 1000,
   "executorLineClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "documentExchangeDaysAfterFreightUnloading": "30",
   "daysAfterDocumentsReceiveForPayment": "30",
   "documentsFormat": "Оригинал",
   "otherConditionsText": "Особые условия",
   "auctionTime": "24:00",
   "auctionBidStep": 500,
   "isAuction": true, 
   "isAuctionAutoComplete": true,
   "isAuctionAutoExtend": true,
   "isPriceOnlyDescend": true,
}

Ответ

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

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

Параметр Тип Значение
isSuccess boolean Успешный ли запрос
message string Сообщение

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