Skip to content
Мои токены Поддержка
Для подтверждения действия введите пароль
Чтобы продолжить, введите пароль для пользователя
llms.txt: canonical markdown source for this page

Методы для работы со складами

Добавление или изменение склада

Чтобы изменить существующий склад, надо передать поле id с идентификатором склада. Если id не передать, то будет создан новый склад. В ответ на запрос возвращается созданный или изменённый склад.

post /gw/timeslots/api/v1/warehouse
Запрос
Модель
{...}
id: integer

Идентификатор склада. Если указан, то при наличии склада в системе, его данные будут обновлены

name*: string

Название склада

address*: string

Адрес склада

city_id*: integer

Идентификатор города. Ему соответствует название города из словаря

}
Пример запроса
curl 'https://api.ati.su/gw/timeslots/api/v1/warehouse' \
-X 'POST' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"Тестовый склад","address":"Гельсингфорсская улица, 2А","city_id":1,"contacts":[{"name":"Имя менеджера склада","phone":"+7 000 000-00-00","country_phone_id":0}],"schedule":[{"time_from":"00:00","time_to":"23:59","day_of_week":1},{"time_from":"00:00","time_to":"23:59","day_of_week":2},{"time_from":"00:00","time_to":"23:59","day_of_week":3},{"time_from":"00:00","time_to":"23:59","day_of_week":4},{"time_from":"00:00","time_to":"23:59","day_of_week":5},{"time_from":"00:00","time_to":"23:59","day_of_week":6},{"time_from":"00:00","time_to":"23:59","day_of_week":7}]}'
Ответ
200 Возвращаются актуальные данные созданного или измененного склада
Модель
{...}
ok: boolean
}
Пример
{...}
"ok":true,
"result":{...}
"warehouse":{...}
"id":29583,
"schedule":[...],
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"1"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"2"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"3"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"4"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"5"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"6"
},
{...}
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"7"
}
],
"contacts":[...],
{...}
"id":31311,
"name":"Имя менеджера склада",
"phone":"+7 000 000-00-00",
"country_phone_id":"0",
"warehouse":29583
}
],
"name":"Тестовый склад",
"address":"Гельсингфорсская улица, 2А",
"owner":9338034,
"city_id":1,
"country_id":1,
"region_id":153,
"city_verbose":"Санкт-Петербург, РФ",
"utc_offset":180,
"date_creation":"2023-06-27T09:57:27.615139+03:00",
"date_modified":"2023-06-27T09:57:27.615186+03:00",
"deleted":false,
"is_test":true
}
}
}
400 Ошибка валидации. Возникает, когда в какое-то из полей передано недопустимое значение
Модель
ANY-OF
Пример
{...}
"error":"multiple_errors",
"error_list":[...],
{...},
"error":"non_field_errors",
"reason":"Ожидался list со значениями, но был получен "str"."
},
{...}
"error":"non_field_errors",
"reason":"Ожидался list со значениями, но был получен "str"."
}
],
"reason":"invalid"
}

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

Возвращается список складов, принадлежащих пользователю, а также список партнерских складов.

get /gw/timeslots/api/v1/warehouse
Запрос
Пример запроса
curl 'https://api.ati.su/gw/timeslots/api/v1/warehouse' \
-X 'GET' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200 Возвращаются все склады пользователя
Модель
{...}
partners_warehouses_count: integer

Количество складов, с которыми у пользователя установлена связь

count: integer

Количество складов

}
Пример
{...}
"ok":true,
"result":{...}
"partners_warehouses_count":0,
"partners_warehouses":[],
"count":1,
"warehouses":[...]
{...}
"id":34823,
"schedule":[...],
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"1"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"2"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"3"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"4"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"5"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"6"
},
{...}
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"7"
}
],
"contacts":[...],
{...}
"id":36735,
"name":"Имя менеджера склада",
"phone":"+7 000 000-00-00",
"country_phone_id":"0",
"warehouse":34823
}
],
"sms_enabled":false,
"name":"Тестовый склад",
"address":"Гельсингфорсская улица, 2А",
"owner":4022713,
"city_id":1,
"country_id":1,
"region_id":153,
"city_verbose":"Санкт-Петербург, РФ",
"utc_offset":180,
"date_creation":"2023-07-04T06:57:45.295611+03:00",
"date_modified":"2023-07-04T06:57:45.295633+03:00",
"deleted":false,
"is_test":true
}
]
}
}

Удаление складов

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

delete /gw/timeslots/api/v1/warehouse
Запрос
Модель
{...}
warehouse_ids*: [integer]

Список идентификаторов складов, которые нужно удалить

}
Пример запроса
curl 'https://api.ati.su/gw/timeslots/api/v1/warehouse' \
-X 'DELETE' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '{"warehouse_ids":[34823]}'
Ответ
200 Возвращаются актуальные данные созданного или измененного склада
Модель
{...}
ok: boolean
}
Пример
{...}
"ok":true,
"result":{...}
"200":[...],
34823
],
"400":[],
"500":[]
}
}
400 Ошибка валидации. Возникает, когда в какое-то из полей передано недопустимое значение
Модель
ANY-OF
Пример
{...}
"error":"bad request",
"reason":"Необходимо передать список warehouse_ids",
"details":null
}

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

get /gw/timeslots/api/v1/warehouse/{warehouse_id}
Запрос
Пример запроса
curl 'https://api.ati.su/gw/timeslots/api/v1/warehouse/{warehouse_id}' \
-X 'GET' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200 Возвращается информация о складе с указанным идентификатором
Модель
{...}
ok: boolean
}
Пример
{...}
"ok":true,
"result":{...}
"warehouse":{...}
"id":34823,
"schedule":[...],
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"1"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"2"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"3"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"4"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"5"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"6"
},
{...}
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"7"
}
],
"contacts":[...],
{...}
"id":36735,
"name":"Имя менеджера склада",
"phone":"+7 000 000-00-00",
"country_phone_id":"0",
"warehouse":34823
}
],
"sms_enabled":false,
"name":"Тестовый склад",
"address":"Гельсингфорсская улица, 2А",
"owner":4022713,
"city_id":1,
"country_id":1,
"region_id":153,
"city_verbose":"Санкт-Петербург, РФ",
"utc_offset":180,
"date_creation":"2023-07-04T06:57:45.295611+03:00",
"date_modified":"2023-07-04T06:57:45.295633+03:00",
"deleted":false,
"is_test":true
}
}
}
404 Склад не найден
Модель
{...}

Одиночная ошибка

error: string

Текстовый код ошибки

reason: string

Человекочитаемый текст ошибки

}
Пример
{...}
"error":"not_found",
"reason":"Склад не найден",
"details":null
}

Получение информации о загрузке склада

get /gw/timeslots/api/v1/warehouse/workload/{warehouse_id}
Запрос
Пример запроса
curl 'https://api.ati.su/gw/timeslots/api/v1/warehouse/workload/{warehouse_id}' \
-X 'GET' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200 Возвращается информация о загруженности склада с указанным идентификатором и указанным типом загрузки
Модель
{...}
ok: boolean
}
Пример
{...}
"ok":true,
"result":{...}
"workload":[...],
{...},
"date":"2023-07-04T04:26:09.706493Z",
"weekday":2,
"possible_slots_count":24,
"available_slots_count":24,
"loading_level":"low"
},
{...},
"date":"2023-07-05T04:26:09.706493Z",
"weekday":3,
"possible_slots_count":24,
"available_slots_count":24,
"loading_level":"low"
},
{...},
"date":"2023-07-06T04:26:09.706493Z",
"weekday":4,
"possible_slots_count":24,
"available_slots_count":24,
"loading_level":"low"
},
{...},
"date":"2023-07-07T04:26:09.706493Z",
"weekday":5,
"possible_slots_count":24,
"available_slots_count":24,
"loading_level":"low"
},
{...},
"date":"2023-07-08T04:26:09.706493Z",
"weekday":6,
"possible_slots_count":24,
"available_slots_count":24,
"loading_level":"low"
},
{...},
"date":"2023-07-09T04:26:09.706493Z",
"weekday":7,
"possible_slots_count":24,
"available_slots_count":24,
"loading_level":"low"
},
{...},
"date":"2023-07-10T04:26:09.706493Z",
"weekday":1,
"possible_slots_count":24,
"available_slots_count":24,
"loading_level":"low"
},
{...},
"date":"2023-07-11T04:26:09.706493Z",
"weekday":2,
"possible_slots_count":24,
"available_slots_count":24,
"loading_level":"low"
},
{...},
"date":"2023-07-12T04:26:09.706493Z",
"weekday":3,
"possible_slots_count":24,
"available_slots_count":24,
"loading_level":"low"
},
{...},
"date":"2023-07-13T04:26:09.706493Z",
"weekday":4,
"possible_slots_count":24,
"available_slots_count":24,
"loading_level":"low"
},
{...},
"date":"2023-07-14T04:26:09.706493Z",
"weekday":5,
"possible_slots_count":24,
"available_slots_count":24,
"loading_level":"low"
},
{...},
"date":"2023-07-15T04:26:09.706493Z",
"weekday":6,
"possible_slots_count":24,
"available_slots_count":24,
"loading_level":"low"
},
{...},
"date":"2023-07-16T04:26:09.706493Z",
"weekday":7,
"possible_slots_count":24,
"available_slots_count":24,
"loading_level":"low"
},
{...}
"date":"2023-07-17T04:26:09.706493Z",
"weekday":1,
"possible_slots_count":24,
"available_slots_count":24,
"loading_level":"low"
}
],
"warehouse":{...}
"id":34823,
"schedule":[...],
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"1"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"2"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"3"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"4"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"5"
},
{...},
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"6"
},
{...}
"time_from":"00:00",
"time_to":"23:59",
"day_of_week":"7"
}
],
"contacts":[...],
{...}
"id":36735,
"name":"Имя менеджера склада",
"phone":"+7 000 000-00-00",
"country_phone_id":"0",
"warehouse":34823
}
],
"sms_enabled":false,
"name":"Тестовый склад",
"address":"Гельсингфорсская улица, 2А",
"owner":4022713,
"city_id":1,
"country_id":1,
"region_id":153,
"city_verbose":"Санкт-Петербург, РФ",
"utc_offset":180,
"date_creation":"2023-07-04T06:57:45.295611+03:00",
"date_modified":"2023-07-04T06:57:45.295633+03:00",
"deleted":false,
"is_test":true
}
}
}
404 Склад не найден
Модель
{...}

Одиночная ошибка

error: string

Текстовый код ошибки

reason: string

Человекочитаемый текст ошибки

}
Пример
{...}
"error":"not_found",
"reason":"Склад не найден",
"details":null
}