Помощь
Чат для вопросов по API
Мгновенно ответим на ваши вопросы
api@ati.su
Электронная почта техподдержки
Тикетная система
Оставить заявку на отдел
«Консультанты по интеграции (API)»
api.ati.su - заказы, торги, площадки
Наш телеграм-канал
Код в АТИ:
Выход

Архивные грузы

Методы для работы с архивными грузами

Восстановление одного архивного груза

 
Восстановление одного груза
put
/v1.0/unpublished-loads/{loadId}/restore
Развернуть все Свернуть все
{...}
ContactId1*: int32

Идентификатор первого выбранного контакта.
Список всех контактов и их идентификаторы можно получить с помощью API для работы с фирмами
Контакт должен быть виден для остальных участников АТИ

ContactId2: int32

Идентификатор второго выбранного контакта, если не выбрано, то null
Контакт должен быть виден для остальных участников АТИ

Note: string

Примечание к грузу
Ограничение по длине: 1000 символов

FirstDate: date-time

Дата, начиная с которой груз актуален, в формате UTC
Минимальное значение равно текущей дате
При значении параметра DateType равным 0, допустимое значение поля - текущая дата
При значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 60 дней вперед
При значении параметра DateType равным 2, допустимое значение поля - текущая дата
При значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать

LastDate: date-time

Дата, после которой груз не актуален, в формате UTC
Минимальное значение равно значению параметра FirstDate
При значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед
При значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед
При значении параметра DateType равным 2, данное поле вычисляется автоматически по формуле FirstDate + 2 месяца, передаваемое значение игнорируется
При значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется

DateType: int32

Выбор типа готовности груза к перевозке

  • 0 - Готов к загрузке
  • 1 - с Х по У
  • 2 - постоянно
  • 3 - груза нет, запрос ставки
PeriodicityId: int32

Периодичность загрузки
Если параметр DateType не равен 2, PeriodicityId равен 0.
Иначе PeriodicityId может принимать следующие значения:

  • 1 - ежедневно
  • 100 - по рабочим дням
OrderNumber: string

Номер заказа
Ограничение по длине: 250 символов

Krugoreis: boolean

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

UnloadFirstDate: date-time

Дата начала разгрузки, в формате UTC.
Может иметь значение null.
Минимальное значение равно текущей дате.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

UnloadLastDate: date-time

Дата окончания разгрузки, в формате UTC. Может иметь значение null.
Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Восстановленный груз
Развернуть все Свернуть все
Пример Модель
{...}
"LoadMeta":{...},
"LoadMetaId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"MetaData":"string"
},
"ContactId1":0,
"ContactId2":0,
"Note":"string",
"FirstDate":"1970-01-01T00:00:00.000Z",
"LastDate":"1970-01-01T00:00:00.000Z",
"DateType":0,
"PeriodicityId":0,
"OrderNumber":"string",
"Krugoreis":false,
"Loading":{...},
"CityId":0,
"Latitude":0.5,
"Longitude":0.5,
"Street":"string",
"TimeStart":"1970-01-01T00:00:00.000Z",
"TimeEnd":"1970-01-01T00:00:00.000Z",
"IsRoundTheClock":false,
"LargeCities":[...]
0
]
},
"ExtraPoints":[...],
{...}
"CityId":0,
"PointType":0,
"Latitude":0.5,
"Longitude":0.5,
"Street":"string",
"OrdinalId":0
}
],
"Unloading":{...},
"CityId":0,
"Latitude":0.5,
"Longitude":0.5,
"Street":"string",
"TimeStart":"1970-01-01T00:00:00.000Z",
"TimeEnd":"1970-01-01T00:00:00.000Z",
"IsRoundTheClock":false,
"LargeCities":[...]
0
]
},
"Cargo":{...},
"Weight":0.5,
"Volume":0.5,
"ADR":0,
"CargoTypeId":0,
"CargoType":"string",
"PackType":0,
"PalletCount":0,
"BeltCount":0,
"DogruzType":0,
"SborGruz":false,
"Size":{...}
"Length":0.5,
"Width":0.5,
"Height":0.5,
"Diameter":0.5,
"LengthHighlight":false,
"WidthHighlight":false,
"HeightHighlight":false
}
},
"Transport":{...},
"CarType":0,
"LoadingType":0,
"LoadingLogicalOperator":"string",
"UnloadingType":0,
"UnloadingLogicalOperator":"string",
"TrucksQuantity":0,
"TemperatureFrom":0,
"TemperatureTo":0,
"Stsepka":false,
"Pnevmohod":false,
"Koniki":false,
"TIR":false,
"CMR":false,
"T1":false,
"SanPassport":false
},
"Payment":{...},
"CurrencyId":0,
"MoneyType":0,
"RateSum":0.5,
"SumWithNDS":0.5,
"SumWithoutNDS":0.5,
"PrepayPercent":0,
"PrepayPercentEnabled":false,
"PayDays":0,
"PayDaysEnabled":false,
"FixedRate":false,
"Torg":false,
"DirectContract":false,
"InFuel":false,
"OnUnloading":false,
"HideResponses":false,
"AcceptPaymentTypes":0
},
"PriorityView":{...},
"DailyLimit":0.5,
"IsForPayedOnly":false,
"OrderLimit":0.5,
"ViewRate":0.5,
"MoneySpentPerDay":0.5,
"MoneySpentPerOrder":0.5
},
"Stealth":{...},
"ListIdToHide":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"FirmRegDateToHide":"1970-01-01T00:00:00.000Z",
"ScoreToHide":0.5
},
"LoadFiles":[...],
{...}
"Id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"FileType":0,
"Attributes":0,
"Name":"string",
"Link":"string",
"Size":0
}
],
"Deal":{...},
"Auction":{...}
"StartRate":0.5,
"Currency":0,
"Step":0.5,
"PaymentType":0,
"AcceptSecondPayType":false,
"StartDate":"1970-01-01T00:00:00.000Z",
"EndDate":"1970-01-01T00:00:00.000Z",
"EndDateBoundary":"1970-01-01T00:00:00.000Z",
"Nds":0.5,
"TimeToProvideDocuments":0.5,
"AutoRenew":false,
"RenewTime":0,
"MaxRenewTime":0,
"RaiseBid":false,
"MaxRate":0.5,
"RaiseBidInterval":0,
"ResponseInMinutes":0,
"Duration":0,
"StartSinceFirstBet":false,
"AuctionRestartParameters":{...},
"AuctionFinishAction":0,
"InitRestartCount":0,
"InitChangeWinnerCount":0,
"DurationAfterRestart":0
},
"AcceptCounterOffersOnlyBeforeFirstBet":false,
"WinnerCriterion":0,
"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ActiveDealId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"State":0,
"Finished":false,
"WinDate":"1970-01-01T00:00:00.000Z",
"AuctionRates":[...]
{...}
"AuctionRateId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"AddedAt":"1970-01-01T00:00:00.000Z",
"RateFirm":{...},
"Score":0.5,
"Status":0,
"Name":"string",
"ContactName":"string",
"AtiId":"string"
},
"Rate":0.5,
"State":0,
"LoadingDate":"1970-01-01T00:00:00.000Z",
"FirmId":0,
"ContactId":0
}
]
}
},
"Boards":[...],
{...}
"BoardId":"string",
"PublicationTime":"1970-01-01T00:00:00.000Z",
"IsReservationEnabled":false,
"PublicationOption":0,
"IsPublished":false,
"IsCommonBoard":false
}
],
"UnloadFirstDate":"1970-01-01T00:00:00.000Z",
"UnloadLastDate":"1970-01-01T00:00:00.000Z",
"TruePrice":0,
"TrueCurrencyId":0,
"ResponseCount":0,
"OfferCount":0,
"CanBeDeleted":false,
"HasPermissionsToLoad":false,
"CanBeEdited":false,
"CanBeRenewed":false,
"CanBeRestored":false,
"EditRestriction":0,
"DeleteRestriction":0,
"RestoreRestriction":0,
"RenewRestriction":"string",
"Id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"LoadNumber":"string",
"UpdatedAt":"1970-01-01T00:00:00.000Z",
"AddedAt":"1970-01-01T00:00:00.000Z",
"Distance":0,
"PlatonRoadsLength":0,
"TollRoadsLength":0,
"TravelTime":"?",
"Zimnik":false,
"Ferries":false,
"FirmId":"string",
"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
{...}
ContactId1*: int32

Идентификатор первого выбранного контакта.
Список всех контактов и их идентификаторы можно получить с помощью API для работы с фирмами
Контакт должен быть виден для остальных участников АТИ

ContactId2: int32

Идентификатор второго выбранного контакта, если не выбрано, то null
Контакт должен быть виден для остальных участников АТИ

Note: string

Примечание к грузу
Ограничение по длине: 1000 символов

FirstDate: date-time

Дата, начиная с которой груз актуален, в формате UTC
Минимальное значение равно текущей дате
При значении параметра DateType равным 0, допустимое значение поля - текущая дата
При значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 60 дней вперед
При значении параметра DateType равным 2, допустимое значение поля - текущая дата
При значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать

LastDate: date-time

Дата, после которой груз не актуален, в формате UTC
Минимальное значение равно значению параметра FirstDate
При значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед
При значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед
При значении параметра DateType равным 2, данное поле вычисляется автоматически по формуле FirstDate + 2 месяца, передаваемое значение игнорируется
При значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется

DateType: int32

Выбор типа готовности груза к перевозке

  • 0 - Готов к загрузке
  • 1 - с Х по У
  • 2 - постоянно
  • 3 - груза нет, запрос ставки
PeriodicityId: int32

Периодичность загрузки
Если параметр DateType не равен 2, PeriodicityId равен 0.
Иначе PeriodicityId может принимать следующие значения:

  • 1 - ежедневно
  • 100 - по рабочим дням
OrderNumber: string

Номер заказа
Ограничение по длине: 250 символов

Krugoreis: boolean

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

UnloadFirstDate: date-time

Дата начала разгрузки, в формате UTC.
Может иметь значение null.
Минимальное значение равно текущей дате.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

UnloadLastDate: date-time

Дата окончания разгрузки, в формате UTC. Может иметь значение null.
Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

TruePrice: int32

Озвученная ставка

TrueCurrencyId: int32

ID валюты озвученной ставки

ResponseCount: int32

Количество отзывов о грузе (без встречных предложений)

OfferCount: int32

Количество встречных предложений (остальные отзывы не учитываются)

CanBeDeleted: boolean

Есть ли доступ на удаление груза.

HasPermissionsToLoad: boolean

Есть ли доступ на работу с грузом (без учета прав).

CanBeEdited: boolean

Есть ли доступ на редактирование груза.

CanBeRenewed: boolean

Есть ли доступ на обновление груза.

CanBeRestored: boolean

Есть ли доступ на восстановление груза

EditRestriction: enum
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]

Причины отказа в доступе на редактирование груза:

  • 0 - Вы имеете доступ к работе с грузом
  • 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
  • 2 - Груз зарезервирован/взят, операции с грузом запрещены
  • 3 - Превышен лимит актуальных грузов
  • 4 - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав
  • 5 - У вашего контакта недостаточно прав для работы с данным грузом
  • 6 - Груз имеет завершенные Торги, операции с грузом запрещены
  • 7 - Сервис сделок временно недоступен
  • 8 - Нельзя изменять или удалять груз из сквозных торгов
  • 9 - У вашего контакта недостаточно прав для создания грузов
  • 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
  • 11 - У вашего контакта недостаточно прав для работы с грузами на Общей площадке
  • 12 - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках
  • 13 - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе
  • 14 - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз
  • 15 - Ваш контакт должен быть указан первым в грузе
DeleteRestriction: enum
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]

Причины отказа в доступе на удаление контакта:

  • 0 - Вы имеете доступ к работе с грузом
  • 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
  • 2 - Груз зарезервирован/взят, операции с грузом запрещены
  • 3 - Превышен лимит актуальных грузов
  • 4 - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав
  • 5 - У вашего контакта недостаточно прав для работы с данным грузом
  • 6 - Груз имеет завершенные Торги, операции с грузом запрещены
  • 7 - Сервис сделок временно недоступен
  • 8 - Нельзя изменять или удалять груз из сквозных торгов
  • 9 - У вашего контакта недостаточно прав для создания грузов
  • 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
  • 11 - У вашего контакта недостаточно прав для работы с грузами на Общей площадке
  • 12 - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках
  • 13 - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе
  • 14 - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз
  • 15 - Ваш контакт должен быть указан первым в грузе
RestoreRestriction: enum
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]

Причины отказа в доступе на восстановление груза:

  • 0 - Вы имеете доступ к работе с грузом
  • 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
  • 2 - Груз зарезервирован/взят, операции с грузом запрещены
  • 3 - Превышен лимит актуальных грузов
  • 4 - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав
  • 5 - У вашего контакта недостаточно прав для работы с данным грузом
  • 6 - Груз имеет завершенные Торги, операции с грузом запрещены
  • 7 - Сервис сделок временно недоступен
  • 8 - Нельзя изменять или удалять груз из сквозных торгов
  • 9 - У вашего контакта недостаточно прав для создания грузов
  • 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
  • 11 - У вашего контакта недостаточно прав для работы с грузами на Общей площадке
  • 12 - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках
  • 13 - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе
  • 14 - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз
  • 15 - Ваш контакт должен быть указан первым в грузе
RenewRestriction: string

Причина отказа в доступе на обновление груза.

Id: guid

Идентификатор груза

LoadNumber: string

Номер груза

UpdatedAt: date-time

Дата последнего изменения груза в формате UTC

AddedAt: date-time

Время добавления груза в формате UTC

Distance: int32

Расстояние по дорогам в км

PlatonRoadsLength: int32

Протяженность дорог в км, в построенном пути за которые взимается плата по системе Платон

TollRoadsLength: int32

Протяженность платных дорог в построенном пути в км

TravelTime: time-span

Время в пути

Zimnik: boolean

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

Ferries: boolean

Параметр, который определяет, учитывать ли паромные переправы для перевозки груза

FirmId: string

Идентификатор фирмы

AuctionId: guid

Id аукциона

}
202 У Вас уже есть груз с такими же параметрами, поэтому два груза объединены в один
Развернуть все Свернуть все
Пример Модель
{...}
"Reason":"string",
"Error":"string"
}
{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}
4XX Ошибка запроса. Подробнее про ошибки API
Развернуть все Свернуть все
Пример Модель
{...}
"Reason":"string",
"Error":"string"
}
{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Групповое восстановление архивных грузов

 
Групповое восстановление грузов
put
/v1.0/unpublished-loads/restore
ids
array
Добавить еще поле
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Статус
Развернуть все Свернуть все
Пример Модель
{...}
"any-key":{...}
"Status":0,
"Message":"string"
}
}
{...}
}
4XX Ошибка запроса. Подробнее про ошибки API
Развернуть все Свернуть все
Пример Модель
{...}
"Reason":"string",
"Error":"string"
}
{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Получение одного архивного груза

 
Метод для получения заданного архивного груза
get
/v1.0/unpublished-loads/{loadId}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Архивный груз
Развернуть все Свернуть все
Пример Модель
{...}
"LoadMeta":{...},
"LoadMetaId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"MetaData":"string"
},
"ContactId1":0,
"ContactId2":0,
"Note":"string",
"FirstDate":"1970-01-01T00:00:00.000Z",
"LastDate":"1970-01-01T00:00:00.000Z",
"DateType":0,
"PeriodicityId":0,
"OrderNumber":"string",
"Krugoreis":false,
"Loading":{...},
"CityId":0,
"Latitude":0.5,
"Longitude":0.5,
"Street":"string",
"TimeStart":"1970-01-01T00:00:00.000Z",
"TimeEnd":"1970-01-01T00:00:00.000Z",
"IsRoundTheClock":false,
"LargeCities":[...]
0
]
},
"ExtraPoints":[...],
{...}
"CityId":0,
"PointType":0,
"Latitude":0.5,
"Longitude":0.5,
"Street":"string",
"OrdinalId":0
}
],
"Unloading":{...},
"CityId":0,
"Latitude":0.5,
"Longitude":0.5,
"Street":"string",
"TimeStart":"1970-01-01T00:00:00.000Z",
"TimeEnd":"1970-01-01T00:00:00.000Z",
"IsRoundTheClock":false,
"LargeCities":[...]
0
]
},
"Cargo":{...},
"Weight":0.5,
"Volume":0.5,
"ADR":0,
"CargoTypeId":0,
"CargoType":"string",
"PackType":0,
"PalletCount":0,
"BeltCount":0,
"DogruzType":0,
"SborGruz":false,
"Size":{...}
"Length":0.5,
"Width":0.5,
"Height":0.5,
"Diameter":0.5,
"LengthHighlight":false,
"WidthHighlight":false,
"HeightHighlight":false
}
},
"Transport":{...},
"CarType":0,
"LoadingType":0,
"LoadingLogicalOperator":"string",
"UnloadingType":0,
"UnloadingLogicalOperator":"string",
"TrucksQuantity":0,
"TemperatureFrom":0,
"TemperatureTo":0,
"Stsepka":false,
"Pnevmohod":false,
"Koniki":false,
"TIR":false,
"CMR":false,
"T1":false,
"SanPassport":false
},
"Payment":{...},
"CurrencyId":0,
"MoneyType":0,
"RateSum":0.5,
"SumWithNDS":0.5,
"SumWithoutNDS":0.5,
"PrepayPercent":0,
"PrepayPercentEnabled":false,
"PayDays":0,
"PayDaysEnabled":false,
"FixedRate":false,
"Torg":false,
"DirectContract":false,
"InFuel":false,
"OnUnloading":false,
"HideResponses":false,
"AcceptPaymentTypes":0
},
"PriorityView":{...},
"DailyLimit":0.5,
"IsForPayedOnly":false,
"OrderLimit":0.5,
"ViewRate":0.5,
"MoneySpentPerDay":0.5,
"MoneySpentPerOrder":0.5
},
"Stealth":{...},
"ListIdToHide":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"FirmRegDateToHide":"1970-01-01T00:00:00.000Z",
"ScoreToHide":0.5
},
"LoadFiles":[...],
{...}
"Id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"FileType":0,
"Attributes":0,
"Name":"string",
"Link":"string",
"Size":0
}
],
"Deal":{...},
"Auction":{...}
"StartRate":0.5,
"Currency":0,
"Step":0.5,
"PaymentType":0,
"AcceptSecondPayType":false,
"StartDate":"1970-01-01T00:00:00.000Z",
"EndDate":"1970-01-01T00:00:00.000Z",
"EndDateBoundary":"1970-01-01T00:00:00.000Z",
"Nds":0.5,
"TimeToProvideDocuments":0.5,
"AutoRenew":false,
"RenewTime":0,
"MaxRenewTime":0,
"RaiseBid":false,
"MaxRate":0.5,
"RaiseBidInterval":0,
"ResponseInMinutes":0,
"Duration":0,
"StartSinceFirstBet":false,
"AuctionRestartParameters":{...},
"AuctionFinishAction":0,
"InitRestartCount":0,
"InitChangeWinnerCount":0,
"DurationAfterRestart":0
},
"AcceptCounterOffersOnlyBeforeFirstBet":false,
"WinnerCriterion":0,
"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ActiveDealId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"State":0,
"Finished":false,
"WinDate":"1970-01-01T00:00:00.000Z",
"AuctionRates":[...]
{...}
"AuctionRateId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"AddedAt":"1970-01-01T00:00:00.000Z",
"RateFirm":{...},
"Score":0.5,
"Status":0,
"Name":"string",
"ContactName":"string",
"AtiId":"string"
},
"Rate":0.5,
"State":0,
"LoadingDate":"1970-01-01T00:00:00.000Z",
"FirmId":0,
"ContactId":0
}
]
}
},
"Boards":[...],
{...}
"BoardId":"string",
"PublicationTime":"1970-01-01T00:00:00.000Z",
"IsReservationEnabled":false,
"PublicationOption":0,
"IsPublished":false,
"IsCommonBoard":false
}
],
"UnloadFirstDate":"1970-01-01T00:00:00.000Z",
"UnloadLastDate":"1970-01-01T00:00:00.000Z",
"TruePrice":0,
"TrueCurrencyId":0,
"ResponseCount":0,
"OfferCount":0,
"CanBeDeleted":false,
"HasPermissionsToLoad":false,
"CanBeEdited":false,
"CanBeRenewed":false,
"CanBeRestored":false,
"EditRestriction":0,
"DeleteRestriction":0,
"RestoreRestriction":0,
"RenewRestriction":"string",
"Id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"LoadNumber":"string",
"UpdatedAt":"1970-01-01T00:00:00.000Z",
"AddedAt":"1970-01-01T00:00:00.000Z",
"Distance":0,
"PlatonRoadsLength":0,
"TollRoadsLength":0,
"TravelTime":"?",
"Zimnik":false,
"Ferries":false,
"FirmId":"string",
"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
{...}
ContactId1*: int32

Идентификатор первого выбранного контакта.
Список всех контактов и их идентификаторы можно получить с помощью API для работы с фирмами
Контакт должен быть виден для остальных участников АТИ

ContactId2: int32

Идентификатор второго выбранного контакта, если не выбрано, то null
Контакт должен быть виден для остальных участников АТИ

Note: string

Примечание к грузу
Ограничение по длине: 1000 символов

FirstDate: date-time

Дата, начиная с которой груз актуален, в формате UTC
Минимальное значение равно текущей дате
При значении параметра DateType равным 0, допустимое значение поля - текущая дата
При значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 60 дней вперед
При значении параметра DateType равным 2, допустимое значение поля - текущая дата
При значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать

LastDate: date-time

Дата, после которой груз не актуален, в формате UTC
Минимальное значение равно значению параметра FirstDate
При значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед
При значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед
При значении параметра DateType равным 2, данное поле вычисляется автоматически по формуле FirstDate + 2 месяца, передаваемое значение игнорируется
При значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется

DateType: int32

Выбор типа готовности груза к перевозке

  • 0 - Готов к загрузке
  • 1 - с Х по У
  • 2 - постоянно
  • 3 - груза нет, запрос ставки
PeriodicityId: int32

Периодичность загрузки
Если параметр DateType не равен 2, PeriodicityId равен 0.
Иначе PeriodicityId может принимать следующие значения:

  • 1 - ежедневно
  • 100 - по рабочим дням
OrderNumber: string

Номер заказа
Ограничение по длине: 250 символов

Krugoreis: boolean

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

UnloadFirstDate: date-time

Дата начала разгрузки, в формате UTC.
Может иметь значение null.
Минимальное значение равно текущей дате.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

UnloadLastDate: date-time

Дата окончания разгрузки, в формате UTC. Может иметь значение null.
Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

TruePrice: int32

Озвученная ставка

TrueCurrencyId: int32

ID валюты озвученной ставки

ResponseCount: int32

Количество отзывов о грузе (без встречных предложений)

OfferCount: int32

Количество встречных предложений (остальные отзывы не учитываются)

CanBeDeleted: boolean

Есть ли доступ на удаление груза.

HasPermissionsToLoad: boolean

Есть ли доступ на работу с грузом (без учета прав).

CanBeEdited: boolean

Есть ли доступ на редактирование груза.

CanBeRenewed: boolean

Есть ли доступ на обновление груза.

CanBeRestored: boolean

Есть ли доступ на восстановление груза

EditRestriction: enum
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]

Причины отказа в доступе на редактирование груза:

  • 0 - Вы имеете доступ к работе с грузом
  • 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
  • 2 - Груз зарезервирован/взят, операции с грузом запрещены
  • 3 - Превышен лимит актуальных грузов
  • 4 - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав
  • 5 - У вашего контакта недостаточно прав для работы с данным грузом
  • 6 - Груз имеет завершенные Торги, операции с грузом запрещены
  • 7 - Сервис сделок временно недоступен
  • 8 - Нельзя изменять или удалять груз из сквозных торгов
  • 9 - У вашего контакта недостаточно прав для создания грузов
  • 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
  • 11 - У вашего контакта недостаточно прав для работы с грузами на Общей площадке
  • 12 - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках
  • 13 - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе
  • 14 - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз
  • 15 - Ваш контакт должен быть указан первым в грузе
DeleteRestriction: enum
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]

Причины отказа в доступе на удаление контакта:

  • 0 - Вы имеете доступ к работе с грузом
  • 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
  • 2 - Груз зарезервирован/взят, операции с грузом запрещены
  • 3 - Превышен лимит актуальных грузов
  • 4 - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав
  • 5 - У вашего контакта недостаточно прав для работы с данным грузом
  • 6 - Груз имеет завершенные Торги, операции с грузом запрещены
  • 7 - Сервис сделок временно недоступен
  • 8 - Нельзя изменять или удалять груз из сквозных торгов
  • 9 - У вашего контакта недостаточно прав для создания грузов
  • 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
  • 11 - У вашего контакта недостаточно прав для работы с грузами на Общей площадке
  • 12 - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках
  • 13 - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе
  • 14 - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз
  • 15 - Ваш контакт должен быть указан первым в грузе
RestoreRestriction: enum
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]

Причины отказа в доступе на восстановление груза:

  • 0 - Вы имеете доступ к работе с грузом
  • 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
  • 2 - Груз зарезервирован/взят, операции с грузом запрещены
  • 3 - Превышен лимит актуальных грузов
  • 4 - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав
  • 5 - У вашего контакта недостаточно прав для работы с данным грузом
  • 6 - Груз имеет завершенные Торги, операции с грузом запрещены
  • 7 - Сервис сделок временно недоступен
  • 8 - Нельзя изменять или удалять груз из сквозных торгов
  • 9 - У вашего контакта недостаточно прав для создания грузов
  • 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
  • 11 - У вашего контакта недостаточно прав для работы с грузами на Общей площадке
  • 12 - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках
  • 13 - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе
  • 14 - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз
  • 15 - Ваш контакт должен быть указан первым в грузе
RenewRestriction: string

Причина отказа в доступе на обновление груза.

Id: guid

Идентификатор груза

LoadNumber: string

Номер груза

UpdatedAt: date-time

Дата последнего изменения груза в формате UTC

AddedAt: date-time

Время добавления груза в формате UTC

Distance: int32

Расстояние по дорогам в км

PlatonRoadsLength: int32

Протяженность дорог в км, в построенном пути за которые взимается плата по системе Платон

TollRoadsLength: int32

Протяженность платных дорог в построенном пути в км

TravelTime: time-span

Время в пути

Zimnik: boolean

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

Ferries: boolean

Параметр, который определяет, учитывать ли паромные переправы для перевозки груза

FirmId: string

Идентификатор фирмы

AuctionId: guid

Id аукциона

}
4XX Ошибка запроса. Подробнее про ошибки API
Развернуть все Свернуть все
Пример Модель
{...}
"Reason":"string",
"Error":"string"
}
{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Получение всех архивных грузов

Доступен фильтр по контакту. При передаче значения в contactId будут получены только те грузы, у которых ContactId1 == contactId либо ContactId2 == contactId.

 
Метод для получения списка всех архивных грузов
get
/v1.0/unpublished-loads
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Архивные грузы
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"LoadMeta":{...},
"LoadMetaId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"MetaData":"string"
},
"ContactId1":0,
"ContactId2":0,
"Note":"string",
"FirstDate":"1970-01-01T00:00:00.000Z",
"LastDate":"1970-01-01T00:00:00.000Z",
"DateType":0,
"PeriodicityId":0,
"OrderNumber":"string",
"Krugoreis":false,
"Loading":{...},
"CityId":0,
"Latitude":0.5,
"Longitude":0.5,
"Street":"string",
"TimeStart":"1970-01-01T00:00:00.000Z",
"TimeEnd":"1970-01-01T00:00:00.000Z",
"IsRoundTheClock":false,
"LargeCities":[...]
0
]
},
"ExtraPoints":[...],
{...}
"CityId":0,
"PointType":0,
"Latitude":0.5,
"Longitude":0.5,
"Street":"string",
"OrdinalId":0
}
],
"Unloading":{...},
"CityId":0,
"Latitude":0.5,
"Longitude":0.5,
"Street":"string",
"TimeStart":"1970-01-01T00:00:00.000Z",
"TimeEnd":"1970-01-01T00:00:00.000Z",
"IsRoundTheClock":false,
"LargeCities":[...]
0
]
},
"Cargo":{...},
"Weight":0.5,
"Volume":0.5,
"ADR":0,
"CargoTypeId":0,
"CargoType":"string",
"PackType":0,
"PalletCount":0,
"BeltCount":0,
"DogruzType":0,
"SborGruz":false,
"Size":{...}
"Length":0.5,
"Width":0.5,
"Height":0.5,
"Diameter":0.5,
"LengthHighlight":false,
"WidthHighlight":false,
"HeightHighlight":false
}
},
"Transport":{...},
"CarType":0,
"LoadingType":0,
"LoadingLogicalOperator":"string",
"UnloadingType":0,
"UnloadingLogicalOperator":"string",
"TrucksQuantity":0,
"TemperatureFrom":0,
"TemperatureTo":0,
"Stsepka":false,
"Pnevmohod":false,
"Koniki":false,
"TIR":false,
"CMR":false,
"T1":false,
"SanPassport":false
},
"Payment":{...},
"CurrencyId":0,
"MoneyType":0,
"RateSum":0.5,
"SumWithNDS":0.5,
"SumWithoutNDS":0.5,
"PrepayPercent":0,
"PrepayPercentEnabled":false,
"PayDays":0,
"PayDaysEnabled":false,
"FixedRate":false,
"Torg":false,
"DirectContract":false,
"InFuel":false,
"OnUnloading":false,
"HideResponses":false,
"AcceptPaymentTypes":0
},
"PriorityView":{...},
"DailyLimit":0.5,
"IsForPayedOnly":false,
"OrderLimit":0.5,
"ViewRate":0.5,
"MoneySpentPerDay":0.5,
"MoneySpentPerOrder":0.5
},
"Stealth":{...},
"ListIdToHide":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"FirmRegDateToHide":"1970-01-01T00:00:00.000Z",
"ScoreToHide":0.5
},
"LoadFiles":[...],
{...}
"Id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"FileType":0,
"Attributes":0,
"Name":"string",
"Link":"string",
"Size":0
}
],
"Deal":{...},
"Auction":{...}
"StartRate":0.5,
"Currency":0,
"Step":0.5,
"PaymentType":0,
"AcceptSecondPayType":false,
"StartDate":"1970-01-01T00:00:00.000Z",
"EndDate":"1970-01-01T00:00:00.000Z",
"EndDateBoundary":"1970-01-01T00:00:00.000Z",
"Nds":0.5,
"TimeToProvideDocuments":0.5,
"AutoRenew":false,
"RenewTime":0,
"MaxRenewTime":0,
"RaiseBid":false,
"MaxRate":0.5,
"RaiseBidInterval":0,
"ResponseInMinutes":0,
"Duration":0,
"StartSinceFirstBet":false,
"AuctionRestartParameters":{...},
"AuctionFinishAction":0,
"InitRestartCount":0,
"InitChangeWinnerCount":0,
"DurationAfterRestart":0
},
"AcceptCounterOffersOnlyBeforeFirstBet":false,
"WinnerCriterion":0,
"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ActiveDealId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"State":0,
"Finished":false,
"WinDate":"1970-01-01T00:00:00.000Z",
"AuctionRates":[...]
{...}
"AuctionRateId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"AddedAt":"1970-01-01T00:00:00.000Z",
"RateFirm":{...},
"Score":0.5,
"Status":0,
"Name":"string",
"ContactName":"string",
"AtiId":"string"
},
"Rate":0.5,
"State":0,
"LoadingDate":"1970-01-01T00:00:00.000Z",
"FirmId":0,
"ContactId":0
}
]
}
},
"Boards":[...],
{...}
"BoardId":"string",
"PublicationTime":"1970-01-01T00:00:00.000Z",
"IsReservationEnabled":false,
"PublicationOption":0,
"IsPublished":false,
"IsCommonBoard":false
}
],
"UnloadFirstDate":"1970-01-01T00:00:00.000Z",
"UnloadLastDate":"1970-01-01T00:00:00.000Z",
"TruePrice":0,
"TrueCurrencyId":0,
"ResponseCount":0,
"OfferCount":0,
"CanBeDeleted":false,
"HasPermissionsToLoad":false,
"CanBeEdited":false,
"CanBeRenewed":false,
"CanBeRestored":false,
"EditRestriction":0,
"DeleteRestriction":0,
"RestoreRestriction":0,
"RenewRestriction":"string",
"Id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"LoadNumber":"string",
"UpdatedAt":"1970-01-01T00:00:00.000Z",
"AddedAt":"1970-01-01T00:00:00.000Z",
"Distance":0,
"PlatonRoadsLength":0,
"TollRoadsLength":0,
"TravelTime":"?",
"Zimnik":false,
"Ferries":false,
"FirmId":"string",
"AuctionId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
[{...}]
ContactId1*: int32

Идентификатор первого выбранного контакта.
Список всех контактов и их идентификаторы можно получить с помощью API для работы с фирмами
Контакт должен быть виден для остальных участников АТИ

ContactId2: int32

Идентификатор второго выбранного контакта, если не выбрано, то null
Контакт должен быть виден для остальных участников АТИ

Note: string

Примечание к грузу
Ограничение по длине: 1000 символов

FirstDate: date-time

Дата, начиная с которой груз актуален, в формате UTC
Минимальное значение равно текущей дате
При значении параметра DateType равным 0, допустимое значение поля - текущая дата
При значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 60 дней вперед
При значении параметра DateType равным 2, допустимое значение поля - текущая дата
При значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать

LastDate: date-time

Дата, после которой груз не актуален, в формате UTC
Минимальное значение равно значению параметра FirstDate
При значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед
При значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед
При значении параметра DateType равным 2, данное поле вычисляется автоматически по формуле FirstDate + 2 месяца, передаваемое значение игнорируется
При значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется

DateType: int32

Выбор типа готовности груза к перевозке

  • 0 - Готов к загрузке
  • 1 - с Х по У
  • 2 - постоянно
  • 3 - груза нет, запрос ставки
PeriodicityId: int32

Периодичность загрузки
Если параметр DateType не равен 2, PeriodicityId равен 0.
Иначе PeriodicityId может принимать следующие значения:

  • 1 - ежедневно
  • 100 - по рабочим дням
OrderNumber: string

Номер заказа
Ограничение по длине: 250 символов

Krugoreis: boolean

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

UnloadFirstDate: date-time

Дата начала разгрузки, в формате UTC.
Может иметь значение null.
Минимальное значение равно текущей дате.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

UnloadLastDate: date-time

Дата окончания разгрузки, в формате UTC. Может иметь значение null.
Если нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate.
При значении параметра DateType равным 3, UnloadFirstDate принимает значение null

TruePrice: int32

Озвученная ставка

TrueCurrencyId: int32

ID валюты озвученной ставки

ResponseCount: int32

Количество отзывов о грузе (без встречных предложений)

OfferCount: int32

Количество встречных предложений (остальные отзывы не учитываются)

CanBeDeleted: boolean

Есть ли доступ на удаление груза.

HasPermissionsToLoad: boolean

Есть ли доступ на работу с грузом (без учета прав).

CanBeEdited: boolean

Есть ли доступ на редактирование груза.

CanBeRenewed: boolean

Есть ли доступ на обновление груза.

CanBeRestored: boolean

Есть ли доступ на восстановление груза

EditRestriction: enum
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]

Причины отказа в доступе на редактирование груза:

  • 0 - Вы имеете доступ к работе с грузом
  • 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
  • 2 - Груз зарезервирован/взят, операции с грузом запрещены
  • 3 - Превышен лимит актуальных грузов
  • 4 - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав
  • 5 - У вашего контакта недостаточно прав для работы с данным грузом
  • 6 - Груз имеет завершенные Торги, операции с грузом запрещены
  • 7 - Сервис сделок временно недоступен
  • 8 - Нельзя изменять или удалять груз из сквозных торгов
  • 9 - У вашего контакта недостаточно прав для создания грузов
  • 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
  • 11 - У вашего контакта недостаточно прав для работы с грузами на Общей площадке
  • 12 - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках
  • 13 - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе
  • 14 - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз
  • 15 - Ваш контакт должен быть указан первым в грузе
DeleteRestriction: enum
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]

Причины отказа в доступе на удаление контакта:

  • 0 - Вы имеете доступ к работе с грузом
  • 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
  • 2 - Груз зарезервирован/взят, операции с грузом запрещены
  • 3 - Превышен лимит актуальных грузов
  • 4 - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав
  • 5 - У вашего контакта недостаточно прав для работы с данным грузом
  • 6 - Груз имеет завершенные Торги, операции с грузом запрещены
  • 7 - Сервис сделок временно недоступен
  • 8 - Нельзя изменять или удалять груз из сквозных торгов
  • 9 - У вашего контакта недостаточно прав для создания грузов
  • 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
  • 11 - У вашего контакта недостаточно прав для работы с грузами на Общей площадке
  • 12 - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках
  • 13 - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе
  • 14 - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз
  • 15 - Ваш контакт должен быть указан первым в грузе
RestoreRestriction: enum
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]

Причины отказа в доступе на восстановление груза:

  • 0 - Вы имеете доступ к работе с грузом
  • 1 - Ваша фирма больше не может размещать грузы из-за нарушения правил АТИ
  • 2 - Груз зарезервирован/взят, операции с грузом запрещены
  • 3 - Превышен лимит актуальных грузов
  • 4 - Вы пытаетесь работать с грузами под общим пользователем. Недостаточно прав
  • 5 - У вашего контакта недостаточно прав для работы с данным грузом
  • 6 - Груз имеет завершенные Торги, операции с грузом запрещены
  • 7 - Сервис сделок временно недоступен
  • 8 - Нельзя изменять или удалять груз из сквозных торгов
  • 9 - У вашего контакта недостаточно прав для создания грузов
  • 10 - У вашего контакта недостаточно прав для работы с виртуальными кошельками
  • 11 - У вашего контакта недостаточно прав для работы с грузами на Общей площадке
  • 12 - У вашего контакта недостаточно прав для работы с грузами на Персональных площадках
  • 13 - У вашего контакта нет доступа для работы с одной или несколькими персональными площадками, указанными в грузе
  • 14 - У вашего контакта нет доступа для работы с подразделением, в которое восстанавливается груз
  • 15 - Ваш контакт должен быть указан первым в грузе
RenewRestriction: string

Причина отказа в доступе на обновление груза.

Id: guid

Идентификатор груза

LoadNumber: string

Номер груза

UpdatedAt: date-time

Дата последнего изменения груза в формате UTC

AddedAt: date-time

Время добавления груза в формате UTC

Distance: int32

Расстояние по дорогам в км

PlatonRoadsLength: int32

Протяженность дорог в км, в построенном пути за которые взимается плата по системе Платон

TollRoadsLength: int32

Протяженность платных дорог в построенном пути в км

TravelTime: time-span

Время в пути

Zimnik: boolean

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

Ferries: boolean

Параметр, который определяет, учитывать ли паромные переправы для перевозки груза

FirmId: string

Идентификатор фирмы

AuctionId: guid

Id аукциона

}]
4XX Ошибка запроса. Подробнее про ошибки API
Развернуть все Свернуть все
Пример Модель
{...}
"Reason":"string",
"Error":"string"
}
{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Удаление одного архивного груза

 
Удаление одного груза
delete
/v1.0/unpublished-loads/{loadId}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Статус
Развернуть все Свернуть все
Пример Модель
{...}
"any-key":{...}
"Status":0,
"Message":"string"
}
}
{...}
}
4XX Ошибка запроса. Подробнее про ошибки API
Развернуть все Свернуть все
Пример Модель
{...}
"Reason":"string",
"Error":"string"
}
{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Удаление нескольких архивных грузов

 
Метод для удаления списка архивных грузов
delete
/v1.0/unpublished-loads
ids
array
Добавить еще поле
id грузов для удаления
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Статус
Развернуть все Свернуть все
Пример Модель
{...}
"any-key":{...}
"Status":0,
"Message":"string"
}
}
{...}
}
4XX Ошибка запроса. Подробнее про ошибки API
Развернуть все Свернуть все
Пример Модель
{...}
"Reason":"string",
"Error":"string"
}
{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Методы для работы с комментариями к архивным грузам

Получение всех комментариев ко всем архивным грузам для текущей фирмы

Ответ будет представлен в виде словаря, где ключ - это id груза, а значение - массив структуры “комментарий”.

 
Получение всех комментариев фирмы ко всем грузам
get
/v1.0/unpublished-loads/comments
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Комментарии ко всем архивным грузам фирмы
Развернуть все Свернуть все
Пример Модель
{...}
"any-key":[...]
{...}
"CommentId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Message":"string",
"ContactId":0,
"CommentDateTime":"1970-01-01T00:00:00.000Z"
}
]
}
{...}
}
4XX Ошибка запроса. Подробнее про ошибки API
Развернуть все Свернуть все
Пример Модель
{...}
"Reason":"string",
"Error":"string"
}
{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Получение всех комментариев к архивному грузу для текущей фирмы

 
Получение всех комментариев к грузу для текущей фирмы.
get
/v1.0/unpublished-loads/{loadId}/comments
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Комментарии к архивному грузу
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"CommentId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Message":"string",
"ContactId":0,
"CommentDateTime":"1970-01-01T00:00:00.000Z"
}
]
[{...}]
CommentId: guid

Идентификатор комментария

Message: string

Комментарий

ContactId: int32

Контакт фирмы, который оставил комментарий

CommentDateTime: date-time

Время, когда комментарий был оставлен

}]
4XX Ошибка запроса. Подробнее про ошибки API
Развернуть все Свернуть все
Пример Модель
{...}
"Reason":"string",
"Error":"string"
}
{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Добавление либо редактирование комментария к архивному грузу

При редактировании комментария у изменённого комментария поменяется CommentId.

Требования к комментарию

  • комментарий не может быть пустым
  • длина комментария не более 128 символов
  • если для фирмы включен режим раздельного доступа, то количество комментариев ограничено одним на контакт, иначе – одним комментарием на фирму
  • комментарий можно добавлять только к собственному грузу
 
Добавление либо редактирование комментария к грузу.
put
/v1.0/unpublished-loads/{loadId}/comments
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Комментарий к архивному грузу
Развернуть все Свернуть все
Пример Модель
{...}
"CommentId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Message":"string",
"ContactId":0,
"CommentDateTime":"1970-01-01T00:00:00.000Z"
}
{...}
CommentId: guid

Идентификатор комментария

Message: string

Комментарий

ContactId: int32

Контакт фирмы, который оставил комментарий

CommentDateTime: date-time

Время, когда комментарий был оставлен

}
4XX Ошибка запроса. Подробнее про ошибки API
Развернуть все Свернуть все
Пример Модель
{...}
"Reason":"string",
"Error":"string"
}
{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Удаление комментария у архивного груза.

 
Удаление комментария у груза.
delete
/v1.0/unpublished-loads/{loadId}/comments
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Комментарий к архивному грузу успешно удален
Развернуть все Свернуть все
Пример Модель
"string"
string
4XX Ошибка запроса. Подробнее про ошибки API
Развернуть все Свернуть все
Пример Модель
{...}
"Reason":"string",
"Error":"string"
}
{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Методы для работы с отзывами к архивным грузам

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

Требования к дате, передаваемой в dateFrom при отправке запросов на получение отзывов:

  • Дата в UTC, начиная с которой необходимо показывать отзывы. Если ничего не передано, значит показываем абсолютно все отзывы
  • Формат даты: yyyy-mm-ddThh:mm:ss<timezone_specifier>, где timezone_specifier обозначает спецификатор часового пояса, например:
    • Z - дата в формате UTC. Пример, 2016-04-28T20:01:57Z;
    • -hh:mm - часовой пояс UTC-hh:mm. Пример UTC-1: 2016-04-28T20:01:57-01:00;
    • %2Bhh:mm - часовой пояс UTC+hh:mm. Пример UTC+1: 2016-04-28T20:01:57%2B01:00;
  • Если модификатора часового пояса нет, дата отправляется в формате UTC+3(Москва)

Получение встречных предложений на все архивные грузы фирмы

 
Получение встречных предложений на грузы фирмы с одной или несколькими ставками .
get
/v1.0/unpublished-loads/new/responses
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Массив отзывов на все грузы фирмы
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"ResponseId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"LoadNumber":"string",
"LoadFirmId":0,
"FirmId":0,
"FirmName":"string",
"ContactId":0,
"AddedAt":"1970-01-01T00:00:00.000Z",
"UpdatedAt":"1970-01-01T00:00:00.000Z",
"Price":0.5,
"CurrencyId":0,
"NdsPrice":0.5,
"NdsCurrencyId":0,
"NotNdsPrice":0.5,
"NotNdsCurrencyId":0,
"CounterOfferSource":0,
"Note":"string",
"PayAttributes":0,
"PrepayPercent":0,
"PayAfterMaxBankDays":0,
"LoadingDate":"1970-01-01T00:00:00.000Z",
"IsOutdated":false,
"IsLoadPublished":false,
"IsNoLoad":false,
"AnnouncedCurrencyId":0,
"AnnouncedRate":0,
"FirmInfo":{...}
"TotalScore":0.5,
"Status":0,
"FullFirmName":"string",
"Contact":{...},
"Id":0,
"Name":"string",
"Telephone":"string",
"Email":"string",
"Icq":"string",
"Mobile":"string",
"MobileOperator":"string",
"SkypeName":"string",
"CityId":0,
"Location":{...}
"CityId":0,
"RegionId":0,
"CountryId":0,
"FullName":"string",
"ShortName":"string",
"IsRegionalCenter":false,
"CitySize":0,
"FiasId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"CityName":"string",
"RegionName":"string",
"CountryName":"string",
"CountryCodeName":"string"
}
},
"Inn":"string"
}
}
]
[{...}]
ResponseId: guid

Id отзыва

LoadId: guid

Id груза, на который оставлен отзыв

LoadNumber: string

Номер груза

LoadFirmId: int32

Id фирмы, которой принадлежит груз

FirmId: int32

Id фирмы, которая оставила отзыв

FirmName: string

Название фирмы

ContactId: int32

Контакт, который сделал встречное предложение

AddedAt: date-time

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

UpdatedAt: date-time

Дата изменения отзыва

Price: decimal

Предложенная цена встречного предложения

CurrencyId: int32

Валюта встречного предложения
Значение из словаря валют АТИ

NdsPrice: decimal

Предложенная цена встречного предложения с ндс

NdsCurrencyId: int32

Валюта ставки встречного предложения б/нал с НДС.Параметр должен быть равен валюте, указанной в грузе, если параметр FixedRate равен True и параметр Torg равен False.
Значение из словаря валют АТИ

NotNdsPrice: decimal

Предложенная цена встречного предложения без ндс

NotNdsCurrencyId: int32

Валюта встречного предложения без ндс

CounterOfferSource: enum
[0, 1, 2, 3, 4, 5, 6]

Обозначение откуда было добавлено встречное предложение

  • 0 - Неизвестный источник
  • 1 - Мобильное приложение
  • 2 - Интегратор
  • 3 - Перехват грузов интегратором
  • 4 - Страница поиска грузов
  • 5 - Перехват машин
  • 6 - Сквозное встречное предложение, добавлено автоматически
Note: string

Примечание к встречному предложению
Максимальная длина - 512 символов

PayAttributes: int32

Атрибуты оплаты, по умолчанию - 0. Битовая сумма следующих параметров:

  • 1 - возможна оплата наличными
  • 2 - возможна оплата по безналичному рассчету
  • 4 - блиц
  • 8 - оплата с НДС
  • 16 - возможна предоплата
  • 32 - оплата на выгрузке
  • 64 - включена ли оплата через некоторое количество банковских дней
PrepayPercent: int32

Процент предоплаты
Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100

PayAfterMaxBankDays: int32

Оплата через ... банковских дней
Должен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 64 - включена оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99

LoadingDate: date-time

Дата, когда предложивший хочет перевезти ваш груз

IsOutdated: boolean

Определяет, просрочен ли отзыв. Когда груз редактируют, удаляют, обновляют, отзыв помечается просроченным.
Только для чтения.

IsLoadPublished: boolean

Относится ли отзыв к публикующемуся грузу

IsNoLoad: boolean

Параметр "Груза нет"

AnnouncedCurrencyId: int32

Валюта "Озвученной ставки"
Значение из словаря валют АТИ

AnnouncedRate: int32

Озвученная ставка

}]
4XX Ошибка запроса. Подробнее про ошибки API
Развернуть все Свернуть все
Пример Модель
{...}
"Reason":"string",
"Error":"string"
}
{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Получение отзывов на архивный груз по ID

 
Получение отзывов на конкретный груз фирмы. На данный момент можно получить только встречные предложения.
get
/v1.0/unpublished-loads/new/{loadId}/responses
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Массив отзывов
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"ResponseId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"LoadId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"LoadNumber":"string",
"LoadFirmId":0,
"FirmId":0,
"FirmName":"string",
"ContactId":0,
"AddedAt":"1970-01-01T00:00:00.000Z",
"UpdatedAt":"1970-01-01T00:00:00.000Z",
"Price":0.5,
"CurrencyId":0,
"NdsPrice":0.5,
"NdsCurrencyId":0,
"NotNdsPrice":0.5,
"NotNdsCurrencyId":0,
"CounterOfferSource":0,
"Note":"string",
"PayAttributes":0,
"PrepayPercent":0,
"PayAfterMaxBankDays":0,
"LoadingDate":"1970-01-01T00:00:00.000Z",
"IsOutdated":false,
"IsLoadPublished":false,
"IsNoLoad":false,
"AnnouncedCurrencyId":0,
"AnnouncedRate":0,
"FirmInfo":{...}
"TotalScore":0.5,
"Status":0,
"FullFirmName":"string",
"Contact":{...},
"Id":0,
"Name":"string",
"Telephone":"string",
"Email":"string",
"Icq":"string",
"Mobile":"string",
"MobileOperator":"string",
"SkypeName":"string",
"CityId":0,
"Location":{...}
"CityId":0,
"RegionId":0,
"CountryId":0,
"FullName":"string",
"ShortName":"string",
"IsRegionalCenter":false,
"CitySize":0,
"FiasId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"CityName":"string",
"RegionName":"string",
"CountryName":"string",
"CountryCodeName":"string"
}
},