Получение списка всех имеющихся в системе типов транспортных средств
| tenant_id required | string <uuid> (Uuid) (?i-mx:^[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12... Example: 9d82fff9-d029-44b2-b6b7-133b957aa926 Идентификатор компании |
[- {
- "external_number": "CODE1",
- "name": "Транспортное средство 1"
}
]Получение списка всех имеющихся в системе видов кузовов
| tenant_id required | string <uuid> (Uuid) (?i-mx:^[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12... Example: 9d82fff9-d029-44b2-b6b7-133b957aa926 Идентификатор компании |
[- {
- "id": "9d82fff9-d029-44b2-b6b7-133b957aa926",
- "name": "Манипулятор"
}
]Получение списка всех имеющихся компаний партнеров-перевозчиков
| tenant_id required | string <uuid> (Uuid) (?i-mx:^[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12... Example: 9d82fff9-d029-44b2-b6b7-133b957aa926 Идентификатор компании |
[- {
- "external_number": "CR_01",
- "inn": "770701000001"
}
]Создание запроса на генерацию отчета с заданными параметрами
| tenant_id required | string <uuid> (Uuid) (?i-mx:^[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12... Example: 9d82fff9-d029-44b2-b6b7-133b957aa926 Идентификатор компании |
| columns required | Array of strings Список колонок, которые должны быть включены в отчет |
| filter_period_by required | string Enum: "loading_date" "unloading_date" "timeslot_booking_date" "order_creation_date" "order_confirmation_date" Период выборки данных * |
| date_from required | string <date> (Date) Дата начала периода выборки (включительно) |
| date_to required | string <date> (Date) Дата окончания периода выборки (включительно) |
| order_statuses | Array of strings Items Enum: "pending" "on_bidding" "on_target_offering" "on_execution" "finalized" Статусы заказов, которые должны быть включены в отчет * |
| modalities | Array of strings Items Enum: "auto" "railway" "sea" "air" Список модальностей, по которым нужно отфильтровать заказы * |
{- "columns": [
- "reference_number",
- "order_status"
], - "filter_period_by": "loading_date",
- "date_from": "2016-07-20",
- "date_to": "2016-07-20",
- "order_statuses": [
- "pending",
- "on_bidding"
], - "modalities": [
- "auto"
]
}{- "id": "9d82fff9-d029-44b2-b6b7-133b957aa926"
}Получение списка полей, которые можно использовать в отчете
| tenant_id required | string <uuid> (Uuid) (?i-mx:^[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12... Example: 9d82fff9-d029-44b2-b6b7-133b957aa926 Идентификатор компании |
[- {
- "key": "orders",
- "title": "Заказы",
- "fields": [
- {
- "key": "reference_number",
- "title": "Номер транспортировки"
}, - {
- "key": "order_status",
- "title": "Статус заказа"
}
]
}
]Скачать ранее сформированный отчет в формате XLSX
| tenant_id required | string <uuid> (Uuid) (?i-mx:^[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12... Example: 9d82fff9-d029-44b2-b6b7-133b957aa926 Идентификатор компании |
| report_id required | string <uuid> (Uuid) (?i-mx:^[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12... Example: 9d82fff9-d029-44b2-b6b7-133b957aa926 Идентификатор отчета |
Получение списка всех тендеров
| tenant_id required | string <uuid> (Uuid) (?i-mx:^[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12... Example: 9d82fff9-d029-44b2-b6b7-133b957aa926 Идентификатор компании |
| page | integer Default: 1 Номер страницы |
| items | integer <= 100 Default: 20 Кол-во объектов на странице |
| search_query | string Полнотекстовый поиск по названию тендера |
| scope | string Enum: "draft" "ready_to_start" "started" "paused" "finished" "canceled" Фильтр по статусу тендера |
| start_date_from | string Example: start_date_from=2023-10-14T12:34:56+03:00 Дата начала фильтра интервала проведения тендера в формате ISO 8601. Используется только вместе с end_date_to. |
| end_date_to | string Example: end_date_to=2023-10-19T12:34:56+03:00 Дата начала фильтра интервала проведения тендера в формате ISO 8601. Используется только вместе с start_date_from. |
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "iid": 0,
- "name": "string",
- "status": "draft",
- "unit": "ton",
- "period_type": "day",
- "quantity_per_period_from": null,
- "quantity_per_period_to": null,
- "runs_execution_starts_on": "2019-08-24",
- "runs_execution_ends_on": "2019-08-24",
- "tender_id": 0,
- "stage_type": "submission",
- "parent_stage_iid": null,
- "created_at": "2019-08-24T14:15:22Z",
- "starts_at": "2019-08-24T14:15:22Z",
- "comment": null,
- "has_quantity_behavior": true,
- "planned_quantity": 0,
- "covered_quantity": 0,
- "respond_quantity": 0
}
]Запросить генерацию результатов тендера в формате .xlsx.
Генерация результатов происходит асинхронно, поэтому в ответе придет идентификатор,
по которому можно будет затем запросить файл экспорта по пути /{tenant_id}/exports/{export_id}/file.
| tenant_id required | string <uuid> (Uuid) (?i-mx:^[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12... Example: 9d82fff9-d029-44b2-b6b7-133b957aa926 Идентификатор компании |
| tender_id required | string <uuid> (Uuid) (?i-mx:^[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12... Example: 9d82fff9-d029-44b2-b6b7-133b957aa926 Идентификатор тендера |
| type | string Enum: "all" "winners" "incompleted" Выбор типа результатов:
|
{- "id": "string"
}По заранее запрошенному идентификатору экспорта получить .xlsx файл.
| tenant_id required | string <uuid> (Uuid) (?i-mx:^[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12... Example: 9d82fff9-d029-44b2-b6b7-133b957aa926 Идентификатор компании |
| export_id required | string <uuid> (Uuid) (?i-mx:^[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12... Example: 9d82fff9-d029-44b2-b6b7-133b957aa926 Идентификатор экспорта |