public-api (v1)

Download OpenAPI specification:Download

Authentication

JWT

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Аутентификация

Аутентификация пользователя

post /auth/token
https://api.traffic.online/api/{version}/auth/token

Аутентификация пользователя

header Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
One of
  • BasicAuth
  • AuthRefresh
grant_type
string
Value: "password"

Тип аутентификации

username
string

Логин пользователя

password
string

Пароль пользователя

Responses

200

Аутентификационные данные

401

Невалидный токен, неверный логин или пароль

Request samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "grant_type": "password",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "access_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 0,
  • "refresh_token": "string",
  • "server_time": "2024-07-30T14:07:50Z"
}

Удаление сессии

delete /auth/token
https://api.traffic.online/api/{version}/auth/token

Удаление сессии

Authorizations:
JWT (TransportCompanyAdmin)

Responses

204

Сессия удалена

401

Невалидный токен, неверный логин или пароль

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": 401,
  • "error": "Unauthorized",
  • "error_description": "Unauthorized"
}

Словари

Список марок автомобилей и прицепов

get /catalog/vehicle_brands
https://api.traffic.online/api/{version}/catalog/vehicle_brands

Список марок автомобилей и прицепов

query Parameters
vehicle_type
string
Enum: "car" "trailer"

Тип транспорта

Responses

200

Марки транспортных средств

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "items":
    [
    ]
}

Получить группы транспортных средств

get /catalog/lifting_capacity
https://api.traffic.online/api/{version}/catalog/lifting_capacity

Получить группы транспортных средств

Authorizations:
JWT (TransportCompanyAdmin)
query Parameters
transport_type
string
Enum: "lorry" "truck" "trailer"

Тип транспорта

transport_body_type
string
Enum: "awning" "full_metal" "isothermal" "refrigerator" "dropside" "tanker" "container"

Тип кузова

Responses

200

Группы транспортных средств

default

Непредвиденная ошибка

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "items":
    [
    ]
}

Водители

Поиск водителей

get /resources/{company_id}/drivers
https://api.traffic.online/api/{version}/resources/{company_id}/drivers

Поиск водителей

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
company_id
required
string <uuid>

ID компании

query Parameters
status
Array of strings

Статусы водителя

full_name
string

ФИО водителя

suitable_for_shipping
string

UUID перевозки, для назначения в которую подходит водитель

human_friendly_id
string
updated_at
string <date-time>
created_at
string <date-time>
admitted_to
Array of strings
Items Enum: "category_1" "category_2"

Категории, к которым водитель имеет допуск

sort
string
Enum: "created_at" "updated_at" "full_name"
order
string
Enum: "asc" "desc"

Тип упорядочивания элементов

per_page
integer >= 1
Default: 10

Количество элементов на странице

page
integer >= 1
Default: 1

Номер текущей страницы

Responses

200
400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "kind": "DriverCollection",
  • "items":
    [
    ],
  • "page_info":
    {
    }
}

Создание водителей

post /resources/{company_id}/drivers
https://api.traffic.online/api/{version}/resources/{company_id}/drivers

Создание водителей

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
company_id
required
string <uuid>

ID компании

header Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
prohibited_categories
Array of any
Items Enum: "category_1" "category_2" "category_3"

Категории клиентов на которые ресурс запрещен к назначению

delivery_allowed
boolean

Водитель допущен только к заявкам с почасовой оплатой.

driver_secret_info
required
object

Эти данные должны храниться в защищённом сигменте

Responses

200

OK

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "prohibited_categories":
    [
    ],
  • "delivery_allowed": true,
  • "driver_secret_info":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "kind": "ResourceDriver",
  • "human_friendly_id": "человекочитаемый id",
  • "full_name": "string",
  • "company_id": "string",
  • "freezing":
    [
    ],
  • "prohibited_categories":
    [
    ],
  • "delivery_allowed": true,
  • "status":
    {
    },
  • "status_updated_at": "2024-07-30T14:07:50Z",
  • "driver_secret_info":
    {
    },
  • "power_of_attorney":
    {
    },
  • "attorneys":
    {
    },
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Получение водителя

get /resources/{company_id}/drivers/{driver_id}
https://api.traffic.online/api/{version}/resources/{company_id}/drivers/{driver_id}

Получение водителя

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
company_id
required
string <uuid>

ID компании

driver_id
required
string <uuid>

ID водителя

Responses

200
400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "kind": "ResourceDriver",
  • "human_friendly_id": "человекочитаемый id",
  • "full_name": "string",
  • "company_id": "string",
  • "freezing":
    [
    ],
  • "prohibited_categories":
    [
    ],
  • "delivery_allowed": true,
  • "status":
    {
    },
  • "status_updated_at": "2024-07-30T14:07:50Z",
  • "driver_secret_info":
    {
    },
  • "power_of_attorney":
    {
    },
  • "attorneys":
    {
    },
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Изменение водителя

put /resources/{company_id}/drivers/{driver_id}
https://api.traffic.online/api/{version}/resources/{company_id}/drivers/{driver_id}

Изменение водителя

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
company_id
required
string <uuid>

ID компании

driver_id
required
string <uuid>

ID водителя

header Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
prohibited_categories
Array of any
Items Enum: "category_1" "category_2" "category_3"

Категории клиентов на которые ресурс запрещен к назначению

delivery_allowed
boolean

Водитель допущен только к заявкам с почасовой оплатой.

driver_secret_info
required
object

Эти данные должны храниться в защищённом сигменте

Responses

200
400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

404

Объект не найден

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "prohibited_categories":
    [
    ],
  • "delivery_allowed": true,
  • "driver_secret_info":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "kind": "ResourceDriver",
  • "human_friendly_id": "человекочитаемый id",
  • "full_name": "string",
  • "company_id": "string",
  • "freezing":
    [
    ],
  • "prohibited_categories":
    [
    ],
  • "delivery_allowed": true,
  • "status":
    {
    },
  • "status_updated_at": "2024-07-30T14:07:50Z",
  • "driver_secret_info":
    {
    },
  • "power_of_attorney":
    {
    },
  • "attorneys":
    {
    },
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Удаление водителя

delete /resources/{company_id}/drivers/{driver_id}
https://api.traffic.online/api/{version}/resources/{company_id}/drivers/{driver_id}

Удаление водителя

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
company_id
required
string <uuid>

ID компании

driver_id
required
string <uuid>

ID водителя

Responses

204

Водитель удален

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": 400,
  • "error": "BadRequest",
  • "error_description": "BadRequest"
}

Получение информации о необходимых документах

get /resources/{company_id}/drivers/{driver_id}/document_types
https://api.traffic.online/api/{version}/resources/{company_id}/drivers/{driver_id}/document_types

Получение информации о необходимых документах

Authorizations:
JWT (TransportCompanyAdmin)

Responses

200

OK

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "kind": "DriverDocumentTypeCollection",
  • "items":
    [
    ]
}

Получения списка созданных документов

get /resources/{company_id}/drivers/{driver_id}/documents
https://api.traffic.online/api/{version}/resources/{company_id}/drivers/{driver_id}/documents

Получения списка созданных документов

Authorizations:
JWT (TransportCompanyAdmin)
query Parameters
page
integer >= 1
Default: 1

Номер текущей страницы

per_page
integer >= 1
Default: 10

Количество элементов на странице

Responses

200

OK

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Response samples

Content type
application/json
Copy
Expand all Collapse all
null

Создание документа

post /resources/{company_id}/drivers/{driver_id}/documents
https://api.traffic.online/api/{version}/resources/{company_id}/drivers/{driver_id}/documents

Создание документа

Authorizations:
JWT (TransportCompanyAdmin)
header Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
document_type_id
integer

Тип документа

comment
string Nullable

Комментарий

Responses

200

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "document_type_id": 0,
  • "comment": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "comment": "string",
  • "entity_id": "string",
  • "company_id": "string",
  • "document_type_id": 0,
  • "files":
    [
    ],
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Получение информации о документе

get /resources/{company_id}/drivers/{driver_id}/documents/{document_id}
https://api.traffic.online/api/{version}/resources/{company_id}/drivers/{driver_id}/documents/{document_id}

Получение информации о документе

Authorizations:
JWT (TransportCompanyAdmin)

Responses

200

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "comment": "string",
  • "entity_id": "string",
  • "company_id": "string",
  • "document_type_id": 0,
  • "files":
    [
    ],
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Добавление файла к документу

post /resources/{company_id}/drivers/{driver_id}/documents/{document_id}/file
https://api.traffic.online/api/{version}/resources/{company_id}/drivers/{driver_id}/documents/{document_id}/file

Добавление файла к документу

Authorizations:
JWT (TransportCompanyAdmin)
header Parameters
Content-Type
required
any
Value: "multipart/form-data"
Request Body schema: multipart/form-data
file
string <binary>

Файл

Responses

200

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "url": "string",
  • "signed_url": "string",
  • "file_name": "string",
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Удаление файла который прикреплен к документу

delete /resources/{company_id}/drivers/{driver_id}/documents/{document_id}/file/{file_id}
https://api.traffic.online/api/{version}/resources/{company_id}/drivers/{driver_id}/documents/{document_id}/file/{file_id}

Удаление файла который прикреплен к документу

Authorizations:
JWT (TransportCompanyAdmin)

Responses

204

Deleted

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": 400,
  • "error": "BadRequest",
  • "error_description": "BadRequest"
}

Скачивание файла

get /resources/{company_id}/drivers/{driver_id}/documents/{document_id}/file/{file_id}/download
https://api.traffic.online/api/{version}/resources/{company_id}/drivers/{driver_id}/documents/{document_id}/file/{file_id}/download

Скачивание файла

Authorizations:
JWT (TransportCompanyAdmin)

Responses

200

Ok

Машины

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

post /resources/cars
https://api.traffic.online/api/{version}/resources/cars

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

Authorizations:
JWT (TransportCompanyAdmin)
query Parameters
kind
required
string
Enum: "ResourceCarLorryAwning" "ResourceCarLorryRefrigerator" "ResourceCarLorryFullMetal" "ResourceCarLorryIsothermal" "ResourceCarLorryDropside" "ResourceCarTruck"
header Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
One of
  • ResourceCarLorryAwning
  • ResourceCarLorryRefrigerator
  • ResourceCarLorryFullMetal
  • ResourceCarLorryIsothermal
  • ResourceCarLorryTanker
  • ResourceCarTruck
loading_option
object

Вариант погрузки

lifting_capacity_id
string
brand
string
car_additional_info
object
car_number
string
car_phone
string
dimensions_cargo_hold
object

Габариты грузового отсека

max_lifting_capacity
number
number_sts
string
owner_sts
string
owning_type
string

Responses

201

Автомобиль

Request samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "loading_option":
    {
    },
  • "lifting_capacity_id": "string",
  • "brand": "string",
  • "car_additional_info":
    {
    },
  • "car_number": "string",
  • "car_phone": "string",
  • "dimensions_cargo_hold":
    {
    },
  • "max_lifting_capacity": 0,
  • "number_sts": "string",
  • "owner_sts": "string",
  • "owning_type": "string"
}

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "loading_option":
    {
    },
  • "id": "string",
  • "human_friendly_id": "человекочитаемый id",
  • "kind": "ResourceCarLorryAwning",
  • "lifting_capacity_id": "string",
  • "lifting_capacity":
    {
    },
  • "company_id": "string",
  • "status":
    {
    },
  • "status_updated_at": "2024-07-30T14:07:50Z",
  • "freezing":
    [
    ],
  • "brand": "string",
  • "car_additional_info":
    {
    },
  • "car_number": "string",
  • "car_phone": "string",
  • "dimensions_cargo_hold":
    {
    },
  • "max_lifting_capacity": 0,
  • "number_sts": "string",
  • "owner_sts": "string",
  • "owning_type": "string",
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Получение автомобиля

get /resources/cars/{car_id}
https://api.traffic.online/api/{version}/resources/cars/{car_id}

Получение автомобиля

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
car_id
required
string <uuid>

ID машины

Responses

200

Автомобиль

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "loading_option":
    {
    },
  • "id": "string",
  • "human_friendly_id": "человекочитаемый id",
  • "kind": "ResourceCarLorryAwning",
  • "lifting_capacity_id": "string",
  • "lifting_capacity":
    {
    },
  • "company_id": "string",
  • "status":
    {
    },
  • "status_updated_at": "2024-07-30T14:07:50Z",
  • "freezing":
    [
    ],
  • "brand": "string",
  • "car_additional_info":
    {
    },
  • "car_number": "string",
  • "car_phone": "string",
  • "dimensions_cargo_hold":
    {
    },
  • "max_lifting_capacity": 0,
  • "number_sts": "string",
  • "owner_sts": "string",
  • "owning_type": "string",
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Обновление автомобиля

put /resources/cars/{car_id}
https://api.traffic.online/api/{version}/resources/cars/{car_id}

Обновление автомобиля

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
car_id
required
string <uuid>

ID машины

header Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
One of
  • ResourceCarLorryAwning
  • ResourceCarLorryRefrigerator
  • ResourceCarLorryFullMetal
  • ResourceCarLorryIsothermal
  • ResourceCarLorryTanker
  • ResourceCarTruck
loading_option
object

Вариант погрузки

lifting_capacity_id
string
brand
string
car_additional_info
object
car_number
string
car_phone
string
dimensions_cargo_hold
object

Габариты грузового отсека

max_lifting_capacity
number
number_sts
string
owner_sts
string
owning_type
string

Responses

200

Автомобиль

Request samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "loading_option":
    {
    },
  • "lifting_capacity_id": "string",
  • "brand": "string",
  • "car_additional_info":
    {
    },
  • "car_number": "string",
  • "car_phone": "string",
  • "dimensions_cargo_hold":
    {
    },
  • "max_lifting_capacity": 0,
  • "number_sts": "string",
  • "owner_sts": "string",
  • "owning_type": "string"
}

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "loading_option":
    {
    },
  • "id": "string",
  • "human_friendly_id": "человекочитаемый id",
  • "kind": "ResourceCarLorryAwning",
  • "lifting_capacity_id": "string",
  • "lifting_capacity":
    {
    },
  • "company_id": "string",
  • "status":
    {
    },
  • "status_updated_at": "2024-07-30T14:07:50Z",
  • "freezing":
    [
    ],
  • "brand": "string",
  • "car_additional_info":
    {
    },
  • "car_number": "string",
  • "car_phone": "string",
  • "dimensions_cargo_hold":
    {
    },
  • "max_lifting_capacity": 0,
  • "number_sts": "string",
  • "owner_sts": "string",
  • "owning_type": "string",
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Поиск по машинам

get /resources/{company_id}/cars
https://api.traffic.online/api/{version}/resources/{company_id}/cars

Поиск по машинам

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
company_id
required
string <uuid>

ID компании

query Parameters
query
string

Госномер или марка машины

status
Array of strings

Статусы машины

human_friendly_id
string
brand
string

Марка

number_sts
string

Номер по СТС

car_number
string

Государственный регистрационный номер

suitable_for_shipping
string

UUID перевозки, для назначения в которую подходит автомобиль

updated_at
string <date-time>
created_at
string <date-time>
sort
string
Enum: "created_at" "updated_at" "brand"
order
string
Enum: "asc" "desc"

Тип упорядочивания элементов

page
integer >= 1
Default: 1

Номер текущей страницы

per_page
integer >= 1
Default: 10

Количество элементов на странице

Responses

200
400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "kind": "Collection",
  • "items":
    [
    ],
  • "page_info":
    {
    }
}

Получение информации о необходимых документах

get /resources/{company_id}/cars/{car_id}/document_types
https://api.traffic.online/api/{version}/resources/{company_id}/cars/{car_id}/document_types

Получение информации о необходимых документах

Authorizations:
JWT (TransportCompanyAdmin)

Responses

200

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "kind": "DriverDocumentTypeCollection",
  • "items":
    [
    ]
}

Получения списка созданных документов

get /resources/{company_id}/cars/{car_id}/documents
https://api.traffic.online/api/{version}/resources/{company_id}/cars/{car_id}/documents

Получения списка созданных документов

Authorizations:
JWT (TransportCompanyAdmin)
query Parameters
page
integer >= 1
Default: 1

Номер текущей страницы

per_page
integer >= 1
Default: 10

Количество элементов на странице

Responses

200

Документы

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "items":
    [
    ]
}

Создание документа

post /resources/{company_id}/cars/{car_id}/documents
https://api.traffic.online/api/{version}/resources/{company_id}/cars/{car_id}/documents

Создание документа

Authorizations:
JWT (TransportCompanyAdmin)
header Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
document_type_id
integer

Тип документа

comment
string Nullable

Комментарий

Responses

200

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "document_type_id": 0,
  • "comment": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "comment": "string",
  • "entity_id": "string",
  • "company_id": "string",
  • "document_type_id": 0,
  • "files":
    [
    ],
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Получение информации о документе

get /resources/{company_id}/cars/{car_id}/documents/{document_id}
https://api.traffic.online/api/{version}/resources/{company_id}/cars/{car_id}/documents/{document_id}

Получение информации о документе

Authorizations:
JWT (TransportCompanyAdmin)

Responses

200

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "comment": "string",
  • "entity_id": "string",
  • "company_id": "string",
  • "document_type_id": 0,
  • "files":
    [
    ],
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Добавление файла к документу

post /resources/{company_id}/cars/{car_id}/documents/{document_id}/file
https://api.traffic.online/api/{version}/resources/{company_id}/cars/{car_id}/documents/{document_id}/file

Добавление файла к документу

Authorizations:
JWT (TransportCompanyAdmin)
header Parameters
Content-Type
required
any
Value: "multipart/form-data"
Request Body schema: multipart/form-data
file
string <binary>

Файл

Responses

200

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "url": "string",
  • "signed_url": "string",
  • "file_name": "string",
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Удаление файла который прикреплен к документу

delete /resources/{company_id}/cars/{car_id}/documents/{document_id}/file/{file_id}
https://api.traffic.online/api/{version}/resources/{company_id}/cars/{car_id}/documents/{document_id}/file/{file_id}

Удаление файла который прикреплен к документу

Authorizations:
JWT (TransportCompanyAdmin)

Responses

204

Deleted

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": 400,
  • "error": "BadRequest",
  • "error_description": "BadRequest"
}

Скачивание файла

get /resources/{company_id}/cars/{car_id}/documents/{document_id}/file/{file_id}/download
https://api.traffic.online/api/{version}/resources/{company_id}/cars/{car_id}/documents/{document_id}/file/{file_id}/download

Скачивание файла

Authorizations:
JWT (TransportCompanyAdmin)

Responses

200

Ok

Прицепы

Создание прицепа по типу

post /resources/trailers
https://api.traffic.online/api/{version}/resources/trailers

Создание прицепа по типу

Authorizations:
JWT (TransportCompanyAdmin)
query Parameters
kind
required
string
Enum: "ResourceTrailerDropside" "ResourceTrailerAwning" "ResourceTrailerFullMetal" "ResourceTrailerRefrigerator"
header Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
One of
  • ResourceTrailerDropside
  • ResourceTrailerAwning
  • ResourceTrailerFullMetal
  • ResourceTrailerRefrigerator
  • object
  • ResourceTrailerTanker
  • ResourceTrailerContainer
loading_option
object

Вариант погрузки

lifting_capacity_id
string
brand
string
trailer_additional_info
object
trailer_number
string
dimensions_cargo_hold
object

Габариты грузового отсека

max_lifting_capacity
number
number_sts
string
owner_sts
string
owning_type
string

Responses

200

OK

Request samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "loading_option":
    {
    },
  • "lifting_capacity_id": "string",
  • "brand": "string",
  • "trailer_additional_info":
    {
    },
  • "trailer_number": "string",
  • "dimensions_cargo_hold":
    {
    },
  • "max_lifting_capacity": 0,
  • "number_sts": "string",
  • "owner_sts": "string",
  • "owning_type": "string"
}

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "loading_option":
    {
    },
  • "id": "string",
  • "human_friendly_id": "человекочитаемый id",
  • "kind": "ResourceCarLorryAwning",
  • "lifting_capacity_id": "string",
  • "lifting_capacity":
    {
    },
  • "company_id": "string",
  • "status":
    {
    },
  • "status_updated_at": "2024-07-30T14:07:50Z",
  • "freezing":
    [
    ],
  • "brand": "string",
  • "trailer_additional_info":
    {
    },
  • "trailer_number": "string",
  • "dimensions_cargo_hold":
    {
    },
  • "max_lifting_capacity": 0,
  • "number_sts": "string",
  • "owner_sts": "string",
  • "owning_type": "string",
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Получение информации о прицепе

get /resources/trailers/{trailer_id}
https://api.traffic.online/api/{version}/resources/trailers/{trailer_id}

Получение информации о прицепе

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
trailer_id
required
string <uuid>

ID прицепа

Responses

200

OK

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "loading_option":
    {
    },
  • "id": "string",
  • "human_friendly_id": "человекочитаемый id",
  • "kind": "ResourceCarLorryAwning",
  • "lifting_capacity_id": "string",
  • "lifting_capacity":
    {
    },
  • "company_id": "string",
  • "status":
    {
    },
  • "status_updated_at": "2024-07-30T14:07:50Z",
  • "freezing":
    [
    ],
  • "brand": "string",
  • "trailer_additional_info":
    {
    },
  • "trailer_number": "string",
  • "dimensions_cargo_hold":
    {
    },
  • "max_lifting_capacity": 0,
  • "number_sts": "string",
  • "owner_sts": "string",
  • "owning_type": "string",
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Обновление информации о прицепе

put /resources/trailers/{trailer_id}
https://api.traffic.online/api/{version}/resources/trailers/{trailer_id}

Обновление информации о прицепе

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
trailer_id
required
string <uuid>

ID прицепа

header Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
One of
  • ResourceTrailerDropside
  • ResourceTrailerAwning
  • ResourceTrailerFullMetal
  • ResourceTrailerRefrigerator
  • object
  • ResourceTrailerTanker
  • ResourceTrailerContainer
loading_option
object

Вариант погрузки

lifting_capacity_id
string
brand
string
trailer_additional_info
object
trailer_number
string
dimensions_cargo_hold
object

Габариты грузового отсека

max_lifting_capacity
number
number_sts
string
owner_sts
string
owning_type
string

Responses

200

OK

Request samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "loading_option":
    {
    },
  • "lifting_capacity_id": "string",
  • "brand": "string",
  • "trailer_additional_info":
    {
    },
  • "trailer_number": "string",
  • "dimensions_cargo_hold":
    {
    },
  • "max_lifting_capacity": 0,
  • "number_sts": "string",
  • "owner_sts": "string",
  • "owning_type": "string"
}

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "loading_option":
    {
    },
  • "id": "string",
  • "human_friendly_id": "человекочитаемый id",
  • "kind": "ResourceCarLorryAwning",
  • "lifting_capacity_id": "string",
  • "lifting_capacity":
    {
    },
  • "company_id": "string",
  • "status":
    {
    },
  • "status_updated_at": "2024-07-30T14:07:50Z",
  • "freezing":
    [
    ],
  • "brand": "string",
  • "trailer_additional_info":
    {
    },
  • "trailer_number": "string",
  • "dimensions_cargo_hold":
    {
    },
  • "max_lifting_capacity": 0,
  • "number_sts": "string",
  • "owner_sts": "string",
  • "owning_type": "string",
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Поиск по прицепам

get /resources/{company_id}/trailers
https://api.traffic.online/api/{version}/resources/{company_id}/trailers

Поиск по прицепам

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
company_id
required
string <uuid>

id компании ( можно получить из JWT token )

query Parameters
query
string

Госномер или марка прицепа

status
Array of strings

Статус прицепа

human_friendly_id
string
brand
string

Марка

vin
string

VIN номер

trailer_number
string

Государственный регистрационный номер

suitable_for_shipping
string

UUID перевозки, для назначения в которую подходит автомобиль

updated_at
string <date-time>
created_at
string <date-time>
sort
string
Enum: "created_at" "updated_at" "brand"
order
string
Enum: "asc" "desc"

Тип упорядочивания элементов

page
integer >= 1
Default: 1

Номер текущей страницы

per_page
integer >= 1
Default: 10

Количество элементов на странице

Responses

200
400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "kind": "Collection",
  • "items":
    [
    ],
  • "page_info":
    {
    }
}

Получение информации о необходимых документах

get /resources/{company_id}/trailers/{trailer_id}/document_types
https://api.traffic.online/api/{version}/resources/{company_id}/trailers/{trailer_id}/document_types

Получение информации о необходимых документах

Authorizations:
JWT (TransportCompanyAdmin)

Responses

200

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "kind": "DriverDocumentTypeCollection",
  • "items":
    [
    ]
}

Получения списка созданных документов

get /resources/{company_id}/trailers/{trailer_id}/documents
https://api.traffic.online/api/{version}/resources/{company_id}/trailers/{trailer_id}/documents

Получения списка созданных документов

Authorizations:
JWT (TransportCompanyAdmin)
query Parameters
page
integer >= 1
Default: 1

Номер текущей страницы

per_page
integer >= 1
Default: 10

Количество элементов на странице

Responses

200

Документы

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "items":
    [
    ]
}

Создание документа

post /resources/{company_id}/trailers/{trailer_id}/documents
https://api.traffic.online/api/{version}/resources/{company_id}/trailers/{trailer_id}/documents

Создание документа

Authorizations:
JWT (TransportCompanyAdmin)
header Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
document_type_id
integer

Тип документа

comment
string Nullable

Комментарий

Responses

200

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "document_type_id": 0,
  • "comment": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "comment": "string",
  • "entity_id": "string",
  • "company_id": "string",
  • "document_type_id": 0,
  • "files":
    [
    ],
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Получение информации о документе

get /resources/{company_id}/trailers/{trailer_id}/documents/{document_id}
https://api.traffic.online/api/{version}/resources/{company_id}/trailers/{trailer_id}/documents/{document_id}

Получение информации о документе

Authorizations:
JWT (TransportCompanyAdmin)

Responses

200

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "comment": "string",
  • "entity_id": "string",
  • "company_id": "string",
  • "document_type_id": 0,
  • "files":
    [
    ],
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Добавление файла к документу

post /resources/{company_id}/trailers/{trailer_id}/documents/{document_id}/file
https://api.traffic.online/api/{version}/resources/{company_id}/trailers/{trailer_id}/documents/{document_id}/file

Добавление файла к документу

Authorizations:
JWT (TransportCompanyAdmin)
header Parameters
Content-Type
required
any
Value: "multipart/form-data"
Request Body schema: multipart/form-data
file
string <binary>

Файл

Responses

200

Ok

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "url": "string",
  • "signed_url": "string",
  • "file_name": "string",
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Удаление файла который прикреплен к документу

delete /resources/{company_id}/trailers/{trailer_id}/documents/{document_id}/file/{file_id}
https://api.traffic.online/api/{version}/resources/{company_id}/trailers/{trailer_id}/documents/{document_id}/file/{file_id}

Удаление файла который прикреплен к документу

Authorizations:
JWT (TransportCompanyAdmin)

Responses

204

Deleted

400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": 400,
  • "error": "BadRequest",
  • "error_description": "BadRequest"
}

Скачивание файла

get /resources/{company_id}/trailers/{trailer_id}/documents/{document_id}/file/{file_id}/download
https://api.traffic.online/api/{version}/resources/{company_id}/trailers/{trailer_id}/documents/{document_id}/file/{file_id}/download

Скачивание файла

Authorizations:
JWT (TransportCompanyAdmin)

Responses

200

Ok

Заявки

Получить список заявок

get /request_view
https://api.traffic.online/api/{version}/request_view

Получить список заявок

Authorizations:
JWT (TransportCompanyAdmin)
query Parameters
human_friendly_id
string

Человекочитаемый ID

type
Array of strings
Items Enum: "shipping_request" "contract" "delivery" "city_delivery"
body_type
any
Enum: "awning" "full_metal" "isothermal" "refrigerator" "dropside"

Тип кузово ТС

circular_route
boolean
max_tonnage
number <double>

Тоннаж по заявке

begin_from
string <date>

Дата начала заявки - ОТ

begin_until
string <date>

Дата начала заявки - ДО

status
string
Enum: "new" "winner_selection" "reserved" "approval_waiting" "trip_waiting" "in_progress" "done" "canceled" "canceled_by_transport_company" "canceled_by_cargo_owning_company" "failed_by_transport_company" "failed_by_cargo_owning_company" "expired" "waiting_forwarder"

Статус заявки:

  • new - В торге

  • winner_selection - Определение победителя

  • reserved - Забронирована

  • approval_waiting - Утверждение перевозки (на утверждении). Перевозчик назначил ресурсы на перевозку

  • trip_waiting - Ожидание перевозки (предстоящиая). Перевозка утверждена, дата подачи в первую точку маршрута не наступила

  • in_progress - На исполнении (выполняется). Перевозка утверждена, дата подачи в первую точку маршрута наступила

  • done - Выполнена (завершена). Грузовладелец успешно завершил перевозку

  • canceled - Отменена грузовладельцем/перевозчиком или сорвана грузовладельцем/перевозчиком. Использовался до разделения статусов отмен/срывов

  • canceled_by_transport_company - Отменена по вине перевочика

  • canceled_by_cargo_owning_company - Отменена по вине грузовладельца

  • failed_by_transport_company - Сорвана по вине перевозчика

  • failed_by_cargo_owning_company - Сорвана по вине грузовладельца

  • expired - Неотторгована (нет исполнителя). Заявку по заказу никто не забронировал, время торга истекло

  • waiting_forwarder - Ожидание ответа экспедитора. Перевозчик отказался от графиковой заявки

target_company_id
any

UUID компании, для которой отобразить "целевые" предложения (теневой торг)

from_location_id
string

ID места начала заявки

from_radius
integer

Радиус вокруг места начала заявки в километрах

direction_location_id
string

ID места направления заявки

direction_radius
integer

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

set_bid
boolean

Только те заявки на которые сделана ставка

kind
any
Value: "ShippingRequest"

Тип объекта

sort
required
any
Enum: "created_at" "updated_at" "car_supply_at"
order
string
Enum: "asc" "desc"

Тип упорядочивания элементов

Responses

200

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "kind": "ShippingRequestCollection",
  • "items":
    [
    ],
  • "page_info":
    {
    }
}

Получить заявку по ID

get /request_view/{id}
https://api.traffic.online/api/{version}/request_view/{id}

Получить заявку по ID

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
id
required
string <uuid>

ID заявки

Responses

200

OK

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "human_friendly_id": "string",
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z",
  • "kind": "ShippingRequest",
  • "status":
    {
    },
  • "status_updated_at": "2024-07-30T14:07:50Z",
  • "status_history":
    [
    ],
  • "type": "shipping_request",
  • "cargo_owning_company_id": "string",
  • "author_id": "string",
  • "shipping_order_id": "string",
  • "contract_id": "string",
  • "contract_hfid": "string",
  • "client_category": "category_1",
  • "comment": "string",
  • "resource_assignment_time": 30,
  • "completed_at": "2024-07-30T14:07:50Z",
  • "contract_begins_at": "2024-07-30T14:07:50Z",
  • "contract_ends_at": "2024-07-30T14:07:50Z",
  • "contract_type": "by_shippings_count",
  • "shippings_count": 1,
  • "max_shippings_per_day": 1,
  • "max_shippings_per_week": 1,
  • "shipping_available_in": 0,
  • "resource_requirements":
    {
    },
  • "cargo_description": "string",
  • "cargo_tonnage": 0,
  • "cargo_volume": 0,
  • "cargo_cost": 0,
  • "cargo_adr": "1",
  • "cargo_length": 0.5,
  • "cargo_width": 0.5,
  • "cargo_height": 0.5,
  • "cargo_places": 0,
  • "cargo_packing": "reels",
  • "route_segments":
    [
    ],
  • "route_points":
    [
    ],
  • "route_direction_id": "string",
  • "route_direction":
    {
    },
  • "circular_route": true,
  • "is_interval": true,
  • "offer_deadline": "2024-07-30T14:07:50Z",
  • "intermediate_results_at": "2024-07-30T14:07:50Z",
  • "auction_type": "instant_reservation",
  • "many_executors_allowed": false,
  • "bid_step": 0,
  • "bids":
    [
    ],
  • "expedited_payment_available": true,
  • "shipping_order_contract_id": "string",
  • "shipping_order_contract_hfid": "string",
  • "contract_shipping_id": "string",
  • "contract_shipping_price": 0,
  • "dynamic_pricing": true,
  • "document_flow":
    [
    ],
  • "closing_documents_period": 1,
  • "closing_documents_period_type": "calendar",
  • "closing_documents":
    [
    ],
  • "agreement_type": "shipping_agreement",
  • "change_requests_allowed": true,
  • "terms_by_partnership_contract": true,
  • "idle_time_cost_without_vat": 50,
  • "documents_for_payment":
    [
    ],
  • "payment_procedure": "prepayment",
  • "payment_period": 1,
  • "payment_period_type": "calendar",
  • "payment_type": "per_hour",
  • "min_work_hours": 0,
  • "cancellation_without_penalty_before": "2024-07-30T14:07:50Z",
  • "cancellation_penalty_percent": 0,
  • "minimum_cancellation_penalty_without_vat": 0,
  • "price": 0,
  • "expedited_payment_fee": 0,
  • "min_bid": 0,
  • "max_bid": 0,
  • "winning_bid": 0,
  • "expedited_payment_winning_bid": 0,
  • "is_bid_winning": true,
  • "tc_requirements_changes":
    [
    ],
  • "tc_requirements_change":
    {
    },
  • "contact":
    {
    }
}

Бронирование заявки на перевозку

post /shipping_requests/{shipping_request_id}/reserve
https://api.traffic.online/api/{version}/shipping_requests/{shipping_request_id}/reserve

Бронирование заявки на перевозку

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
shipping_request_id
required
string <uuid>

ID заявки

header Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
price
number <double>

Своя цена заявки (Толко для ДЛ-Транс)

expedited_payment
boolean

Бронирование заявки по условиям ускоренной оплаты

Responses

200
400

Неверные параметры запроса

401

Невалидный токен, неверный логин или пароль

403

Нет прав на выполнение действия

404

Объект не найден

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "price": 0,
  • "expedited_payment": true
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "shipping_request_info":
    {
    },
  • "assigned_resources":
    [
    ],
  • "selected_car_supply":
    [
    ],
  • "completed_at": "2024-07-30T14:07:50Z",
  • "resource_assignment_deadline": "2024-07-30T14:07:50Z",
  • "kind": "ShippingOutput",
  • "id": "string",
  • "human_friendly_id": "Человеко понятный id",
  • "status":
    {
    },
  • "status_updated_at": "2024-07-30T14:07:50Z",
  • "status_history":
    [
    ],
  • "scancopy_status": "cargo_owner_signing",
  • "scancopy_status_comment": "string",
  • "contract_id": "string",
  • "contract_hfid": "string",
  • "shipping_order_contract_id": "string",
  • "shipping_order_contract_hfid": "string",
  • "contract_shipping_id": "string",
  • "company_id": "string",
  • "company":
    {
    },
  • "shipping_request_id": "string",
  • "shipping_order_id": "string",
  • "assigned_resource_objects":
    {
    },
  • "expedited_payment": true,
  • "document_flow": "scancopy",
  • "shippings_count": 1,
  • "scancopy_attachment_deadline": "2024-07-30T14:07:50Z",
  • "requirements_changes_deadline": "2024-07-30T14:07:50Z",
  • "reserved_at": "2024-07-30T14:07:50Z",
  • "important_changes_at": "2024-07-30T14:07:50Z",
  • "requirements_accepted_at": "2024-07-30T14:07:50Z",
  • "closing_ttd_documents_accepted_at": "string",
  • "closing_ttd_documents_rejected_at": "string",
  • "closing_ttd_documents_rejection_comment": "string",
  • "closing_ttd_forwarder_documents_accepted_at": "string",
  • "closing_ttd_forwarder_documents_rejected_at": "string",
  • "closing_ttd_forwarder_documents_rejection_comment": "string",
  • "closing_bd_documents_accepted_at": "string",
  • "closing_bd_documents_rejected_at": "string",
  • "closing_bd_documents_rejection_comment": "string",
  • "closing_status": "documents_accepted",
  • "planned_payment_date": "2024-07-30",
  • "actual_payment_date": "2024-07-30",
  • "contact":
    {
    },
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Сделать ставку на заявку

post /shipping_requests/{shipping_request_id}/bids
https://api.traffic.online/api/{version}/shipping_requests/{shipping_request_id}/bids

Сделать ставку на заявку

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
shipping_request_id
required
string

ID заявки

header Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
value
integer

Значение ставки

expedited_payment
boolean

Сделана ли ставка по условиям ускоренной оплаты

Responses

201
400

Неверные параметры запроса

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "value": 0,
  • "expedited_payment": true
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "ntk_id": "string",
  • "author":
    {
    },
  • "shipping_request_id": "string",
  • "shipping_order_id": "string",
  • "value": 1,
  • "status": "current",
  • "tax_type": "with_vat",
  • "expedited_payment": false,
  • "shippings_count": 1,
  • "auction_stage_number": 1,
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Получить список ставок на заявку

get /shipping_requests/{shipping_request_id}/bids
https://api.traffic.online/api/{version}/shipping_requests/{shipping_request_id}/bids

Получить список ставок на заявку

Authorizations:
JWT (TransportCompanyAdmin)
query Parameters
status
string
Enum: "current" "archived" "won" "cancelled"
ntk_id
string

Responses

200

Коллекция ставок на заявку

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "items":
    [
    ]
}

Сделать ставку на заявку неактивной

put /shipping_requests/{shipping_request_id}/bids/{bid_id}/archive
https://api.traffic.online/api/{version}/shipping_requests/{shipping_request_id}/bids/{bid_id}/archive

Сделать ставку на заявку неактивной

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
shipping_request_id
required
string <uuid>

ID заявки

bid_id
required
string <uuid>

ID ставки

Responses

200
400

Неверные параметры запроса

403

Нет прав на выполнение действия

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "ntk_id": "string",
  • "author":
    {
    },
  • "shipping_request_id": "string",
  • "shipping_order_id": "string",
  • "value": 1,
  • "status": "current",
  • "tax_type": "with_vat",
  • "expedited_payment": false,
  • "shippings_count": 1,
  • "auction_stage_number": 1,
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Ставки

Сделать ставку на заявку

post /shipping_requests/{shipping_request_id}/bids
https://api.traffic.online/api/{version}/shipping_requests/{shipping_request_id}/bids

Сделать ставку на заявку

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
shipping_request_id
required
string

ID заявки

header Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
value
integer

Значение ставки

expedited_payment
boolean

Сделана ли ставка по условиям ускоренной оплаты

Responses

201
400

Неверные параметры запроса

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "value": 0,
  • "expedited_payment": true
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "ntk_id": "string",
  • "author":
    {
    },
  • "shipping_request_id": "string",
  • "shipping_order_id": "string",
  • "value": 1,
  • "status": "current",
  • "tax_type": "with_vat",
  • "expedited_payment": false,
  • "shippings_count": 1,
  • "auction_stage_number": 1,
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Получить список ставок на заявку

get /shipping_requests/{shipping_request_id}/bids
https://api.traffic.online/api/{version}/shipping_requests/{shipping_request_id}/bids

Получить список ставок на заявку

Authorizations:
JWT (TransportCompanyAdmin)
query Parameters
status
string
Enum: "current" "archived" "won" "cancelled"
ntk_id
string

Responses

200

Коллекция ставок на заявку

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "items":
    [
    ]
}

Сделать ставку на заявку неактивной

put /shipping_requests/{shipping_request_id}/bids/{bid_id}/archive
https://api.traffic.online/api/{version}/shipping_requests/{shipping_request_id}/bids/{bid_id}/archive

Сделать ставку на заявку неактивной

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
shipping_request_id
required
string <uuid>

ID заявки

bid_id
required
string <uuid>

ID ставки

Responses

200
400

Неверные параметры запроса

403

Нет прав на выполнение действия

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "ntk_id": "string",
  • "author":
    {
    },
  • "shipping_request_id": "string",
  • "shipping_order_id": "string",
  • "value": 1,
  • "status": "current",
  • "tax_type": "with_vat",
  • "expedited_payment": false,
  • "shippings_count": 1,
  • "auction_stage_number": 1,
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Перевозки

Получение списка перевозок

get /shippings
https://api.traffic.online/api/{version}/shippings

Получение списка перевозок

Authorizations:
JWT (TransportCompanyAdmin)
query Parameters
query
string

Человекочитаемый ID перевозки или графика, на основе которого была создана перевозка

status
string
Enum: "resources_waiting" "trip_waiting" "in_way" "done" "canceled"
contract_id
string

Идентификатор графика на площадке

company_id
string <uuid>

ID Компании

only_regular
boolean

Показать перевозки по разовым заявкам

only_by_contract
boolean

Показать перевозки по графикам

from_location_id
string

ID места начала перевозки

from_radius
integer

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

direction_location_id
string

ID места направления перевозки

direction_radius
integer

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

begin_from
string <date>

Дата начала перевозки - ОТ

begin_until
string <date>

Дата начала перевозки - ДО

order
string
Enum: "asc" "desc"

Тип упорядочивания элементов

sort
required
string
Value: "created_at"
page
integer >= 1
Default: 1

Номер текущей страницы

per_page
integer >= 1
Default: 10

Количество элементов на странице

Responses

200

Перевозки

400

Неверные параметры запроса

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "items":
    [
    ],
  • "page_info":
    {
    }
}

Получение информации о перевозке

get /shippings/{shipping_id}
https://api.traffic.online/api/{version}/shippings/{shipping_id}

Получение информации о перевозке

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
shipping_id
required
string <uuid>

ID перевозки

Responses

200
403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "shipping_request_info":
    {
    },
  • "assigned_resources":
    [
    ],
  • "selected_car_supply":
    [
    ],
  • "completed_at": "2024-07-30T14:07:50Z",
  • "resource_assignment_deadline": "2024-07-30T14:07:50Z",
  • "kind": "ShippingOutput",
  • "id": "string",
  • "human_friendly_id": "Человеко понятный id",
  • "status":
    {
    },
  • "status_updated_at": "2024-07-30T14:07:50Z",
  • "status_history":
    [
    ],
  • "scancopy_status": "cargo_owner_signing",
  • "scancopy_status_comment": "string",
  • "contract_id": "string",
  • "contract_hfid": "string",
  • "shipping_order_contract_id": "string",
  • "shipping_order_contract_hfid": "string",
  • "contract_shipping_id": "string",
  • "company_id": "string",
  • "company":
    {
    },
  • "shipping_request_id": "string",
  • "shipping_order_id": "string",
  • "assigned_resource_objects":
    {
    },
  • "expedited_payment": true,
  • "document_flow": "scancopy",
  • "shippings_count": 1,
  • "scancopy_attachment_deadline": "2024-07-30T14:07:50Z",
  • "requirements_changes_deadline": "2024-07-30T14:07:50Z",
  • "reserved_at": "2024-07-30T14:07:50Z",
  • "important_changes_at": "2024-07-30T14:07:50Z",
  • "requirements_accepted_at": "2024-07-30T14:07:50Z",
  • "closing_ttd_documents_accepted_at": "string",
  • "closing_ttd_documents_rejected_at": "string",
  • "closing_ttd_documents_rejection_comment": "string",
  • "closing_ttd_forwarder_documents_accepted_at": "string",
  • "closing_ttd_forwarder_documents_rejected_at": "string",
  • "closing_ttd_forwarder_documents_rejection_comment": "string",
  • "closing_bd_documents_accepted_at": "string",
  • "closing_bd_documents_rejected_at": "string",
  • "closing_bd_documents_rejection_comment": "string",
  • "closing_status": "documents_accepted",
  • "planned_payment_date": "2024-07-30",
  • "actual_payment_date": "2024-07-30",
  • "contact":
    {
    },
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Установить время подачи автомобиля для точки

post /shippings/{shipping_id}/route_points/{route_point_id}/set_car_supply_time
https://api.traffic.online/api/{version}/shippings/{shipping_id}/route_points/{route_point_id}/set_car_supply_time

Установить время подачи автомобиля для точки

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
shipping_id
required
string <uuid>

ID перевозки

route_point_id
required
integer

ID точки маршрута

header Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
car_supply_at
string <date-time>

Выбранная перевозчиком дата подачи автомобиля для интервальных заявок

Responses

200
400

Неверные параметры запроса

403

Нет прав на выполнение действия

404

Объект не найден

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "car_supply_at": "2024-07-30T14:07:50Z"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "shipping_request_info":
    {
    },
  • "assigned_resources":
    [
    ],
  • "selected_car_supply":
    [
    ],
  • "completed_at": "2024-07-30T14:07:50Z",
  • "resource_assignment_deadline": "2024-07-30T14:07:50Z",
  • "kind": "ShippingOutput",
  • "id": "string",
  • "human_friendly_id": "Человеко понятный id",
  • "status":
    {
    },
  • "status_updated_at": "2024-07-30T14:07:50Z",
  • "status_history":
    [
    ],
  • "scancopy_status": "cargo_owner_signing",
  • "scancopy_status_comment": "string",
  • "contract_id": "string",
  • "contract_hfid": "string",
  • "shipping_order_contract_id": "string",
  • "shipping_order_contract_hfid": "string",
  • "contract_shipping_id": "string",
  • "company_id": "string",
  • "company":
    {
    },
  • "shipping_request_id": "string",
  • "shipping_order_id": "string",
  • "assigned_resource_objects":
    {
    },
  • "expedited_payment": true,
  • "document_flow": "scancopy",
  • "shippings_count": 1,
  • "scancopy_attachment_deadline": "2024-07-30T14:07:50Z",
  • "requirements_changes_deadline": "2024-07-30T14:07:50Z",
  • "reserved_at": "2024-07-30T14:07:50Z",
  • "important_changes_at": "2024-07-30T14:07:50Z",
  • "requirements_accepted_at": "2024-07-30T14:07:50Z",
  • "closing_ttd_documents_accepted_at": "string",
  • "closing_ttd_documents_rejected_at": "string",
  • "closing_ttd_documents_rejection_comment": "string",
  • "closing_ttd_forwarder_documents_accepted_at": "string",
  • "closing_ttd_forwarder_documents_rejected_at": "string",
  • "closing_ttd_forwarder_documents_rejection_comment": "string",
  • "closing_bd_documents_accepted_at": "string",
  • "closing_bd_documents_rejected_at": "string",
  • "closing_bd_documents_rejection_comment": "string",
  • "closing_status": "documents_accepted",
  • "planned_payment_date": "2024-07-30",
  • "actual_payment_date": "2024-07-30",
  • "contact":
    {
    },
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Отказаться от выполнения перевозки

post /shippings/{shipping_id}/cancel
https://api.traffic.online/api/{version}/shippings/{shipping_id}/cancel

Отказаться от выполнения перевозки

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
shipping_id
required
string <uuid>

ID перевозки

Responses

200
400

Неверные параметры запроса

403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "shipping_request_info":
    {
    },
  • "assigned_resources":
    [
    ],
  • "selected_car_supply":
    [
    ],
  • "completed_at": "2024-07-30T14:07:50Z",
  • "resource_assignment_deadline": "2024-07-30T14:07:50Z",
  • "kind": "ShippingOutput",
  • "id": "string",
  • "human_friendly_id": "Человеко понятный id",
  • "status":
    {
    },
  • "status_updated_at": "2024-07-30T14:07:50Z",
  • "status_history":
    [
    ],
  • "scancopy_status": "cargo_owner_signing",
  • "scancopy_status_comment": "string",
  • "contract_id": "string",
  • "contract_hfid": "string",
  • "shipping_order_contract_id": "string",
  • "shipping_order_contract_hfid": "string",
  • "contract_shipping_id": "string",
  • "company_id": "string",
  • "company":
    {
    },
  • "shipping_request_id": "string",
  • "shipping_order_id": "string",
  • "assigned_resource_objects":
    {
    },
  • "expedited_payment": true,
  • "document_flow": "scancopy",
  • "shippings_count": 1,
  • "scancopy_attachment_deadline": "2024-07-30T14:07:50Z",
  • "requirements_changes_deadline": "2024-07-30T14:07:50Z",
  • "reserved_at": "2024-07-30T14:07:50Z",
  • "important_changes_at": "2024-07-30T14:07:50Z",
  • "requirements_accepted_at": "2024-07-30T14:07:50Z",
  • "closing_ttd_documents_accepted_at": "string",
  • "closing_ttd_documents_rejected_at": "string",
  • "closing_ttd_documents_rejection_comment": "string",
  • "closing_ttd_forwarder_documents_accepted_at": "string",
  • "closing_ttd_forwarder_documents_rejected_at": "string",
  • "closing_ttd_forwarder_documents_rejection_comment": "string",
  • "closing_bd_documents_accepted_at": "string",
  • "closing_bd_documents_rejected_at": "string",
  • "closing_bd_documents_rejection_comment": "string",
  • "closing_status": "documents_accepted",
  • "planned_payment_date": "2024-07-30",
  • "actual_payment_date": "2024-07-30",
  • "contact":
    {
    },
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

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

post /shippings/{shipping_id}/assign_resources
https://api.traffic.online/api/{version}/shippings/{shipping_id}/assign_resources

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

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
shipping_id
required
string <uuid>

ID перевозки

header Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
assigned_resources
Array of objects (AssignedResources)

Назначаемые ресурсы

document_flow
string Nullable
Enum: "scancopy" "online_confirmation" "qualified_signature"

Механизм работы с документами:

  • scancopy - сканкопия
  • online_confirmation - онлайн подтверждение (также известен как EDI, Простая Электронная Подпись, онлайн бронирование)
  • qualified_signature - квалифицированная электронная подпись (КЭП)

Responses

200
400

Неверные параметры запроса

403

Нет прав на выполнение действия

404

Объект не найден

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "assigned_resources":
    [
    ],
  • "document_flow": "scancopy"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "shipping_request_info":
    {
    },
  • "assigned_resources":
    [
    ],
  • "selected_car_supply":
    [
    ],
  • "completed_at": "2024-07-30T14:07:50Z",
  • "resource_assignment_deadline": "2024-07-30T14:07:50Z",
  • "kind": "ShippingOutput",
  • "id": "string",
  • "human_friendly_id": "Человеко понятный id",
  • "status":
    {
    },
  • "status_updated_at": "2024-07-30T14:07:50Z",
  • "status_history":
    [
    ],
  • "scancopy_status": "cargo_owner_signing",
  • "scancopy_status_comment": "string",
  • "contract_id": "string",
  • "contract_hfid": "string",
  • "shipping_order_contract_id": "string",
  • "shipping_order_contract_hfid": "string",
  • "contract_shipping_id": "string",
  • "company_id": "string",
  • "company":
    {
    },
  • "shipping_request_id": "string",
  • "shipping_order_id": "string",
  • "assigned_resource_objects":
    {
    },
  • "expedited_payment": true,
  • "document_flow": "scancopy",
  • "shippings_count": 1,
  • "scancopy_attachment_deadline": "2024-07-30T14:07:50Z",
  • "requirements_changes_deadline": "2024-07-30T14:07:50Z",
  • "reserved_at": "2024-07-30T14:07:50Z",
  • "important_changes_at": "2024-07-30T14:07:50Z",
  • "requirements_accepted_at": "2024-07-30T14:07:50Z",
  • "closing_ttd_documents_accepted_at": "string",
  • "closing_ttd_documents_rejected_at": "string",
  • "closing_ttd_documents_rejection_comment": "string",
  • "closing_ttd_forwarder_documents_accepted_at": "string",
  • "closing_ttd_forwarder_documents_rejected_at": "string",
  • "closing_ttd_forwarder_documents_rejection_comment": "string",
  • "closing_bd_documents_accepted_at": "string",
  • "closing_bd_documents_rejected_at": "string",
  • "closing_bd_documents_rejection_comment": "string",
  • "closing_status": "documents_accepted",
  • "planned_payment_date": "2024-07-30",
  • "actual_payment_date": "2024-07-30",
  • "contact":
    {
    },
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

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

get /shippings/{shipping_id}/assigned_resources
https://api.traffic.online/api/{version}/shippings/{shipping_id}/assigned_resources

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

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
shipping_id
required
string <uuid>

ID перевозки

Responses

200

OK

400

Неверные параметры запроса

403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "drivers":
    [
    ],
  • "cars":
    [
    ],
  • "trailers":
    [
    ]
}

Получить список ПФЗ

get /shippings/{shipping_id}/scancopies
https://api.traffic.online/api/{version}/shippings/{shipping_id}/scancopies

Получить список ПФЗ

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
shipping_id
required
string <uuid>

ID перевозки

Responses

200

OK

400

Неверные параметры запроса

403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "items":
    [
    ]
}

Получить ПФЗ по ID

get /shippings/{shipping_id}/scancopies/{scancopy_id}
https://api.traffic.online/api/{version}/shippings/{shipping_id}/scancopies/{scancopy_id}

Получить ПФЗ по ID

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
shipping_id
required
string <uuid>

ID перевозки

scancopy_id
required
string <uuid>

ID документа

Responses

200

OK

400

Неверные параметры запроса

403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "shipping_request_info":
    {
    },
  • "assigned_resources":
    [
    ],
  • "selected_car_supply":
    [
    ],
  • "completed_at": "2024-07-30T14:07:50Z",
  • "resource_assignment_deadline": "2024-07-30T14:07:50Z",
  • "kind": "ShippingOutput",
  • "id": "string",
  • "human_friendly_id": "Человеко понятный id",
  • "status":
    {
    },
  • "status_updated_at": "2024-07-30T14:07:50Z",
  • "status_history":
    [
    ],
  • "scancopy_status": "cargo_owner_signing",
  • "scancopy_status_comment": "string",
  • "contract_id": "string",
  • "contract_hfid": "string",
  • "shipping_order_contract_id": "string",
  • "shipping_order_contract_hfid": "string",
  • "contract_shipping_id": "string",
  • "company_id": "string",
  • "company":
    {
    },
  • "shipping_request_id": "string",
  • "shipping_order_id": "string",
  • "assigned_resource_objects":
    {
    },
  • "expedited_payment": true,
  • "document_flow": "scancopy",
  • "shippings_count": 1,
  • "scancopy_attachment_deadline": "2024-07-30T14:07:50Z",
  • "requirements_changes_deadline": "2024-07-30T14:07:50Z",
  • "reserved_at": "2024-07-30T14:07:50Z",
  • "important_changes_at": "2024-07-30T14:07:50Z",
  • "requirements_accepted_at": "2024-07-30T14:07:50Z",
  • "closing_ttd_documents_accepted_at": "string",
  • "closing_ttd_documents_rejected_at": "string",
  • "closing_ttd_documents_rejection_comment": "string",
  • "closing_ttd_forwarder_documents_accepted_at": "string",
  • "closing_ttd_forwarder_documents_rejected_at": "string",
  • "closing_ttd_forwarder_documents_rejection_comment": "string",
  • "closing_bd_documents_accepted_at": "string",
  • "closing_bd_documents_rejected_at": "string",
  • "closing_bd_documents_rejection_comment": "string",
  • "closing_status": "documents_accepted",
  • "planned_payment_date": "2024-07-30",
  • "actual_payment_date": "2024-07-30",
  • "contact":
    {
    },
  • "created_at": "2024-07-30T14:07:50Z",
  • "updated_at": "2024-07-30T14:07:50Z"
}

Добавление файла

post /shippings/{shipping_id}/scancopies/{scancopy_id}/file
https://api.traffic.online/api/{version}/shippings/{shipping_id}/scancopies/{scancopy_id}/file

Добавление файла

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
shipping_id
required
string <uuid>

ID перевозки

scancopy_id
required
string <uuid>

ID документа

header Parameters
Content-Type
required
any
Value: "application/octet-stream"
Request Body schema: application/octet-stream
string <= 10485760 characters

Responses

403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": 403,
  • "error": "Forbidden",
  • "error_description": "Forbidden"
}

Удаление файла который прикреплен

delete /shippings/{shipping_id}/scancopies/{scancopy_id}/file/{file_id}
https://api.traffic.online/api/{version}/shippings/{shipping_id}/scancopies/{scancopy_id}/file/{file_id}

Удаление файла который прикреплен

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
shipping_id
required
string <uuid>

ID перевозки

scancopy_id
required
string <uuid>

ID документа

file_id
required
string <uuid>

ID файла

Responses

200
403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": 403,
  • "error": "Forbidden",
  • "error_description": "Forbidden"
}

Скачивание файла

get /shippings/{shipping_id}/scancopies/{scancopy_id}/file/{file_id}/download
https://api.traffic.online/api/{version}/shippings/{shipping_id}/scancopies/{scancopy_id}/file/{file_id}/download

Скачивание файла

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
shipping_id
required
string <uuid>

ID перевозки

scancopy_id
required
string <uuid>

ID документа

file_id
required
string <uuid>

ID файла

Responses

200

OK

400

Неверные параметры запроса

403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": 400,
  • "error": "BadRequest",
  • "error_description": "BadRequest"
}

Подписать ПФЗ

post /shippings/{shipping_id}/scancopies/{scancopy_id}/accept
https://api.traffic.online/api/{version}/shippings/{shipping_id}/scancopies/{scancopy_id}/accept

Подписать ПФЗ

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
shipping_id
required
string <uuid>

ID перевозки

scancopy_id
required
string <uuid>

ID документа

Responses

200

OK

400

Неверные параметры запроса

403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "status": "cargo_owner_signing",
  • "comment": "string",
  • "status_history":
    [
    ],
  • "status_updated_at": "2024-07-30T14:07:51Z",
  • "files":
    [
    ],
  • "created_at": "2024-07-30T14:07:51Z",
  • "deleted_at": "2024-07-30T14:07:51Z"
}

Скачать шаблон ПФЗ

get /shippings/scancopies/template/{shipping_id}/file
https://api.traffic.online/api/{version}/shippings/scancopies/template/{shipping_id}/file

Скачать шаблон ПФЗ

Authorizations:
JWT (TransportCompanyAdmin)
path Parameters
shipping_id
required
string <uuid>

ID перевозки

Responses

200
400

Неверные параметры запроса

403

Нет прав на выполнение действия

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": 400,
  • "error": "BadRequest",
  • "error_description": "BadRequest"
}

Компании

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

get /company/search_by_ids
https://api.traffic.online/api/{version}/company/search_by_ids

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

Authorizations:
JWT (TransportCompanyAdmin)
query Parameters
companies_ids
Array of strings <uuid>

IDS Компаний

Responses

200

Список компаний с базовой информацией

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "items":
    [
    ]
}

Получить компанию по ID

get /company/{company_id}
https://api.traffic.online/api/{version}/company/{company_id}

Получить компанию по ID

Authorizations:
JWT (TransportCompanyAdmin)

Responses

200

Компания

404

Объект не найден

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "human_friendly_id": "string",
  • "kinds":
    [
    ],
  • "company_status":
    {
    },
  • "status_updated_at": "2024-07-30T14:07:51Z",
  • "created_at": "2024-07-30T14:07:51Z",
  • "updated_at": "2024-07-30T14:07:51Z",
  • "country_id": 0,
  • "country":
    {
    },
  • "online_contract_approved": true,
  • "online_contract_id": "string",
  • "tc_categories":
    [
    ],
  • "has_transit_contract": true,
  • "vip": true,
  • "expedited_payment_available": true,
  • "rating": 0,
  • "logo_url": "string",
  • "priority": 0,
  • "trusted_person_info":
    {
    },
  • "ceo_info":
    {
    },
  • "accountant_info":
    {
    },
  • "additional_info":
    {
    },
  • "props":
    {
    },
  • "contacts":
    {
    },
  • "manual_spot_winner_pick_allowed": true,
  • "auction_auto_extend_period": 1
}