Структура "Аукцион" [1.0]

Описание

Здесь вы сможете найти описание основных параметров структуры "Аукцион".


Вложенные структуры

Структура "Ставка аукциона"

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

Название
Тип
Описание
Особые значения
Обязательный
auctionRateIdGuidТолько для чтения. Идентификатор ставки аукциона.

auctionIdGuid

Идентификатор аукциона. Аукцион должен существовать и не должен быть завершен. Вы должны состоять на одной из площадок, на которых проходит аукцион. Ваша уже установленная ранее ставка не должна быть лучшей.


+
contactIdintId контакта, который оставил ставку. По умолчанию 0.

addedAtDateTimeТолько для чтения. Дата добавления ставки.

ratedecimalСтавка. Должна быть больше 0 и меньше уже поставленной ставки.
+
stateintСтатус ставки. Только для чтения.
  • -8: Грузовладелец отклонил документ
  • -7: Победитель отклонил документ
  • -6: Победитель отменил безоговорочную сделку
  • -5: Грузовладелец отменил безоговорочную сделку
  • -4: Победитель отказался от участия
  • -3: Бывший победитель, который не прислал документы
  • -2: Участник аукциона отменил ставку
  • 0: Обычная ставка по аукциону (участник аукциона)
  • 1: Победная ставка в аукционе

rateFirmСтруктура "Информация по фирме"Информация о фирме, оставившей ставку. Только для чтения.

firmIdintКод фирмы, сделавшей ставку


Структура "Информация по фирме"

Представляет собой структуру, предоставляющую информацию о фирме, оставившей ставку. Только для чтения

Название
Тип
Описание
Особые значения
scoredouble"Звезды" фирмы
statusint

Тип звезд фирмы

  • 0: Серый
  • 1: Красный
  • 2: Желтый
  • 3: Зеленый
  • 4: Партнер АТИ
  • 5: Сотрудник АТИ
  • 6: Гос. органы
  • 7: ОДКС
namestringИмя фирмы
contactNamestringИмя контакта
atiIdstringИдентификатор фирмы в АТИ
LoadingDateDateTimeБлижайшая возможная для перевозчика дата загрузкиИспользуется только в аукционах с критерием победы по ставке и дате загрузки

Структура "Аукцион"

Название
Тип
Описание
Особые значения
Обязательный
AuctionId
GuidТолько для чтения. Идентификатор аукциона.

LoadIdGuidТолько для чтения. Идентификатор груза.



ActiveDealIdGuidТолько для чтения. Идентификатор безоговорочной сделки, привязанной к аукциону.

ActiveDealСтруктура "Безоговорочная Сделка"Только для чтения. Активная Безоговорочная Сделка аукциона.

FinishedboolТолько для чтения. Флаг, определяющий, завершен аукцион или нет.

StartRatedecimalНачальная ставка аукциона. Параметр должен принимать значение от 1 до 9999999999 (включительно) и содержать не более 10 символов.
+
CurrencyintВалюта аукциона. Значение из словаря.
+
AcceptSecondPayTypeboolПринимать ставки без НДС. Параметр можно указать, если начальная ставка указана с НДС (PaymentType=24)

Ndsdecimal% НДС, от 1 до 99. Если выбрана опция "Принимать ставки без НДС", этот параметр определяет величину процента НДС.

StepdecimalМинимальное изменение ставки по аукциону. Параметр должен принимать значение от 1 до 9999999999 (включительно), содержать не более 10 символов и не должен превышать половину начальной ставки startRate.
+
PaymentTypeintТип оплаты аукциона.
  • 22: любой
  • 1: наличные
  • 23: по карте
  • 24: безнал с НДС
  • 25: безнал без НДС
+
StartDateDateTimeВремя начала аукциона. Должно быть позже времени начала публикации груза на площадке. По умолчанию устанавливается текущая дата UTC.

EndDateDateTimeВремя окончания аукциона. Необязательное поле, если есть значение в поле Duration

EndDateBoundaryDateTimeВремя окончания аукциона "завершить не позже". Необязательное поле. Если указанное время, меньше значения Duration - аукцион заканчивается по времени "завершить не позже", если нет автопродления. Время устанавливается в формате UTC.

StartSinceFirstBetboolФлаг, определяющий, что обратный отсчет до окончания аукциона начинается только после первой ставки.

Durationint

Длительность аукциона в минутах: 30, 60, 120, 180, 240, 360, 720, 1440, 2880, 4320, 5760, 7200

Значение не может быть больше времени актуальности груза LastDate из Структура "Груз" [1.0]


+
TimeToProvideDocumentsdecimalВремя на отправку заявки перевозчиком (в часах). Время на отправку заявки перевозчику должно быть не больше 24 часов, и не должно превышать 4 символов в длину.
+
AutoRenewboolФлаг, определяющий, нужно ли продление аукциона, если была ставка в последние 5 минут до окончания. По умолчанию false.

RenewTimeintВремя, на которое надо сдвигать окончание аукциона в минутах. При autoRenew = true должно быть больше 0.
+/-
MaxRenewTimeintМаксимально допустимое время, на которое можно сдвинуть окончание аукциона в минутах. При autoRenew = true, должно быть больше 0 и меньше промежутка времени до окончания публикации груза и больше или равно renewTime.
+/-
RaiseBidbool

Флаг, показывающий, нужно ли повысить ставку на step, если нет предложений. По умолчанию raiseBid = false.



MaxRatedecimal

Максимально допустимая ставка по аукциону. Указывать, если raiseBid = true. Параметр должен принимать значение от 1 до 999999 (включительно) и содержать не более 6 символов.


+/-
RaiseBidIntervalintПериод увеличения ставки при отсутствии предложений (в минутах). При raiseBid = true должно принимать значение не меньше 1 минуты и не больше 24 часов.
+/-
WinDateDateTimeТолько для чтения. Время выигрыша ставки (когда для определенной ставки в auctionRates установлен State = 1).

ResponseInMinutesintУказывает через какой промежуток времени с момента публикации аукциона и до 1-й ставки принимать встречные предложения

0 - сразу

15, 30, 60, 120, 180 - время в минутах

null - не принимать


AuctionRatesМассив Структур "Ставка аукциона"Только для чтения. Текущие ставки аукциона.

LoadLastDateDateTimeДата публикации груза (только в параметре запроса сохранения аукциона)

WinnerCriterionint

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

По умолчанию 0+/-
AcceptCounterOffersOnlyBeforeFirstBetboolФлаг, определяющий, можно ли принимать встречные предложения только до первой ставки.

AuctionRestartParameters

Структура, описывающая поведение Торгов после завершения

Структура AuctionRestartParameters

Название

Тип

Описание

Информация

Обязательный

AuctionFinishAction

int

1 - Опубликовать груз со ставкой груза
2- Опубликовать груз с запросом ставки
3 - Перенести груз в архив

Если выбран 1 - опубликовать груз со ставкой, в грузе должна быть указана ставка (SumWithNDS, SumWithoutNDS, RateSum - см. структуру "Груз").

Если выбран 2, то возможные типы оплаты будут взяты из поля AcceptPaymentTypes структуры "Груз".

+

InitRestartCount

intКоличество перезапусков Торгов, от 0 до 3 включительноЕсли параметр не передать, по умолчанию 0+/-

InitChangeWinnerCount

intСколько раз выбирать следующего победителя с лучшей ставкой, если предыдущий отказался, от 0 до 3 включительноЕсли параметр не передать, по умолчанию 0+/-
DurationAfterRestartintДлительность торгов в минутах после перезапускаНеобязательное поле, если его не передавать, то торги будут перезапущены с изначальной длительностью (поле Duration в структуре Аукцион). Однако если в структуре Аукцион заполнено поле EndDateBoundary и поле InitRestartCount имеет значение больше 0, то DurationAfterRestart становится обязательным+/-