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

API Тракмаркета: работа с объявлениями

Тракмаркет — раздел, где вы можете продавать, покупать и арендовать транспорт или спецтехнику.

Подробнее

Термины

  • ID объявления — уникальный идентификатор, который есть у каждого объявления. Представляет собой строку из 24 символов.

Методы

Получение объявления по ID или URL

Возвращает все поля объявления. Необходимо передать ID объявления или его URL.

 
post
/truckmarket/public/api/v1/transports/getone
Развернуть все Свернуть все
{...}
_id: string

ID объявления

url: string

URL объявления

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

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

                
Пример ответа Ответ
200 Возвращается объявление
Развернуть все Свернуть все
Пример Модель
{...}
"ok":false,
"result":{...}
"_id":"string",
"status":"active",
"advert_type":"sale",
"proposal_type":"purchase",
"archive_reason":"sold_on_ati",
"period_type":"hour",
"accident_description":"string",
"views_count":0,
"viewed_contacts_count":0,
"busy_date_ranges":[...],
{...}
"from":0,
"to":0
}
],
"owner_acc":"string",
"owner_contact":0,
"contacts":[...],
{...}
"id":0
}
],
"date_creation":"string",
"date_modified":"string",
"photos":[...],
"string"
],
"photo_url":"string",
"city_verbose":"string",
"country_verbose":"string",
"city_ati_id":"string",
"country_ati_id":"string",
"region_ati_id":"string",
"address":"string",
"price":0,
"currency":"rub",
"comment":"string",
"advert_item_type":"truck",
"advert_item":{...},
"is_new":false,
"brand":{...},
"id":0,
"name":"string",
"name_eng":"string",
"name_ru":"string"
},
"model":{...},
"id":0,
"model":"string"
},
"year":0,
"mileage":0,
"vin":"string",
"gov_num":"string",
"engine_type":"1",
"engine_volume":0,
"owner_count":"string",
"body_brand":"string",
"engine_power":0,
"gearbox_type":"1",
"body_type":"1",
"volume":0,
"capacity":0,
"length":0,
"height":0,
"width":0,
"cabin_type":"1",
"suspension_type":"1",
"wheel_formula":"1",
"drive_type":"1",
"max_speed":0,
"fuel_consumption_100":0,
"tank_volume":0,
"tanks_count":0,
"right_side_helm":false,
"computer":false,
"central_oil_management":false,
"conditioner":false,
"heater_in_cabin":false,
"engine_preheater":false
},
"advert_items":[...],
{...}
"type":"string",
"transport":{...}
"is_new":false,
"brand":{...},
"id":0,
"name":"string",
"name_eng":"string",
"name_ru":"string"
},
"model":{...},
"id":0,
"model":"string"
},
"year":0,
"mileage":0,
"vin":"string",
"gov_num":"string",
"engine_type":"1",
"engine_volume":0,
"owner_count":"string",
"body_brand":"string",
"engine_power":0,
"gearbox_type":"1",
"body_type":"1",
"volume":0,
"capacity":0,
"length":0,
"height":0,
"width":0,
"cabin_type":"1",
"suspension_type":"1",
"wheel_formula":"1",
"drive_type":"1",
"max_speed":0,
"fuel_consumption_100":0,
"tank_volume":0,
"tanks_count":0,
"right_side_helm":false,
"computer":false,
"central_oil_management":false,
"conditioner":false,
"heater_in_cabin":false,
"engine_preheater":false
}
}
],
"availability":"in_stock",
"with_driver":false
}
}
{...}

Запрос успешно выполнен

ok: enum
[true]
}
400 Ошибка валидации
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string",
"error_list":[...]
{...}
"error":"string",
"reason":"string"
}
]
}
{...}

Возвращаемое значение в случае ошибок

error*: string

В некоторых случаях (валидация) - ID ошибки, например ApplicationAlreadyCreated в случае "вы уже подали заявку на эту площадку"

reason*: string

Человекочитаемый (ну, почти всегда) текст ошибки

}
404 Объявление не найдено
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}

Возвращаемое значение в случае ошибок

error*: string

В некоторых случаях (валидация) - ID ошибки, например ApplicationAlreadyCreated в случае "вы уже подали заявку на эту площадку"

reason*: string

Человекочитаемый (ну, почти всегда) текст ошибки

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

Создание или изменение объявления

Позволяет создать новое или изменить существующее объявление. Обязательно передать все поля объявления и их значения, кроме ID.

Если передать ID объявления — будет изменено существующее объявление. Если не передавать — будет создано новое объявление.

 
post
/truckmarket/api/v1/transports
Развернуть все Свернуть все
{...}
_id: string

Уникальный ID объекта из mongodb, есть только у уже сохраненных, используется как поле идемпотентности

status*: enum
[active, archived]

Статус объявления (Активное, в Архиве)

advert_type*: enum
[sale, rent, purchase]

Тип объявления

proposal_type: enum
[purchase, rent]

Тип заявки объявления

archive_reason: enum
[sold_on_ati, sold_elsewhere, stop_rent, transport_crash, rent_elsewhere, stop_purchase, purchase_elsewhere, stop_rent_proposal, rent_proposal_elsewhere, another_reason]

Причина архивации

period_type: enum
[hour, day, shift, contract]

Единица измерения времени аренды
'hour': 'час',
'day': 'день',
'shift': 'смена',
'contract': 'договорная'

accident_description: string

Описание ДТП у ТС

owner_acc: string

ID фирмы владельца

owner_contact: integer

ID контакта владельца

date_creation: string

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

date_modified: string

Дата изменения объявления

photos*: [string]

Фотографии объявления. Не обязательное поле для заявок

photo_url*: string

Ссылка на превью. Не обязательное поле для заявок

city_verbose: string

Название города
Значение из словаря

country_verbose: string

Название страны
Значение из словаря

city_ati_id*: string

ID города
Значение из словаря

country_ati_id*: string

ID страны
Значение из словаря

region_ati_id*: string

ID региона
Значение из словаря

address: string

Адрес, где расположено ТС

price*: integer

Цена

currency*: enum
[rub]

Валюта

comment: string

Подробное текстовое описание

advert_item_type*: enum
[truck, tractor, trailer, semitrailer, road_train, bus, truck_crane, excavator, dozer, loader, other_special]

Тип ТС.
'truck': 'Грузовик',
'tractor': 'Тягач',
'trailer': 'Прицеп',
'semitrailer': 'Полуприцеп',
'road_train': 'Автопоезд',
'bus': 'Автобус',
'truck_crane': 'Автокран',
'excavator': 'Экскаватор',
'dozer': 'Бульдозер',
'loader': 'Погрузчик',
'other_special': 'Спецтехника (другое)'

advert_item*:

Данные о характеристиках ТС. Обязательное поле для всех типов ТС, кроме Автопоезда

ONE-OF
availability: enum
[in_stock, on_order]

Доступность ТС (В наличии, под заказ)

with_driver: boolean

ТС с водителем или без

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

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

                
Пример ответа Ответ
200 Возвращается объявление
Развернуть все Свернуть все
Пример Модель
{...}
"ok":false,
"result":{...}
"_id":"string",
"status":"active",
"advert_type":"sale",
"proposal_type":"purchase",
"archive_reason":"sold_on_ati",
"period_type":"hour",
"accident_description":"string",
"views_count":0,
"viewed_contacts_count":0,
"busy_date_ranges":[...],
{...}
"from":0,
"to":0
}
],
"owner_acc":"string",
"owner_contact":0,
"contacts":[...],
{...}
"id":0
}
],
"date_creation":"string",
"date_modified":"string",
"photos":[...],
"string"
],
"photo_url":"string",
"city_verbose":"string",
"country_verbose":"string",
"city_ati_id":"string",
"country_ati_id":"string",
"region_ati_id":"string",
"address":"string",
"price":0,
"currency":"rub",
"comment":"string",
"advert_item_type":"truck",
"advert_item":{...},
"is_new":false,
"brand":{...},
"id":0,
"name":"string",
"name_eng":"string",
"name_ru":"string"
},
"model":{...},
"id":0,
"model":"string"
},
"year":0,
"mileage":0,
"vin":"string",
"gov_num":"string",
"engine_type":"1",
"engine_volume":0,
"owner_count":"string",
"body_brand":"string",
"engine_power":0,
"gearbox_type":"1",
"body_type":"1",
"volume":0,
"capacity":0,
"length":0,
"height":0,
"width":0,
"cabin_type":"1",
"suspension_type":"1",
"wheel_formula":"1",
"drive_type":"1",
"max_speed":0,
"fuel_consumption_100":0,
"tank_volume":0,
"tanks_count":0,
"right_side_helm":false,
"computer":false,
"central_oil_management":false,
"conditioner":false,
"heater_in_cabin":false,
"engine_preheater":false
},
"advert_items":[...],
{...}
"type":"string",
"transport":{...}
"is_new":false,
"brand":{...},
"id":0,
"name":"string",
"name_eng":"string",
"name_ru":"string"
},
"model":{...},
"id":0,
"model":"string"
},
"year":0,
"mileage":0,
"vin":"string",
"gov_num":"string",
"engine_type":"1",
"engine_volume":0,
"owner_count":"string",
"body_brand":"string",
"engine_power":0,
"gearbox_type":"1",
"body_type":"1",
"volume":0,
"capacity":0,
"length":0,
"height":0,
"width":0,
"cabin_type":"1",
"suspension_type":"1",
"wheel_formula":"1",
"drive_type":"1",
"max_speed":0,
"fuel_consumption_100":0,
"tank_volume":0,
"tanks_count":0,
"right_side_helm":false,
"computer":false,
"central_oil_management":false,
"conditioner":false,
"heater_in_cabin":false,
"engine_preheater":false
}
}
],
"availability":"in_stock",
"with_driver":false
}
}
{...}

Запрос успешно выполнен

ok: enum
[true]
}
400 Ошибка валидации
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string",
"error_list":[...]
{...}
"error":"string",
"reason":"string"
}
]
}
{...}

Возвращаемое значение в случае ошибок

error*: string

В некоторых случаях (валидация) - ID ошибки, например ApplicationAlreadyCreated в случае "вы уже подали заявку на эту площадку"

reason*: string

Человекочитаемый (ну, почти всегда) текст ошибки

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

Изменение части объявления

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

 
patch
/truckmarket/api/v1/transports
Развернуть все Свернуть все
{...}
_id*: string

Уникальный ID объекта из mongodb, есть только у уже сохраненных, используется как поле идемпотентности

is_new: boolean

Новое ТС или БУ

status*: enum
[active, archived]

Статус объявления (Активное, в Архиве)

advert_type*: enum
[sale, rent, purchase]

Тип объявления

proposal_type: enum
[purchase, rent]

Тип заявки объявления

archive_reason: enum
[sold_on_ati, sold_elsewhere, stop_rent, transport_crash, rent_elsewhere, stop_purchase, purchase_elsewhere, stop_rent_proposal, rent_proposal_elsewhere, another_reason]

Причина архивации

owner_acc: string

ID фирмы владельца

owner_contact: integer

ID контакта владельца

date_creation: string

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

date_modified: string

Дата изменения объявления

photos*: [string]

Фотографии объявления. Не обязательное поле для заявок

photo_url*: string

Ссылка на превью. Не обязательное поле для заявок

city_verbose: string

Название города
Значение из словаря

country_verbose: string

Название страны
Значение из словаря

city_ati_id*: string

ID города
Значение из словаря

country_ati_id*: string

ID страны
Значение из словаря

region_ati_id*: string

ID региона
Значение из словаря

address: string

Адрес, где расположено ТС

price*: integer

Цена

currency*: enum
[rub]

Валюта

comment: string

Подробное текстовое описание

advert_item_type*: enum
[truck, tractor, trailer, semitrailer, road_train, bus, truck_crane, excavator, dozer, loader, other_special]

Тип ТС.
'truck': 'Грузовик',
'tractor': 'Тягач',
'trailer': 'Прицеп',
'semitrailer': 'Полуприцеп',
'road_train': 'Автопоезд',
'bus': 'Автобус',
'truck_crane': 'Автокран',
'excavator': 'Экскаватор',
'dozer': 'Бульдозер',
'loader': 'Погрузчик',
'other_special': 'Спецтехника (другое)'

advert_item*:

Данные о характеристиках ТС. Обязательное поле для всех типов ТС, кроме Автопоезда

ONE-OF
availability: enum
[in_stock, on_order]

Доступность ТС (В наличии, под заказ)

with_driver: boolean

ТС с водителем или без

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

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

                
Пример ответа Ответ
200 Возвращается объявление
Развернуть все Свернуть все
Пример Модель
{...}
"ok":false,
"result":{...}
"_id":"string",
"status":"active",
"advert_type":"sale",
"proposal_type":"purchase",
"archive_reason":"sold_on_ati",
"period_type":"hour",
"accident_description":"string",
"views_count":0,
"viewed_contacts_count":0,
"busy_date_ranges":[...],
{...}
"from":0,
"to":0
}
],
"owner_acc":"string",
"owner_contact":0,
"contacts":[...],
{...}
"id":0
}
],
"date_creation":"string",
"date_modified":"string",
"photos":[...],
"string"
],
"photo_url":"string",
"city_verbose":"string",
"country_verbose":"string",
"city_ati_id":"string",
"country_ati_id":"string",
"region_ati_id":"string",
"address":"string",
"price":0,
"currency":"rub",
"comment":"string",
"advert_item_type":"truck",
"advert_item":{...},
"is_new":false,
"brand":{...},
"id":0,
"name":"string",
"name_eng":"string",
"name_ru":"string"
},
"model":{...},
"id":0,
"model":"string"
},
"year":0,
"mileage":0,
"vin":"string",
"gov_num":"string",
"engine_type":"1",
"engine_volume":0,
"owner_count":"string",
"body_brand":"string",
"engine_power":0,
"gearbox_type":"1",
"body_type":"1",
"volume":0,
"capacity":0,
"length":0,
"height":0,
"width":0,
"cabin_type":"1",
"suspension_type":"1",
"wheel_formula":"1",
"drive_type":"1",
"max_speed":0,
"fuel_consumption_100":0,
"tank_volume":0,
"tanks_count":0,
"right_side_helm":false,
"computer":false,
"central_oil_management":false,
"conditioner":false,
"heater_in_cabin":false,
"engine_preheater":false
},
"advert_items":[...],
{...}
"type":"string",
"transport":{...}
"is_new":false,
"brand":{...},
"id":0,
"name":"string",
"name_eng":"string",
"name_ru":"string"
},
"model":{...},
"id":0,
"model":"string"
},
"year":0,
"mileage":0,
"vin":"string",
"gov_num":"string",
"engine_type":"1",
"engine_volume":0,
"owner_count":"string",
"body_brand":"string",
"engine_power":0,
"gearbox_type":"1",
"body_type":"1",
"volume":0,
"capacity":0,
"length":0,
"height":0,
"width":0,
"cabin_type":"1",
"suspension_type":"1",
"wheel_formula":"1",
"drive_type":"1",
"max_speed":0,
"fuel_consumption_100":0,
"tank_volume":0,
"tanks_count":0,
"right_side_helm":false,
"computer":false,
"central_oil_management":false,
"conditioner":false,
"heater_in_cabin":false,
"engine_preheater":false
}
}
],
"availability":"in_stock",
"with_driver":false
}
}
{...}

Запрос успешно выполнен

ok: enum
[true]
}
400 Ошибка валидации
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string",
"error_list":[...]
{...}
"error":"string",
"reason":"string"
}
]
}
{...}

Возвращаемое значение в случае ошибок

error*: string

В некоторых случаях (валидация) - ID ошибки, например ApplicationAlreadyCreated в случае "вы уже подали заявку на эту площадку"

reason*: string

Человекочитаемый (ну, почти всегда) текст ошибки

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

Удаление объявления

Позволяет удалить объявление с Тракмаркета. Необходимо передать ID объявления.

 
delete
/truckmarket/api/v1/transports/{id}
CURL 1C
CURL
Копировать

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

                
Пример ответа Ответ
200 Объявление удалено
Развернуть все Свернуть все
Пример Модель
{...}
"ok":false,
"result":{}
}
{...}

Запрос успешно выполнен

ok: enum
[true]
result:{}

Результат запроса

}
400 Некорректный id объявления
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string",
"error_list":[...]
{...}
"error":"string",
"reason":"string"
}
]
}
{...}

Возвращаемое значение в случае ошибок

error*: string

В некоторых случаях (валидация) - ID ошибки, например ApplicationAlreadyCreated в случае "вы уже подали заявку на эту площадку"

reason*: string

Человекочитаемый (ну, почти всегда) текст ошибки

}
404 Объявление не найдено
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string"
}
{...}

Возвращаемое значение в случае ошибок

error*: string

В некоторых случаях (валидация) - ID ошибки, например ApplicationAlreadyCreated в случае "вы уже подали заявку на эту площадку"

reason*: string

Человекочитаемый (ну, почти всегда) текст ошибки

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