Documentation Powered by ReDoc

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

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

path 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
BasicAuth
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-01-31T07:17:34Z"
}

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

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

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

Authorizations:
JWT (CargoOwningCompanyAdmin)

Responses

204

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

401

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

Response samples

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

Партнерства

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

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

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

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

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

per_page
integer >= 1
Default: 10

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

status
Array of strings
Items Enum: "blacklisted" "requested" "active"

Статус партнёрства

q
string

Человекочитаемый ID партнёра, название компании партнёра или ИНН партнёра

qroups_ids
Array of strings <uuid>

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

Responses

200

Коллекция партнёрств

400

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

401

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

Response samples

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

Получение списка групп партнёров

get /partnerships/groups
https://api.traffic.online/api/{version}/partnerships/groups

Получение списка групп партнёров

Authorizations:
JWT (CargoOwningCompanyAdmin)
query Parameters
q
string >= 1

Поисковая строка

Responses

200

Коллекция групп партнёрств

400

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

401

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

Response samples

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

Заказы

Создать заказ и сразу же опубликовать его

post /shipping_orders
https://api.traffic.online/api/{version}/shipping_orders

Создать заказ и сразу же опубликовать его

Authorizations:
JWT (CargoOwningCompanyAdmin)
path Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
type
string
Enum: "shipping_request" "contract" "delivery" "city_delivery"

Тип заказа:

  • shipping_request - разовый (заявка на перевозку груза)
  • contract - графиковый (график на несколько заявок на перевозку груза)
  • delivery - автодоставка (аренда ТС с экипажем)
  • city_delivery - автодоставка (городская)
external_info_id
string Nullable

Идентификатор заказа во внешних системах. Используется только для информации

parent_id
string <uuid> Nullable

ID заказа, на основании которого был создан текущий заказ. Используется только для информации

contact
object

Ответственное лицо всего заказа

comment
string Nullable

Комментарий к заказу

hide_contacts
boolean

Скрыть контакты

resource_assignment_time
integer [ 60 .. 144000 ] Nullable

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

resource_assignment_till
string <date-time> Nullable

Конкретное время назначение ресурсов после бронирования заявки (необходмо передать один из resource_assignment_time или resource_assignment_till)

change_requests_allowed
boolean Nullable

Можно ли создавать запросы на изменение заказа

contract_begins_at
string <date-time> Nullable

Дата начала исполнения. Указывается в часовом поясе первой точки маршрута

contract_ends_at
string <date-time> Nullable

Дата окончания исполнения. Указывается в часовом поясе последней точки маршрута

contract_type
string Nullable
Enum: "by_shippings_count" "by_schedule"

Вид графикового заказа:

  • by_shippings_count - по объёму (количеству перевозок)
  • by_schedule - по точному расписанию
shippings_count
integer [ 1 .. 100000 ] Nullable

Объём графикового заказа - количество перевозок

max_shippings_per_day
integer [ 1 .. 100000 ] Nullable

Максимальное количество перевозок в день по данному графиковому заказу для перевозчика. null означает, что ограничений нет

max_shippings_per_week
integer [ 1 .. 100000 ] Nullable

Максимальное количество перевозок в неделю по данному графиковому заказу для перевозчика. null означает, что ограничений нет

shipping_available_in
integer [ 0 .. 43200 ] Nullable

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

transport_body_types
Array of strings non-empty
Items Enum: "awning" "full_metal" "isothermal" "refrigerator" "dropside" "tanker" "container"

Типы кузова транспорта

transport_tonnage
number <double> [ 0 .. 200 ]

Тоннаж транспорта в тоннах

transport_volume
number <double> [ 0 .. 200 ]

Объём транспорта в кубических метрах

resource_requirements
object

Требования к ресурсам

cargo_name
string

Наименование груза

cargo_tonnage
number <double> [ 0 .. 24 ]

Тоннаж груза в тоннах

cargo_volume
number <double> [ 0 .. 150 ]

Объём груза в кубических метрах

cargo_cost
integer [ 0 .. 999999999 ] Nullable

Стоимость груза

cargo_adr
string Nullable
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"

Класс опасности груза

cargo_length
number <double> [ 0.5 .. 17 ] Nullable

Длина груза в метрах

cargo_width
number <double> [ 0.5 .. 2.75 ] Nullable

Ширина груза в метрах

cargo_height
number <double> [ 0.5 .. 3 ] Nullable

Высота груза в метрах

cargo_places
integer [ 0 .. 100 ] Nullable

Количество грузомест

cargo_packing
string Nullable
Enum: "reels" "big_bags" "barrels" "eurocubes" "cans" "coils" "boxes" "sheets" "bags" "in_bulk" "not_specified" "pallets" "fin_pallets" "packs" "pyramid" "loose" "rolls" "cases"

Упаковка груза:

  • reels - Барабаны
  • big_bags - Биг-бэги
  • barrels - Бочки
  • eurocubes - Еврокубы
  • cans - Канистры
  • coils - Катушки
  • boxes - Коробки
  • sheets - Листы
  • bags - Мешки
  • in_bulk - Навалом
  • not_specified - Нет упаковки
  • pallets - Паллеты EUR
  • fin_pallets - Паллеты FIN
  • packs - Пачки
  • pyramid - Пирамида
  • loose - Россыпью
  • rolls - Рулоны
  • cases - Ящики
route_points
Array of objects [ 2 .. 100 ] items

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

auction_stages
Array of objects [ 0 .. 1000 ] items

Этапы торга

executors
Array of objects [ 0 .. 1 ] items

Исполнители заказа, указанные в момент создания

contract_id
string <uuid> Nullable

ID графикового заказа, для которого создаётся данный заказ

contract_shipping_price
integer [ 0 .. 999999999 ] Nullable

Стоимость заказа по графику. В случае, если поле не заполнено, стоимость будет браться из графика

dynamic_pricing
boolean Nullable

Применять ли динамический коридор ставки для открытых аукционов

auction_auto_extend_period
integer [ 1 .. 24 ] Nullable

Период автопродления торга

rebidding
boolean Nullable

Возможноть переторжки

manual_spot_winner_pick_allowed
boolean

Можно ли выбирать выигрышную ставку в процессе торга спот заказа

partnership_contract_type
string Nullable
Default: "all"

Тип договора:

  • bts - БТС (от ДЛ или ГК)
  • mkt - МКТ (от ДЛ)
  • all - внешние ГВ, автодоставка
document_flows
Array of strings
Items Enum: "scancopy" "online_confirmation" "qualified_signature"

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

closing_documents_period
integer [ 1 .. 366 ] Nullable

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

closing_documents_period_type
string Nullable
Enum: "calendar" "working"

Тип дней в периоде предоставления закрывающих документов:

  • calendar - Календарный день
  • working - Рабочий день
agreement_type
string Nullable
Enum: "shipping_agreement" "freight_forwarding_agreement"

Вид договора

  • shipping_agreement - Договор перевозки
  • freight_forwarding_agreement - Договор транспортной экспедиции
closing_documents
Array of objects non-empty

Закрывающие документы

terms_by_partnership_contract
boolean

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

idle_time_cost_without_vat
integer [ 100 .. 1500 ] Nullable

Стоимость одного часа простоя сверх времени работы в точке без НДС, кратно 100

documents_for_payment
Array of strings
Items Enum: "bill_of_lading" "waybill" "bill_of_lading_or_waybill" "packing_list" "bill" "acceptance_certificate" "delivery_certificate" "invoice" "power_of_attorney" "universal_transfer_document" "accompanying_document" "cmr" "forwarding_order" "shipping_order" "forwarding_receipt" "attachment_to_bill_of_lading"

Документы для оплаты

payment_procedure
string Nullable
Enum: "prepayment" "payment_by_scancopy" "payment_by_original_documents" "payment_by_unloading" "payment_by_loading"

Порядок оплаты:

  • prepayment - Предоплата
  • payment_by_scancopy - Оплата по скан-копиям документов
  • payment_by_original_documents - Оплата по оригиналам документов
  • payment_by_unloading - Оплата по факту выгрузки
  • payment_by_loading - Оплата по факту загрузки
payment_period
integer [ 1 .. 366 ] Nullable

Период оплаты в днях

payment_period_type
string Nullable
Enum: "calendar" "working"

Тип дней в периоде оплаты:

  • calendar - Календарный день
  • working - Рабочий день
cancellation_without_penalty_before
string <date-time> Nullable

Допустимое время для отказа от перевозки до наступления санкций

cancellation_penalty_percent
integer [ 0 .. 100 ] Nullable

Штраф за отказ от перевозки после наступления санкций в процентах от стоимости без НДС

minimum_cancellation_penalty_without_vat
integer [ 0 .. 999999999 ] Nullable

Минимальный штраф за отказ от перевозки после наступления санкций без НДС

payer_opf_id
integer [ 1 .. 8 ] Nullable

ID ОПФ плательщика:

  • 1 - ООО
  • 2 - ЗАО
  • 3 - ПАО
  • 4 - ИП
  • 5 - АО
  • 6 - АНО
  • 7 - ГКФХ
  • 8 - ЧП
payer_title
string Nullable

Название организации (либо ФИО физ. лица) плательщика.

payment_form
string Nullable

Форма оплаты:

  • cashless - безналичная оплата
  • cash - оплата наличными
forward_request_number
string Nullable

Номер заявки экспедитора по перевозке.

auto_accept_changes
boolean

Указывает на возможность авто согласования изменений

Responses

200

Заказ

400

Для одной из точек маршрута не удалось определить геокоординаты

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "type": "shipping_request",
  • "external_info_id": "string",
  • "parent_id": "string",
  • "contact":
    {
    },
  • "comment": "string",
  • "hide_contacts": true,
  • "resource_assignment_time": 60,
  • "resource_assignment_till": "2020-03-13T15:46:31+00:00",
  • "change_requests_allowed": true,
  • "contract_begins_at": "2024-01-31T07:17:34Z",
  • "contract_ends_at": "2024-01-31T07:17:34Z",
  • "contract_type": "by_shippings_count",
  • "shippings_count": 1,
  • "max_shippings_per_day": 1,
  • "max_shippings_per_week": 1,
  • "shipping_available_in": 0,
  • "transport_body_types":
    [
    ],
  • "transport_tonnage": 0,
  • "transport_volume": 0,
  • "resource_requirements":
    {
    },
  • "cargo_name": "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_points":
    [
    ],
  • "auction_stages":
    [
    ],
  • "executors":
    [
    ],
  • "contract_id": "string",
  • "contract_shipping_price": 0,
  • "dynamic_pricing": true,
  • "auction_auto_extend_period": 1,
  • "rebidding": true,
  • "manual_spot_winner_pick_allowed": true,
  • "partnership_contract_type": "all",
  • "document_flows":
    [
    ],
  • "closing_documents_period": 1,
  • "closing_documents_period_type": "calendar",
  • "agreement_type": "shipping_agreement",
  • "closing_documents":
    [
    ],
  • "terms_by_partnership_contract": true,
  • "idle_time_cost_without_vat": 100,
  • "documents_for_payment":
    [
    ],
  • "payment_procedure": "prepayment",
  • "payment_period": 1,
  • "payment_period_type": "calendar",
  • "cancellation_without_penalty_before": "2024-01-31T07:17:34Z",
  • "cancellation_penalty_percent": 0,
  • "minimum_cancellation_penalty_without_vat": 0,
  • "payer_opf_id": 1,
  • "payer_title": "string",
  • "payment_form": "string",
  • "forward_request_number": "string",
  • "shipping":
    {
    },
  • "auto_accept_changes": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "human_friendly_id": "string",
  • "created_at": "2024-01-31T07:17:34Z",
  • "updated_at": "2024-01-31T07:17:34Z",
  • "deleted_at": "2024-01-31T07:17:34Z",
  • "status": "draft",
  • "status_comment": "string",
  • "status_updated_at": "2024-01-31T07:17:34Z",
  • "status_history":
    [
    ],
  • "cargo_owning_company_id": "string",
  • "author_id": "string",
  • "type": "shipping_request",
  • "external_info_id": "string",
  • "parent_id": "string",
  • "contact":
    {
    },
  • "comment": "string",
  • "archived": true,
  • "hide_contacts": true,
  • "resource_assignment_time": 60,
  • "resource_assignment_till": "2020-03-13T15:46:31+00:00",
  • "change_requests_allowed": true,
  • "change_request_status": "string",
  • "change_resources_request_status": "string",
  • "contract_begins_at": "2024-01-31T07:17:34Z",
  • "contract_ends_at": "2024-01-31T07:17:34Z",
  • "contract_type": "by_shippings_count",
  • "shippings_count": 1,
  • "max_shippings_per_day": 1,
  • "max_shippings_per_week": 1,
  • "shipping_available_in": 0,
  • "transport_body_types":
    [
    ],
  • "transport_tonnage": 0,
  • "transport_volume": 0,
  • "resource_requirements":
    {
    },
  • "cargo_name": "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_points":
    [
    ],
  • "route_direction":
    {
    },
  • "is_route_circular": true,
  • "auction_stages":
    [
    ],
  • "executors":
    [
    ],
  • "contract_id": "string",
  • "contract_hfid": "string",
  • "contract_shipping_id": "string",
  • "contract_shipping_price": 0,
  • "dynamic_pricing": true,
  • "auction_auto_extend_period": 1,
  • "rebidding": true,
  • "manual_spot_winner_pick_allowed": true,
  • "partnership_contract_type": "all",
  • "document_flows":
    [
    ],
  • "closing_documents_period": 1,
  • "closing_documents_period_type": "calendar",
  • "agreement_type": "shipping_agreement",
  • "closing_documents":
    [
    ],
  • "terms_by_partnership_contract": true,
  • "idle_time_cost_without_vat": 100,
  • "documents_for_payment":
    [
    ],
  • "payment_procedure": "prepayment",
  • "payment_period": 1,
  • "payment_period_type": "calendar",
  • "cancellation_without_penalty_before": "2024-01-31T07:17:34Z",
  • "cancellation_penalty_percent": 0,
  • "minimum_cancellation_penalty_without_vat": 0,
  • "payer_opf_id": 1,
  • "payer_title": "string",
  • "payment_form": "string",
  • "forward_request_number": "string",
  • "shipping_price": 0,
  • "shipping_price_tax_type": "string",
  • "shipping_payment_type": "string",
  • "shipping_id": "string",
  • "shipping_min_work_hours": 0,
  • "shipping":
    {
    },
  • "current_auction_stage_number": 1,
  • "winning_bid_id": "string",
  • "winning_bid_min_work_hours": 0,
  • "winning_bid_price_with_vat": 1,
  • "winning_bid_price_without_vat": 1,
  • "auto_accept_changes": true
}

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

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

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

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

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

per_page
integer >= 1
Default: 10

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

human_friendly_id
any

Номер заказа на перевозку

type
Array of strings
Items Enum: "shipping_request" "contract" "delivery" "city_delivery"
from
string

ID места, в которой начинается перевозка

to
string

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

date_from
string <date>

Фильтр по датам "с"

date_till
string <date>

Фильтр по датам "по"

status
Array of strings
Items Enum: "draft" "auction_waiting" "in_auction" "winner_selection" "reserved" "approval_waiting" "trip_waiting" "in_trip" "completed" "canceled_by_transport_company" "canceled_by_cargo_owning_company" "failed_by_transport_company" "failed_by_cargo_owning_company" "expired"

Статус заказа

contract_shipping_id
string <uuid>

ID графиковой перевозки (квоты), для которой был создан данный заказ

archived
boolean

Находится ли заказ в архиве

realization_start_at_from
string <date>

Фильтр по дате начала графика графика "с"

realization_start_at_until
string <date>

Фильтр по дате начала графика графика "по"

realization_end_at_from
string <date>

Фильтр по дате окончания графика графика "с"

realization_end_at_until
string <date>

Фильтр по дате окончания графика графика "по"

Responses

200

Коллекция заказов

400

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

401

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

Response samples

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

Получение заказа по id

get /shipping_orders/{shipping_order_id}
https://api.traffic.online/api/{version}/shipping_orders/{shipping_order_id}

Получение заказа по id

Authorizations:
JWT (CargoOwningCompanyAdmin)
path Parameters
shipping_order_id
any

id Заказа

Responses

200

Черновик заказа

400

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

401

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

403

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

404

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "human_friendly_id": "string",
  • "created_at": "2024-01-31T07:17:34Z",
  • "updated_at": "2024-01-31T07:17:34Z",
  • "deleted_at": "2024-01-31T07:17:34Z",
  • "status": "draft",
  • "status_comment": "string",
  • "status_updated_at": "2024-01-31T07:17:34Z",
  • "status_history":
    [
    ],
  • "cargo_owning_company_id": "string",
  • "author_id": "string",
  • "type": "shipping_request",
  • "external_info_id": "string",
  • "parent_id": "string",
  • "contact":
    {
    },
  • "comment": "string",
  • "archived": true,
  • "resource_assignment_time": 60,
  • "resource_assignment_till": "2020-03-13T15:46:31+00:00",
  • "change_requests_allowed": false,
  • "change_request_status": "string",
  • "change_resources_request_status": "string",
  • "contract_begins_at": "2024-01-31T07:17:34Z",
  • "contract_ends_at": "2024-01-31T07:17:34Z",
  • "contract_type": "by_shippings_count",
  • "shippings_count": 1,
  • "max_shippings_per_day": 1,
  • "max_shippings_per_week": 1,
  • "shipping_available_in": 0,
  • "transport_body_types": [ ],
  • "transport_tonnage": 0,
  • "transport_volume": 0,
  • "resource_requirements":
    {
    },
  • "cargo_name": "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_points":
    [
    ],
  • "route_direction":
    {
    },
  • "is_route_circular": true,
  • "auction_stages":
    [
    ],
  • "executors":
    [
    ],
  • "contract_id": "string",
  • "contract_hfid": "string",
  • "contract_shipping_id": "string",
  • "manual_spot_winner_pick_allowed": true,
  • "auction_auto_extend_period": 1,
  • "document_flows": [ ],
  • "closing_documents_period": 1,
  • "closing_documents_period_type": "calendar",
  • "closing_documents": [ ],
  • "agreement_type": "shipping_agreement",
  • "terms_by_partnership_contract": false,
  • "idle_time_cost_without_vat": 100,
  • "documents_for_payment": [ ],
  • "payment_procedure": "prepayment",
  • "payment_period": 1,
  • "payment_period_type": "calendar",
  • "cancellation_without_penalty_before": "2024-01-31T07:17:34Z",
  • "cancellation_penalty_percent": 0,
  • "minimum_cancellation_penalty_without_vat": 0,
  • "shipping_price": 0,
  • "shipping_price_tax_type": "string",
  • "shipping_id": "string",
  • "shipping_payment_type": "per_hour",
  • "shipping_min_work_hours": 0,
  • "shipping":
    {
    },
  • "current_auction_stage_number": 1,
  • "winning_bid_id": "string",
  • "winning_bid_min_work_hours": 0,
  • "winning_bid_price_with_vat": null,
  • "winning_bid_price_without_vat": null,
  • "winning_bid": null,
  • "watching_count":
    [
    ]
}

Обновить черновик заказа

put /shipping_orders/{shipping_order_id}
https://api.traffic.online/api/{version}/shipping_orders/{shipping_order_id}

Обновить черновик заказа

Authorizations:
JWT (CargoOwningCompanyAdmin)
path Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
author_id
string <uuid> Nullable

ID пользователя, создавшего заказ.

type
string
Enum: "shipping_request" "contract" "delivery" "city_delivery"

Тип заказа:

  • shipping_request - разовый (заявка на перевозку груза)
  • contract - графиковый (график на несколько заявок на перевозку груза)
  • delivery - автодоставка (аренда ТС с экипажем)
  • city_delivery - автодоставка (городская)
external_info_id
string Nullable

Идентификатор заказа во внешних системах. Используется только для информации

parent_id
string <uuid> Nullable

ID заказа, на основании которого был создан текущий заказ. Используется только для информации

contact
object Nullable

Ответственное лицо всего заказа

comment
string Nullable

Комментарий к заказу

resource_assignment_time
integer [ 60 .. 144000 ] Nullable

Время на назначение ресурсов после бронирования заявки в минутах

resource_assignment_till
string <date-time> Nullable

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

change_requests_allowed
boolean
Default: false

Можно ли создавать запросы на изменение заказа

change_request_status
string <text> Nullable

Статус заявки на изменение требований заказа.

change_resources_request_status
string <text> Nullable

Статус заявки на измнение русурсов заказа.

contract_begins_at
string <date-time> Nullable

Дата начала исполнения. Указывается в часовом поясе первой точки маршрута

contract_ends_at
string <date-time> Nullable

Дата окончания исполнения. Указывается в часовом поясе последней точки маршрута

contract_type
string Nullable
Enum: "by_shippings_count" "by_schedule"

Вид графикового заказа:

  • by_shippings_count - по объёму (количеству перевозок)
  • by_schedule - по точному расписанию
shippings_count
integer [ 1 .. 100000 ] Nullable

Объём графикового заказа - количество перевозок

max_shippings_per_day
integer [ 1 .. 100000 ] Nullable

Максимальное количество перевозок в день по данному графиковому заказу для перевозчика. null означает, что ограничений нет

max_shippings_per_week
integer [ 1 .. 100000 ] Nullable

Максимальное количество перевозок в неделю по данному графиковому заказу для перевозчика. null означает, что ограничений нет

shipping_available_in
integer [ 0 .. 43200 ] Nullable

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

transport_body_types
Array of strings non-empty
Default: []
Items Enum: "awning" "full_metal" "isothermal" "refrigerator" "dropside" "tanker" "container"

Типы кузова транспорта

transport_tonnage
number <double> [ 0 .. 200 ] Nullable

Тоннаж транспорта в тоннах

transport_volume
number <double> [ 0 .. 200 ] Nullable

Объём транспорта в кубических метрах

resource_requirements
object

Требования к ресурсам

cargo_name
string <= 150 characters Nullable

Наименование груза

cargo_tonnage
number <double> [ 0 .. 24 ] Nullable

Тоннаж груза в тоннах

cargo_volume
number <double> [ 0 .. 150 ] Nullable

Объём груза в кубических метрах

cargo_cost
integer [ 0 .. 999999999 ] Nullable

Стоимость груза

cargo_adr
string Nullable
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"

Класс опасности груза

cargo_length
number <double> [ 0.5 .. 17 ] Nullable

Длина груза в метрах

cargo_width
number <double> [ 0.5 .. 2.75 ] Nullable

Ширина груза в метрах

cargo_height
number <double> [ 0.5 .. 3 ] Nullable

Высота груза в метрах

cargo_places
integer [ 0 .. 100 ] Nullable

Количество грузомест

cargo_packing
string Nullable
Enum: "reels" "big_bags" "barrels" "eurocubes" "cans" "coils" "boxes" "sheets" "bags" "in_bulk" "not_specified" "pallets" "fin_pallets" "packs" "pyramid" "loose" "rolls" "cases"

Упаковка груза:

  • reels - Барабаны
  • big_bags - Биг-бэги
  • barrels - Бочки
  • eurocubes - Еврокубы
  • cans - Канистры
  • coils - Катушки
  • boxes - Коробки
  • sheets - Листы
  • bags - Мешки
  • in_bulk - Навалом
  • not_specified - Нет упаковки
  • pallets - Паллеты EUR
  • fin_pallets - Паллеты FIN
  • packs - Пачки
  • pyramid - Пирамида
  • loose - Россыпью
  • rolls - Рулоны
  • cases - Ящики
route_points
Array of objects <= 100 items

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

auction_stages
Array of objects [ 0 .. 1000 ] items

Этапы торга

executors
Array of objects [ 0 .. 1 ] items

Исполнители заказа, указанные в момент создания

contract_id
string <uuid> Nullable

ID графикового заказа, для которого создаётся данный заказ

manual_spot_winner_pick_allowed
boolean

Можно ли выбирать выигрышную ставку в процессе торга спот заказа

auction_auto_extend_period
integer [ 1 .. 24 ] Nullable

Период автопродления торга

document_flows
Array of strings
Default: []
Items Enum: "scancopy" "online_confirmation" "qualified_signature"

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

closing_documents_period
integer [ 1 .. 366 ] Nullable

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

closing_documents_period_type
string Nullable
Enum: "calendar" "working"

Тип дней в периоде предоставления закрывающих документов:

  • calendar - Календарный день
  • working - Рабочий день
closing_documents
Array of objects
Default: []

Закрывающие документы

agreement_type
string Nullable
Enum: "shipping_agreement" "freight_forwarding_agreement"

Вид договора

  • shipping_agreement - Договор перевозки
  • freight_forwarding_agreement - Договор транспортной экспедиции
terms_by_partnership_contract
boolean
Default: false

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

idle_time_cost_without_vat
integer [ 100 .. 1500 ] Nullable

Стоимость одного часа простоя сверх времени работы в точке без НДС, кратно 100

documents_for_payment
Array of strings
Default: []
Items Enum: "bill_of_lading" "waybill" "bill_of_lading_or_waybill" "packing_list" "bill" "acceptance_certificate" "delivery_certificate" "invoice" "power_of_attorney" "universal_transfer_document" "accompanying_document" "cmr" "forwarding_order" "shipping_order" "forwarding_receipt" "attachment_to_bill_of_lading"

Документы для оплаты

payment_procedure
string Nullable
Enum: "prepayment" "payment_by_scancopy" "payment_by_original_documents" "payment_by_unloading" "payment_by_loading"

Порядок оплаты:

  • prepayment - Предоплата
  • payment_by_scancopy - Оплата по скан-копиям документов
  • payment_by_original_documents - Оплата по оригиналам документов
  • payment_by_unloading - Оплата по факту выгрузки
  • payment_by_loading - Оплата по факту загрузки
payment_period
integer [ 1 .. 366 ] Nullable

Период оплаты в днях

payment_period_type
string Nullable
Enum: "calendar" "working"

Тип дней в периоде оплаты:

  • calendar - Календарный день
  • working - Рабочий день
cancellation_without_penalty_before
string <date-time> Nullable

Допустимое время для отказа от перевозки до наступления санкций

cancellation_penalty_percent
integer [ 0 .. 100 ] Nullable

Штраф за отказ от перевозки после наступления санкций в процентах от стоимости без НДС

minimum_cancellation_penalty_without_vat
integer [ 0 .. 999999999 ] Nullable

Минимальный штраф за отказ от перевозки после наступления санкций без НДС

shipping_payment_type
string Nullable
Enum: "per_hour" "fixed"

Тип цены:

  • per_hour - За час
  • fixed - Фисированая
shipping_min_work_hours
integer Nullable

Минимально оплачиваемое количество часов в заказе.

winning_bid_id
string <uuid> Nullable

ID выигравшей стваки.

winning_bid_min_work_hours
integer Nullable

Минимально оплачиваемое количество часов выигравшей ставки.

winning_bid_price_with_vat
decimal Nullable

Цена победившей стваки (с НДС).

winning_bid_price_without_vat
decimal Nullable

Цена победившей стваки (без НДС).

winning_bid
float Nullable

Выигравшая ставка.

watching_count
Array of objects Nullable

Счетчик количества просмотров заявки.

Responses

200

Черновик заказа

400

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

401

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

403

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

404

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "author_id": "string",
  • "type": "shipping_request",
  • "external_info_id": "string",
  • "parent_id": "string",
  • "contact":
    {
    },
  • "comment": "string",
  • "resource_assignment_time": 60,
  • "resource_assignment_till": "2020-03-13T15:46:31+00:00",
  • "change_requests_allowed": false,
  • "change_request_status": "string",
  • "change_resources_request_status": "string",
  • "contract_begins_at": "2024-01-31T07:17:35Z",
  • "contract_ends_at": "2024-01-31T07:17:35Z",
  • "contract_type": "by_shippings_count",
  • "shippings_count": 1,
  • "max_shippings_per_day": 1,
  • "max_shippings_per_week": 1,
  • "shipping_available_in": 0,
  • "transport_body_types": [ ],
  • "transport_tonnage": 0,
  • "transport_volume": 0,
  • "resource_requirements":
    {
    },
  • "cargo_name": "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_points":
    [
    ],
  • "auction_stages":
    [
    ],
  • "executors":
    [
    ],
  • "contract_id": "string",
  • "manual_spot_winner_pick_allowed": true,
  • "auction_auto_extend_period": 1,
  • "document_flows": [ ],
  • "closing_documents_period": 1,
  • "closing_documents_period_type": "calendar",
  • "closing_documents": [ ],
  • "agreement_type": "shipping_agreement",
  • "terms_by_partnership_contract": false,
  • "idle_time_cost_without_vat": 100,
  • "documents_for_payment": [ ],
  • "payment_procedure": "prepayment",
  • "payment_period": 1,
  • "payment_period_type": "calendar",
  • "cancellation_without_penalty_before": "2024-01-31T07:17:35Z",
  • "cancellation_penalty_percent": 0,
  • "minimum_cancellation_penalty_without_vat": 0,
  • "shipping_payment_type": "per_hour",
  • "shipping_min_work_hours": 0,
  • "shipping":
    {
    },
  • "winning_bid_id": "string",
  • "winning_bid_min_work_hours": 0,
  • "winning_bid_price_with_vat": null,
  • "winning_bid_price_without_vat": null,
  • "winning_bid": null,
  • "watching_count":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "human_friendly_id": "string",
  • "created_at": "2024-01-31T07:17:35Z",
  • "updated_at": "2024-01-31T07:17:35Z",
  • "deleted_at": "2024-01-31T07:17:35Z",
  • "status": "draft",
  • "status_comment": "string",
  • "status_updated_at": "2024-01-31T07:17:35Z",
  • "status_history":
    [
    ],
  • "cargo_owning_company_id": "string",
  • "author_id": "string",
  • "type": "shipping_request",
  • "external_info_id": "string",
  • "parent_id": "string",
  • "contact":
    {
    },
  • "comment": "string",
  • "archived": true,
  • "resource_assignment_time": 60,
  • "resource_assignment_till": "2020-03-13T15:46:31+00:00",
  • "change_requests_allowed": false,
  • "change_request_status": "string",
  • "change_resources_request_status": "string",
  • "contract_begins_at": "2024-01-31T07:17:35Z",
  • "contract_ends_at": "2024-01-31T07:17:35Z",
  • "contract_type": "by_shippings_count",
  • "shippings_count": 1,
  • "max_shippings_per_day": 1,
  • "max_shippings_per_week": 1,
  • "shipping_available_in": 0,
  • "transport_body_types": [ ],
  • "transport_tonnage": 0,
  • "transport_volume": 0,
  • "resource_requirements":
    {
    },
  • "cargo_name": "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_points":
    [
    ],
  • "route_direction":
    {
    },
  • "is_route_circular": true,
  • "auction_stages":
    [
    ],
  • "executors":
    [
    ],
  • "contract_id": "string",
  • "contract_hfid": "string",
  • "contract_shipping_id": "string",
  • "manual_spot_winner_pick_allowed": true,
  • "auction_auto_extend_period": 1,
  • "document_flows": [ ],
  • "closing_documents_period": 1,
  • "closing_documents_period_type": "calendar",
  • "closing_documents": [ ],
  • "agreement_type": "shipping_agreement",
  • "terms_by_partnership_contract": false,
  • "idle_time_cost_without_vat": 100,
  • "documents_for_payment": [ ],
  • "payment_procedure": "prepayment",
  • "payment_period": 1,
  • "payment_period_type": "calendar",
  • "cancellation_without_penalty_before": "2024-01-31T07:17:35Z",
  • "cancellation_penalty_percent": 0,
  • "minimum_cancellation_penalty_without_vat": 0,
  • "shipping_price": 0,
  • "shipping_price_tax_type": "string",
  • "shipping_id": "string",
  • "shipping_payment_type": "per_hour",
  • "shipping_min_work_hours": 0,
  • "shipping":
    {
    },
  • "current_auction_stage_number": 1,
  • "winning_bid_id": "string",
  • "winning_bid_min_work_hours": 0,
  • "winning_bid_price_with_vat": null,
  • "winning_bid_price_without_vat": null,
  • "winning_bid": null,
  • "watching_count":
    [
    ]
}

Удалить заказ

delete /shipping_orders/{shipping_order_id}
https://api.traffic.online/api/{version}/shipping_orders/{shipping_order_id}

Удалить заказ

Authorizations:
JWT (CargoOwningCompanyAdmin)

Responses

204

Заказ удалён

400

Заказ не является черновиком

404

Заказ не найден

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "error": "string",
  • "error_code": "string",
  • "error_description": "string"
}

Утверждение заказа

post /shipping_orders/{shipping_order_id}/accept_shipping
https://api.traffic.online/api/{version}/shipping_orders/{shipping_order_id}/accept_shipping

Утверждение заказа

Authorizations:
JWT (CargoOwningCompanyAdmin)
path Parameters
Content-Type
required
any
Value: "application/json"
shipping_order_id
any

id Заказа

Request Body schema: application/json

Параметры точек маршрута, комментарий и идентификатор во внешней системе

external_info_id
string Nullable

Идентификатор заказа во внешних системах. Используется только для информации

comment
string Nullable

Комментарий к заказу

agreement_number
string Nullable

Номер договора

agreement_date
string <date> Nullable

Номер договора

route_points
Array of objects >= 2 items

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

Responses

200

Заказ

400

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

401

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

403

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

404

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "external_info_id": "string",
  • "comment": "string",
  • "agreement_number": "string",
  • "agreement_date": "2024-01-31",
  • "route_points":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "human_friendly_id": "string",
  • "created_at": "2024-01-31T07:17:35Z",
  • "updated_at": "2024-01-31T07:17:35Z",
  • "deleted_at": "2024-01-31T07:17:35Z",
  • "status": "draft",
  • "status_comment": "string",
  • "status_updated_at": "2024-01-31T07:17:35Z",
  • "status_history":
    [
    ],
  • "cargo_owning_company_id": "string",
  • "author_id": "string",
  • "type": "shipping_request",
  • "external_info_id": "string",
  • "parent_id": "string",
  • "contact":
    {
    },
  • "comment": "string",
  • "archived": true,
  • "hide_contacts": true,
  • "resource_assignment_time": 60,
  • "resource_assignment_till": "2020-03-13T15:46:31+00:00",
  • "change_requests_allowed": true,
  • "change_request_status": "string",
  • "change_resources_request_status": "string",
  • "contract_begins_at": "2024-01-31T07:17:35Z",
  • "contract_ends_at": "2024-01-31T07:17:35Z",
  • "contract_type": "by_shippings_count",
  • "shippings_count": 1,
  • "max_shippings_per_day": 1,
  • "max_shippings_per_week": 1,
  • "shipping_available_in": 0,
  • "transport_body_types":
    [
    ],
  • "transport_tonnage": 0,
  • "transport_volume": 0,
  • "resource_requirements":
    {
    },
  • "cargo_name": "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_points":
    [
    ],
  • "route_direction":
    {
    },
  • "is_route_circular": true,
  • "auction_stages":
    [
    ],
  • "executors":
    [
    ],
  • "contract_id": "string",
  • "contract_hfid": "string",
  • "contract_shipping_id": "string",
  • "contract_shipping_price": 0,
  • "dynamic_pricing": true,
  • "auction_auto_extend_period": 1,
  • "rebidding": true,
  • "manual_spot_winner_pick_allowed": true,
  • "partnership_contract_type": "all",
  • "document_flows":
    [
    ],
  • "closing_documents_period": 1,
  • "closing_documents_period_type": "calendar",
  • "agreement_type": "shipping_agreement",
  • "closing_documents":
    [
    ],
  • "terms_by_partnership_contract": true,
  • "idle_time_cost_without_vat": 100,
  • "documents_for_payment":
    [
    ],
  • "payment_procedure": "prepayment",
  • "payment_period": 1,
  • "payment_period_type": "calendar",
  • "cancellation_without_penalty_before": "2024-01-31T07:17:35Z",
  • "cancellation_penalty_percent": 0,
  • "minimum_cancellation_penalty_without_vat": 0,
  • "payer_opf_id": 1,
  • "payer_title": "string",
  • "payment_form": "string",
  • "forward_request_number": "string",
  • "shipping_price": 0,
  • "shipping_price_tax_type": "string",
  • "shipping_payment_type": "string",
  • "shipping_id": "string",
  • "shipping_min_work_hours": 0,
  • "shipping":
    {
    },
  • "current_auction_stage_number": 1,
  • "winning_bid_id": "string",
  • "winning_bid_min_work_hours": 0,
  • "winning_bid_price_with_vat": 1,
  • "winning_bid_price_without_vat": 1,
  • "auto_accept_changes": true
}

Отменить заказ

post /shipping_orders/{shipping_order_id}/cancel
https://api.traffic.online/api/{version}/shipping_orders/{shipping_order_id}/cancel

Отменить заказ

Authorizations:
JWT (CargoOwningCompanyAdmin)
path Parameters
Content-Type
required
any
Value: "application/json"
shipping_order_id
any

id Заказа

Request Body schema: application/json

Комментарий к отмене

status_comment
string Nullable

Responses

200

Заказ

400

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

401

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

403

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

404

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status_comment": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "human_friendly_id": "string",
  • "created_at": "2024-01-31T07:17:35Z",
  • "updated_at": "2024-01-31T07:17:35Z",
  • "deleted_at": "2024-01-31T07:17:35Z",
  • "status": "draft",
  • "status_comment": "string",
  • "status_updated_at": "2024-01-31T07:17:35Z",
  • "status_history":
    [
    ],
  • "cargo_owning_company_id": "string",
  • "author_id": "string",
  • "type": "shipping_request",
  • "external_info_id": "string",
  • "parent_id": "string",
  • "contact":
    {
    },
  • "comment": "string",
  • "archived": true,
  • "hide_contacts": true,
  • "resource_assignment_time": 60,
  • "resource_assignment_till": "2020-03-13T15:46:31+00:00",
  • "change_requests_allowed": true,
  • "change_request_status": "string",
  • "change_resources_request_status": "string",
  • "contract_begins_at": "2024-01-31T07:17:35Z",
  • "contract_ends_at": "2024-01-31T07:17:35Z",
  • "contract_type": "by_shippings_count",
  • "shippings_count": 1,
  • "max_shippings_per_day": 1,
  • "max_shippings_per_week": 1,
  • "shipping_available_in": 0,
  • "transport_body_types":
    [
    ],
  • "transport_tonnage": 0,
  • "transport_volume": 0,
  • "resource_requirements":
    {
    },
  • "cargo_name": "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_points":
    [
    ],
  • "route_direction":
    {
    },
  • "is_route_circular": true,
  • "auction_stages":
    [
    ],
  • "executors":
    [
    ],
  • "contract_id": "string",
  • "contract_hfid": "string",
  • "contract_shipping_id": "string",
  • "contract_shipping_price": 0,
  • "dynamic_pricing": true,
  • "auction_auto_extend_period": 1,
  • "rebidding": true,
  • "manual_spot_winner_pick_allowed": true,
  • "partnership_contract_type": "all",
  • "document_flows":
    [
    ],
  • "closing_documents_period": 1,
  • "closing_documents_period_type": "calendar",
  • "agreement_type": "shipping_agreement",
  • "closing_documents":
    [
    ],
  • "terms_by_partnership_contract": true,
  • "idle_time_cost_without_vat": 100,
  • "documents_for_payment":
    [
    ],
  • "payment_procedure": "prepayment",
  • "payment_period": 1,
  • "payment_period_type": "calendar",
  • "cancellation_without_penalty_before": "2024-01-31T07:17:35Z",
  • "cancellation_penalty_percent": 0,
  • "minimum_cancellation_penalty_without_vat": 0,
  • "payer_opf_id": 1,
  • "payer_title": "string",
  • "payment_form": "string",
  • "forward_request_number": "string",
  • "shipping_price": 0,
  • "shipping_price_tax_type": "string",
  • "shipping_payment_type": "string",
  • "shipping_id": "string",
  • "shipping_min_work_hours": 0,
  • "shipping":
    {
    },
  • "current_auction_stage_number": 1,
  • "winning_bid_id": "string",
  • "winning_bid_min_work_hours": 0,
  • "winning_bid_price_with_vat": 1,
  • "winning_bid_price_without_vat": 1,
  • "auto_accept_changes": true
}

Отправить заказ в архив

post /shipping_orders/{shipping_order_id}/archive
https://api.traffic.online/api/{version}/shipping_orders/{shipping_order_id}/archive

Отправить заказ в архив

Authorizations:
JWT (CargoOwningCompanyAdmin)
path Parameters
shipping_order_id
any

id Заказа

Responses

200

Заказ

400

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

401

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

403

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

404

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "human_friendly_id": "string",
  • "created_at": "2024-01-31T07:17:35Z",
  • "updated_at": "2024-01-31T07:17:35Z",
  • "deleted_at": "2024-01-31T07:17:35Z",
  • "status": "draft",
  • "status_comment": "string",
  • "status_updated_at": "2024-01-31T07:17:35Z",
  • "status_history":
    [
    ],
  • "cargo_owning_company_id": "string",
  • "author_id": "string",
  • "type": "shipping_request",
  • "external_info_id": "string",
  • "parent_id": "string",
  • "contact":
    {
    },
  • "comment": "string",
  • "archived": true,
  • "hide_contacts": true,
  • "resource_assignment_time": 60,
  • "resource_assignment_till": "2020-03-13T15:46:31+00:00",
  • "change_requests_allowed": true,
  • "change_request_status": "string",
  • "change_resources_request_status": "string",
  • "contract_begins_at": "2024-01-31T07:17:35Z",
  • "contract_ends_at": "2024-01-31T07:17:35Z",
  • "contract_type": "by_shippings_count",
  • "shippings_count": 1,
  • "max_shippings_per_day": 1,
  • "max_shippings_per_week": 1,
  • "shipping_available_in": 0,
  • "transport_body_types":
    [
    ],
  • "transport_tonnage": 0,
  • "transport_volume": 0,
  • "resource_requirements":
    {
    },
  • "cargo_name": "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_points":
    [
    ],
  • "route_direction":
    {
    },
  • "is_route_circular": true,
  • "auction_stages":
    [
    ],
  • "executors":
    [
    ],
  • "contract_id": "string",
  • "contract_hfid": "string",
  • "contract_shipping_id": "string",
  • "contract_shipping_price": 0,
  • "dynamic_pricing": true,
  • "auction_auto_extend_period": 1,
  • "rebidding": true,
  • "manual_spot_winner_pick_allowed": true,
  • "partnership_contract_type": "all",
  • "document_flows":
    [
    ],
  • "closing_documents_period": 1,
  • "closing_documents_period_type": "calendar",
  • "agreement_type": "shipping_agreement",
  • "closing_documents":
    [
    ],
  • "terms_by_partnership_contract": true,
  • "idle_time_cost_without_vat": 100,
  • "documents_for_payment":
    [
    ],
  • "payment_procedure": "prepayment",
  • "payment_period": 1,
  • "payment_period_type": "calendar",
  • "cancellation_without_penalty_before": "2024-01-31T07:17:35Z",
  • "cancellation_penalty_percent": 0,
  • "minimum_cancellation_penalty_without_vat": 0,
  • "payer_opf_id": 1,
  • "payer_title": "string",
  • "payment_form": "string",
  • "forward_request_number": "string",
  • "shipping_price": 0,
  • "shipping_price_tax_type": "string",
  • "shipping_payment_type": "string",
  • "shipping_id": "string",
  • "shipping_min_work_hours": 0,
  • "shipping":
    {
    },
  • "current_auction_stage_number": 1,
  • "winning_bid_id": "string",
  • "winning_bid_min_work_hours": 0,
  • "winning_bid_price_with_vat": 1,
  • "winning_bid_price_without_vat": 1,
  • "auto_accept_changes": true
}

Создать черновик заказа

post /shipping_orders/draft
https://api.traffic.online/api/{version}/shipping_orders/draft

Создать черновик заказа

Authorizations:
JWT (CargoOwningCompanyAdmin)
path Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
author_id
string <uuid> Nullable

ID пользователя, создавшего заказ.

type
string
Enum: "shipping_request" "contract" "delivery" "city_delivery"

Тип заказа:

  • shipping_request - разовый (заявка на перевозку груза)
  • contract - графиковый (график на несколько заявок на перевозку груза)
  • delivery - автодоставка (аренда ТС с экипажем)
  • city_delivery - автодоставка (городская)
external_info_id
string Nullable

Идентификатор заказа во внешних системах. Используется только для информации

parent_id
string <uuid> Nullable

ID заказа, на основании которого был создан текущий заказ. Используется только для информации

contact
object Nullable

Ответственное лицо всего заказа

comment
string Nullable

Комментарий к заказу

resource_assignment_time
integer [ 60 .. 144000 ] Nullable

Время на назначение ресурсов после бронирования заявки в минутах

resource_assignment_till
string <date-time> Nullable

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

change_requests_allowed
boolean
Default: false

Можно ли создавать запросы на изменение заказа

change_request_status
string <text> Nullable

Статус заявки на изменение требований заказа.

change_resources_request_status
string <text> Nullable

Статус заявки на измнение русурсов заказа.

contract_begins_at
string <date-time> Nullable

Дата начала исполнения. Указывается в часовом поясе первой точки маршрута

contract_ends_at
string <date-time> Nullable

Дата окончания исполнения. Указывается в часовом поясе последней точки маршрута

contract_type
string Nullable
Enum: "by_shippings_count" "by_schedule"

Вид графикового заказа:

  • by_shippings_count - по объёму (количеству перевозок)
  • by_schedule - по точному расписанию
shippings_count
integer [ 1 .. 100000 ] Nullable

Объём графикового заказа - количество перевозок

max_shippings_per_day
integer [ 1 .. 100000 ] Nullable

Максимальное количество перевозок в день по данному графиковому заказу для перевозчика. null означает, что ограничений нет

max_shippings_per_week
integer [ 1 .. 100000 ] Nullable

Максимальное количество перевозок в неделю по данному графиковому заказу для перевозчика. null означает, что ограничений нет

shipping_available_in
integer [ 0 .. 43200 ] Nullable

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

transport_body_types
Array of strings non-empty
Default: []
Items Enum: "awning" "full_metal" "isothermal" "refrigerator" "dropside" "tanker" "container"

Типы кузова транспорта

transport_tonnage
number <double> [ 0 .. 200 ] Nullable

Тоннаж транспорта в тоннах

transport_volume
number <double> [ 0 .. 200 ] Nullable

Объём транспорта в кубических метрах

resource_requirements
object

Требования к ресурсам

cargo_name
string <= 150 characters Nullable

Наименование груза

cargo_tonnage
number <double> [ 0 .. 24 ] Nullable

Тоннаж груза в тоннах

cargo_volume
number <double> [ 0 .. 150 ] Nullable

Объём груза в кубических метрах

cargo_cost
integer [ 0 .. 999999999 ] Nullable

Стоимость груза

cargo_adr
string Nullable
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"

Класс опасности груза

cargo_length
number <double> [ 0.5 .. 17 ] Nullable

Длина груза в метрах

cargo_width
number <double> [ 0.5 .. 2.75 ] Nullable

Ширина груза в метрах

cargo_height
number <double> [ 0.5 .. 3 ] Nullable

Высота груза в метрах

cargo_places
integer [ 0 .. 100 ] Nullable

Количество грузомест

cargo_packing
string Nullable
Enum: "reels" "big_bags" "barrels" "eurocubes" "cans" "coils" "boxes" "sheets" "bags" "in_bulk" "not_specified" "pallets" "fin_pallets" "packs" "pyramid" "loose" "rolls" "cases"

Упаковка груза:

  • reels - Барабаны
  • big_bags - Биг-бэги
  • barrels - Бочки
  • eurocubes - Еврокубы
  • cans - Канистры
  • coils - Катушки
  • boxes - Коробки
  • sheets - Листы
  • bags - Мешки
  • in_bulk - Навалом
  • not_specified - Нет упаковки
  • pallets - Паллеты EUR
  • fin_pallets - Паллеты FIN
  • packs - Пачки
  • pyramid - Пирамида
  • loose - Россыпью
  • rolls - Рулоны
  • cases - Ящики
route_points
Array of objects <= 100 items

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

auction_stages
Array of objects [ 0 .. 1000 ] items

Этапы торга

executors
Array of objects [ 0 .. 1 ] items

Исполнители заказа, указанные в момент создания

contract_id
string <uuid> Nullable

ID графикового заказа, для которого создаётся данный заказ

manual_spot_winner_pick_allowed
boolean

Можно ли выбирать выигрышную ставку в процессе торга спот заказа

auction_auto_extend_period
integer [ 1 .. 24 ] Nullable

Период автопродления торга

document_flows
Array of strings
Default: []
Items Enum: "scancopy" "online_confirmation" "qualified_signature"

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

closing_documents_period
integer [ 1 .. 366 ] Nullable

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

closing_documents_period_type
string Nullable
Enum: "calendar" "working"

Тип дней в периоде предоставления закрывающих документов:

  • calendar - Календарный день
  • working - Рабочий день
closing_documents
Array of objects
Default: []

Закрывающие документы

agreement_type
string Nullable
Enum: "shipping_agreement" "freight_forwarding_agreement"

Вид договора

  • shipping_agreement - Договор перевозки
  • freight_forwarding_agreement - Договор транспортной экспедиции
terms_by_partnership_contract
boolean
Default: false

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

idle_time_cost_without_vat
integer [ 100 .. 1500 ] Nullable

Стоимость одного часа простоя сверх времени работы в точке без НДС, кратно 100

documents_for_payment
Array of strings
Default: []
Items Enum: "bill_of_lading" "waybill" "bill_of_lading_or_waybill" "packing_list" "bill" "acceptance_certificate" "delivery_certificate" "invoice" "power_of_attorney" "universal_transfer_document" "accompanying_document" "cmr" "forwarding_order" "shipping_order" "forwarding_receipt" "attachment_to_bill_of_lading"

Документы для оплаты

payment_procedure
string Nullable
Enum: "prepayment" "payment_by_scancopy" "payment_by_original_documents" "payment_by_unloading" "payment_by_loading"

Порядок оплаты:

  • prepayment - Предоплата
  • payment_by_scancopy - Оплата по скан-копиям документов
  • payment_by_original_documents - Оплата по оригиналам документов
  • payment_by_unloading - Оплата по факту выгрузки
  • payment_by_loading - Оплата по факту загрузки
payment_period
integer [ 1 .. 366 ] Nullable

Период оплаты в днях

payment_period_type
string Nullable
Enum: "calendar" "working"

Тип дней в периоде оплаты:

  • calendar - Календарный день
  • working - Рабочий день
cancellation_without_penalty_before
string <date-time> Nullable

Допустимое время для отказа от перевозки до наступления санкций

cancellation_penalty_percent
integer [ 0 .. 100 ] Nullable

Штраф за отказ от перевозки после наступления санкций в процентах от стоимости без НДС

minimum_cancellation_penalty_without_vat
integer [ 0 .. 999999999 ] Nullable

Минимальный штраф за отказ от перевозки после наступления санкций без НДС

shipping_payment_type
string Nullable
Enum: "per_hour" "fixed"

Тип цены:

  • per_hour - За час
  • fixed - Фисированая
shipping_min_work_hours
integer Nullable

Минимально оплачиваемое количество часов в заказе.

winning_bid_id
string <uuid> Nullable

ID выигравшей стваки.

winning_bid_min_work_hours
integer Nullable

Минимально оплачиваемое количество часов выигравшей ставки.

winning_bid_price_with_vat
decimal Nullable

Цена победившей стваки (с НДС).

winning_bid_price_without_vat
decimal Nullable

Цена победившей стваки (без НДС).

winning_bid
float Nullable

Выигравшая ставка.

watching_count
Array of objects Nullable

Счетчик количества просмотров заявки.

Responses

200

Черновик заказа

400

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

401

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

403

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "author_id": "string",
  • "type": "shipping_request",
  • "external_info_id": "string",
  • "parent_id": "string",
  • "contact":
    {
    },
  • "comment": "string",
  • "resource_assignment_time": 60,
  • "resource_assignment_till": "2020-03-13T15:46:31+00:00",
  • "change_requests_allowed": false,
  • "change_request_status": "string",
  • "change_resources_request_status": "string",
  • "contract_begins_at": "2024-01-31T07:17:35Z",
  • "contract_ends_at": "2024-01-31T07:17:35Z",
  • "contract_type": "by_shippings_count",
  • "shippings_count": 1,
  • "max_shippings_per_day": 1,
  • "max_shippings_per_week": 1,
  • "shipping_available_in": 0,
  • "transport_body_types": [ ],
  • "transport_tonnage": 0,
  • "transport_volume": 0,
  • "resource_requirements":
    {
    },
  • "cargo_name": "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_points":
    [
    ],
  • "auction_stages":
    [
    ],
  • "executors":
    [
    ],
  • "contract_id": "string",
  • "manual_spot_winner_pick_allowed": true,
  • "auction_auto_extend_period": 1,
  • "document_flows": [ ],
  • "closing_documents_period": 1,
  • "closing_documents_period_type": "calendar",
  • "closing_documents": [ ],
  • "agreement_type": "shipping_agreement",
  • "terms_by_partnership_contract": false,
  • "idle_time_cost_without_vat": 100,
  • "documents_for_payment": [ ],
  • "payment_procedure": "prepayment",
  • "payment_period": 1,
  • "payment_period_type": "calendar",
  • "cancellation_without_penalty_before": "2024-01-31T07:17:35Z",
  • "cancellation_penalty_percent": 0,
  • "minimum_cancellation_penalty_without_vat": 0,
  • "shipping_payment_type": "per_hour",
  • "shipping_min_work_hours": 0,
  • "shipping":
    {
    },
  • "winning_bid_id": "string",
  • "winning_bid_min_work_hours": 0,
  • "winning_bid_price_with_vat": null,
  • "winning_bid_price_without_vat": null,
  • "winning_bid": null,
  • "watching_count":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "human_friendly_id": "string",
  • "created_at": "2024-01-31T07:17:35Z",
  • "updated_at": "2024-01-31T07:17:35Z",
  • "deleted_at": "2024-01-31T07:17:35Z",
  • "status": "draft",
  • "status_comment": "string",
  • "status_updated_at": "2024-01-31T07:17:35Z",
  • "status_history":
    [
    ],
  • "cargo_owning_company_id": "string",
  • "author_id": "string",
  • "type": "shipping_request",
  • "external_info_id": "string",
  • "parent_id": "string",
  • "contact":
    {
    },
  • "comment": "string",
  • "archived": true,
  • "resource_assignment_time": 60,
  • "resource_assignment_till": "2020-03-13T15:46:31+00:00",
  • "change_requests_allowed": false,
  • "change_request_status": "string",
  • "change_resources_request_status": "string",
  • "contract_begins_at": "2024-01-31T07:17:35Z",
  • "contract_ends_at": "2024-01-31T07:17:35Z",
  • "contract_type": "by_shippings_count",
  • "shippings_count": 1,
  • "max_shippings_per_day": 1,
  • "max_shippings_per_week": 1,
  • "shipping_available_in": 0,
  • "transport_body_types": [ ],
  • "transport_tonnage": 0,
  • "transport_volume": 0,
  • "resource_requirements":
    {
    },
  • "cargo_name": "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_points":
    [
    ],
  • "route_direction":
    {
    },
  • "is_route_circular": true,
  • "auction_stages":
    [
    ],
  • "executors":
    [
    ],
  • "contract_id": "string",
  • "contract_hfid": "string",
  • "contract_shipping_id": "string",
  • "manual_spot_winner_pick_allowed": true,
  • "auction_auto_extend_period": 1,
  • "document_flows": [ ],
  • "closing_documents_period": 1,
  • "closing_documents_period_type": "calendar",
  • "closing_documents": [ ],
  • "agreement_type": "shipping_agreement",
  • "terms_by_partnership_contract": false,
  • "idle_time_cost_without_vat": 100,
  • "documents_for_payment": [ ],
  • "payment_procedure": "prepayment",
  • "payment_period": 1,
  • "payment_period_type": "calendar",
  • "cancellation_without_penalty_before": "2024-01-31T07:17:35Z",
  • "cancellation_penalty_percent": 0,
  • "minimum_cancellation_penalty_without_vat": 0,
  • "shipping_price": 0,
  • "shipping_price_tax_type": "string",
  • "shipping_id": "string",
  • "shipping_payment_type": "per_hour",
  • "shipping_min_work_hours": 0,
  • "shipping":
    {
    },
  • "current_auction_stage_number": 1,
  • "winning_bid_id": "string",
  • "winning_bid_min_work_hours": 0,
  • "winning_bid_price_with_vat": null,
  • "winning_bid_price_without_vat": null,
  • "winning_bid": null,
  • "watching_count":
    [
    ]
}

Опубликовать черновик заказа

post /shipping_orders/{shipping_order_id}/publish
https://api.traffic.online/api/{version}/shipping_orders/{shipping_order_id}/publish

Опубликовать черновик заказа

Authorizations:
JWT (CargoOwningCompanyAdmin)
path Parameters
Content-Type
required
any
Value: "application/json"

Responses

200

Заказ

400

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

401

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

403

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

404

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "human_friendly_id": "string",
  • "created_at": "2024-01-31T07:17:35Z",
  • "updated_at": "2024-01-31T07:17:35Z",
  • "deleted_at": "2024-01-31T07:17:35Z",
  • "status": "draft",
  • "status_comment": "string",
  • "status_updated_at": "2024-01-31T07:17:35Z",
  • "status_history":
    [
    ],
  • "cargo_owning_company_id": "string",
  • "author_id": "string",
  • "type": "shipping_request",
  • "external_info_id": "string",
  • "parent_id": "string",
  • "contact":
    {
    },
  • "comment": "string",
  • "archived": true,
  • "hide_contacts": true,
  • "resource_assignment_time": 60,
  • "resource_assignment_till": "2020-03-13T15:46:31+00:00",
  • "change_requests_allowed": true,
  • "change_request_status": "string",
  • "change_resources_request_status": "string",
  • "contract_begins_at": "2024-01-31T07:17:35Z",
  • "contract_ends_at": "2024-01-31T07:17:35Z",
  • "contract_type": "by_shippings_count",
  • "shippings_count": 1,
  • "max_shippings_per_day": 1,
  • "max_shippings_per_week": 1,
  • "shipping_available_in": 0,
  • "transport_body_types":
    [
    ],
  • "transport_tonnage": 0,
  • "transport_volume": 0,
  • "resource_requirements":
    {
    },
  • "cargo_name": "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_points":
    [
    ],
  • "route_direction":
    {
    },
  • "is_route_circular": true,
  • "auction_stages":
    [
    ],
  • "executors":
    [
    ],
  • "contract_id": "string",
  • "contract_hfid": "string",
  • "contract_shipping_id": "string",
  • "contract_shipping_price": 0,
  • "dynamic_pricing": true,
  • "auction_auto_extend_period": 1,
  • "rebidding": true,
  • "manual_spot_winner_pick_allowed": true,
  • "partnership_contract_type": "all",
  • "document_flows":
    [
    ],
  • "closing_documents_period": 1,
  • "closing_documents_period_type": "calendar",
  • "agreement_type": "shipping_agreement",
  • "closing_documents":
    [
    ],
  • "terms_by_partnership_contract": true,
  • "idle_time_cost_without_vat": 100,
  • "documents_for_payment":
    [
    ],
  • "payment_procedure": "prepayment",
  • "payment_period": 1,
  • "payment_period_type": "calendar",
  • "cancellation_without_penalty_before": "2024-01-31T07:17:35Z",
  • "cancellation_penalty_percent": 0,
  • "minimum_cancellation_penalty_without_vat": 0,
  • "payer_opf_id": 1,
  • "payer_title": "string",
  • "payment_form": "string",
  • "forward_request_number": "string",
  • "shipping_price": 0,
  • "shipping_price_tax_type": "string",
  • "shipping_payment_type": "string",
  • "shipping_id": "string",
  • "shipping_min_work_hours": 0,
  • "shipping":
    {
    },
  • "current_auction_stage_number": 1,
  • "winning_bid_id": "string",
  • "winning_bid_min_work_hours": 0,
  • "winning_bid_price_with_vat": 1,
  • "winning_bid_price_without_vat": 1,
  • "auto_accept_changes": true
}

Черновики

Обновить черновик заказа

put /shipping_orders/{shipping_order_id}
https://api.traffic.online/api/{version}/shipping_orders/{shipping_order_id}

Обновить черновик заказа

Authorizations:
JWT (CargoOwningCompanyAdmin)
path Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
author_id
string <uuid> Nullable

ID пользователя, создавшего заказ.

type
string
Enum: "shipping_request" "contract" "delivery" "city_delivery"

Тип заказа:

  • shipping_request - разовый (заявка на перевозку груза)
  • contract - графиковый (график на несколько заявок на перевозку груза)
  • delivery - автодоставка (аренда ТС с экипажем)
  • city_delivery - автодоставка (городская)
external_info_id
string Nullable

Идентификатор заказа во внешних системах. Используется только для информации

parent_id
string <uuid> Nullable

ID заказа, на основании которого был создан текущий заказ. Используется только для информации

contact
object Nullable

Ответственное лицо всего заказа

comment
string Nullable

Комментарий к заказу

resource_assignment_time
integer [ 60 .. 144000 ] Nullable

Время на назначение ресурсов после бронирования заявки в минутах

resource_assignment_till
string <date-time> Nullable

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

change_requests_allowed
boolean
Default: false

Можно ли создавать запросы на изменение заказа

change_request_status
string <text> Nullable

Статус заявки на изменение требований заказа.

change_resources_request_status
string <text> Nullable

Статус заявки на измнение русурсов заказа.

contract_begins_at
string <date-time> Nullable

Дата начала исполнения. Указывается в часовом поясе первой точки маршрута

contract_ends_at
string <date-time> Nullable

Дата окончания исполнения. Указывается в часовом поясе последней точки маршрута

contract_type
string Nullable
Enum: "by_shippings_count" "by_schedule"

Вид графикового заказа:

  • by_shippings_count - по объёму (количеству перевозок)
  • by_schedule - по точному расписанию
shippings_count
integer [ 1 .. 100000 ] Nullable

Объём графикового заказа - количество перевозок

max_shippings_per_day
integer [ 1 .. 100000 ] Nullable

Максимальное количество перевозок в день по данному графиковому заказу для перевозчика. null означает, что ограничений нет

max_shippings_per_week
integer [ 1 .. 100000 ] Nullable

Максимальное количество перевозок в неделю по данному графиковому заказу для перевозчика. null означает, что ограничений нет

shipping_available_in
integer [ 0 .. 43200 ] Nullable

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

transport_body_types
Array of strings non-empty
Default: []
Items Enum: "awning" "full_metal" "isothermal" "refrigerator" "dropside" "tanker" "container"

Типы кузова транспорта

transport_tonnage
number <double> [ 0 .. 200 ] Nullable

Тоннаж транспорта в тоннах

transport_volume
number <double> [ 0 .. 200 ] Nullable

Объём транспорта в кубических метрах

resource_requirements
object

Требования к ресурсам

cargo_name
string <= 150 characters Nullable

Наименование груза

cargo_tonnage
number <double> [ 0 .. 24 ] Nullable

Тоннаж груза в тоннах

cargo_volume
number <double> [ 0 .. 150 ] Nullable

Объём груза в кубических метрах

cargo_cost
integer [ 0 .. 999999999 ] Nullable

Стоимость груза

cargo_adr
string Nullable
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"

Класс опасности груза

cargo_length
number <double> [ 0.5 .. 17 ] Nullable

Длина груза в метрах

cargo_width
number <double> [ 0.5 .. 2.75 ] Nullable

Ширина груза в метрах

cargo_height
number <double> [ 0.5 .. 3 ] Nullable

Высота груза в метрах

cargo_places
integer [ 0 .. 100 ] Nullable

Количество грузомест

cargo_packing
string Nullable
Enum: "reels" "big_bags" "barrels" "eurocubes" "cans" "coils" "boxes" "sheets" "bags" "in_bulk" "not_specified" "pallets" "fin_pallets" "packs" "pyramid" "loose" "rolls" "cases"

Упаковка груза:

  • reels - Барабаны
  • big_bags - Биг-бэги
  • barrels - Бочки
  • eurocubes - Еврокубы
  • cans - Канистры
  • coils - Катушки
  • boxes - Коробки
  • sheets - Листы
  • bags - Мешки
  • in_bulk - Навалом
  • not_specified - Нет упаковки
  • pallets - Паллеты EUR
  • fin_pallets - Паллеты FIN
  • packs - Пачки
  • pyramid - Пирамида
  • loose - Россыпью
  • rolls - Рулоны
  • cases - Ящики
route_points
Array of objects <= 100 items

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

auction_stages
Array of objects [ 0 .. 1000 ] items

Этапы торга

executors
Array of objects [ 0 .. 1 ] items

Исполнители заказа, указанные в момент создания

contract_id
string <uuid> Nullable

ID графикового заказа, для которого создаётся данный заказ

manual_spot_winner_pick_allowed
boolean

Можно ли выбирать выигрышную ставку в процессе торга спот заказа

auction_auto_extend_period
integer [ 1 .. 24 ] Nullable

Период автопродления торга

document_flows
Array of strings
Default: []
Items Enum: "scancopy" "online_confirmation" "qualified_signature"

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

closing_documents_period
integer [ 1 .. 366 ] Nullable

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

closing_documents_period_type
string Nullable
Enum: "calendar" "working"

Тип дней в периоде предоставления закрывающих документов:

  • calendar - Календарный день
  • working - Рабочий день
closing_documents
Array of objects
Default: []

Закрывающие документы

agreement_type
string Nullable
Enum: "shipping_agreement" "freight_forwarding_agreement"

Вид договора

  • shipping_agreement - Договор перевозки
  • freight_forwarding_agreement - Договор транспортной экспедиции
terms_by_partnership_contract
boolean
Default: false

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

idle_time_cost_without_vat
integer [ 100 .. 1500 ] Nullable

Стоимость одного часа простоя сверх времени работы в точке без НДС, кратно 100

documents_for_payment
Array of strings
Default: []
Items Enum: "bill_of_lading" "waybill" "bill_of_lading_or_waybill" "packing_list" "bill" "acceptance_certificate" "delivery_certificate" "invoice" "power_of_attorney" "universal_transfer_document" "accompanying_document" "cmr" "forwarding_order" "shipping_order" "forwarding_receipt" "attachment_to_bill_of_lading"

Документы для оплаты

payment_procedure
string Nullable
Enum: "prepayment" "payment_by_scancopy" "payment_by_original_documents" "payment_by_unloading" "payment_by_loading"

Порядок оплаты:

  • prepayment - Предоплата
  • payment_by_scancopy - Оплата по скан-копиям документов
  • payment_by_original_documents - Оплата по оригиналам документов
  • payment_by_unloading - Оплата по факту выгрузки
  • payment_by_loading - Оплата по факту загрузки
payment_period
integer [ 1 .. 366 ] Nullable

Период оплаты в днях

payment_period_type
string Nullable
Enum: "calendar" "working"

Тип дней в периоде оплаты:

  • calendar - Календарный день
  • working - Рабочий день
cancellation_without_penalty_before
string <date-time> Nullable

Допустимое время для отказа от перевозки до наступления санкций

cancellation_penalty_percent
integer [ 0 .. 100 ] Nullable

Штраф за отказ от перевозки после наступления санкций в процентах от стоимости без НДС

minimum_cancellation_penalty_without_vat
integer [ 0 .. 999999999 ] Nullable

Минимальный штраф за отказ от перевозки после наступления санкций без НДС

shipping_payment_type
string Nullable
Enum: "per_hour" "fixed"

Тип цены:

  • per_hour - За час
  • fixed - Фисированая
shipping_min_work_hours
integer Nullable

Минимально оплачиваемое количество часов в заказе.

winning_bid_id
string <uuid> Nullable

ID выигравшей стваки.

winning_bid_min_work_hours
integer Nullable

Минимально оплачиваемое количество часов выигравшей ставки.

winning_bid_price_with_vat
decimal Nullable

Цена победившей стваки (с НДС).

winning_bid_price_without_vat
decimal Nullable

Цена победившей стваки (без НДС).

winning_bid
float Nullable

Выигравшая ставка.

watching_count
Array of objects Nullable

Счетчик количества просмотров заявки.

Responses

200

Черновик заказа

400

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

401

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

403

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

404

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "author_id": "string",
  • "type": "shipping_request",
  • "external_info_id": "string",
  • "parent_id": "string",
  • "contact":
    {
    },
  • "comment": "string",
  • "resource_assignment_time": 60,
  • "resource_assignment_till": "2020-03-13T15:46:31+00:00",
  • "change_requests_allowed": false,
  • "change_request_status": "string",
  • "change_resources_request_status": "string",
  • "contract_begins_at": "2024-01-31T07:17:35Z",
  • "contract_ends_at": "2024-01-31T07:17:35Z",
  • "contract_type": "by_shippings_count",
  • "shippings_count": 1,
  • "max_shippings_per_day": 1,
  • "max_shippings_per_week": 1,
  • "shipping_available_in": 0,
  • "transport_body_types": [ ],
  • "transport_tonnage": 0,
  • "transport_volume": 0,
  • "resource_requirements":
    {
    },
  • "cargo_name": "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_points":
    [
    ],
  • "auction_stages":
    [
    ],
  • "executors":
    [
    ],
  • "contract_id": "string",
  • "manual_spot_winner_pick_allowed": true,
  • "auction_auto_extend_period": 1,
  • "document_flows": [ ],
  • "closing_documents_period": 1,
  • "closing_documents_period_type": "calendar",
  • "closing_documents": [ ],
  • "agreement_type": "shipping_agreement",
  • "terms_by_partnership_contract": false,
  • "idle_time_cost_without_vat": 100,
  • "documents_for_payment": [ ],
  • "payment_procedure": "prepayment",
  • "payment_period": 1,
  • "payment_period_type": "calendar",
  • "cancellation_without_penalty_before": "2024-01-31T07:17:35Z",
  • "cancellation_penalty_percent": 0,
  • "minimum_cancellation_penalty_without_vat": 0,
  • "shipping_payment_type": "per_hour",
  • "shipping_min_work_hours": 0,
  • "shipping":
    {
    },
  • "winning_bid_id": "string",
  • "winning_bid_min_work_hours": 0,
  • "winning_bid_price_with_vat": null,
  • "winning_bid_price_without_vat": null,
  • "winning_bid": null,
  • "watching_count":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "human_friendly_id": "string",
  • "created_at": "2024-01-31T07:17:35Z",
  • "updated_at": "2024-01-31T07:17:35Z",
  • "deleted_at": "2024-01-31T07:17:35Z",
  • "status": "draft",
  • "status_comment": "string",
  • "status_updated_at": "2024-01-31T07:17:35Z",
  • "status_history":
    [
    ],
  • "cargo_owning_company_id": "string",
  • "author_id": "string",
  • "type": "shipping_request",
  • "external_info_id": "string",
  • "parent_id": "string",
  • "contact":
    {
    },
  • "comment": "string",
  • "archived": true,
  • "resource_assignment_time": 60,
  • "resource_assignment_till": "2020-03-13T15:46:31+00:00",
  • "change_requests_allowed": false,
  • "change_request_status": "string",
  • "change_resources_request_status": "string",
  • "contract_begins_at": "2024-01-31T07:17:35Z",
  • "contract_ends_at": "2024-01-31T07:17:35Z",
  • "contract_type": "by_shippings_count",
  • "shippings_count": 1,
  • "max_shippings_per_day": 1,
  • "max_shippings_per_week": 1,
  • "shipping_available_in": 0,
  • "transport_body_types": [ ],
  • "transport_tonnage": 0,
  • "transport_volume": 0,
  • "resource_requirements":
    {
    },
  • "cargo_name": "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_points":
    [
    ],
  • "route_direction":
    {
    },
  • "is_route_circular": true,
  • "auction_stages":
    [
    ],
  • "executors":
    [
    ],
  • "contract_id": "string",
  • "contract_hfid": "string",
  • "contract_shipping_id": "string",
  • "manual_spot_winner_pick_allowed": true,
  • "auction_auto_extend_period": 1,
  • "document_flows": [ ],
  • "closing_documents_period": 1,
  • "closing_documents_period_type": "calendar",
  • "closing_documents": [ ],
  • "agreement_type": "shipping_agreement",
  • "terms_by_partnership_contract": false,
  • "idle_time_cost_without_vat": 100,
  • "documents_for_payment": [ ],
  • "payment_procedure": "prepayment",
  • "payment_period": 1,
  • "payment_period_type": "calendar",
  • "cancellation_without_penalty_before": "2024-01-31T07:17:35Z",
  • "cancellation_penalty_percent": 0,
  • "minimum_cancellation_penalty_without_vat": 0,
  • "shipping_price": 0,
  • "shipping_price_tax_type": "string",
  • "shipping_id": "string",
  • "shipping_payment_type": "per_hour",
  • "shipping_min_work_hours": 0,
  • "shipping":
    {
    },
  • "current_auction_stage_number": 1,
  • "winning_bid_id": "string",
  • "winning_bid_min_work_hours": 0,
  • "winning_bid_price_with_vat": null,
  • "winning_bid_price_without_vat": null,
  • "winning_bid": null,
  • "watching_count":
    [
    ]
}

Удалить заказ

delete /shipping_orders/{shipping_order_id}
https://api.traffic.online/api/{version}/shipping_orders/{shipping_order_id}

Удалить заказ

Authorizations:
JWT (CargoOwningCompanyAdmin)

Responses

204

Заказ удалён

400

Заказ не является черновиком

404

Заказ не найден

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "error": "string",
  • "error_code": "string",
  • "error_description": "string"
}

Создать черновик заказа

post /shipping_orders/draft
https://api.traffic.online/api/{version}/shipping_orders/draft

Создать черновик заказа

Authorizations:
JWT (CargoOwningCompanyAdmin)
path Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
author_id
string <uuid> Nullable

ID пользователя, создавшего заказ.

type
string
Enum: "shipping_request" "contract" "delivery" "city_delivery"

Тип заказа:

  • shipping_request - разовый (заявка на перевозку груза)
  • contract - графиковый (график на несколько заявок на перевозку груза)
  • delivery - автодоставка (аренда ТС с экипажем)
  • city_delivery - автодоставка (городская)
external_info_id
string Nullable

Идентификатор заказа во внешних системах. Используется только для информации

parent_id
string <uuid> Nullable

ID заказа, на основании которого был создан текущий заказ. Используется только для информации

contact
object Nullable

Ответственное лицо всего заказа

comment
string Nullable

Комментарий к заказу

resource_assignment_time
integer [ 60 .. 144000 ] Nullable

Время на назначение ресурсов после бронирования заявки в минутах

resource_assignment_till
string <date-time> Nullable

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

change_requests_allowed
boolean
Default: false

Можно ли создавать запросы на изменение заказа

change_request_status
string <text> Nullable

Статус заявки на изменение требований заказа.

change_resources_request_status
string <text> Nullable

Статус заявки на измнение русурсов заказа.

contract_begins_at
string <date-time> Nullable

Дата начала исполнения. Указывается в часовом поясе первой точки маршрута

contract_ends_at
string <date-time> Nullable

Дата окончания исполнения. Указывается в часовом поясе последней точки маршрута

contract_type
string Nullable
Enum: "by_shippings_count" "by_schedule"

Вид графикового заказа:

  • by_shippings_count - по объёму (количеству перевозок)
  • by_schedule - по точному расписанию
shippings_count
integer [ 1 .. 100000 ] Nullable

Объём графикового заказа - количество перевозок

max_shippings_per_day
integer [ 1 .. 100000 ] Nullable

Максимальное количество перевозок в день по данному графиковому заказу для перевозчика. null означает, что ограничений нет

max_shippings_per_week
integer [ 1 .. 100000 ] Nullable

Максимальное количество перевозок в неделю по данному графиковому заказу для перевозчика. null означает, что ограничений нет

shipping_available_in
integer [ 0 .. 43200 ] Nullable

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

transport_body_types
Array of strings non-empty
Default: []
Items Enum: "awning" "full_metal" "isothermal" "refrigerator" "dropside" "tanker" "container"

Типы кузова транспорта

transport_tonnage
number <double> [ 0 .. 200 ] Nullable

Тоннаж транспорта в тоннах

transport_volume
number <double> [ 0 .. 200 ] Nullable

Объём транспорта в кубических метрах

resource_requirements
object

Требования к ресурсам

cargo_name
string <= 150 characters Nullable

Наименование груза

cargo_tonnage
number <double> [ 0 .. 24 ] Nullable

Тоннаж груза в тоннах

cargo_volume
number <double> [ 0 .. 150 ] Nullable

Объём груза в кубических метрах

cargo_cost
integer [ 0 .. 999999999 ] Nullable

Стоимость груза

cargo_adr
string Nullable
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"

Класс опасности груза

cargo_length
number <double> [ 0.5 .. 17 ] Nullable

Длина груза в метрах

cargo_width
number <double> [ 0.5 .. 2.75 ] Nullable

Ширина груза в метрах

cargo_height
number <double> [ 0.5 .. 3 ] Nullable

Высота груза в метрах

cargo_places
integer [ 0 .. 100 ] Nullable

Количество грузомест

cargo_packing
string Nullable
Enum: "reels" "big_bags" "barrels" "eurocubes" "cans" "coils" "boxes" "sheets" "bags" "in_bulk" "not_specified" "pallets" "fin_pallets" "packs" "pyramid" "loose" "rolls" "cases"

Упаковка груза:

  • reels - Барабаны
  • big_bags - Биг-бэги
  • barrels - Бочки
  • eurocubes - Еврокубы
  • cans - Канистры
  • coils - Катушки
  • boxes - Коробки
  • sheets - Листы
  • bags - Мешки
  • in_bulk - Навалом
  • not_specified - Нет упаковки
  • pallets - Паллеты EUR
  • fin_pallets - Паллеты FIN
  • packs - Пачки
  • pyramid - Пирамида
  • loose - Россыпью
  • rolls - Рулоны
  • cases - Ящики
route_points
Array of objects <= 100 items

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

auction_stages
Array of objects [ 0 .. 1000 ] items

Этапы торга

executors
Array of objects [ 0 .. 1 ] items

Исполнители заказа, указанные в момент создания

contract_id
string <uuid> Nullable

ID графикового заказа, для которого создаётся данный заказ

manual_spot_winner_pick_allowed
boolean

Можно ли выбирать выигрышную ставку в процессе торга спот заказа

auction_auto_extend_period
integer [ 1 .. 24 ] Nullable

Период автопродления торга

document_flows
Array of strings
Default: []
Items Enum: "scancopy" "online_confirmation" "qualified_signature"

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

closing_documents_period
integer [ 1 .. 366 ] Nullable

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

closing_documents_period_type
string Nullable
Enum: "calendar" "working"

Тип дней в периоде предоставления закрывающих документов:

  • calendar - Календарный день
  • working - Рабочий день
closing_documents
Array of objects
Default: []

Закрывающие документы

agreement_type
string Nullable
Enum: "shipping_agreement" "freight_forwarding_agreement"

Вид договора

  • shipping_agreement - Договор перевозки
  • freight_forwarding_agreement - Договор транспортной экспедиции
terms_by_partnership_contract
boolean
Default: false

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

idle_time_cost_without_vat
integer [ 100 .. 1500 ] Nullable

Стоимость одного часа простоя сверх времени работы в точке без НДС, кратно 100

documents_for_payment
Array of strings
Default: []
Items Enum: "bill_of_lading" "waybill" "bill_of_lading_or_waybill" "packing_list" "bill" "acceptance_certificate" "delivery_certificate" "invoice" "power_of_attorney" "universal_transfer_document" "accompanying_document" "cmr" "forwarding_order" "shipping_order" "forwarding_receipt" "attachment_to_bill_of_lading"

Документы для оплаты

payment_procedure
string Nullable
Enum: "prepayment" "payment_by_scancopy" "payment_by_original_documents" "payment_by_unloading" "payment_by_loading"

Порядок оплаты:

  • prepayment - Предоплата
  • payment_by_scancopy - Оплата по скан-копиям документов
  • payment_by_original_documents - Оплата по оригиналам документов
  • payment_by_unloading - Оплата по факту выгрузки
  • payment_by_loading - Оплата по факту загрузки
payment_period
integer [ 1 .. 366 ] Nullable

Период оплаты в днях

payment_period_type
string Nullable
Enum: "calendar" "working"

Тип дней в периоде оплаты:

  • calendar - Календарный день
  • working - Рабочий день
cancellation_without_penalty_before
string <date-time> Nullable

Допустимое время для отказа от перевозки до наступления санкций

cancellation_penalty_percent
integer [ 0 .. 100 ] Nullable

Штраф за отказ от перевозки после наступления санкций в процентах от стоимости без НДС

minimum_cancellation_penalty_without_vat
integer [ 0 .. 999999999 ] Nullable

Минимальный штраф за отказ от перевозки после наступления санкций без НДС

shipping_payment_type
string Nullable
Enum: "per_hour" "fixed"

Тип цены:

  • per_hour - За час
  • fixed - Фисированая
shipping_min_work_hours
integer Nullable

Минимально оплачиваемое количество часов в заказе.

winning_bid_id
string <uuid> Nullable

ID выигравшей стваки.

winning_bid_min_work_hours
integer Nullable

Минимально оплачиваемое количество часов выигравшей ставки.

winning_bid_price_with_vat
decimal Nullable

Цена победившей стваки (с НДС).

winning_bid_price_without_vat
decimal Nullable

Цена победившей стваки (без НДС).

winning_bid
float Nullable

Выигравшая ставка.

watching_count
Array of objects Nullable

Счетчик количества просмотров заявки.

Responses

200

Черновик заказа

400

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

401

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

403

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "author_id": "string",
  • "type": "shipping_request",
  • "external_info_id": "string",
  • "parent_id": "string",
  • "contact":
    {
    },
  • "comment": "string",
  • "resource_assignment_time": 60,
  • "resource_assignment_till": "2020-03-13T15:46:31+00:00",
  • "change_requests_allowed": false,
  • "change_request_status": "string",
  • "change_resources_request_status": "string",
  • "contract_begins_at": "2024-01-31T07:17:35Z",
  • "contract_ends_at": "2024-01-31T07:17:35Z",
  • "contract_type": "by_shippings_count",
  • "shippings_count": 1,
  • "max_shippings_per_day": 1,
  • "max_shippings_per_week": 1,
  • "shipping_available_in": 0,
  • "transport_body_types": [ ],
  • "transport_tonnage": 0,
  • "transport_volume": 0,
  • "resource_requirements":
    {
    },
  • "cargo_name": "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_points":
    [
    ],
  • "auction_stages":
    [
    ],
  • "executors":
    [
    ],
  • "contract_id": "string",
  • "manual_spot_winner_pick_allowed": true,
  • "auction_auto_extend_period": 1,
  • "document_flows": [ ],
  • "closing_documents_period": 1,
  • "closing_documents_period_type": "calendar",
  • "closing_documents": [ ],
  • "agreement_type": "shipping_agreement",
  • "terms_by_partnership_contract": false,
  • "idle_time_cost_without_vat": 100,
  • "documents_for_payment": [ ],
  • "payment_procedure": "prepayment",
  • "payment_period": 1,
  • "payment_period_type": "calendar",
  • "cancellation_without_penalty_before": "2024-01-31T07:17:35Z",
  • "cancellation_penalty_percent": 0,
  • "minimum_cancellation_penalty_without_vat": 0,
  • "shipping_payment_type": "per_hour",
  • "shipping_min_work_hours": 0,
  • "shipping":
    {
    },
  • "winning_bid_id": "string",
  • "winning_bid_min_work_hours": 0,
  • "winning_bid_price_with_vat": null,
  • "winning_bid_price_without_vat": null,
  • "winning_bid": null,
  • "watching_count":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "human_friendly_id": "string",
  • "created_at": "2024-01-31T07:17:35Z",
  • "updated_at": "2024-01-31T07:17:35Z",
  • "deleted_at": "2024-01-31T07:17:35Z",
  • "status": "draft",
  • "status_comment": "string",
  • "status_updated_at": "2024-01-31T07:17:35Z",
  • "status_history":
    [
    ],
  • "cargo_owning_company_id": "string",
  • "author_id": "string",
  • "type": "shipping_request",
  • "external_info_id": "string",
  • "parent_id": "string",
  • "contact":
    {
    },
  • "comment": "string",
  • "archived": true,
  • "resource_assignment_time": 60,
  • "resource_assignment_till": "2020-03-13T15:46:31+00:00",
  • "change_requests_allowed": false,
  • "change_request_status": "string",
  • "change_resources_request_status": "string",
  • "contract_begins_at": "2024-01-31T07:17:35Z",
  • "contract_ends_at": "2024-01-31T07:17:35Z",
  • "contract_type": "by_shippings_count",
  • "shippings_count": 1,
  • "max_shippings_per_day": 1,
  • "max_shippings_per_week": 1,
  • "shipping_available_in": 0,
  • "transport_body_types": [ ],
  • "transport_tonnage": 0,
  • "transport_volume": 0,
  • "resource_requirements":
    {
    },
  • "cargo_name": "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_points":
    [
    ],
  • "route_direction":
    {
    },
  • "is_route_circular": true,
  • "auction_stages":
    [
    ],
  • "executors":
    [
    ],
  • "contract_id": "string",
  • "contract_hfid": "string",
  • "contract_shipping_id": "string",
  • "manual_spot_winner_pick_allowed": true,
  • "auction_auto_extend_period": 1,
  • "document_flows": [ ],
  • "closing_documents_period": 1,
  • "closing_documents_period_type": "calendar",
  • "closing_documents": [ ],
  • "agreement_type": "shipping_agreement",
  • "terms_by_partnership_contract": false,
  • "idle_time_cost_without_vat": 100,
  • "documents_for_payment": [ ],
  • "payment_procedure": "prepayment",
  • "payment_period": 1,
  • "payment_period_type": "calendar",
  • "cancellation_without_penalty_before": "2024-01-31T07:17:35Z",
  • "cancellation_penalty_percent": 0,
  • "minimum_cancellation_penalty_without_vat": 0,
  • "shipping_price": 0,
  • "shipping_price_tax_type": "string",
  • "shipping_id": "string",
  • "shipping_payment_type": "per_hour",
  • "shipping_min_work_hours": 0,
  • "shipping":
    {
    },
  • "current_auction_stage_number": 1,
  • "winning_bid_id": "string",
  • "winning_bid_min_work_hours": 0,
  • "winning_bid_price_with_vat": null,
  • "winning_bid_price_without_vat": null,
  • "winning_bid": null,
  • "watching_count":
    [
    ]
}

Опубликовать черновик заказа

post /shipping_orders/{shipping_order_id}/publish
https://api.traffic.online/api/{version}/shipping_orders/{shipping_order_id}/publish

Опубликовать черновик заказа

Authorizations:
JWT (CargoOwningCompanyAdmin)
path Parameters
Content-Type
required
any
Value: "application/json"

Responses

200

Заказ

400

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

401

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

403

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

404

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "human_friendly_id": "string",
  • "created_at": "2024-01-31T07:17:35Z",
  • "updated_at": "2024-01-31T07:17:35Z",
  • "deleted_at": "2024-01-31T07:17:35Z",
  • "status": "draft",
  • "status_comment": "string",
  • "status_updated_at": "2024-01-31T07:17:35Z",
  • "status_history":
    [
    ],
  • "cargo_owning_company_id": "string",
  • "author_id": "string",
  • "type": "shipping_request",
  • "external_info_id": "string",
  • "parent_id": "string",
  • "contact":
    {
    },
  • "comment": "string",
  • "archived": true,
  • "hide_contacts": true,
  • "resource_assignment_time": 60,
  • "resource_assignment_till": "2020-03-13T15:46:31+00:00",
  • "change_requests_allowed": true,
  • "change_request_status": "string",
  • "change_resources_request_status": "string",
  • "contract_begins_at": "2024-01-31T07:17:35Z",
  • "contract_ends_at": "2024-01-31T07:17:35Z",
  • "contract_type": "by_shippings_count",
  • "shippings_count": 1,
  • "max_shippings_per_day": 1,
  • "max_shippings_per_week": 1,
  • "shipping_available_in": 0,
  • "transport_body_types":
    [
    ],
  • "transport_tonnage": 0,
  • "transport_volume": 0,
  • "resource_requirements":
    {
    },
  • "cargo_name": "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_points":
    [
    ],
  • "route_direction":
    {
    },
  • "is_route_circular": true,
  • "auction_stages":
    [
    ],
  • "executors":
    [
    ],
  • "contract_id": "string",
  • "contract_hfid": "string",
  • "contract_shipping_id": "string",
  • "contract_shipping_price": 0,
  • "dynamic_pricing": true,
  • "auction_auto_extend_period": 1,
  • "rebidding": true,
  • "manual_spot_winner_pick_allowed": true,
  • "partnership_contract_type": "all",
  • "document_flows":
    [
    ],
  • "closing_documents_period": 1,
  • "closing_documents_period_type": "calendar",
  • "agreement_type": "shipping_agreement",
  • "closing_documents":
    [
    ],
  • "terms_by_partnership_contract": true,
  • "idle_time_cost_without_vat": 100,
  • "documents_for_payment":
    [
    ],
  • "payment_procedure": "prepayment",
  • "payment_period": 1,
  • "payment_period_type": "calendar",
  • "cancellation_without_penalty_before": "2024-01-31T07:17:35Z",
  • "cancellation_penalty_percent": 0,
  • "minimum_cancellation_penalty_without_vat": 0,
  • "payer_opf_id": 1,
  • "payer_title": "string",
  • "payment_form": "string",
  • "forward_request_number": "string",
  • "shipping_price": 0,
  • "shipping_price_tax_type": "string",
  • "shipping_payment_type": "string",
  • "shipping_id": "string",
  • "shipping_min_work_hours": 0,
  • "shipping":
    {
    },
  • "current_auction_stage_number": 1,
  • "winning_bid_id": "string",
  • "winning_bid_min_work_hours": 0,
  • "winning_bid_price_with_vat": 1,
  • "winning_bid_price_without_vat": 1,
  • "auto_accept_changes": true
}

Перевозки

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

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

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

Authorizations:
JWT (CargoOwningCompanyAdmin)
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-01-31T07:17:35Z",
  • "resource_assignment_deadline": "2024-01-31T07:17:35Z",
  • "kind": "ShippingOutput",
  • "id": "string",
  • "human_friendly_id": "Человеко понятный id",
  • "status":
    {
    },
  • "status_updated_at": "2024-01-31T07:17:35Z",
  • "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-01-31T07:17:35Z",
  • "requirements_changes_deadline": "2024-01-31T07:17:35Z",
  • "reserved_at": "2024-01-31T07:17:35Z",
  • "important_changes_at": "2024-01-31T07:17:35Z",
  • "requirements_accepted_at": "2024-01-31T07:17:35Z",
  • "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-01-31",
  • "actual_payment_date": "2024-01-31",
  • "contact":
    {
    },
  • "created_at": "2024-01-31T07:17:35Z",
  • "updated_at": "2024-01-31T07:17:35Z"
}

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

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

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

Authorizations:
JWT (CargoOwningCompanyAdmin)
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-01-31T07:17:35Z",
  • "files":
    [
    ],
  • "created_at": "2024-01-31T07:17:35Z",
  • "deleted_at": "2024-01-31T07:17:35Z"
}

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

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

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

Authorizations:
JWT (CargoOwningCompanyAdmin)
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 (CargoOwningCompanyAdmin)
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-01-31T07:17:35Z",
  • "resource_assignment_deadline": "2024-01-31T07:17:35Z",
  • "kind": "ShippingOutput",
  • "id": "string",
  • "human_friendly_id": "Человеко понятный id",
  • "status":
    {
    },
  • "status_updated_at": "2024-01-31T07:17:35Z",
  • "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-01-31T07:17:35Z",
  • "requirements_changes_deadline": "2024-01-31T07:17:35Z",
  • "reserved_at": "2024-01-31T07:17:35Z",
  • "important_changes_at": "2024-01-31T07:17:35Z",
  • "requirements_accepted_at": "2024-01-31T07:17:35Z",
  • "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-01-31",
  • "actual_payment_date": "2024-01-31",
  • "contact":
    {
    },
  • "created_at": "2024-01-31T07:17:35Z",
  • "updated_at": "2024-01-31T07:17:35Z"
}

Скачивание файла ПФЗ

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 (CargoOwningCompanyAdmin)
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}/done
https://api.traffic.online/api/{version}/shippings/{shipping_id}/done

Подтвердить завершение перевозки

Authorizations:
JWT (CargoOwningCompanyAdmin)
path Parameters
Content-Type
required
any
Value: "application/json"
Request Body schema: application/json
completed_at
required
string <date-time>

Дата фактического завершения перевозки.

Responses

200

OK

400

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

403

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

404

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "completed_at": "2024-01-31T07:17:35Z"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "shipping_request_info":
    {
    },
  • "assigned_resources":
    [
    ],
  • "selected_car_supply":
    [
    ],
  • "completed_at": "2024-01-31T07:17:35Z",
  • "resource_assignment_deadline": "2024-01-31T07:17:35Z",
  • "kind": "ShippingOutput",
  • "id": "string",
  • "human_friendly_id": "Человеко понятный id",
  • "status":
    {
    },
  • "status_updated_at": "2024-01-31T07:17:35Z",
  • "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-01-31T07:17:35Z",
  • "requirements_changes_deadline": "2024-01-31T07:17:35Z",
  • "reserved_at": "2024-01-31T07:17:35Z",
  • "important_changes_at": "2024-01-31T07:17:35Z",
  • "requirements_accepted_at": "2024-01-31T07:17:35Z",
  • "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-01-31",
  • "actual_payment_date": "2024-01-31",
  • "contact":
    {
    },
  • "created_at": "2024-01-31T07:17:35Z",
  • "updated_at": "2024-01-31T07:17:35Z"
}

Справочники

Получение списка доступных типов ОПФ

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

Получение списка доступных типов ОПФ

Authorizations:
JWT (CargoOwningCompanyAdmin)

Responses

200

ОПФ компаний

Response samples

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

Подсказки адреса

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

Подсказки адреса

Authorizations:
JWT (CargoOwningCompanyAdmin)
query Parameters
q
required
string

Строка для поиска

from_bound
string
Enum: "region" "area" "city" "settlement" "street" "house"

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

to_bound
string
Enum: "region" "area" "city" "settlement" "street" "house"

Ограничение поиска снизу указанным типом адреса

parent_kladr_id
string
Example: parent_kladr_id=0200000000000

Код КЛАДР адресного объекта, среди всех дочерних элементов которого следует осуществлять поиск

Responses

200

Адреса

Response samples

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

Поиск адреса по геокоординатам

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

Поиск адреса по геокоординатам

Authorizations:
JWT (CargoOwningCompanyAdmin)
query Parameters
lat
required
number <double>

Широта

lon
required
number <double>

Долгота

radius_meters
integer [ 0 .. 1000 ]
Default: 100

Радиус поиска в метрах

Responses

200

Адреса

Response samples

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

Получить полный объект адреса по ФИАС

get /catalog/address/{fias}
https://api.traffic.online/api/{version}/catalog/address/{fias}
Authorizations:
JWT (CargoOwningCompanyAdmin)
path Parameters
fias
required
string

ФИАС

Responses

200

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "country": "Россия",
  • "country_iso_code": "RU",
  • "federal_district": "Северо-Западный",
  • "region": "Санкт-Петербург",
  • "region_type": "г",
  • "region_with_type": "г Санкт-Петербург",
  • "region_fias_id": "c2deb16a-0330-4f05-821f-1d09c93331e6",
  • "region_kladr_id": "7800000000000",
  • "region_iso_code": "RU-SPE",
  • "area": "Краснокамский",
  • "area_type": "р-н",
  • "area_with_type": "Краснокамский р-н",
  • "area_fias_id": "c278cbbc-e209-4b0f-b20e-9c19ed6f6802",
  • "area_kladr_id": "0203100000000",
  • "city": "Санкт-Петербург",
  • "city_type": "г",
  • "city_with_type": "г Санкт-Петербург",
  • "city_fias_id": "c2deb16a-0330-4f05-821f-1d09c93331e6",
  • "city_kladr_id": "7800000000000",
  • "settlement": "Жилгородок",
  • "settlement_type": "п",
  • "settlement_with_type": "п Жилгородок",
  • "settlement_fias_id": "8eab754d-38df-4fac-bebd-b27a46f45ea2",
  • "settlement_kladr_id": "4701200005100",
  • "street": "Московский",
  • "street_type": "пр-кт",
  • "street_with_type": "Московский пр-кт",
  • "street_fias_id": "01b3acfc-5a4d-4d0f-a2de-67aef6effe31",
  • "street_kladr_id": "78000000000085200",
  • "house": "дом 1А/2 строение 3 корпус 4 литера Б",
  • "house_fias_id": "315a5cc2-7676-460f-ab44-a85c38eea89a",
  • "house_kladr_id": "7800000000013430010",
  • "office": "офис 1 помещение 2",
  • "fias_id": "315a5cc2-7676-460f-ab44-a85c38eea89a",
  • "kladr_id": "7800000000013430010",
  • "lat": 59.9017959,
  • "lng": 30.3194694,
  • "zip_code": "196084",
  • "timezone_name": "Europe/Moscow",
  • "level": "country",
  • "house_number": "94",
  • "house_type": "д",
  • "block": "string",
  • "block_type": "string",
  • "time_zone": 5,
  • "value": "string"
}

Рассчитать стоимость

Рассчитать стоимость

post /market_prices
https://api.traffic.online/api/{version}/market_prices

Рассчитать стоимость

Authorizations:
JWT (CargoOwningCompanyAdmin)
Request Body schema: application/json
transport_body_type
string
Enum: "awning" "isothermal" "refrigerator"

Тип кузова транспорта

  • awning - тент
  • isothermal - изотерм
  • refrigerator - рефрижератор
tonnage
number <double>

Тоннаж транспорта в тоннах

volume
integer

Объём транспорта в кубических метрах

from
string <date-time>

Период данных - ОТ

till
string <date-time>

Период данных - ДО

routes
Array of objects

Маршруты

Responses

200

Расчитанные рыночные цены

400

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "transport_body_type": "awning",
  • "tonnage": 0,
  • "volume": 0,
  • "from": "2024-01-31T07:17:35Z",
  • "till": "2024-01-31T07:17:35Z",
  • "routes":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "transport_body_type": "awning",
  • "tonnage": 0,
  • "volume": 0,
  • "from": "2024-01-31T07:17:35Z",
  • "till": "2024-01-31T07:17:35Z",
  • "routes":
    [
    ]
}