Обезличенные сделки

API обезличенных сделок

Описание

API для получения ваших сделок в обезличенном виде. Мы не получаем информацию о вас и ваших контрагентах. Через API передаются общие данные по сделке и грузу.

Обязательные параметры для передачи:

• дата погрузки;
• город или регион загрузки;
• город или регион разгрузки;
• расстояние;
• вес или объем груза;
• догруз или отдельная машина;
• тип кузова;
• ставка, с указанием типа.

Доступ к API

По вопросам обращайтесь к Александру Вильде.

Email: sas@ati.su

Телефон: + 7-812-602-01-04 доб.108

Методы

Предоставление обезличенных сделок

Передать нам обезличенные сделки. Массив json-объектов с параметрами, стандартизированными в ATI.SU.

Предоставить обезличенные сделки

post /impersonaldeals/v1/give_deals

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
demo	boolean	query	Если `true`, сделки проходят ту же валидацию, что и при реальной отправке, но не сохраняются и не тарифицируются (тестовый режим). Пример: false

Запрос

Модель

{...}

Тело запроса на предоставление обезличенных сделок.

Data*:[{...}]

Сделки, которые вы хотите передать

LoadId*: string

Минимальное количество символов: 1

Идентификатор груза в вашей системе (либо хэш идентификаторов, если несколько). Минимальное количество символов: 1. Не передавайте в одном пакете одинаковый LoadId.

Date*: string

Дата погрузки, в формате ISO-8601, без времени: YYYY-MM-DD

From*:{...}

Гео-пункт загрузки

AtiId:{...}

Гео-точка ATI.SU.

Id*: integer

>=1 and <= 2147483647

ID гео-пункта. Используется для города, региона или страны. Город — значение поля id в структуре city, регион — значение поля id в структуре region, страна — значение поля id в структуре country из словаря ATI.SU

Type*: integer

Тип гео-пункта

• 0 - страна
• 1 - регион
• 2 - город

}

FiasId: string

FiasId гео-пункта. Значение fias_id из словаря Fias.

• Пример: C2DEB16A-0330-4F05-821F-1D09C93331E6 - Санкт-Петербург

Text: string

Текстовое поле для описания гео-пункта.

• Пример: город Санкт-Петербург, улица Народного Ополчения 10

}

To*:{...}

Гео-пункт разгрузки

AtiId:{...}

Гео-точка ATI.SU.

Id*: integer

>=1 and <= 2147483647

ID гео-пункта. Используется для города, региона или страны. Город — значение поля id в структуре city, регион — значение поля id в структуре region, страна — значение поля id в структуре country из словаря ATI.SU

Type*: integer

Тип гео-пункта

• 0 - страна
• 1 - регион
• 2 - город

}

FiasId: string

FiasId гео-пункта. Значение fias_id из словаря Fias.

• Пример: C2DEB16A-0330-4F05-821F-1D09C93331E6 - Санкт-Петербург

Text: string

Текстовое поле для описания гео-пункта.

• Пример: город Санкт-Петербург, улица Народного Ополчения 10

}

ExtraPointsCityCount:

Количество дополнительных точек на маршруте

ANY-OF

integer

>=0

null

ExtraPointsCities:

Доп. точки маршрута в том же формате, что и From/To:
значение поля id в структуре city из словаря городов ATI.SU
или fias_id из словаря Fias или текст

ANY-OF

0:[]

null

Distance: integer

>=0

Расстояние маршрута в километрах. Если не передать, расстояние рассчитывается автоматически — но только когда и From, и To заданы городами. Если хотя бы один из пунктов — регион или страна, параметр обязателен.

CargoTypeId:

Идентификатор наименования груза.
Значение поля dictionary_item_id из
словаря наименований грузов.
Словарь нужно запрашивать с параметром attributeFieldFormat=2, иначе attributes_dictionary в ответе не вернётся.

ANY-OF

integer

>=0

null

ADR:

Параметр, определяющий степень опасности груза. Допустимое значение от 0 до 9

ANY-OF

integer

>=0 and <= 9

null

Weight:

Вес груза в тоннах. Обязательный параметр, если не задан параметр Volume.

ANY-OF

number

>=0 and <= 100

null

Volume:

Объем груза в кубических метрах. Обязательный параметр, если не задан параметр Weight.

ANY-OF

number

>=0 and <= 200

null

PalletCount:

Количество упаковок для груза

ANY-OF

integer

>=0

null

CarType*: integer

Тип кузова. Значение поля mask из attributes_dictionary словаря кузовов ATI.SU. Словарь нужно запрашивать с параметром attributeFieldFormat=2, иначе attributes_dictionary в ответе не вернётся. В словаре атрибуты приходят строками, а поле ожидает число: передавайте "1" как 1. Не передавайте dictionary_item_id — это идентификатор элемента словаря, а не маска кузова.

DogruzType*: integer

Вариант перевозки:

• 1 - отдельной машиной
• 2 - только догрузом

Rate*: number

>=1

Ставка, по которой совершена сделка

CurrencyId*: integer

>=0

Валюта ставки в сделке. Значение поля dictionary_item_id из словаря валют ATI.SU. Словарь нужно запрашивать с параметром attributeFieldFormat=2, иначе attributes_dictionary в ответе не вернётся.

PaymentType*: integer

Параметр, определяющий тип ставки.

• 1 - нал
• 2 - с НДС
• 3 - без НДС

Executor:

Параметр, определяющий исполнителя перевозки:
* 1 - перевозчик — если сделка между вами и перевозчиком
* 2 - экспедитор — если сделка между вами и грузовладельцем
* null - неизвестно

ANY-OF

integer

null

}]

}

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

CURL

curl 'https://api.ati.su/impersonaldeals/v1/give_deals' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"Data":[{"LoadId":"E45CCE73-Q040-6641-A19A-FFFFFFFFFFFF","Date":"2021-01-01","From":{"AtiId":{"Id":3611,"Type":2}},"To":{"AtiId":{"Id":1,"Type":2}},"Distance":750,"Weight":45.5,"CarType":1,"DogruzType":1,"Rate":"27500.00","CurrencyId":1,"PaymentType":2,"Executor":1}]}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/impersonaldeals/v1/give_deals", "{""Data"":[{""LoadId"":""E45CCE73-Q040-6641-A19A-FFFFFFFFFFFF"",""Date"":""2021-01-01"",""From"":{""AtiId"":{""Id"":3611,""Type"":2}},""To"":{""AtiId"":{""Id"":1,""Type"":2}},""Distance"":750,""Weight"":45.5,""CarType"":1,""DogruzType"":1,""Rate"":""27500.00"",""CurrencyId"":1,""PaymentType"":2,""Executor"":1}]}");

Ответ

200 Ваши данные успешно приняты. Тело ответа — boolean `true`. При `demo=true` означает, что сделки прошли валидацию, но сохранены не были.

Модель

boolean

Пример

true

402 Не удалось начислить атисы, сделки не были загружены. Код: `FACELESS_52_GIVE_DEALS_BILLING_ERROR`

Модель

{...}

Формат возвращаемых ошибок.
Сервис возвращает ошибки в двух видах, различать их нужно по error_list:
* error_list пуст — произошла одна ошибка, она описана в полях
error, reason и details;
* error_list не пуст — ошибок несколько, разбирать нужно каждый его
элемент, а верхнеуровневый error в этом случае всегда равен
validation_errors.
Как разбирать ошибку:
1. Ветвите логику по error — это стабильный машинный код.
2. reason предназначен для показа пользователю. Текст может меняться,
разбирать его не нужно.
3. details.location указывает на поле, вызвавшее ошибку.
4. details.index и details.LoadId указывают на конкретную сделку
в массиве Data и заполняются только для /v1/give_deals.

error*:

Машинный код ошибки.
Для ответов с несколькими ошибками (непустой error_list)
принимает фиксированное значение validation_errors.

ANY-OF

enum

[FACELESS_1_UNKNOWN, FACELESS_2_UNRECOGNIZED_ADDRESS, FACELESS_3_UNCALCULATED_DISTANCE, FACELESS_4_DISTANCE_NEEDED_FOR_REGION, FACELESS_5_SPECIFY_EXTRA_POINT, FACELESS_6_PRICE_ABOVE_MARKET, FACELESS_7_WRONG_CARTYPE, FACELESS_8_WRONG_DOGRUZ_TYPE, FACELESS_9_WRONG_PAYMENT_TYPE, FACELESS_10_WRONG_EXECUTOR, FACELESS_11_ZERO_RATE, FACELESS_12_RATE_IS_NOT_A_NUMBER, FACELESS_13_FUTURE_DATE, FACELESS_14_WRONG_DATE_FORMAT, FACELESS_15_WEIGHT_OR_VOLUME_NEEDED, FACELESS_16_NOT_EQUAL_GEO_POINTS, FACELESS_17_INVALID_FIAS_ID, FACELESS_18_FIAS_ID_NOT_FOUND, FACELESS_19_NOT_ENOUGH_GEO_POINTS, FACELESS_20_NEED_EXTRAPOINTS_DISTANCE, FACELESS_21_UNSUPPORTED_GEO_POINT_TYPE, FACELESS_22_NEEDED_GEO_POINT, FACELESS_23_MANY_GEO_TYPES, FACELESS_25_WRONG_ATI_GEO_POINT_TYPE, FACELESS_26_ATI_COUNTRY_NOT_FOUND, FACELESS_27_ATI_REGION_NOT_FOUND, FACELESS_28_ATI_CITY_NOT_FOUND, FACELESS_29_EQUAL_LOAD_ID, FACELESS_30_WRONG_ADR, FACELESS_31_FROM_OR_TO_NEEDED, FACELESS_32_START_DATE_GT_END_DATE, FACELESS_33_BAD_COUNTRY, FACELESS_34_NO_LOAD_ID, FACELESS_35_PRICE_BELOW_MARKET, FACELESS_36_DEAL_IS_TOO_OLD, FACELESS_37_FIELD_REQUIRED, FACELESS_38_JSON_DECODE, FACELESS_39_DEALS_NOT_FOUND, FACELESS_40_LARGE_DEALS_NUMBER_TIMEOUT, FACELESS_41_LARGE_DEALS_NUMBER_SIZE, FACELESS_42_FORBIDDEN, FACELESS_43_UNPROCESSABLE_INPUT, FACELESS_44_SQL_ERROR, FACELESS_45_DATE_OUT_OF_RANGE, FACELESS_46_MIN_DEALS_BLOCK, FACELESS_47_MAX_DEALS_BLOCK, FACELESS_48_DATE_BLOCK, FACELESS_49_GET_DEALS_BILLING_ERROR, FACELESS_50_PAYMENT_FORBIDDEN, FACELESS_51_NOT_ENOUGH_MONEY, FACELESS_52_GIVE_DEALS_BILLING_ERROR, FACELESS_53_VALIDATION_ERROR, FACELESS_54_CONDITION_ERROR, FACELESS_55_WRONG_CAR_TYPE_ID, FACELESS_56_WRONG_CURRENCY_ID, FACELESS_57_WRONG_CARGO_TYPE_ID, FACELESS_58_WRONG_CARTYPE]

Машинный код ошибки сервиса.

enum

[validation_errors]

reason*: string

Человекочитаемое описание ошибки.

details:

Детали ошибки (null, если их нет).
Для ответов с несколькими ошибками всегда null: детали каждой ошибки
лежат в соответствующем элементе error_list.

ANY-OF

1:{...}

Детали ошибки.
Набор заполненных полей зависит от вида ошибки: незаполненные поля
в ответе отсутствуют. Само наличие поля — признак того, что ошибка
относится к соответствующей сущности.

location:

Путь до поля, к которому относится ошибка.
Сегменты пути разделены ->.
* Для /v1/give_deals путь начинается с Data -> <индекс сделки>.
* Для остальных методов путь состоит из имени поля, например StartDate.
* Пустая строка, если ошибка относится к телу запроса целиком.

ANY-OF

string

null

index:

Индекс сделки в массиве Data. Только для /v1/give_deals.

ANY-OF

integer

null

LoadId:

LoadId сделки, к которой относится ошибка.
Только для /v1/give_deals. Может быть null, если поле не передали.

ANY-OF

string

integer

null

msg:

Исходный текст ошибки Pydantic. Только для FACELESS_53_VALIDATION_ERROR.

ANY-OF

string

null

type:

Исходный тип ошибки Pydantic. Только для FACELESS_53_VALIDATION_ERROR.

ANY-OF

string

null

acceptedIndex:

Индекс сделки, которая была записана из группы дубликатов.
Только для FACELESS_29_EQUAL_LOAD_ID.

ANY-OF

integer

null

dublicateIndexes:

Индексы всех сделок-дубликатов в группе.
Только для FACELESS_29_EQUAL_LOAD_ID.

ANY-OF

0: [integer]

null

indexesByLoadId:

Индексы сделок, сгруппированные по повторяющемуся LoadId.
Только для FACELESS_29_EQUAL_LOAD_ID, обнаруженной до разбора пакета по сделкам.

ANY-OF

1:{}

null

about:

Пояснение по получению доступа. Только для FACELESS_42_FORBIDDEN.

ANY-OF

string

null

}

null

error_list*:[{...}]

Список ошибок. Пуст, если произошла одна ошибка — тогда она описана в полях выше.

error*: enum

[FACELESS_1_UNKNOWN, FACELESS_2_UNRECOGNIZED_ADDRESS, FACELESS_3_UNCALCULATED_DISTANCE, FACELESS_4_DISTANCE_NEEDED_FOR_REGION, FACELESS_5_SPECIFY_EXTRA_POINT, FACELESS_6_PRICE_ABOVE_MARKET, FACELESS_7_WRONG_CARTYPE, FACELESS_8_WRONG_DOGRUZ_TYPE, FACELESS_9_WRONG_PAYMENT_TYPE, FACELESS_10_WRONG_EXECUTOR, FACELESS_11_ZERO_RATE, FACELESS_12_RATE_IS_NOT_A_NUMBER, FACELESS_13_FUTURE_DATE, FACELESS_14_WRONG_DATE_FORMAT, FACELESS_15_WEIGHT_OR_VOLUME_NEEDED, FACELESS_16_NOT_EQUAL_GEO_POINTS, FACELESS_17_INVALID_FIAS_ID, FACELESS_18_FIAS_ID_NOT_FOUND, FACELESS_19_NOT_ENOUGH_GEO_POINTS, FACELESS_20_NEED_EXTRAPOINTS_DISTANCE, FACELESS_21_UNSUPPORTED_GEO_POINT_TYPE, FACELESS_22_NEEDED_GEO_POINT, FACELESS_23_MANY_GEO_TYPES, FACELESS_25_WRONG_ATI_GEO_POINT_TYPE, FACELESS_26_ATI_COUNTRY_NOT_FOUND, FACELESS_27_ATI_REGION_NOT_FOUND, FACELESS_28_ATI_CITY_NOT_FOUND, FACELESS_29_EQUAL_LOAD_ID, FACELESS_30_WRONG_ADR, FACELESS_31_FROM_OR_TO_NEEDED, FACELESS_32_START_DATE_GT_END_DATE, FACELESS_33_BAD_COUNTRY, FACELESS_34_NO_LOAD_ID, FACELESS_35_PRICE_BELOW_MARKET, FACELESS_36_DEAL_IS_TOO_OLD, FACELESS_37_FIELD_REQUIRED, FACELESS_38_JSON_DECODE, FACELESS_39_DEALS_NOT_FOUND, FACELESS_40_LARGE_DEALS_NUMBER_TIMEOUT, FACELESS_41_LARGE_DEALS_NUMBER_SIZE, FACELESS_42_FORBIDDEN, FACELESS_43_UNPROCESSABLE_INPUT, FACELESS_44_SQL_ERROR, FACELESS_45_DATE_OUT_OF_RANGE, FACELESS_46_MIN_DEALS_BLOCK, FACELESS_47_MAX_DEALS_BLOCK, FACELESS_48_DATE_BLOCK, FACELESS_49_GET_DEALS_BILLING_ERROR, FACELESS_50_PAYMENT_FORBIDDEN, FACELESS_51_NOT_ENOUGH_MONEY, FACELESS_52_GIVE_DEALS_BILLING_ERROR, FACELESS_53_VALIDATION_ERROR, FACELESS_54_CONDITION_ERROR, FACELESS_55_WRONG_CAR_TYPE_ID, FACELESS_56_WRONG_CURRENCY_ID, FACELESS_57_WRONG_CARGO_TYPE_ID, FACELESS_58_WRONG_CARTYPE]

Машинный код ошибки сервиса.

reason*: string

Человекочитаемое описание ошибки.

details:

Детали ошибки (null, если их нет).

ANY-OF

1:{...}

Детали ошибки.
Набор заполненных полей зависит от вида ошибки: незаполненные поля
в ответе отсутствуют. Само наличие поля — признак того, что ошибка
относится к соответствующей сущности.

location:

Путь до поля, к которому относится ошибка.
Сегменты пути разделены ->.
* Для /v1/give_deals путь начинается с Data -> <индекс сделки>.
* Для остальных методов путь состоит из имени поля, например StartDate.
* Пустая строка, если ошибка относится к телу запроса целиком.

ANY-OF

string

null

index:

Индекс сделки в массиве Data. Только для /v1/give_deals.

ANY-OF

integer

null

LoadId:

LoadId сделки, к которой относится ошибка.
Только для /v1/give_deals. Может быть null, если поле не передали.

ANY-OF

string

integer

null

msg:

Исходный текст ошибки Pydantic. Только для FACELESS_53_VALIDATION_ERROR.

ANY-OF

string

null

type:

Исходный тип ошибки Pydantic. Только для FACELESS_53_VALIDATION_ERROR.

ANY-OF

string

null

acceptedIndex:

Индекс сделки, которая была записана из группы дубликатов.
Только для FACELESS_29_EQUAL_LOAD_ID.

ANY-OF

integer

null

dublicateIndexes:

Индексы всех сделок-дубликатов в группе.
Только для FACELESS_29_EQUAL_LOAD_ID.

ANY-OF

0: [integer]

null

indexesByLoadId:

Индексы сделок, сгруппированные по повторяющемуся LoadId.
Только для FACELESS_29_EQUAL_LOAD_ID, обнаруженной до разбора пакета по сделкам.

ANY-OF

1:{}

null

about:

Пояснение по получению доступа. Только для FACELESS_42_FORBIDDEN.

ANY-OF

string

null

}

null

}]

}

Пример

{...}

"error":"FACELESS_52_GIVE_DEALS_BILLING_ERROR",

"reason":"Мы не смогли начислить атисы. Сделки не были загружены. Повторите загрузку позже.",

"error_list":[]

}

403 Доступ запрещён. Возможные коды: `FACELESS_42_FORBIDDEN`, `FACELESS_48_DATE_BLOCK`

Модель

{...}

Формат возвращаемых ошибок.
Сервис возвращает ошибки в двух видах, различать их нужно по error_list:
* error_list пуст — произошла одна ошибка, она описана в полях
error, reason и details;
* error_list не пуст — ошибок несколько, разбирать нужно каждый его
элемент, а верхнеуровневый error в этом случае всегда равен
validation_errors.
Как разбирать ошибку:
1. Ветвите логику по error — это стабильный машинный код.
2. reason предназначен для показа пользователю. Текст может меняться,
разбирать его не нужно.
3. details.location указывает на поле, вызвавшее ошибку.
4. details.index и details.LoadId указывают на конкретную сделку
в массиве Data и заполняются только для /v1/give_deals.

error*:

Машинный код ошибки.
Для ответов с несколькими ошибками (непустой error_list)
принимает фиксированное значение validation_errors.

ANY-OF

enum

[FACELESS_1_UNKNOWN, FACELESS_2_UNRECOGNIZED_ADDRESS, FACELESS_3_UNCALCULATED_DISTANCE, FACELESS_4_DISTANCE_NEEDED_FOR_REGION, FACELESS_5_SPECIFY_EXTRA_POINT, FACELESS_6_PRICE_ABOVE_MARKET, FACELESS_7_WRONG_CARTYPE, FACELESS_8_WRONG_DOGRUZ_TYPE, FACELESS_9_WRONG_PAYMENT_TYPE, FACELESS_10_WRONG_EXECUTOR, FACELESS_11_ZERO_RATE, FACELESS_12_RATE_IS_NOT_A_NUMBER, FACELESS_13_FUTURE_DATE, FACELESS_14_WRONG_DATE_FORMAT, FACELESS_15_WEIGHT_OR_VOLUME_NEEDED, FACELESS_16_NOT_EQUAL_GEO_POINTS, FACELESS_17_INVALID_FIAS_ID, FACELESS_18_FIAS_ID_NOT_FOUND, FACELESS_19_NOT_ENOUGH_GEO_POINTS, FACELESS_20_NEED_EXTRAPOINTS_DISTANCE, FACELESS_21_UNSUPPORTED_GEO_POINT_TYPE, FACELESS_22_NEEDED_GEO_POINT, FACELESS_23_MANY_GEO_TYPES, FACELESS_25_WRONG_ATI_GEO_POINT_TYPE, FACELESS_26_ATI_COUNTRY_NOT_FOUND, FACELESS_27_ATI_REGION_NOT_FOUND, FACELESS_28_ATI_CITY_NOT_FOUND, FACELESS_29_EQUAL_LOAD_ID, FACELESS_30_WRONG_ADR, FACELESS_31_FROM_OR_TO_NEEDED, FACELESS_32_START_DATE_GT_END_DATE, FACELESS_33_BAD_COUNTRY, FACELESS_34_NO_LOAD_ID, FACELESS_35_PRICE_BELOW_MARKET, FACELESS_36_DEAL_IS_TOO_OLD, FACELESS_37_FIELD_REQUIRED, FACELESS_38_JSON_DECODE, FACELESS_39_DEALS_NOT_FOUND, FACELESS_40_LARGE_DEALS_NUMBER_TIMEOUT, FACELESS_41_LARGE_DEALS_NUMBER_SIZE, FACELESS_42_FORBIDDEN, FACELESS_43_UNPROCESSABLE_INPUT, FACELESS_44_SQL_ERROR, FACELESS_45_DATE_OUT_OF_RANGE, FACELESS_46_MIN_DEALS_BLOCK, FACELESS_47_MAX_DEALS_BLOCK, FACELESS_48_DATE_BLOCK, FACELESS_49_GET_DEALS_BILLING_ERROR, FACELESS_50_PAYMENT_FORBIDDEN, FACELESS_51_NOT_ENOUGH_MONEY, FACELESS_52_GIVE_DEALS_BILLING_ERROR, FACELESS_53_VALIDATION_ERROR, FACELESS_54_CONDITION_ERROR, FACELESS_55_WRONG_CAR_TYPE_ID, FACELESS_56_WRONG_CURRENCY_ID, FACELESS_57_WRONG_CARGO_TYPE_ID, FACELESS_58_WRONG_CARTYPE]

Машинный код ошибки сервиса.

enum

[validation_errors]

reason*: string

Человекочитаемое описание ошибки.

details:

Детали ошибки (null, если их нет).
Для ответов с несколькими ошибками всегда null: детали каждой ошибки
лежат в соответствующем элементе error_list.

ANY-OF

1:{...}

Детали ошибки.
Набор заполненных полей зависит от вида ошибки: незаполненные поля
в ответе отсутствуют. Само наличие поля — признак того, что ошибка
относится к соответствующей сущности.

location:

Путь до поля, к которому относится ошибка.
Сегменты пути разделены ->.
* Для /v1/give_deals путь начинается с Data -> <индекс сделки>.
* Для остальных методов путь состоит из имени поля, например StartDate.
* Пустая строка, если ошибка относится к телу запроса целиком.

ANY-OF

string

null

index:

Индекс сделки в массиве Data. Только для /v1/give_deals.

ANY-OF

integer

null

LoadId:

LoadId сделки, к которой относится ошибка.
Только для /v1/give_deals. Может быть null, если поле не передали.

ANY-OF

string

integer

null

msg:

Исходный текст ошибки Pydantic. Только для FACELESS_53_VALIDATION_ERROR.

ANY-OF

string

null

type:

Исходный тип ошибки Pydantic. Только для FACELESS_53_VALIDATION_ERROR.

ANY-OF

string

null

acceptedIndex:

Индекс сделки, которая была записана из группы дубликатов.
Только для FACELESS_29_EQUAL_LOAD_ID.

ANY-OF

integer

null

dublicateIndexes:

Индексы всех сделок-дубликатов в группе.
Только для FACELESS_29_EQUAL_LOAD_ID.

ANY-OF

0: [integer]

null

indexesByLoadId:

Индексы сделок, сгруппированные по повторяющемуся LoadId.
Только для FACELESS_29_EQUAL_LOAD_ID, обнаруженной до разбора пакета по сделкам.

ANY-OF

1:{}

null

about:

Пояснение по получению доступа. Только для FACELESS_42_FORBIDDEN.

ANY-OF

string

null

}

null

error_list*:[{...}]

Список ошибок. Пуст, если произошла одна ошибка — тогда она описана в полях выше.

error*: enum

[FACELESS_1_UNKNOWN, FACELESS_2_UNRECOGNIZED_ADDRESS, FACELESS_3_UNCALCULATED_DISTANCE, FACELESS_4_DISTANCE_NEEDED_FOR_REGION, FACELESS_5_SPECIFY_EXTRA_POINT, FACELESS_6_PRICE_ABOVE_MARKET, FACELESS_7_WRONG_CARTYPE, FACELESS_8_WRONG_DOGRUZ_TYPE, FACELESS_9_WRONG_PAYMENT_TYPE, FACELESS_10_WRONG_EXECUTOR, FACELESS_11_ZERO_RATE, FACELESS_12_RATE_IS_NOT_A_NUMBER, FACELESS_13_FUTURE_DATE, FACELESS_14_WRONG_DATE_FORMAT, FACELESS_15_WEIGHT_OR_VOLUME_NEEDED, FACELESS_16_NOT_EQUAL_GEO_POINTS, FACELESS_17_INVALID_FIAS_ID, FACELESS_18_FIAS_ID_NOT_FOUND, FACELESS_19_NOT_ENOUGH_GEO_POINTS, FACELESS_20_NEED_EXTRAPOINTS_DISTANCE, FACELESS_21_UNSUPPORTED_GEO_POINT_TYPE, FACELESS_22_NEEDED_GEO_POINT, FACELESS_23_MANY_GEO_TYPES, FACELESS_25_WRONG_ATI_GEO_POINT_TYPE, FACELESS_26_ATI_COUNTRY_NOT_FOUND, FACELESS_27_ATI_REGION_NOT_FOUND, FACELESS_28_ATI_CITY_NOT_FOUND, FACELESS_29_EQUAL_LOAD_ID, FACELESS_30_WRONG_ADR, FACELESS_31_FROM_OR_TO_NEEDED, FACELESS_32_START_DATE_GT_END_DATE, FACELESS_33_BAD_COUNTRY, FACELESS_34_NO_LOAD_ID, FACELESS_35_PRICE_BELOW_MARKET, FACELESS_36_DEAL_IS_TOO_OLD, FACELESS_37_FIELD_REQUIRED, FACELESS_38_JSON_DECODE, FACELESS_39_DEALS_NOT_FOUND, FACELESS_40_LARGE_DEALS_NUMBER_TIMEOUT, FACELESS_41_LARGE_DEALS_NUMBER_SIZE, FACELESS_42_FORBIDDEN, FACELESS_43_UNPROCESSABLE_INPUT, FACELESS_44_SQL_ERROR, FACELESS_45_DATE_OUT_OF_RANGE, FACELESS_46_MIN_DEALS_BLOCK, FACELESS_47_MAX_DEALS_BLOCK, FACELESS_48_DATE_BLOCK, FACELESS_49_GET_DEALS_BILLING_ERROR, FACELESS_50_PAYMENT_FORBIDDEN, FACELESS_51_NOT_ENOUGH_MONEY, FACELESS_52_GIVE_DEALS_BILLING_ERROR, FACELESS_53_VALIDATION_ERROR, FACELESS_54_CONDITION_ERROR, FACELESS_55_WRONG_CAR_TYPE_ID, FACELESS_56_WRONG_CURRENCY_ID, FACELESS_57_WRONG_CARGO_TYPE_ID, FACELESS_58_WRONG_CARTYPE]

Машинный код ошибки сервиса.

reason*: string

Человекочитаемое описание ошибки.

details:

Детали ошибки (null, если их нет).

ANY-OF

1:{...}

Детали ошибки.
Набор заполненных полей зависит от вида ошибки: незаполненные поля
в ответе отсутствуют. Само наличие поля — признак того, что ошибка
относится к соответствующей сущности.

location:

Путь до поля, к которому относится ошибка.
Сегменты пути разделены ->.
* Для /v1/give_deals путь начинается с Data -> <индекс сделки>.
* Для остальных методов путь состоит из имени поля, например StartDate.
* Пустая строка, если ошибка относится к телу запроса целиком.

ANY-OF

string

null

index:

Индекс сделки в массиве Data. Только для /v1/give_deals.

ANY-OF

integer

null

LoadId:

LoadId сделки, к которой относится ошибка.
Только для /v1/give_deals. Может быть null, если поле не передали.

ANY-OF

string

integer

null

msg:

Исходный текст ошибки Pydantic. Только для FACELESS_53_VALIDATION_ERROR.

ANY-OF

string

null

type:

Исходный тип ошибки Pydantic. Только для FACELESS_53_VALIDATION_ERROR.

ANY-OF

string

null

acceptedIndex:

Индекс сделки, которая была записана из группы дубликатов.
Только для FACELESS_29_EQUAL_LOAD_ID.

ANY-OF

integer

null

dublicateIndexes:

Индексы всех сделок-дубликатов в группе.
Только для FACELESS_29_EQUAL_LOAD_ID.

ANY-OF

0: [integer]

null

indexesByLoadId:

Индексы сделок, сгруппированные по повторяющемуся LoadId.
Только для FACELESS_29_EQUAL_LOAD_ID, обнаруженной до разбора пакета по сделкам.

ANY-OF

1:{}

null

about:

Пояснение по получению доступа. Только для FACELESS_42_FORBIDDEN.

ANY-OF

string

null

}

null

}]

}

Пример

{...}

"error":"FACELESS_42_FORBIDDEN",

"reason":"У вас нет доступа к этому API!",

"details":{...},

"about":"Доступ к API предоставляется по запросу. По вопросам подключения обращайтесь к Александру Вильде. Email: sas@ati.su Телефон: + 7-812-602-01-04 доб.108"

},

"error_list":[]

}

411 Все ошибки в пакете — одного кода: не удалось рассчитать расстояние. Если среди ошибок есть хотя бы одна с другим кодом, возвращается 422. Сделки без ошибок при этом сохраняются. Код: `FACELESS_3_UNCALCULATED_DISTANCE`

Модель

{...}

Формат возвращаемых ошибок.
Сервис возвращает ошибки в двух видах, различать их нужно по error_list:
* error_list пуст — произошла одна ошибка, она описана в полях
error, reason и details;
* error_list не пуст — ошибок несколько, разбирать нужно каждый его
элемент, а верхнеуровневый error в этом случае всегда равен
validation_errors.
Как разбирать ошибку:
1. Ветвите логику по error — это стабильный машинный код.
2. reason предназначен для показа пользователю. Текст может меняться,
разбирать его не нужно.
3. details.location указывает на поле, вызвавшее ошибку.
4. details.index и details.LoadId указывают на конкретную сделку
в массиве Data и заполняются только для /v1/give_deals.

error*:

Машинный код ошибки.
Для ответов с несколькими ошибками (непустой error_list)
принимает фиксированное значение validation_errors.

ANY-OF

enum

[FACELESS_1_UNKNOWN, FACELESS_2_UNRECOGNIZED_ADDRESS, FACELESS_3_UNCALCULATED_DISTANCE, FACELESS_4_DISTANCE_NEEDED_FOR_REGION, FACELESS_5_SPECIFY_EXTRA_POINT, FACELESS_6_PRICE_ABOVE_MARKET, FACELESS_7_WRONG_CARTYPE, FACELESS_8_WRONG_DOGRUZ_TYPE, FACELESS_9_WRONG_PAYMENT_TYPE, FACELESS_10_WRONG_EXECUTOR, FACELESS_11_ZERO_RATE, FACELESS_12_RATE_IS_NOT_A_NUMBER, FACELESS_13_FUTURE_DATE, FACELESS_14_WRONG_DATE_FORMAT, FACELESS_15_WEIGHT_OR_VOLUME_NEEDED, FACELESS_16_NOT_EQUAL_GEO_POINTS, FACELESS_17_INVALID_FIAS_ID, FACELESS_18_FIAS_ID_NOT_FOUND, FACELESS_19_NOT_ENOUGH_GEO_POINTS, FACELESS_20_NEED_EXTRAPOINTS_DISTANCE, FACELESS_21_UNSUPPORTED_GEO_POINT_TYPE, FACELESS_22_NEEDED_GEO_POINT, FACELESS_23_MANY_GEO_TYPES, FACELESS_25_WRONG_ATI_GEO_POINT_TYPE, FACELESS_26_ATI_COUNTRY_NOT_FOUND, FACELESS_27_ATI_REGION_NOT_FOUND, FACELESS_28_ATI_CITY_NOT_FOUND, FACELESS_29_EQUAL_LOAD_ID, FACELESS_30_WRONG_ADR, FACELESS_31_FROM_OR_TO_NEEDED, FACELESS_32_START_DATE_GT_END_DATE, FACELESS_33_BAD_COUNTRY, FACELESS_34_NO_LOAD_ID, FACELESS_35_PRICE_BELOW_MARKET, FACELESS_36_DEAL_IS_TOO_OLD, FACELESS_37_FIELD_REQUIRED, FACELESS_38_JSON_DECODE, FACELESS_39_DEALS_NOT_FOUND, FACELESS_40_LARGE_DEALS_NUMBER_TIMEOUT, FACELESS_41_LARGE_DEALS_NUMBER_SIZE, FACELESS_42_FORBIDDEN, FACELESS_43_UNPROCESSABLE_INPUT, FACELESS_44_SQL_ERROR, FACELESS_45_DATE_OUT_OF_RANGE, FACELESS_46_MIN_DEALS_BLOCK, FACELESS_47_MAX_DEALS_BLOCK, FACELESS_48_DATE_BLOCK, FACELESS_49_GET_DEALS_BILLING_ERROR, FACELESS_50_PAYMENT_FORBIDDEN, FACELESS_51_NOT_ENOUGH_MONEY, FACELESS_52_GIVE_DEALS_BILLING_ERROR, FACELESS_53_VALIDATION_ERROR, FACELESS_54_CONDITION_ERROR, FACELESS_55_WRONG_CAR_TYPE_ID, FACELESS_56_WRONG_CURRENCY_ID, FACELESS_57_WRONG_CARGO_TYPE_ID, FACELESS_58_WRONG_CARTYPE]

Машинный код ошибки сервиса.

enum

[validation_errors]

reason*: string

Человекочитаемое описание ошибки.

details:

Детали ошибки (null, если их нет).
Для ответов с несколькими ошибками всегда null: детали каждой ошибки
лежат в соответствующем элементе error_list.

ANY-OF

1:{...}

Детали ошибки.
Набор заполненных полей зависит от вида ошибки: незаполненные поля
в ответе отсутствуют. Само наличие поля — признак того, что ошибка
относится к соответствующей сущности.

location:

Путь до поля, к которому относится ошибка.
Сегменты пути разделены ->.
* Для /v1/give_deals путь начинается с Data -> <индекс сделки>.
* Для остальных методов путь состоит из имени поля, например StartDate.
* Пустая строка, если ошибка относится к телу запроса целиком.

ANY-OF

string

null

index:

Индекс сделки в массиве Data. Только для /v1/give_deals.

ANY-OF

integer

null

LoadId:

LoadId сделки, к которой относится ошибка.
Только для /v1/give_deals. Может быть null, если поле не передали.

ANY-OF

string

integer

null

msg:

Исходный текст ошибки Pydantic. Только для FACELESS_53_VALIDATION_ERROR.

ANY-OF

string

null

type:

Исходный тип ошибки Pydantic. Только для FACELESS_53_VALIDATION_ERROR.

ANY-OF

string

null

acceptedIndex:

Индекс сделки, которая была записана из группы дубликатов.
Только для FACELESS_29_EQUAL_LOAD_ID.

ANY-OF

integer

null

dublicateIndexes:

Индексы всех сделок-дубликатов в группе.
Только для FACELESS_29_EQUAL_LOAD_ID.

ANY-OF

0: [integer]

null

indexesByLoadId:

Индексы сделок, сгруппированные по повторяющемуся LoadId.
Только для FACELESS_29_EQUAL_LOAD_ID, обнаруженной до разбора пакета по сделкам.

ANY-OF

1:{}

null

about:

Пояснение по получению доступа. Только для FACELESS_42_FORBIDDEN.

ANY-OF

string

null

}

null

error_list*:[{...}]

Список ошибок. Пуст, если произошла одна ошибка — тогда она описана в полях выше.

error*: enum

[FACELESS_1_UNKNOWN, FACELESS_2_UNRECOGNIZED_ADDRESS, FACELESS_3_UNCALCULATED_DISTANCE, FACELESS_4_DISTANCE_NEEDED_FOR_REGION, FACELESS_5_SPECIFY_EXTRA_POINT, FACELESS_6_PRICE_ABOVE_MARKET, FACELESS_7_WRONG_CARTYPE, FACELESS_8_WRONG_DOGRUZ_TYPE, FACELESS_9_WRONG_PAYMENT_TYPE, FACELESS_10_WRONG_EXECUTOR, FACELESS_11_ZERO_RATE, FACELESS_12_RATE_IS_NOT_A_NUMBER, FACELESS_13_FUTURE_DATE, FACELESS_14_WRONG_DATE_FORMAT, FACELESS_15_WEIGHT_OR_VOLUME_NEEDED, FACELESS_16_NOT_EQUAL_GEO_POINTS, FACELESS_17_INVALID_FIAS_ID, FACELESS_18_FIAS_ID_NOT_FOUND, FACELESS_19_NOT_ENOUGH_GEO_POINTS, FACELESS_20_NEED_EXTRAPOINTS_DISTANCE, FACELESS_21_UNSUPPORTED_GEO_POINT_TYPE, FACELESS_22_NEEDED_GEO_POINT, FACELESS_23_MANY_GEO_TYPES, FACELESS_25_WRONG_ATI_GEO_POINT_TYPE, FACELESS_26_ATI_COUNTRY_NOT_FOUND, FACELESS_27_ATI_REGION_NOT_FOUND, FACELESS_28_ATI_CITY_NOT_FOUND, FACELESS_29_EQUAL_LOAD_ID, FACELESS_30_WRONG_ADR, FACELESS_31_FROM_OR_TO_NEEDED, FACELESS_32_START_DATE_GT_END_DATE, FACELESS_33_BAD_COUNTRY, FACELESS_34_NO_LOAD_ID, FACELESS_35_PRICE_BELOW_MARKET, FACELESS_36_DEAL_IS_TOO_OLD, FACELESS_37_FIELD_REQUIRED, FACELESS_38_JSON_DECODE, FACELESS_39_DEALS_NOT_FOUND, FACELESS_40_LARGE_DEALS_NUMBER_TIMEOUT, FACELESS_41_LARGE_DEALS_NUMBER_SIZE, FACELESS_42_FORBIDDEN, FACELESS_43_UNPROCESSABLE_INPUT, FACELESS_44_SQL_ERROR, FACELESS_45_DATE_OUT_OF_RANGE, FACELESS_46_MIN_DEALS_BLOCK, FACELESS_47_MAX_DEALS_BLOCK, FACELESS_48_DATE_BLOCK, FACELESS_49_GET_DEALS_BILLING_ERROR, FACELESS_50_PAYMENT_FORBIDDEN, FACELESS_51_NOT_ENOUGH_MONEY, FACELESS_52_GIVE_DEALS_BILLING_ERROR, FACELESS_53_VALIDATION_ERROR, FACELESS_54_CONDITION_ERROR, FACELESS_55_WRONG_CAR_TYPE_ID, FACELESS_56_WRONG_CURRENCY_ID, FACELESS_57_WRONG_CARGO_TYPE_ID, FACELESS_58_WRONG_CARTYPE]

Машинный код ошибки сервиса.

reason*: string

Человекочитаемое описание ошибки.

details:

Детали ошибки (null, если их нет).

ANY-OF

1:{...}

Детали ошибки.
Набор заполненных полей зависит от вида ошибки: незаполненные поля
в ответе отсутствуют. Само наличие поля — признак того, что ошибка
относится к соответствующей сущности.

location:

Путь до поля, к которому относится ошибка.
Сегменты пути разделены ->.
* Для /v1/give_deals путь начинается с Data -> <индекс сделки>.
* Для остальных методов путь состоит из имени поля, например StartDate.
* Пустая строка, если ошибка относится к телу запроса целиком.

ANY-OF

string

null

index:

Индекс сделки в массиве Data. Только для /v1/give_deals.

ANY-OF

integer

null

LoadId:

LoadId сделки, к которой относится ошибка.
Только для /v1/give_deals. Может быть null, если поле не передали.

ANY-OF

string

integer

null

msg:

Исходный текст ошибки Pydantic. Только для FACELESS_53_VALIDATION_ERROR.

ANY-OF

string

null

type:

Исходный тип ошибки Pydantic. Только для FACELESS_53_VALIDATION_ERROR.

ANY-OF

string

null

acceptedIndex:

Индекс сделки, которая была записана из группы дубликатов.
Только для FACELESS_29_EQUAL_LOAD_ID.

ANY-OF

integer

null

dublicateIndexes:

Индексы всех сделок-дубликатов в группе.
Только для FACELESS_29_EQUAL_LOAD_ID.

ANY-OF

0: [integer]

null

indexesByLoadId:

Индексы сделок, сгруппированные по повторяющемуся LoadId.
Только для FACELESS_29_EQUAL_LOAD_ID, обнаруженной до разбора пакета по сделкам.

ANY-OF

1:{}

null

about:

Пояснение по получению доступа. Только для FACELESS_42_FORBIDDEN.

ANY-OF

string

null

}

null

}]

}

Пример

{...}

"error":"validation_errors",

"reason":"Произошли ошибки валидации",

"error_list":[...]

{...}

"error":"FACELESS_3_UNCALCULATED_DISTANCE",

"reason":"Не удалось рассчитать расстояние между точками. Укажите его самостоятельно.",

"details":{...}

"location":"Data -> 0 -> Distance",

"index":0,

"LoadId":"test001"

}

}

]

}

422 Ошибки валидации переданных сделок. Одна сделка может дать несколько ошибок, все они перечислены в `error_list`: `details.index` и `details.LoadId` указывают на проблемную сделку в массиве `Data`, а `details.location` — на конкретное поле. Возможные значения `error` перечислены в схеме `FacelessErrorCode`. Сделки без ошибок при этом сохраняются: ответ 422 не означает, что не принят весь пакет. При `demo=true` не сохраняется ничего, но состав ошибок тот же.

Модель

{...}

Формат возвращаемых ошибок.
Сервис возвращает ошибки в двух видах, различать их нужно по error_list:
* error_list пуст — произошла одна ошибка, она описана в полях
error, reason и details;
* error_list не пуст — ошибок несколько, разбирать нужно каждый его
элемент, а верхнеуровневый error в этом случае всегда равен
validation_errors.
Как разбирать ошибку:
1. Ветвите логику по error — это стабильный машинный код.
2. reason предназначен для показа пользователю. Текст может меняться,
разбирать его не нужно.
3. details.location указывает на поле, вызвавшее ошибку.
4. details.index и details.LoadId указывают на конкретную сделку
в массиве Data и заполняются только для /v1/give_deals.

error*:

Машинный код ошибки.
Для ответов с несколькими ошибками (непустой error_list)
принимает фиксированное значение validation_errors.

ANY-OF

enum

[FACELESS_1_UNKNOWN, FACELESS_2_UNRECOGNIZED_ADDRESS, FACELESS_3_UNCALCULATED_DISTANCE, FACELESS_4_DISTANCE_NEEDED_FOR_REGION, FACELESS_5_SPECIFY_EXTRA_POINT, FACELESS_6_PRICE_ABOVE_MARKET, FACELESS_7_WRONG_CARTYPE, FACELESS_8_WRONG_DOGRUZ_TYPE, FACELESS_9_WRONG_PAYMENT_TYPE, FACELESS_10_WRONG_EXECUTOR, FACELESS_11_ZERO_RATE, FACELESS_12_RATE_IS_NOT_A_NUMBER, FACELESS_13_FUTURE_DATE, FACELESS_14_WRONG_DATE_FORMAT, FACELESS_15_WEIGHT_OR_VOLUME_NEEDED, FACELESS_16_NOT_EQUAL_GEO_POINTS, FACELESS_17_INVALID_FIAS_ID, FACELESS_18_FIAS_ID_NOT_FOUND, FACELESS_19_NOT_ENOUGH_GEO_POINTS, FACELESS_20_NEED_EXTRAPOINTS_DISTANCE, FACELESS_21_UNSUPPORTED_GEO_POINT_TYPE, FACELESS_22_NEEDED_GEO_POINT, FACELESS_23_MANY_GEO_TYPES, FACELESS_25_WRONG_ATI_GEO_POINT_TYPE, FACELESS_26_ATI_COUNTRY_NOT_FOUND, FACELESS_27_ATI_REGION_NOT_FOUND, FACELESS_28_ATI_CITY_NOT_FOUND, FACELESS_29_EQUAL_LOAD_ID, FACELESS_30_WRONG_ADR, FACELESS_31_FROM_OR_TO_NEEDED, FACELESS_32_START_DATE_GT_END_DATE, FACELESS_33_BAD_COUNTRY, FACELESS_34_NO_LOAD_ID, FACELESS_35_PRICE_BELOW_MARKET, FACELESS_36_DEAL_IS_TOO_OLD, FACELESS_37_FIELD_REQUIRED, FACELESS_38_JSON_DECODE, FACELESS_39_DEALS_NOT_FOUND, FACELESS_40_LARGE_DEALS_NUMBER_TIMEOUT, FACELESS_41_LARGE_DEALS_NUMBER_SIZE, FACELESS_42_FORBIDDEN, FACELESS_43_UNPROCESSABLE_INPUT, FACELESS_44_SQL_ERROR, FACELESS_45_DATE_OUT_OF_RANGE, FACELESS_46_MIN_DEALS_BLOCK, FACELESS_47_MAX_DEALS_BLOCK, FACELESS_48_DATE_BLOCK, FACELESS_49_GET_DEALS_BILLING_ERROR, FACELESS_50_PAYMENT_FORBIDDEN, FACELESS_51_NOT_ENOUGH_MONEY, FACELESS_52_GIVE_DEALS_BILLING_ERROR, FACELESS_53_VALIDATION_ERROR, FACELESS_54_CONDITION_ERROR, FACELESS_55_WRONG_CAR_TYPE_ID, FACELESS_56_WRONG_CURRENCY_ID, FACELESS_57_WRONG_CARGO_TYPE_ID, FACELESS_58_WRONG_CARTYPE]

Машинный код ошибки сервиса.

enum

[validation_errors]

reason*: string

Человекочитаемое описание ошибки.

details:

Детали ошибки (null, если их нет).
Для ответов с несколькими ошибками всегда null: детали каждой ошибки
лежат в соответствующем элементе error_list.

ANY-OF

1:{...}

Детали ошибки.
Набор заполненных полей зависит от вида ошибки: незаполненные поля
в ответе отсутствуют. Само наличие поля — признак того, что ошибка
относится к соответствующей сущности.

location:

Путь до поля, к которому относится ошибка.
Сегменты пути разделены ->.
* Для /v1/give_deals путь начинается с Data -> <индекс сделки>.
* Для остальных методов путь состоит из имени поля, например StartDate.
* Пустая строка, если ошибка относится к телу запроса целиком.

ANY-OF

string

null

index:

Индекс сделки в массиве Data. Только для /v1/give_deals.

ANY-OF

integer

null

LoadId:

LoadId сделки, к которой относится ошибка.
Только для /v1/give_deals. Может быть null, если поле не передали.

ANY-OF

string

integer

null

msg:

Исходный текст ошибки Pydantic. Только для FACELESS_53_VALIDATION_ERROR.

ANY-OF

string

null

type:

Исходный тип ошибки Pydantic. Только для FACELESS_53_VALIDATION_ERROR.

ANY-OF

string

null

acceptedIndex:

Индекс сделки, которая была записана из группы дубликатов.
Только для FACELESS_29_EQUAL_LOAD_ID.

ANY-OF

integer

null

dublicateIndexes:

Индексы всех сделок-дубликатов в группе.
Только для FACELESS_29_EQUAL_LOAD_ID.

ANY-OF

0: [integer]

null

indexesByLoadId:

Индексы сделок, сгруппированные по повторяющемуся LoadId.
Только для FACELESS_29_EQUAL_LOAD_ID, обнаруженной до разбора пакета по сделкам.

ANY-OF

1:{}

null

about:

Пояснение по получению доступа. Только для FACELESS_42_FORBIDDEN.

ANY-OF

string

null

}

null

error_list*:[{...}]

Список ошибок. Пуст, если произошла одна ошибка — тогда она описана в полях выше.

error*: enum

[FACELESS_1_UNKNOWN, FACELESS_2_UNRECOGNIZED_ADDRESS, FACELESS_3_UNCALCULATED_DISTANCE, FACELESS_4_DISTANCE_NEEDED_FOR_REGION, FACELESS_5_SPECIFY_EXTRA_POINT, FACELESS_6_PRICE_ABOVE_MARKET, FACELESS_7_WRONG_CARTYPE, FACELESS_8_WRONG_DOGRUZ_TYPE, FACELESS_9_WRONG_PAYMENT_TYPE, FACELESS_10_WRONG_EXECUTOR, FACELESS_11_ZERO_RATE, FACELESS_12_RATE_IS_NOT_A_NUMBER, FACELESS_13_FUTURE_DATE, FACELESS_14_WRONG_DATE_FORMAT, FACELESS_15_WEIGHT_OR_VOLUME_NEEDED, FACELESS_16_NOT_EQUAL_GEO_POINTS, FACELESS_17_INVALID_FIAS_ID, FACELESS_18_FIAS_ID_NOT_FOUND, FACELESS_19_NOT_ENOUGH_GEO_POINTS, FACELESS_20_NEED_EXTRAPOINTS_DISTANCE, FACELESS_21_UNSUPPORTED_GEO_POINT_TYPE, FACELESS_22_NEEDED_GEO_POINT, FACELESS_23_MANY_GEO_TYPES, FACELESS_25_WRONG_ATI_GEO_POINT_TYPE, FACELESS_26_ATI_COUNTRY_NOT_FOUND, FACELESS_27_ATI_REGION_NOT_FOUND, FACELESS_28_ATI_CITY_NOT_FOUND, FACELESS_29_EQUAL_LOAD_ID, FACELESS_30_WRONG_ADR, FACELESS_31_FROM_OR_TO_NEEDED, FACELESS_32_START_DATE_GT_END_DATE, FACELESS_33_BAD_COUNTRY, FACELESS_34_NO_LOAD_ID, FACELESS_35_PRICE_BELOW_MARKET, FACELESS_36_DEAL_IS_TOO_OLD, FACELESS_37_FIELD_REQUIRED, FACELESS_38_JSON_DECODE, FACELESS_39_DEALS_NOT_FOUND, FACELESS_40_LARGE_DEALS_NUMBER_TIMEOUT, FACELESS_41_LARGE_DEALS_NUMBER_SIZE, FACELESS_42_FORBIDDEN, FACELESS_43_UNPROCESSABLE_INPUT, FACELESS_44_SQL_ERROR, FACELESS_45_DATE_OUT_OF_RANGE, FACELESS_46_MIN_DEALS_BLOCK, FACELESS_47_MAX_DEALS_BLOCK, FACELESS_48_DATE_BLOCK, FACELESS_49_GET_DEALS_BILLING_ERROR, FACELESS_50_PAYMENT_FORBIDDEN, FACELESS_51_NOT_ENOUGH_MONEY, FACELESS_52_GIVE_DEALS_BILLING_ERROR, FACELESS_53_VALIDATION_ERROR, FACELESS_54_CONDITION_ERROR, FACELESS_55_WRONG_CAR_TYPE_ID, FACELESS_56_WRONG_CURRENCY_ID, FACELESS_57_WRONG_CARGO_TYPE_ID, FACELESS_58_WRONG_CARTYPE]

Машинный код ошибки сервиса.

reason*: string

Человекочитаемое описание ошибки.

details:

Детали ошибки (null, если их нет).

ANY-OF

1:{...}

Детали ошибки.
Набор заполненных полей зависит от вида ошибки: незаполненные поля
в ответе отсутствуют. Само наличие поля — признак того, что ошибка
относится к соответствующей сущности.

location:

Путь до поля, к которому относится ошибка.
Сегменты пути разделены ->.
* Для /v1/give_deals путь начинается с Data -> <индекс сделки>.
* Для остальных методов путь состоит из имени поля, например StartDate.
* Пустая строка, если ошибка относится к телу запроса целиком.

ANY-OF

string

null

index:

Индекс сделки в массиве Data. Только для /v1/give_deals.

ANY-OF

integer

null

LoadId:

LoadId сделки, к которой относится ошибка.
Только для /v1/give_deals. Может быть null, если поле не передали.

ANY-OF

string

integer

null

msg:

Исходный текст ошибки Pydantic. Только для FACELESS_53_VALIDATION_ERROR.

ANY-OF

string

null

type:

Исходный тип ошибки Pydantic. Только для FACELESS_53_VALIDATION_ERROR.

ANY-OF

string

null

acceptedIndex:

Индекс сделки, которая была записана из группы дубликатов.
Только для FACELESS_29_EQUAL_LOAD_ID.

ANY-OF

integer

null

dublicateIndexes:

Индексы всех сделок-дубликатов в группе.
Только для FACELESS_29_EQUAL_LOAD_ID.

ANY-OF

0: [integer]

null

indexesByLoadId:

Индексы сделок, сгруппированные по повторяющемуся LoadId.
Только для FACELESS_29_EQUAL_LOAD_ID, обнаруженной до разбора пакета по сделкам.

ANY-OF

1:{}

null

about:

Пояснение по получению доступа. Только для FACELESS_42_FORBIDDEN.

ANY-OF

string

null

}

null

}]

}

Пример

{...}

"error":"validation_errors",

"reason":"Произошли ошибки валидации",

"error_list":[...]

{...},

"error":"FACELESS_28_ATI_CITY_NOT_FOUND",

"reason":"Данного города нет в списке городов ATI.SU!",

"details":{...}

"location":"Data -> 0 -> From -> AtiId -> Id",

"index":0,

"LoadId":"test001"

}

},

{...}

"error":"FACELESS_15_WEIGHT_OR_VOLUME_NEEDED",

"reason":"Укажите значение Weight или Volume. Один из параметров обязательно должен быть заполнен.",

"details":{...}

"location":"Data -> 1",

"index":1,

"LoadId":"test002"

}

}

]

}

Консоль

Отправить

Параметры

demo true false Если `true`, сделки проходят ту же валидацию, что и при реальной отправке, но не сохраняются и не тарифицируются (тестовый режим).

{ "Data": [ { "LoadId": "E45CCE73-Q040-6641-A19A-FFFFFFFFFFFF", "Date": "2021-01-01", "From": { "AtiId": { "Id": 3611, "Type": 2 } }, "To": { "AtiId": { "Id": 1, "Type": 2 } }, "Distance": 750, "Weight": 45.5, "CarType": 1, "DogruzType": 1, "Rate": "27500.00", "CurrencyId": 1, "PaymentType": 2, "Executor": 1 } ] }