Методы для работы с бронированиями
Добавление или изменение бронирования
Чтобы изменить существующее бронирования, надо передать поле id с идентификатором бронирования.
Если id не передать, то будет создано новое бронирование.
В ответ на запрос возвращается созданное или изменённое бронирование.
Получение существующих бронирований и точек заказа без брони
Возвращается список существующих бронирований и точек заказа, для которых бронирования ещё не созданы.
Запрашивающий пользователь должен быть создателем бронирования, или владельцем груза (из заказа), или перевозчиком (из заказа).
get
/gw/timeslots/api/v1/timeslots/my
Отправить
CURL
1C
Пример ответа
Ответ
200 Возвращаются все бронирования и точки заказа без бронирований
Развернуть все
Свернуть все
Пример
Модель
{...}
"ok" : false ,
"result" : {...}
"order_points_without_slots_count" : 0 ,
"order_points_without_slots" : [...],
{...}
"id" : 0 ,
"can_be_created" : false ,
"load_number" : "string" ,
"deal_id" : "string" ,
"warehouse" : {...},
"id" : 0 ,
"name" : "string" ,
"address" : "string" ,
"city_verbose" : "string"
} ,
"driver_name" : "string" ,
"driver_phone" : "string" ,
"car_number" : "string" ,
"car_load_capacity" : 0.5 ,
"load_owner_contact_id" : 0 ,
"order_loads" : [...],
{...}
"ordinal_number" : 0 ,
"weight" : 0.5 ,
"volume" : 0.5 ,
"cargo_type" : "string"
}
] ,
"warehouse_owner" : 0 ,
"order_route" : [...],
{...}
"name" : "string" ,
"type" : "loading"
}
] ,
"ordinal_id" : 0 ,
"point_type" : "string" ,
"car_type" : "string"
}
] ,
"count" : 0 ,
"time_slots" : [...],
{...}
"id" : 0 ,
"time_from" : "string" ,
"time_to" : "string" ,
"warehouse_info" : {...},
"id" : 0 ,
"name" : "string" ,
"address" : "string" ,
"city_verbose" : "string" ,
"utc_offset" : 0 ,
"owner" : 0
} ,
"can_be_edited" : false ,
"is_expired" : false ,
"timeslot_readable_id" : "string" ,
"approve_status" : "approved" ,
"action_type" : "unloading" ,
"slot_owner" : 0 ,
"contact_id" : 0 ,
"email" : "string" ,
"contact_name" : "string" ,
"contact_phone" : "string" ,
"country_phone_id" : 0 ,
"gate_number" : 0 ,
"car_number" : "string" ,
"car_capacity" : 0 ,
"body_type" : "string" ,
"cargo" : "string" ,
"cargo_count" : 0 ,
"cargo_unit" : "string" ,
"cargo_owner" : "string" ,
"cargo_owner_contact_name" : "string" ,
"cargo_owner_contact_number" : "string" ,
"comment" : "string" ,
"firm_name" : "string" ,
"date_from" : "string" ,
"data_to" : "string" ,
"date_creation" : "string" ,
"date_modified" : "string" ,
"deleted" : false ,
"is_test" : false ,
"warehouse" : 0 ,
"terminal" : 0 ,
"order_point" : {...},
"id" : 0 ,
"can_be_created" : false ,
"load_number" : "string" ,
"deal_id" : "string" ,
"warehouse" : {...},
"id" : 0 ,
"name" : "string" ,
"address" : "string" ,
"city_verbose" : "string"
} ,
"driver_name" : "string" ,
"driver_phone" : "string" ,
"car_number" : "string" ,
"car_load_capacity" : 0.5 ,
"load_owner_contact_id" : 0 ,
"order_loads" : [...],
{...}
"ordinal_number" : 0 ,
"weight" : 0.5 ,
"volume" : 0.5 ,
"cargo_type" : "string"
}
] ,
"warehouse_owner" : 0 ,
"order_route" : [...],
{...}
"name" : "string" ,
"type" : "loading"
}
] ,
"ordinal_id" : 0 ,
"point_type" : "string" ,
"car_type" : "string"
} ,
"warehouse_name" : "string" ,
"terminal_name" : "string"
}
] ,
"accounts" : [...],
{...}
"any-key" : {...}
"firm_type" : "string" ,
"firm_id" : 0 ,
"account_id" : "string" ,
"full_firm_name" : "string" ,
"firm_name" : "string" ,
"brand" : "string" ,
"location" : {...},
"city_id" : 0 ,
"region_id" : 0 ,
"country_id" : 0 ,
"full_name" : "string" ,
"short_name" : "string" ,
"is_regional_center" : false ,
"city_size" : 0 ,
"fias_id" : "string" ,
"attributes" : 0 ,
"city_name" : "string" ,
"region_name" : "string" ,
"country_code_name" : "string"
} ,
"passport" : {...},
"ati_id" : "string" ,
"total_score" : 0.5 ,
"ati_data_match_point" : 0.5 ,
"account_lifetime_point" : 0.5 ,
"business_activity_point" : 0.5 ,
"round_table_point" : 0.5 ,
"claim_point" : 0.5 ,
"prof_activity_point" : 0.5 ,
"ati_administration_point" : 0.5 ,
"clones_point" : 0.5 ,
"egr_point" : 0.5 ,
"mass_registration_point" : 0.5 ,
"mass_founder_point" : 0.5 ,
"firm_lifetime_point" : 0.5 ,
"guaranteed_payment_point" : 0.5 ,
"virtual_account_debts_point" : 0.5 ,
"bad_partner_mentions_point" : 0.5 ,
"ri_users_attributes" : 0 ,
"recommendations_count" : 0 ,
"status" : 0 ,
"status_description" : "string" ,
"negative_points_sum" : 0.5
} ,
}
}
] ,
"timeslot_filters" : {...}
"timeslot_id" : 0 ,
"order_point_id" : 0 ,
"only_timeslots" : false ,
"only_order_points_without_slots" : false
}
}
}
order_points_without_slots_count :
integer
Количество точек заказа, для которых не создано бронирование
order_points_without_slots :[{...}]
id :
integer
Идентификатор точки заказа во Временных окнах
id :
integer
Идентификатор склада во Временных окнах
city_verbose :
string
Название города, в котором расположен склад
}
car_number :
string
Государственный регистрационный номер автомобиля
load_owner_contact_id :
integer
(nullable)
cargo_type :
string
Тип груза. Может быть введен пользователем
}]
warehouse_owner :
integer
Идентификатор фирмы, которая владеет складом
type :
enum
[loading, unloading]
Тип точки
}]
}]
count :
integer
Количество созданных бронирований
id :
integer
Идентификатор бронирования. Если передан, то бронирование будет обновлено
warehouse_info :{...}
Информация о складе, на котором создано бронирование
city_verbose :
string
Название города, в котором находится склад
utc_offset :
integer
Количество минут, на которые время склада отличается от UTC
owner :
integer
Идентификатор фирмы, которой принадлежит склад
}
attached_files :
array
Список приложенных к бронированию файлов
can_be_edited :
boolean
Флаг, указывающий на возможность редактирования бронирования
is_expired :
boolean
Флаг, указывающий просрочено ли временя бронирования
timeslot_readable_id :
string
Человекочитаемый идентификатор бронирования
approve_status :
enum
[approved, decline, await_reaction, await_client]
Статус бронирования
action_type :
enum
[unloading, loading, loading_unloading]
Тип действия на складе
slot_owner :
integer
Идентификатор фирмы пользователя, создавшего бронирования
contact_id :
integer
Идентификатор контакта пользователя, создавшего бронирование
email :
string
Адрес электронной почты создателя бронирования
country_phone_id :
integer
>=0 and <= 4
Идентификатор страны телефона контактного лица. 0-Россия, 1-Украина, 2-Казахстан, 3-Беларусь, 4-Другие
car_number :
string
Государственный регистрационный номер автомобиля
car_capacity :
integer
Грузоподъемность транспортного средства
cargo_owner_contact_name :
string
cargo_owner_contact_number :
string
Телефонный номер грузовладельца
firm_name :
string
Название фирмы перевозчика
data_to :
string
Дата окончания бронирования
date_creation :
string
Дата и время создания бронирования
date_modified :
string
Дата и время изменения бронирования
deleted :
boolean
Флаг, показывающий удалено бронирование или нет
is_test :
boolean
Флаг, показывающий является ли бронирование тестовым
terminal :
integer
Идентификатор площадки погрузки-выгрузки
id :
integer
Идентификатор точки заказа во Временных окнах
id :
integer
Идентификатор склада во Временных окнах
city_verbose :
string
Название города, в котором расположен склад
}
car_number :
string
Государственный регистрационный номер автомобиля
load_owner_contact_id :
integer
(nullable)
cargo_type :
string
Тип груза. Может быть введен пользователем
}]
warehouse_owner :
integer
Идентификатор фирмы, которая владеет складом
type :
enum
[loading, unloading]
Тип точки
}]
}
terminal_name :
string
Название площадки погрузки-выгрузки
}]
is_regional_center :
boolean
country_code_name :
string
}
ati_data_match_point :
float
account_lifetime_point :
float
business_activity_point :
float
prof_activity_point :
float
ati_administration_point :
float
mass_registration_point :
float
mass_founder_point :
float
firm_lifetime_point :
float
guaranteed_payment_point :
float
virtual_account_debts_point :
float
bad_partner_mentions_point :
float
ri_users_attributes :
integer
recommendations_count :
integer
status_description :
string
negative_points_sum :
float
}
}
}]
only_order_points_without_slots :
boolean
}
}
}
Загрузка...
Развернуть все
Свернуть все
Загрузка...
Получение существующих бронирований фирмы
Возвращается список существующих бронирований. Идентификатор фирмы передается в path.
Также с помощью query параметров можно передать фильтры.
get
/gw/timeslots/api/v1/timeslots/{ati_id}
Отправить
Номера площадок погрузки-выгрузки
Идентификатор площадки погрузки-разгрузки
Дата окончания бронирований
Время начала бронирований
Время окончания бронирований
Порядковый номер точки в заказе
Тип точки в заказе. 1 - точка загрузки, 2 - точка разгрузки
-----
approved
decline
await_reaction
await_client
Статус бронирования
Идентификатор бронирования
Идентификатор точки заказа
Флаг, определяющий, что надо вернуть только бронирования, без точек из заказа
only_order_points_without_slots
boolean
Флаг, определяющий, что надо вернуть только точки из заказа без бронирований
CURL
1C
Пример ответа
Ответ
200 Возвращается информация бронированиях с учетом фильтров
Развернуть все
Свернуть все
Пример
Модель
{...}
"ok" : true ,
"result" : {...}
"count" : 1 ,
"time_slots" : [...],
{...}
"id" : 12429 ,
"time_from" : "00:00" ,
"time_to" : "00:00" ,
"warehouse_info" : {...},
"id" : 34824 ,
"name" : "Тестовый склад" ,
"address" : "Гельсингфорсская улица, 2А" ,
"city_verbose" : "Санкт-Петербург, РФ" ,
"utc_offset" : 180 ,
"owner" : 4022713
} ,
"staying_statuses_history" : [...],
{...}
"status_name" : "Ожидается" ,
"date_start" : "2023-07-04T08:29:44.946522+03:00" ,
"date_end" : null ,
"staying_status" : 173845 ,
"timeslot" : 12429 ,
"comment" : "" ,
"color" : "rgb(219, 169, 46)"
}
] ,
"can_be_edited" : true ,
"is_expired" : true ,
"timeslot_readable_id" : "34824-12429" ,
"approve_status" : "approved" ,
"action_type" : "loading_unloading" ,
"slot_owner" : 4022713 ,
"contact_id" : 0 ,
"email" : "" ,
"contact_name" : null ,
"contact_phone" : "" ,
"country_phone_id" : "" ,
"gate_number" : 1 ,
"car_number" : null ,
"car_capacity" : null ,
"body_type" : null ,
"cargo" : "" ,
"cargo_count" : null ,
"cargo_unit" : "" ,
"cargo_owner" : "" ,
"cargo_owner_contact_name" : "" ,
"cargo_owner_contact_number" : "" ,
"comment" : "Тестовый комментарий" ,
"firm_name" : "" ,
"date_from" : "2023-07-04" ,
"date_to" : "2023-07-04" ,
"date_creation" : "2023-07-04T08:29:44.939037+03:00" ,
"date_modified" : "2023-07-04T08:29:44.939059+03:00" ,
"deleted" : false ,
"is_test" : true ,
"warehouse" : 34824 ,
"terminal" : 35264 ,
"order_point" : null ,
"warehouse_name" : "Тестовый склад" ,
"terminal_name" : "Тестовая площадка"
}
] ,
"accounts" : {...},
"4022713" : {...}
"firm_type" : "Экспедитор" ,
"firm_id" : 4022713 ,
"account_id" : "4022713" ,
"full_firm_name" : "JtNEFfon8443, ИП" ,
"firm_name" : "JtNEFfon8443" ,
"brand" : null ,
"location" : {...},
"city_id" : 1 ,
"region_id" : 153 ,
"country_id" : 1 ,
"full_name" : "Санкт-Петербург, Санкт-Петербург (регион), Россия" ,
"short_name" : "Санкт-Петербург" ,
"is_regional_center" : true ,
"city_size" : 6 ,
"fias_id" : "c2deb16a-0330-4f05-821f-1d09c93331e6" ,
"attributes" : 2052 ,
"city_name" : "Санкт-Петербург" ,
"region_name" : "Санкт-Петербург (регион)" ,
"country_name" : "Россия" ,
"country_code_name" : "RUS"
} ,
"passport" : {...},
"ati_id" : "4022713" ,
"total_score" : 0 ,
"ati_data_match_point" : 0 ,
"account_lifetime_point" : 0 ,
"business_activity_point" : 0 ,
"round_table_point" : 0 ,
"claim_point" : 0 ,
"prof_activity_point" : 0 ,
"ati_administration_point" : 0 ,
"clones_point" : 0 ,
"egr_point" : 0 ,
"mass_registration_point" : 0 ,
"mass_founder_point" : 0 ,
"firm_lifetime_point" : 0 ,
"guaranteed_payment_point" : 0 ,
"virtual_account_debts_point" : 0 ,
"bad_partner_mentions_point" : 0 ,
"ri_users_attributes" : 100380 ,
"recommendations_count" : 0 ,
"status" : 2 ,
"status_description" : "Отсутствует балл "Аккаунт подтвержден" или cумма любых красных баллов меньше или равна 1" ,
"negative_points_sum" : 0
} ,
"contacts" : [...]
{...}
"id" : 0 ,
"name" : "director"
}
]
}
} ,
"timeslot_filters" : {...}
"timeslot_id" : null ,
"order_point_id" : null ,
"only_timeslots" : false ,
"only_order_points_without_slots" : false
}
}
}
count :
integer
Количество найденных бронирований
id :
integer
Идентификатор бронирования. Если передан, то бронирование будет обновлено
warehouse_info :{...}
Информация о складе, на котором создано бронирование
city_verbose :
string
Название города, в котором находится склад
utc_offset :
integer
Количество минут, на которые время склада отличается от UTC
owner :
integer
Идентификатор фирмы, которой принадлежит склад
}
attached_files :
array
Список приложенных к бронированию файлов
can_be_edited :
boolean
Флаг, указывающий на возможность редактирования бронирования
is_expired :
boolean
Флаг, указывающий просрочено ли временя бронирования
timeslot_readable_id :
string
Человекочитаемый идентификатор бронирования
approve_status :
enum
[approved, decline, await_reaction, await_client]
Статус бронирования
action_type :
enum
[unloading, loading, loading_unloading]
Тип действия на складе
slot_owner :
integer
Идентификатор фирмы пользователя, создавшего бронирования
contact_id :
integer
Идентификатор контакта пользователя, создавшего бронирование
email :
string
Адрес электронной почты создателя бронирования
country_phone_id :
integer
>=0 and <= 4
Идентификатор страны телефона контактного лица. 0-Россия, 1-Украина, 2-Казахстан, 3-Беларусь, 4-Другие
car_number :
string
Государственный регистрационный номер автомобиля
car_capacity :
integer
Грузоподъемность транспортного средства
cargo_owner_contact_name :
string
cargo_owner_contact_number :
string
Телефонный номер грузовладельца
firm_name :
string
Название фирмы перевозчика
data_to :
string
Дата окончания бронирования
date_creation :
string
Дата и время создания бронирования
date_modified :
string
Дата и время изменения бронирования
deleted :
boolean
Флаг, показывающий удалено бронирование или нет
is_test :
boolean
Флаг, показывающий является ли бронирование тестовым
terminal :
integer
Идентификатор площадки погрузки-выгрузки
id :
integer
Идентификатор точки заказа во Временных окнах
id :
integer
Идентификатор склада во Временных окнах
city_verbose :
string
Название города, в котором расположен склад
}
car_number :
string
Государственный регистрационный номер автомобиля
load_owner_contact_id :
integer
(nullable)
cargo_type :
string
Тип груза. Может быть введен пользователем
}]
warehouse_owner :
integer
Идентификатор фирмы, которая владеет складом
type :
enum
[loading, unloading]
Тип точки
}]
}
terminal_name :
string
Название площадки погрузки-выгрузки
}
is_regional_center :
boolean
country_code_name :
string
}
ati_data_match_point :
float
account_lifetime_point :
float
business_activity_point :
float
prof_activity_point :
float
ati_administration_point :
float
mass_registration_point :
float
mass_founder_point :
float
firm_lifetime_point :
float
guaranteed_payment_point :
float
virtual_account_debts_point :
float
bad_partner_mentions_point :
float
ri_users_attributes :
integer
recommendations_count :
integer
status_description :
string
negative_points_sum :
float
}
}
}
only_order_points_without_slots :
boolean
}
}
}
400 Фирма не найдена
Развернуть все
Свернуть все
Пример
Модель
{...}
"error" : "bad_request" ,
"reason" : "Фирма не найдена"
}
reason :
string
Человекочитаемый текст ошибки
}
Загрузка...
Развернуть все
Свернуть все
Загрузка...
Поучение количества бронирований в статусе await_reaction
Возвращается количество бронирований в статусе await_reaction для каждого склада пользователя.
post
/gw/timeslots/api/v1/timeslots/counters
Отправить
Развернуть все
Свернуть все
{
"warehouse_ids": [
34824
]
}
warehouse_ids* :
[integer]
Идентификатор склада во Временных окнах
}
CURL
1C
Пример ответа
Ответ
200 Возвращаются количество бронирований пользователей в статусе await_reaction в переданных складах
Развернуть все
Свернуть все
400 Ошибка валидации. Возникает, когда в какое-то из полей передано недопустимое значение
Развернуть все
Свернуть все
Пример
Модель
{...}
"error" : "bad_request" ,
"reason" : "warehouse_ids должен содержать айдишники складов" ,
"details" : null
}
reason :
string
Человекочитаемый текст ошибки
}
Загрузка...
Развернуть все
Свернуть все
Загрузка...
Получение истории изменений бронирования
Возвращается история изменения бронирования
get
/gw/timeslots/api/v1/timeslots/history/{timeslot_id}
Отправить
CURL
1C
Пример ответа
Ответ
200 Возвращается история изменений бронирования
Развернуть все
Свернуть все
Пример
Модель
{...}
"ok" : true ,
"result" : {...}
"history_changes" : [...]
{...},
"iso_warehouse_local_datetime" : "2023-07-05T08:19:13.132092+03:00" ,
"changes" : {...}
"updated" : [...],
{...}
"field" : {...}
"name" : "comment" ,
"old_value" : "Тестовый комментарий" ,
"new_value" : "Измененный комментарий"
}
}
] ,
}
} ,
{...}
"iso_warehouse_local_datetime" : "2023-07-04T08:29:44.939059+03:00" ,
"changes" : {...}
"created" : [...],
{...},
"field" : {...}
"name" : "timeslot_created" ,
"old_value" : null ,
"new_value" : null
}
} ,
{...}
"field" : {...}
"name" : "staying_statuses" ,
"old_value" : null ,
}
}
] ,
}
}
]
}
}
iso_warehouse_local_datetime :
string
Время изменения в локальном времени склада
}]
}
}
404 Бронирование не найдено
Развернуть все
Свернуть все
Пример
Модель
{...}
"error" : "not_found" ,
"reason" : "Timeslot not found"
}
reason :
string
Человекочитаемый текст ошибки
}
Загрузка...
Развернуть все
Свернуть все
Загрузка...