API для работы с Торгами (аукционами)

Возможности API

API Торгов (аукционов) позволяет работать с Торгами от лица грузовладельца или перевозчика.

Грузовладелец может:

Получить Торги (аукцион) по ID
Получить список Торгов (аукционов) по набору ID
Отменить Торги (аукцион)
Досрочно завершить Торги (аукцион)
Изменить победителя после завершения Торгов (аукциона)

Перевозчик может:

Получить Торги (аукцион)
Поставить ставку
Отменить ставку
Отказаться от победы в Торгах (аукционе)

Как проходят Торги (аукцион)

auction_flow

Важно!

API позволяет работать с уже существующими Торгами (аукционами). Сами Торги создаются при добавлении груза с помощью API грузов.

Для грузовладельца

Торги (аукцион) начинаются с создания груза с Торгами (аукционом) и его публикации. Далее участники делают, перебивают, отменяют ставки.

Далее вы можете получить информацию о нужных Торгах с помощью соответствующих методов. На основе полученной информации вы решаете, что делать дальше:

Если Торги (аукцион) не завершились:
- завершить Торги досрочно. В этом случае побеждает участник с лучшей на момент завершения ставкой;
- отменить Торги.
Если Торги (аукцион) завершились (с победителем или без):
- сменить победителя при его наличии;
- отменить Торги.

Завершение Торгов (аукциона)

Торги (аукцион) могут быть завершены тремя способами:

автоматически по времени;
автоматически по минимальной ставке;
досрочно по инициативе грузовладельца.

Для перевозчика

О наличии Торгов (аукционов) вы можете узнать, получив грузы по площадкам. За наличие аукциона в грузе отвечает поле AuctionID.

Зная Id Торгов (аукциона) вы можете:

Получить информацию о Торгах (аукционе)
Поставить ставку
Отменить ставку
Отказаться от победы

Внимание!

Отменить ставку можно не позднее, чем через 30 секунд после ее выставления.

Методы для работы с Торгами (аукционами)

Получение списка торгов для грузовладельца

Получение всех Торгов (аукционов) для грузовладельца

get

/v1.2/auction

CURL

Копировать

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

Ответ

200 Торги (аукционы) грузовладельца

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"accept_second_pay_type":true,

"active_deal_id":"adb51ee2-2eda-4e1b-9081-6d95f10e8466",

"auction_id":"e1143412-6bf4-43f3-932b-d00f9a65849c",

"auction_rates":[...],

{...},

"added_at":"2023-04-24T11:31:51.9748922Z",

"ati_id":"12345",

"auction_rate_id":"8afae956-adcd-4bdd-9676-f3a8485a6d25",

"contact_id":0,

"loading_date":null,

"rate_with_nds":5500,

"rate_without_nds":6600,

"source":0,

"state":0

{...}

"added_at":"2023-04-24T11:32:51.9749001Z",

"ati_id":"33345",

"auction_rate_id":"789d9dea-98d5-4a71-8c9d-de9be2ca6b86",

"contact_id":0,

"loading_date":null,

"rate_with_nds":5000,

"rate_without_nds":6000,

"source":0,

"state":1

}

"auction_restart_parameters":{...},

"auction_finish_action":1,

"current_change_winner_count":2,

"current_restart_count":1,

"duration_after_restart":30,

"init_change_winner_count":2,

"init_restart_count":1,

"is_manually_restarted":false,

"rate_increase":null,

"rate_increase_option":null

"auto_renew":true,

"currency":1,

"current_rate_with_nds":5000,

"current_rate_without_nds":6000,

"deleted":false,

"docs_expired_date":"2023-04-24T14:36:51.9749155Z",

"duration":6,

"end_date":"2023-04-24T11:36:51.9749281Z",

"end_date_boundary":"2023-04-24T11:36:51.9749281Z",

"finish_type":0,

"finished":true,

"is_docs_expired":false,

"load_id":"aeae42f6-0102-46e4-8310-2fa8cd23d771",

"max_rate":6000,

"max_renew_time":60,

"nds":20,

"participants_count":2,

"raise_bid":true,

"raise_bid_interval":30,

"renew_time":20,

"response_in_minutes":0,

"response_prohibited":false,

"server_date":"2023-04-24T11:36:51.9752751Z",

"start_date":"2023-04-24T11:30:51.9749144Z",

"start_since_first_bet":false,

"state":0,

"step":500,

"time_to_provide_documents":3,

"win_date":"2023-04-24T11:36:51.9749244Z",

"winner_criterion":0

}

]

[{...}]

Торги (аукцион) для грузовладельца

accept_second_pay_type: boolean

Возможность принимать другой тип оплаты (с НДС или без НДС)

active_deal_id: uuid

Id сделки, привязанной к Торгам (аукциону)

auction_id*: uuid

Id Торгов (аукциона)

auction_rates:[{...}]

Список ставок по Торгам (аукциону)

added_at*: date-time

Дата добавления

ati_id*: string

Фирма, поставившая ставку

auction_rate_id*: uuid

Id ставки

contact_id*: int32

Контакт

loading_date: date-time

Ближайшая возможная для перевозчика дата загрузки. Используется только в Торгах с критерием победы по ставке и дате загрузки

rate_with_nds: double

Ставка c НДС на груз, выставленная перевозчиком

rate_without_nds: double

Ставка без НДС на груз, выставленная перевозчиком

source: enum

[0, 1]

Система, на стороне которой сделана ставка

state*: enum

[0, 1, -8, -7, -6, -5, -4, -3, -2]

Статус ставки

-8 - Грузоотправитель отклонил документ
-7 - Победитель отклонил документ
-6 - Победитель отменил сделку
-5 - Грузовладелец отменил сделку
-4 - Победитель отказался, теперь его нельзя выбрать больше в качестве победителя
-3 - Бывший победитель
-2 - Перевозчик отказался от участия
0 - Непобедная ставка при завершении Торгов (аукциона)
1 - Победная ставка

}]

auction_restart_parameters:{...}

Параметры перезапуска торгов

auction_finish_action: enum

[1, 2, 3]

Финальное действие после завершения аукциона

1 — Опубликовать груз со ставкой
2 — Опубликовать груз с запросом ставки
3 — Удалить груз

current_change_winner_count: int32

Оставшееся количество попыток выбора нового победителя

current_restart_count: int32

Оставшееся количество попыток перезапуска торгов

duration_after_restart: int32

Длительность торгов в минутах после перезапуска

init_change_winner_count: int32

Начальное количество попыток выбора нового победителя

init_restart_count: int32

Начальное количество попыток перезапуска торгов

is_manually_restarted: boolean

Параметр, показывающий, был ли последний перезапуск выбран вручную

rate_increase: double

Повышение ставки при перезапуске

rate_increase_option: enum

[1, 2]

Способ повышения ставки

1 — Повышение ставки в валюте
2 — Повышение ставки в процентах

}

auto_renew*: boolean

Автопродление Торгов (аукциона) при выставлении ставки в последние 5 минут до окончания Торгов (аукциона)

currency*: int32

Валюта ставки на груз

current_rate_with_nds: double

Текущая ставка с НДС

current_rate_without_nds: double

Текущая ставка без НДС

deleted*: boolean

Аукцион помечен удалённым - спустя некоторое время он автоматически удалится полностью

docs_expired_date: date-time

Время окончания подачи документов (только для победителя)

duration: int32

Длительность Торгов (аукциона) в минутах

end_date: date-time

Время окончания Торгов (аукциона)

end_date_boundary: date-time

Время окончания Торгов (аукциона), после которого они автоматически завершаются, если нет автопродления

finish_type: enum

[0, 1, 2]

Тип окончания аукциона

0 - По времени
1 - По минимальной ставке
2 - Досрочное

finished*: boolean

Завершены ли Торги (аукцион)

is_docs_expired: boolean

Время подачи документов истекло (только для победителя)

load_id*: uuid

Id груза, для которого активны Торги (аукцион)

max_rate: double

Максимально допустимая ставка по Торгам (аукциону) при автоповышении (RaiseBid = true)

max_renew_time: int32

Максимально допустимое время, на которое сдвигается окончание Торгов (аукциона) при включённом AutoRenew (в минутах)

nds: double

Ставка НДС

next_rate_with_nds: double

Следующая возможная ставка с НДС

next_rate_without_nds: double

Следующая возможная ставка без НДС

participants_count*: int32

Количество участников

raise_bid: boolean

Автоповышение ставки на Шаг (step), если нет предложений

raise_bid_interval: int32

Период увеличения ставки в минутах при автоповышении (RaiseBid = true)

refuse_bet_prohibited: boolean

Отмена ставки запрещена

renew_time: int32

Время, на которое сдвигается окончание Торгов (аукциона) при включённом AutoRenew (в минутах)

response_in_minutes: int32

Количество минут с момента начала Торгов (аукциона) (StartDate), после которых возможно принимать встречные предложения

response_prohibited: boolean

Встречные предложения запрещены

server_date*: date-time

Серверное время. Для синхронизации Торгов (аукциона)

start_date*: date-time

Время начала Торгов (аукциона)

start_since_first_bet: boolean

Длительность Торгов (аукциона) отсчитывается с момента первой ставки

state: enum

[0, 1, -100, -14, -13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1]

Статус аукциона

-100 - Не удалось определить состояние аукциона
-14 - Аукцион отменён вручную грузовладельцем
-13 - Аукцион удалён, т.к. расторгнут заказ
-12 - Аукцион без ставок завершён
-11 - Аукцион удалён автоматически
-10 - Аукцион удалён т.к. сделка завершена
-9 - Аукцион удалён
-8 - При включённом копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменён, других участников нет
-7 - При включённом копировании грузов: ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменён и есть потенциальный победитель
-6 - При включённом копировании грузов: торги завершены, экспедитор не является победителем
-5 - Одна ставка лучшая по цене, другая по дате
-4 - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители
-3 - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель
-2 - Закончился, ждем когда победитель возьмёт груз
-1 - Закончился, ставок нет
0 - Идет, ставок нет
1 - Идёт (уже есть валидные ставки)

step*: double

Шаг изменения ставки Торгов (аукциона)

time_to_provide_documents: double

Время на предоставление перевозчиком данных для заявки (в часах)

win_date: date-time

Время выигрыша ставки (только для победителя)

winner_criterion: enum

[0, 1]

Критерий победы в аукционе

0 - Выбор победителя происходит автоматически по лучшей ставке
1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную

}]

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение торга по его идентификатору

Получение Торгов (аукциона) по Id

get

/v1.2/auction/{auctionId}

auctionId

uuid

Id Торгов (аукциона)

withDeleted

boolean

Возвращать удалённые торги

CURL

Копировать

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

Ответ

200 Торги (аукцион) для грузовладельца (код 200)

Развернуть все Свернуть все

Пример

Модель

{...}

"accept_second_pay_type":true,

"active_deal_id":"4300ad9e-c164-447d-a00c-1b0f16355c89",

"auction_id":"edfa4cbc-868f-4ce7-89e2-8764df59151a",

"auction_rates":[...],

{...},

"added_at":"2023-04-24T11:31:51.9296722Z",

"ati_id":"12345",

"auction_rate_id":"fb6093ff-28e8-4c45-ac33-5c88e68b349f",

"contact_id":0,

"loading_date":null,

"rate_with_nds":5500,

"rate_without_nds":6600,

"source":0,

"state":0

{...}

"added_at":"2023-04-24T11:32:51.9296877Z",

"ati_id":"33345",

"auction_rate_id":"fdae4ca4-8c8b-44ac-9174-21614de4341f",

"contact_id":0,

"loading_date":null,

"rate_with_nds":5000,

"rate_without_nds":6000,

"source":0,

"state":1

}

"auction_restart_parameters":{...},

"auction_finish_action":1,

"current_change_winner_count":2,

"current_restart_count":1,

"duration_after_restart":30,

"init_change_winner_count":2,

"init_restart_count":1,

"is_manually_restarted":false,

"rate_increase":null,

"rate_increase_option":null

"auto_renew":true,

"currency":1,

"current_rate_with_nds":5000,

"current_rate_without_nds":6000,

"deleted":false,

"docs_expired_date":"2023-04-24T14:36:51.9297113Z",

"duration":6,

"end_date":"2023-04-24T11:36:51.9297297Z",

"end_date_boundary":"2023-04-24T11:36:51.9297268Z",

"finish_type":0,

"finished":true,

"is_docs_expired":false,

"load_id":"a2f03352-d1f2-4d76-bc65-94d5c2914847",

"max_rate":6000,

"max_renew_time":60,

"nds":20,

"participants_count":2,

"raise_bid":true,

"raise_bid_interval":30,

"renew_time":20,

"response_in_minutes":0,

"response_prohibited":false,

"server_date":"2023-04-24T11:36:51.9302947Z",

"start_date":"2023-04-24T11:30:51.9297089Z",

"start_since_first_bet":false,

"state":0,

"step":500,

"time_to_provide_documents":3,

"win_date":"2023-04-24T11:36:51.9297244Z",

"winner_criterion":0

}

{...}

Торги (аукцион) для грузовладельца

accept_second_pay_type: boolean

Возможность принимать другой тип оплаты (с НДС или без НДС)

active_deal_id: uuid

Id сделки, привязанной к Торгам (аукциону)

auction_id*: uuid

Id Торгов (аукциона)

auction_rates:[{...}]

Список ставок по Торгам (аукциону)

added_at*: date-time

Дата добавления

ati_id*: string

Фирма, поставившая ставку

auction_rate_id*: uuid

Id ставки

contact_id*: int32

Контакт

loading_date: date-time

rate_with_nds: double

Ставка c НДС на груз, выставленная перевозчиком

rate_without_nds: double

Ставка без НДС на груз, выставленная перевозчиком

source: enum

[0, 1]

Система, на стороне которой сделана ставка

state*: enum

[0, 1, -8, -7, -6, -5, -4, -3, -2]

Статус ставки

-8 - Грузоотправитель отклонил документ
-7 - Победитель отклонил документ
-6 - Победитель отменил сделку
-5 - Грузовладелец отменил сделку
-4 - Победитель отказался, теперь его нельзя выбрать больше в качестве победителя
-3 - Бывший победитель
-2 - Перевозчик отказался от участия
0 - Непобедная ставка при завершении Торгов (аукциона)
1 - Победная ставка

}]

auction_restart_parameters:{...}

Параметры перезапуска торгов

auction_finish_action: enum

[1, 2, 3]

Финальное действие после завершения аукциона

1 — Опубликовать груз со ставкой
2 — Опубликовать груз с запросом ставки
3 — Удалить груз

current_change_winner_count: int32

Оставшееся количество попыток выбора нового победителя

current_restart_count: int32

Оставшееся количество попыток перезапуска торгов

duration_after_restart: int32

Длительность торгов в минутах после перезапуска

init_change_winner_count: int32

Начальное количество попыток выбора нового победителя

init_restart_count: int32

Начальное количество попыток перезапуска торгов

is_manually_restarted: boolean

Параметр, показывающий, был ли последний перезапуск выбран вручную

rate_increase: double

Повышение ставки при перезапуске

rate_increase_option: enum

[1, 2]

Способ повышения ставки

1 — Повышение ставки в валюте
2 — Повышение ставки в процентах

}

auto_renew*: boolean

Автопродление Торгов (аукциона) при выставлении ставки в последние 5 минут до окончания Торгов (аукциона)

currency*: int32

Валюта ставки на груз

current_rate_with_nds: double

Текущая ставка с НДС

current_rate_without_nds: double

Текущая ставка без НДС

deleted*: boolean

Аукцион помечен удалённым - спустя некоторое время он автоматически удалится полностью

docs_expired_date: date-time

Время окончания подачи документов (только для победителя)

duration: int32

Длительность Торгов (аукциона) в минутах

end_date: date-time

Время окончания Торгов (аукциона)

end_date_boundary: date-time

Время окончания Торгов (аукциона), после которого они автоматически завершаются, если нет автопродления

finish_type: enum

[0, 1, 2]

Тип окончания аукциона

0 - По времени
1 - По минимальной ставке
2 - Досрочное

finished*: boolean

Завершены ли Торги (аукцион)

is_docs_expired: boolean

Время подачи документов истекло (только для победителя)

load_id*: uuid

Id груза, для которого активны Торги (аукцион)

max_rate: double

Максимально допустимая ставка по Торгам (аукциону) при автоповышении (RaiseBid = true)

max_renew_time: int32

nds: double

Ставка НДС

next_rate_with_nds: double

Следующая возможная ставка с НДС

next_rate_without_nds: double

Следующая возможная ставка без НДС

participants_count*: int32

Количество участников

raise_bid: boolean

Автоповышение ставки на Шаг (step), если нет предложений

raise_bid_interval: int32

Период увеличения ставки в минутах при автоповышении (RaiseBid = true)

refuse_bet_prohibited: boolean

Отмена ставки запрещена

renew_time: int32

Время, на которое сдвигается окончание Торгов (аукциона) при включённом AutoRenew (в минутах)

response_in_minutes: int32

response_prohibited: boolean

Встречные предложения запрещены

server_date*: date-time

Серверное время. Для синхронизации Торгов (аукциона)

start_date*: date-time

Время начала Торгов (аукциона)

start_since_first_bet: boolean

Длительность Торгов (аукциона) отсчитывается с момента первой ставки

state: enum

[0, 1, -100, -14, -13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1]

Статус аукциона

-100 - Не удалось определить состояние аукциона
-14 - Аукцион отменён вручную грузовладельцем
-13 - Аукцион удалён, т.к. расторгнут заказ
-12 - Аукцион без ставок завершён
-11 - Аукцион удалён автоматически
-10 - Аукцион удалён т.к. сделка завершена
-9 - Аукцион удалён
-8 - При включённом копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменён, других участников нет
-7 - При включённом копировании грузов: ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменён и есть потенциальный победитель
-6 - При включённом копировании грузов: торги завершены, экспедитор не является победителем
-5 - Одна ставка лучшая по цене, другая по дате
-4 - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители
-3 - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель
-2 - Закончился, ждем когда победитель возьмёт груз
-1 - Закончился, ставок нет
0 - Идет, ставок нет
1 - Идёт (уже есть валидные ставки)

step*: double

Шаг изменения ставки Торгов (аукциона)

time_to_provide_documents: double

Время на предоставление перевозчиком данных для заявки (в часах)

win_date: date-time

Время выигрыша ставки (только для победителя)

winner_criterion: enum

[0, 1]

Критерий победы в аукционе

0 - Выбор победителя происходит автоматически по лучшей ставке
1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную

}

201 Торги (аукцион) для участника (код 200)

Развернуть все Свернуть все

Пример

Модель

{...}

"auction_id":"248de03c-c445-4cca-8858-4e9b495ce3d7",

"currency":1,

"current_rate_with_nds":5000,

"current_rate_without_nds":6000,

"end_date":"2023-04-24T11:36:51.930351Z",

"finished":false,

"is_our_rate_best":true,

"load_id":"dcbe9875-ebb8-4c06-bbb9-ab4093c5fe20",

"next_rate_with_nds":5500,

"next_rate_without_nds":6600,

"our_rate":{...},

"added_at":"2023-04-24T11:35:51.9303557Z",

"auction_rate_id":"47c55885-1ca1-4d05-bc66-968d0e53f0ce",

"contact_id":1,

"loading_date":null,

"rate_with_nds":4500,

"rate_without_nds":5400,

"state":0

"participants_count":2,

"response_prohibited":false,

"server_date":"2023-04-24T11:36:51.9305017Z",

"start_date":"2023-04-24T11:30:51.930351Z",

"winner_criterion":0

}

{...}

Торги (аукцион) для перевозчика

auction_id*: uuid

Id Торгов (аукциона)

currency*: int32

Валюта ставки на груз

current_rate_with_nds: double

Текущая ставка с НДС

current_rate_without_nds: double

Текущая ставка без НДС

end_date: date-time

Время окончания Торгов (аукциона)

finished*: boolean

Завершены ли Торги (аукцион)

is_our_rate_best: boolean

Ставка лучшая в незавершенных Торгах (аукционе) (в завершенных - не отображается)

load_id*: uuid

Id груза, для которого активны Торги (аукцион)

next_rate_with_nds: double

Следующая возможная ставка с НДС

next_rate_without_nds: double

Следующая возможная ставка без НДС

our_rate:{...}

Выставленная ставка

added_at*: date-time

Дата добавления

auction_rate_id*: uuid

Id ставки

contact_id*: int32

Контакт

loading_date: date-time

rate_with_nds: double

Ставка c НДС на груз, выставленная перевозчиком

rate_without_nds: double

Ставка без НДС на груз, выставленная перевозчиком

state*: enum

[0, 1, -8, -7, -6, -5, -4, -3, -2]

Статус ставки

-8 - Грузоотправитель отклонил документ
-7 - Победитель отклонил документ
-6 - Победитель отменил сделку
-5 - Грузовладелец отменил сделку
-4 - Победитель отказался, теперь его нельзя выбрать больше в качестве победителя
-3 - Бывший победитель
-2 - Перевозчик отказался от участия
0 - Непобедная ставка при завершении Торгов (аукциона)
1 - Победная ставка

}

participants_count*: int32

Количество участников

refuse_bet_prohibited: boolean

Отмена ставки запрещена

response_prohibited: boolean

Встречные предложения запрещены

server_date*: date-time

Серверное время. Для синхронизации Торгов (аукциона)

start_date*: date-time

Время начала Торгов (аукциона)

winner_criterion: enum

[0, 1]

Критерий победы в аукционе

0 - Выбор победителя происходит автоматически по лучшей ставке
1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную

}

202 Торги (аукцион) для победителя (код 200)

Развернуть все Свернуть все

Пример

Модель

{...}

"active_deal_id":"38bd5f61-d3e4-432f-be4c-6bcf0a5b7045",

"auction_id":"fd831353-d13d-43a1-91d3-6ad06c84a8db",

"currency":1,

"current_rate_with_nds":5000,

"current_rate_without_nds":6000,

"docs_expired_date":"2023-04-24T14:36:51.9305482Z",

"end_date":"2023-04-24T11:36:51.93054Z",

"finished":true,

"is_docs_expired":false,

"load_id":"f0f98614-3fa3-4a6f-87ed-953b0f500eeb",

"our_rate":{...},

"added_at":"2023-04-24T11:35:51.9305428Z",

"auction_rate_id":"242bc0ad-56d9-49c1-93eb-7e93f53b139e",

"contact_id":1,

"loading_date":null,

"rate_with_nds":6000,

"rate_without_nds":5000,

"state":1

"participants_count":2,

"response_prohibited":false,

"server_date":"2023-04-24T11:36:51.9306908Z",

"start_date":"2023-04-24T11:30:51.93054Z",

"time_to_provide_documents":3,

"win_date":"2023-04-24T11:36:51.9305506Z",

"winner_criterion":0

}

{...}

Торги (аукцион) для победителя

active_deal_id: uuid

Id сделки, привязанной к Торгам (аукциону)

auction_id*: uuid

Id Торгов (аукциона)

currency*: int32

Валюта ставки на груз

current_rate_with_nds: double

Текущая ставка с НДС

current_rate_without_nds: double

Текущая ставка без НДС

docs_expired_date: date-time

Время окончания подачи документов (только для победителя)

end_date: date-time

Время окончания Торгов (аукциона)

finished*: boolean

Завершены ли Торги (аукцион)

is_docs_expired: boolean

Время подачи документов истекло (только для победителя)

load_id*: uuid

Id груза, для которого активны Торги (аукцион)

our_rate:{...}

Выставленная ставка

added_at*: date-time

Дата добавления

auction_rate_id*: uuid

Id ставки

contact_id*: int32

Контакт

loading_date: date-time

rate_with_nds: double

Ставка c НДС на груз, выставленная перевозчиком

rate_without_nds: double

Ставка без НДС на груз, выставленная перевозчиком

state*: enum

[0, 1, -8, -7, -6, -5, -4, -3, -2]

Статус ставки

-8 - Грузоотправитель отклонил документ
-7 - Победитель отклонил документ
-6 - Победитель отменил сделку
-5 - Грузовладелец отменил сделку
-4 - Победитель отказался, теперь его нельзя выбрать больше в качестве победителя
-3 - Бывший победитель
-2 - Перевозчик отказался от участия
0 - Непобедная ставка при завершении Торгов (аукциона)
1 - Победная ставка

}

participants_count*: int32

Количество участников

refuse_bet_prohibited: boolean

Отмена ставки запрещена

response_prohibited: boolean

Встречные предложения запрещены

server_date*: date-time

Серверное время. Для синхронизации Торгов (аукциона)

start_date*: date-time

Время начала Торгов (аукциона)

time_to_provide_documents: double

Время на предоставление перевозчиком данных для заявки (в часах)

win_date: date-time

Время выигрыша ставки (только для победителя)

winner_criterion: enum

[0, 1]

Критерий победы в аукционе

0 - Выбор победителя происходит автоматически по лучшей ставке
1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную

}

404 Торги (аукцион) не найдены

Развернуть все Свернуть все

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение списка торгов по их идентификаторам

Получение списка Торгов (аукционов) по массиву id Торгов (аукционов)

post

/v1.2/auction/byids

Развернуть все Свернуть все

body

array

Массив Id Торгов (аукционов)

[uuid]

Массив Id Торгов (аукционов)

CURL

Копировать

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

Ответ

200 Торги (аукционы) грузовладельца, участника, победителя

Развернуть все Свернуть все

Пример

Модель

[...]

{...},

"accept_second_pay_type":true,

"active_deal_id":"11fd8b8d-1a68-4e02-a9ec-6af5b90d89a8",

"auction_id":"a93234db-3ba6-44fc-b946-06c08c8f58f7",

"auction_rates":[...],

{...},

"added_at":"2023-04-24T11:31:51.9996831Z",

"ati_id":"12345",

"auction_rate_id":"1f8b6617-c717-47ec-8deb-2fef504e5a2f",

"contact_id":0,

"loading_date":null,

"rate_with_nds":5500,

"rate_without_nds":6600,

"source":0,

"state":0

{...}

"added_at":"2023-04-24T11:32:51.9996963Z",

"ati_id":"33345",

"auction_rate_id":"cac6be64-8b82-43fd-9a87-8208913f894b",

"contact_id":0,

"loading_date":null,

"rate_with_nds":5000,

"rate_without_nds":6000,

"source":0,

"state":1

}

"auction_restart_parameters":{...},

"auction_finish_action":1,

"current_change_winner_count":2,

"current_restart_count":1,

"duration_after_restart":30,

"init_change_winner_count":2,

"init_restart_count":1,

"is_manually_restarted":false,

"rate_increase":null,

"rate_increase_option":null

"auto_renew":true,

"currency":1,

"current_rate_with_nds":5000,

"current_rate_without_nds":6000,

"deleted":false,

"docs_expired_date":"2023-04-24T14:36:51.9997183Z",

"duration":6,

"end_date":"2023-04-24T11:36:51.9997338Z",

"end_date_boundary":"2023-04-24T11:36:51.999732Z",

"finish_type":0,

"finished":true,

"is_docs_expired":false,

"load_id":"62cec59c-fd1b-4545-95b7-08f1bb95e368",

"max_rate":6000,

"max_renew_time":60,

"nds":20,

"participants_count":2,

"raise_bid":true,

"raise_bid_interval":30,

"renew_time":20,

"response_in_minutes":0,

"response_prohibited":false,

"server_date":"2023-04-24T11:36:52.0002292Z",

"start_date":"2023-04-24T11:30:51.9997166Z",

"start_since_first_bet":false,

"state":0,

"step":500,

"time_to_provide_documents":3,

"win_date":"2023-04-24T11:36:51.9997291Z",

"winner_criterion":0

{...},

"auction_id":"48866a07-b1b9-4f4e-8980-19118ed25c10",

"currency":1,

"current_rate_with_nds":5000,

"current_rate_without_nds":6000,

"end_date":"2023-04-24T11:36:51.9997534Z",

"finished":false,

"is_our_rate_best":true,

"load_id":"ef34b355-62ae-428a-83b1-8bf5809209a2",

"next_rate_with_nds":5500,

"next_rate_without_nds":6600,

"our_rate":{...},

"added_at":"2023-04-24T11:35:51.9997573Z",

"auction_rate_id":"981ccdef-5f13-4599-b994-76a1991255db",

"contact_id":1,

"loading_date":null,

"rate_with_nds":4500,

"rate_without_nds":5400,

"state":0

"participants_count":2,

"response_prohibited":false,

"server_date":"2023-04-24T11:36:52.0003727Z",

"start_date":"2023-04-24T11:30:51.9997516Z",

"winner_criterion":0

{...}

"active_deal_id":"143a9e3b-368b-4fca-9d12-1c035d45d074",

"auction_id":"1acfb6a9-81bd-4abe-afb5-a1fe3be17653",

"currency":1,

"current_rate_with_nds":5000,

"current_rate_without_nds":6000,

"docs_expired_date":"2023-04-24T14:36:51.9997965Z",

"end_date":"2023-04-24T11:36:51.9997816Z",

"finished":true,

"is_docs_expired":false,

"load_id":"97c210ee-8431-4a64-93c6-4eeb2d95be7d",

"our_rate":{...},

"added_at":"2023-04-24T11:35:51.9997838Z",

"auction_rate_id":"4567c7d0-83f4-49c5-9779-89473f976d0f",

"contact_id":1,

"loading_date":null,

"rate_with_nds":6000,

"rate_without_nds":5000,

"state":1

"participants_count":2,

"response_prohibited":false,

"server_date":"2023-04-24T11:36:52.0004775Z",

"start_date":"2023-04-24T11:30:51.9997795Z",

"time_to_provide_documents":3,

"win_date":"2023-04-24T11:36:51.9997995Z",

"winner_criterion":0

}

]

[{...}]

Торги (аукцион) для грузовладельца

accept_second_pay_type: boolean

Возможность принимать другой тип оплаты (с НДС или без НДС)

active_deal_id: uuid

Id сделки, привязанной к Торгам (аукциону)

auction_id*: uuid

Id Торгов (аукциона)

auction_rates:[{...}]

Список ставок по Торгам (аукциону)

added_at*: date-time

Дата добавления

ati_id*: string

Фирма, поставившая ставку

auction_rate_id*: uuid

Id ставки

contact_id*: int32

Контакт

loading_date: date-time

rate_with_nds: double

Ставка c НДС на груз, выставленная перевозчиком

rate_without_nds: double

Ставка без НДС на груз, выставленная перевозчиком

source: enum

[0, 1]

Система, на стороне которой сделана ставка

state*: enum

[0, 1, -8, -7, -6, -5, -4, -3, -2]

Статус ставки

-8 - Грузоотправитель отклонил документ
-7 - Победитель отклонил документ
-6 - Победитель отменил сделку
-5 - Грузовладелец отменил сделку
-4 - Победитель отказался, теперь его нельзя выбрать больше в качестве победителя
-3 - Бывший победитель
-2 - Перевозчик отказался от участия
0 - Непобедная ставка при завершении Торгов (аукциона)
1 - Победная ставка

}]

auction_restart_parameters:{...}

Параметры перезапуска торгов

auction_finish_action: enum

[1, 2, 3]

Финальное действие после завершения аукциона

1 — Опубликовать груз со ставкой
2 — Опубликовать груз с запросом ставки
3 — Удалить груз

current_change_winner_count: int32

Оставшееся количество попыток выбора нового победителя

current_restart_count: int32

Оставшееся количество попыток перезапуска торгов

duration_after_restart: int32

Длительность торгов в минутах после перезапуска

init_change_winner_count: int32

Начальное количество попыток выбора нового победителя

init_restart_count: int32

Начальное количество попыток перезапуска торгов

is_manually_restarted: boolean

Параметр, показывающий, был ли последний перезапуск выбран вручную

rate_increase: double

Повышение ставки при перезапуске

rate_increase_option: enum

[1, 2]

Способ повышения ставки

1 — Повышение ставки в валюте
2 — Повышение ставки в процентах

}

auto_renew*: boolean

Автопродление Торгов (аукциона) при выставлении ставки в последние 5 минут до окончания Торгов (аукциона)

currency*: int32

Валюта ставки на груз

current_rate_with_nds: double

Текущая ставка с НДС

current_rate_without_nds: double

Текущая ставка без НДС

deleted*: boolean

Аукцион помечен удалённым - спустя некоторое время он автоматически удалится полностью

docs_expired_date: date-time

Время окончания подачи документов (только для победителя)

duration: int32

Длительность Торгов (аукциона) в минутах

end_date: date-time

Время окончания Торгов (аукциона)

end_date_boundary: date-time

Время окончания Торгов (аукциона), после которого они автоматически завершаются, если нет автопродления

finish_type: enum

[0, 1, 2]

Тип окончания аукциона

0 - По времени
1 - По минимальной ставке
2 - Досрочное

finished*: boolean

Завершены ли Торги (аукцион)

is_docs_expired: boolean

Время подачи документов истекло (только для победителя)

load_id*: uuid

Id груза, для которого активны Торги (аукцион)

max_rate: double

Максимально допустимая ставка по Торгам (аукциону) при автоповышении (RaiseBid = true)

max_renew_time: int32

nds: double

Ставка НДС

next_rate_with_nds: double

Следующая возможная ставка с НДС

next_rate_without_nds: double

Следующая возможная ставка без НДС

participants_count*: int32

Количество участников

raise_bid: boolean

Автоповышение ставки на Шаг (step), если нет предложений

raise_bid_interval: int32

Период увеличения ставки в минутах при автоповышении (RaiseBid = true)

refuse_bet_prohibited: boolean

Отмена ставки запрещена

renew_time: int32

Время, на которое сдвигается окончание Торгов (аукциона) при включённом AutoRenew (в минутах)

response_in_minutes: int32

response_prohibited: boolean

Встречные предложения запрещены

server_date*: date-time

Серверное время. Для синхронизации Торгов (аукциона)

start_date*: date-time

Время начала Торгов (аукциона)

start_since_first_bet: boolean

Длительность Торгов (аукциона) отсчитывается с момента первой ставки

state: enum

[0, 1, -100, -14, -13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1]

Статус аукциона

-100 - Не удалось определить состояние аукциона
-14 - Аукцион отменён вручную грузовладельцем
-13 - Аукцион удалён, т.к. расторгнут заказ
-12 - Аукцион без ставок завершён
-11 - Аукцион удалён автоматически
-10 - Аукцион удалён т.к. сделка завершена
-9 - Аукцион удалён
-8 - При включённом копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменён, других участников нет
-7 - При включённом копировании грузов: ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменён и есть потенциальный победитель
-6 - При включённом копировании грузов: торги завершены, экспедитор не является победителем
-5 - Одна ставка лучшая по цене, другая по дате
-4 - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители
-3 - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель
-2 - Закончился, ждем когда победитель возьмёт груз
-1 - Закончился, ставок нет
0 - Идет, ставок нет
1 - Идёт (уже есть валидные ставки)

step*: double

Шаг изменения ставки Торгов (аукциона)

time_to_provide_documents: double

Время на предоставление перевозчиком данных для заявки (в часах)

win_date: date-time

Время выигрыша ставки (только для победителя)

winner_criterion: enum

[0, 1]

Критерий победы в аукционе

0 - Выбор победителя происходит автоматически по лучшей ставке
1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную

}]

Загрузка...

Развернуть все Свернуть все

Загрузка...

Отмена торгов

Отмена Торгов (аукциона) по Id

delete

/v1.2/auction/{auctionId}

auctionId

uuid

Id Торгов (аукциона)

CURL

Копировать

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

Ответ

200 Торги (аукцион) отменены

Развернуть все Свернуть все

403 У Торгов (аукциона) имеются активные сделки

Развернуть все Свернуть все

404 Торги (аукцион) не найдены

Развернуть все Свернуть все

Загрузка...

Развернуть все Свернуть все

Загрузка...

Досрочное завершение

Досрочное завершение Торгов (аукциона)

post

/v1.2/auction/{auctionId}/finish_aot

auctionId

uuid

Id Торгов (аукциона)

CURL

Копировать

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

Ответ

200 Торги (аукцион) грузовладельца

Развернуть все Свернуть все

Пример

Модель

{...}

"accept_second_pay_type":true,

"active_deal_id":"aa30b2e3-778b-4125-ae26-75269311542e",

"auction_id":"60a21a9c-727e-42b1-b092-cea3b87a0f56",

"auction_rates":[...],

{...},

"added_at":"2023-04-24T11:31:52.100118Z",

"ati_id":"12345",

"auction_rate_id":"057b35fd-59f8-4e42-a1b0-cf7c0e6e5260",

"contact_id":0,

"loading_date":null,

"rate_with_nds":5500,

"rate_without_nds":6600,

"source":0,

"state":0

{...}

"added_at":"2023-04-24T11:32:52.1001269Z",

"ati_id":"33345",

"auction_rate_id":"c057841f-0e55-45b3-b46f-def80b479e29",

"contact_id":0,

"loading_date":null,

"rate_with_nds":5000,

"rate_without_nds":6000,

"source":0,

"state":1

}

"auction_restart_parameters":{...},

"auction_finish_action":1,

"current_change_winner_count":2,

"current_restart_count":1,

"duration_after_restart":30,

"init_change_winner_count":2,

"init_restart_count":1,

"is_manually_restarted":false,

"rate_increase":null,

"rate_increase_option":null

"auto_renew":true,

"currency":1,

"current_rate_with_nds":5000,

"current_rate_without_nds":6000,

"deleted":false,

"docs_expired_date":"2023-04-24T14:36:52.1001426Z",

"duration":6,

"end_date":"2023-04-24T11:36:52.1001554Z",

"end_date_boundary":"2023-04-24T11:36:52.1001542Z",

"finish_type":0,

"finished":true,

"is_docs_expired":false,

"load_id":"aa5cfb62-de6d-4c3b-853f-3270fc8793a9",

"max_rate":6000,

"max_renew_time":60,

"nds":20,

"participants_count":2,

"raise_bid":true,

"raise_bid_interval":30,

"renew_time":20,

"response_in_minutes":0,

"response_prohibited":false,

"server_date":"2023-04-24T11:36:52.1004411Z",

"start_date":"2023-04-24T11:30:52.1001412Z",

"start_since_first_bet":false,

"state":0,

"step":500,

"time_to_provide_documents":3,

"win_date":"2023-04-24T11:36:52.1001516Z",

"winner_criterion":0

}

{...}

Торги (аукцион) для грузовладельца

accept_second_pay_type: boolean

Возможность принимать другой тип оплаты (с НДС или без НДС)

active_deal_id: uuid

Id сделки, привязанной к Торгам (аукциону)

auction_id*: uuid

Id Торгов (аукциона)

auction_rates:[{...}]

Список ставок по Торгам (аукциону)

added_at*: date-time

Дата добавления

ati_id*: string

Фирма, поставившая ставку

auction_rate_id*: uuid

Id ставки

contact_id*: int32

Контакт

loading_date: date-time

rate_with_nds: double

Ставка c НДС на груз, выставленная перевозчиком

rate_without_nds: double

Ставка без НДС на груз, выставленная перевозчиком

source: enum

[0, 1]

Система, на стороне которой сделана ставка

state*: enum

[0, 1, -8, -7, -6, -5, -4, -3, -2]

Статус ставки

-8 - Грузоотправитель отклонил документ
-7 - Победитель отклонил документ
-6 - Победитель отменил сделку
-5 - Грузовладелец отменил сделку
-4 - Победитель отказался, теперь его нельзя выбрать больше в качестве победителя
-3 - Бывший победитель
-2 - Перевозчик отказался от участия
0 - Непобедная ставка при завершении Торгов (аукциона)
1 - Победная ставка

}]

auction_restart_parameters:{...}

Параметры перезапуска торгов

auction_finish_action: enum

[1, 2, 3]

Финальное действие после завершения аукциона

1 — Опубликовать груз со ставкой
2 — Опубликовать груз с запросом ставки
3 — Удалить груз

current_change_winner_count: int32

Оставшееся количество попыток выбора нового победителя

current_restart_count: int32

Оставшееся количество попыток перезапуска торгов

duration_after_restart: int32

Длительность торгов в минутах после перезапуска

init_change_winner_count: int32

Начальное количество попыток выбора нового победителя

init_restart_count: int32

Начальное количество попыток перезапуска торгов

is_manually_restarted: boolean

Параметр, показывающий, был ли последний перезапуск выбран вручную

rate_increase: double

Повышение ставки при перезапуске

rate_increase_option: enum

[1, 2]

Способ повышения ставки

1 — Повышение ставки в валюте
2 — Повышение ставки в процентах

}

auto_renew*: boolean

Автопродление Торгов (аукциона) при выставлении ставки в последние 5 минут до окончания Торгов (аукциона)

currency*: int32

Валюта ставки на груз

current_rate_with_nds: double

Текущая ставка с НДС

current_rate_without_nds: double

Текущая ставка без НДС

deleted*: boolean

Аукцион помечен удалённым - спустя некоторое время он автоматически удалится полностью

docs_expired_date: date-time

Время окончания подачи документов (только для победителя)

duration: int32

Длительность Торгов (аукциона) в минутах

end_date: date-time

Время окончания Торгов (аукциона)

end_date_boundary: date-time

Время окончания Торгов (аукциона), после которого они автоматически завершаются, если нет автопродления

finish_type: enum

[0, 1, 2]

Тип окончания аукциона

0 - По времени
1 - По минимальной ставке
2 - Досрочное

finished*: boolean

Завершены ли Торги (аукцион)

is_docs_expired: boolean

Время подачи документов истекло (только для победителя)

load_id*: uuid

Id груза, для которого активны Торги (аукцион)

max_rate: double

Максимально допустимая ставка по Торгам (аукциону) при автоповышении (RaiseBid = true)

max_renew_time: int32

nds: double

Ставка НДС

next_rate_with_nds: double

Следующая возможная ставка с НДС

next_rate_without_nds: double

Следующая возможная ставка без НДС

participants_count*: int32

Количество участников

raise_bid: boolean

Автоповышение ставки на Шаг (step), если нет предложений

raise_bid_interval: int32

Период увеличения ставки в минутах при автоповышении (RaiseBid = true)

refuse_bet_prohibited: boolean

Отмена ставки запрещена

renew_time: int32

Время, на которое сдвигается окончание Торгов (аукциона) при включённом AutoRenew (в минутах)

response_in_minutes: int32

response_prohibited: boolean

Встречные предложения запрещены

server_date*: date-time

Серверное время. Для синхронизации Торгов (аукциона)

start_date*: date-time

Время начала Торгов (аукциона)

start_since_first_bet: boolean

Длительность Торгов (аукциона) отсчитывается с момента первой ставки

state: enum

[0, 1, -100, -14, -13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1]

Статус аукциона

-100 - Не удалось определить состояние аукциона
-14 - Аукцион отменён вручную грузовладельцем
-13 - Аукцион удалён, т.к. расторгнут заказ
-12 - Аукцион без ставок завершён
-11 - Аукцион удалён автоматически
-10 - Аукцион удалён т.к. сделка завершена
-9 - Аукцион удалён
-8 - При включённом копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменён, других участников нет
-7 - При включённом копировании грузов: ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменён и есть потенциальный победитель
-6 - При включённом копировании грузов: торги завершены, экспедитор не является победителем
-5 - Одна ставка лучшая по цене, другая по дате
-4 - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители
-3 - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель
-2 - Закончился, ждем когда победитель возьмёт груз
-1 - Закончился, ставок нет
0 - Идет, ставок нет
1 - Идёт (уже есть валидные ставки)

step*: double

Шаг изменения ставки Торгов (аукциона)

time_to_provide_documents: double

Время на предоставление перевозчиком данных для заявки (в часах)

win_date: date-time

Время выигрыша ставки (только для победителя)

winner_criterion: enum

[0, 1]

Критерий победы в аукционе

0 - Выбор победителя происходит автоматически по лучшей ставке
1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную

}

403 Торги (аукцион) уже завершены

Развернуть все Свернуть все

410 Торги (аукцион) были отменены

Развернуть все Свернуть все

Загрузка...

Развернуть все Свернуть все

Загрузка...

Смена победителя

Смена победителя Торгов (аукциона)

post

/v1.2/auction/bet/win/{auctionRateId}

auctionRateId

uuid

Id ставки Торгов (аукциона) (выбирается одна из ставок со статусами state=[0,-3]) устанавливается победной (со статусом state=1)

CURL

Копировать

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

Ответ

200 Торги (аукцион) грузовладельца

Развернуть все Свернуть все

Пример

Модель

{...}

"accept_second_pay_type":true,

"active_deal_id":"c7ba865c-6dd2-43e4-bb29-66df7583989a",

"auction_id":"c771ed18-84e4-4ab8-8f91-1be412274d86",

"auction_rates":[...],

{...},

"added_at":"2023-04-24T11:31:52.0690515Z",

"ati_id":"12345",

"auction_rate_id":"5a2e6b1c-b02a-45b0-9136-f64a9236ab21",

"contact_id":0,

"loading_date":null,

"rate_with_nds":5500,

"rate_without_nds":6600,

"source":0,

"state":0

{...}

"added_at":"2023-04-24T11:32:52.0690605Z",

"ati_id":"33345",

"auction_rate_id":"cd342abc-ac8d-4b08-87d3-def8f125b28d",

"contact_id":0,

"loading_date":null,

"rate_with_nds":5000,

"rate_without_nds":6000,

"source":0,

"state":1

}

"auction_restart_parameters":{...},

"auction_finish_action":1,

"current_change_winner_count":2,

"current_restart_count":1,

"duration_after_restart":30,

"init_change_winner_count":2,

"init_restart_count":1,

"is_manually_restarted":false,

"rate_increase":null,

"rate_increase_option":null

"auto_renew":true,

"currency":1,

"current_rate_with_nds":5000,

"current_rate_without_nds":6000,

"deleted":false,

"docs_expired_date":"2023-04-24T14:36:52.0690757Z",

"duration":6,

"end_date":"2023-04-24T11:36:52.0690878Z",

"end_date_boundary":"2023-04-24T11:36:52.0690866Z",

"finish_type":0,

"finished":true,

"is_docs_expired":false,

"load_id":"a86db870-967e-4893-b6e1-fef16c73b054",

"max_rate":6000,

"max_renew_time":60,

"nds":20,

"participants_count":2,

"raise_bid":true,

"raise_bid_interval":30,

"renew_time":20,

"response_in_minutes":0,

"response_prohibited":false,

"server_date":"2023-04-24T11:36:52.069361Z",

"start_date":"2023-04-24T11:30:52.0690743Z",

"start_since_first_bet":false,

"state":0,

"step":500,

"time_to_provide_documents":3,

"win_date":"2023-04-24T11:36:52.0690844Z",

"winner_criterion":0

}

{...}

Торги (аукцион) для грузовладельца

accept_second_pay_type: boolean

Возможность принимать другой тип оплаты (с НДС или без НДС)

active_deal_id: uuid

Id сделки, привязанной к Торгам (аукциону)

auction_id*: uuid

Id Торгов (аукциона)

auction_rates:[{...}]

Список ставок по Торгам (аукциону)

added_at*: date-time

Дата добавления

ati_id*: string

Фирма, поставившая ставку

auction_rate_id*: uuid

Id ставки

contact_id*: int32

Контакт

loading_date: date-time

rate_with_nds: double

Ставка c НДС на груз, выставленная перевозчиком

rate_without_nds: double

Ставка без НДС на груз, выставленная перевозчиком

source: enum

[0, 1]

Система, на стороне которой сделана ставка

state*: enum

[0, 1, -8, -7, -6, -5, -4, -3, -2]

Статус ставки

-8 - Грузоотправитель отклонил документ
-7 - Победитель отклонил документ
-6 - Победитель отменил сделку
-5 - Грузовладелец отменил сделку
-4 - Победитель отказался, теперь его нельзя выбрать больше в качестве победителя
-3 - Бывший победитель
-2 - Перевозчик отказался от участия
0 - Непобедная ставка при завершении Торгов (аукциона)
1 - Победная ставка

}]

auction_restart_parameters:{...}

Параметры перезапуска торгов

auction_finish_action: enum

[1, 2, 3]

Финальное действие после завершения аукциона

1 — Опубликовать груз со ставкой
2 — Опубликовать груз с запросом ставки
3 — Удалить груз

current_change_winner_count: int32

Оставшееся количество попыток выбора нового победителя

current_restart_count: int32

Оставшееся количество попыток перезапуска торгов

duration_after_restart: int32

Длительность торгов в минутах после перезапуска

init_change_winner_count: int32

Начальное количество попыток выбора нового победителя

init_restart_count: int32

Начальное количество попыток перезапуска торгов

is_manually_restarted: boolean

Параметр, показывающий, был ли последний перезапуск выбран вручную

rate_increase: double

Повышение ставки при перезапуске

rate_increase_option: enum

[1, 2]

Способ повышения ставки

1 — Повышение ставки в валюте
2 — Повышение ставки в процентах

}

auto_renew*: boolean

Автопродление Торгов (аукциона) при выставлении ставки в последние 5 минут до окончания Торгов (аукциона)

currency*: int32

Валюта ставки на груз

current_rate_with_nds: double

Текущая ставка с НДС

current_rate_without_nds: double

Текущая ставка без НДС

deleted*: boolean

Аукцион помечен удалённым - спустя некоторое время он автоматически удалится полностью

docs_expired_date: date-time

Время окончания подачи документов (только для победителя)

duration: int32

Длительность Торгов (аукциона) в минутах

end_date: date-time

Время окончания Торгов (аукциона)

end_date_boundary: date-time

Время окончания Торгов (аукциона), после которого они автоматически завершаются, если нет автопродления

finish_type: enum

[0, 1, 2]

Тип окончания аукциона

0 - По времени
1 - По минимальной ставке
2 - Досрочное

finished*: boolean

Завершены ли Торги (аукцион)

is_docs_expired: boolean

Время подачи документов истекло (только для победителя)

load_id*: uuid

Id груза, для которого активны Торги (аукцион)

max_rate: double

Максимально допустимая ставка по Торгам (аукциону) при автоповышении (RaiseBid = true)

max_renew_time: int32

nds: double

Ставка НДС

next_rate_with_nds: double

Следующая возможная ставка с НДС

next_rate_without_nds: double

Следующая возможная ставка без НДС

participants_count*: int32

Количество участников

raise_bid: boolean

Автоповышение ставки на Шаг (step), если нет предложений

raise_bid_interval: int32

Период увеличения ставки в минутах при автоповышении (RaiseBid = true)

refuse_bet_prohibited: boolean

Отмена ставки запрещена

renew_time: int32

Время, на которое сдвигается окончание Торгов (аукциона) при включённом AutoRenew (в минутах)

response_in_minutes: int32

response_prohibited: boolean

Встречные предложения запрещены

server_date*: date-time

Серверное время. Для синхронизации Торгов (аукциона)

start_date*: date-time

Время начала Торгов (аукциона)

start_since_first_bet: boolean

Длительность Торгов (аукциона) отсчитывается с момента первой ставки

state: enum

[0, 1, -100, -14, -13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1]

Статус аукциона

-100 - Не удалось определить состояние аукциона
-14 - Аукцион отменён вручную грузовладельцем
-13 - Аукцион удалён, т.к. расторгнут заказ
-12 - Аукцион без ставок завершён
-11 - Аукцион удалён автоматически
-10 - Аукцион удалён т.к. сделка завершена
-9 - Аукцион удалён
-8 - При включённом копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменён, других участников нет
-7 - При включённом копировании грузов: ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменён и есть потенциальный победитель
-6 - При включённом копировании грузов: торги завершены, экспедитор не является победителем
-5 - Одна ставка лучшая по цене, другая по дате
-4 - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители
-3 - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель
-2 - Закончился, ждем когда победитель возьмёт груз
-1 - Закончился, ставок нет
0 - Идет, ставок нет
1 - Идёт (уже есть валидные ставки)

step*: double

Шаг изменения ставки Торгов (аукциона)

time_to_provide_documents: double

Время на предоставление перевозчиком данных для заявки (в часах)

win_date: date-time

Время выигрыша ставки (только для победителя)

winner_criterion: enum

[0, 1]

Критерий победы в аукционе

0 - Выбор победителя происходит автоматически по лучшей ставке
1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную

}

403 У вас нет доступа на установление победной ставки

Развернуть все Свернуть все

404 Торги (аукцион) не найдены, либо груз не найден

Развернуть все Свернуть все

Загрузка...

Развернуть все Свернуть все

Загрузка...

Выставление ставки в торгах

Выставление ставки в Торгах (аукционе)

post

/v1.2/auction/bet

Развернуть все Свернуть все

body

object

Объект ставки Торгов (аукциона)

{...}

Для внесения ставки грузоперевозчиком

auction_id*: uuid

Id аукциона

loading_date: date-time

payment_type*: enum

[1, 22, 23, 24, 25]

Тип оплаты

1 - Наличка
22 - Любая
23 - На карту
24 - С НДС
25 - Без НДС
Остальные зарезервированы

rate*: double

Ставка на груз, поставленная перевозчиком

}

CURL

Копировать

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

Ответ

200 Статус ставки

Развернуть все Свернуть все

Пример

Модель

{...}

"auction":{...},

"auction_id":"8ef73743-fb35-4bdc-83a9-5904fa517ded",

"currency":1,

"current_rate_with_nds":5000,

"current_rate_without_nds":6000,

"end_date":"2023-04-24T11:36:52.0301243Z",

"finished":false,

"is_our_rate_best":true,

"load_id":"2f86f429-334a-4dae-be3f-624f92870829",

"next_rate_with_nds":5500,

"next_rate_without_nds":6600,

"our_rate":{...},

"added_at":"2023-04-24T11:35:52.0301298Z",

"auction_rate_id":"d4aa20cc-500b-494d-b67e-77a9fe8826bf",

"contact_id":1,

"loading_date":null,

"rate_with_nds":4500,

"rate_without_nds":5400,

"state":0

"participants_count":2,

"response_prohibited":false,

"server_date":"2023-04-24T11:36:52.0302924Z",

"start_date":"2023-04-24T11:30:52.0301216Z",

"winner_criterion":0

"auction_end_date":"2023-04-24T11:36:52.0300965Z",

"result_status":0

}

{...}

Статус ставки после выставления

auction:{...}

Торги (аукцион) для перевозчика

auction_id*: uuid

Id Торгов (аукциона)

currency*: int32

Валюта ставки на груз

current_rate_with_nds: double

Текущая ставка с НДС

current_rate_without_nds: double

Текущая ставка без НДС

end_date: date-time

Время окончания Торгов (аукциона)

finished*: boolean

Завершены ли Торги (аукцион)

is_our_rate_best: boolean

Ставка лучшая в незавершенных Торгах (аукционе) (в завершенных - не отображается)

load_id*: uuid

Id груза, для которого активны Торги (аукцион)

next_rate_with_nds: double

Следующая возможная ставка с НДС

next_rate_without_nds: double

Следующая возможная ставка без НДС

our_rate:{...}

Выставленная ставка

added_at*: date-time

Дата добавления

auction_rate_id*: uuid

Id ставки

contact_id*: int32

Контакт

loading_date: date-time

rate_with_nds: double

Ставка c НДС на груз, выставленная перевозчиком

rate_without_nds: double

Ставка без НДС на груз, выставленная перевозчиком

state*: enum

[0, 1, -8, -7, -6, -5, -4, -3, -2]

Статус ставки

-8 - Грузоотправитель отклонил документ
-7 - Победитель отклонил документ
-6 - Победитель отменил сделку
-5 - Грузовладелец отменил сделку
-4 - Победитель отказался, теперь его нельзя выбрать больше в качестве победителя
-3 - Бывший победитель
-2 - Перевозчик отказался от участия
0 - Непобедная ставка при завершении Торгов (аукциона)
1 - Победная ставка

}

participants_count*: int32

Количество участников

refuse_bet_prohibited: boolean

Отмена ставки запрещена

response_prohibited: boolean

Встречные предложения запрещены

server_date*: date-time

Серверное время. Для синхронизации Торгов (аукциона)

start_date*: date-time

Время начала Торгов (аукциона)

winner_criterion: enum

[0, 1]

Критерий победы в аукционе

0 - Выбор победителя происходит автоматически по лучшей ставке
1 - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную

}

auction_end_date: date-time

Параметр устарел, используйте auction.end_date. Дата окончания Торгов (аукциона).

result_status: enum

[0, 1, 2, 3, 4, 5, 6]

Статус выставленной ставки

0 - Ставка выставлена
1 - Ставка выставлена и Торги (аукцион) завершены
2 - Ставка не выставлена, поскольку Торги (аукцион) не найдены
3 - Ставка не выставлена, поскольку она не лучшая
4 - Ставка выставлена минимальная, но Торги (аукцион) не завершены
5 - Ставка выставлена и Торги (аукцион) продлены
6 - Ставка не выставлена, поскольку торги завершены

}

403 У вас нет доступа на сохранение ставки

Развернуть все Свернуть все

404 Торги (аукцион) не найдены

Развернуть все Свернуть все

Загрузка...

Развернуть все Свернуть все

Загрузка...

Отмена ставки

Отмена ставки в Торгах (аукционе)

post

/v1.2/auction/bet/refuse/{auctionRateId}

auctionRateId

uuid

Id ставки Торгов (аукциона)

CURL

Копировать

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

Ответ

200

Результат отмены ставки:

        * `0` - Ставка удалена;
        * `5` - Ставка удалена, уже есть другие ставки;
        * Остальные зарезервированы

Развернуть все Свернуть все

Пример

Модель

enum

[0, 1, 2, 3, 4, 5, -1]

Результат отмены ставки аукциона

-1 - Случилось что-то непонятное, но ставка не удалилась
0 - Cтавка удалена
1 - Ставка не найдена
2 - Время на отмену ставки прошло
3 - Аукцион не найден
4 - Аукцион завершен
5 - Ставка удалена уже есть другие ставки

403 Время вышло, ставку по Торгам (аукциону) отменить нельзя

Развернуть все Свернуть все

404 Ставка не найдена

Развернуть все Свернуть все

Загрузка...

Развернуть все Свернуть все

Загрузка...

Отказ от победы

Отказ от победы в Торгах (аукционе)

post

/v1.2/auction/{auctionId}/refuse

auctionId

uuid

Id Торгов (аукциона)

CURL

Копировать

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

Ответ

200 Успешное выполнение

Развернуть все Свернуть все

403 Торги (аукцион) не завершены, либо вы не являетесь победителем Торгов (аукциона)

Развернуть все Свернуть все

404 Торги (аукцион) не найдены

Развернуть все Свернуть все

Загрузка...

Развернуть все Свернуть все

Загрузка...