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

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

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

post

/gw/timeslots/api/v1/warehouse

Развернуть все Свернуть все

body

object

{...}

id: integer

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

name*: string

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

address*: string

Адрес склада

city_id*: integer

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

contacts*:[{...}]

Контакты контактного лица/лиц склада

id: integer

Идентификатор контакта во временных окнах

name*: string

Имя контактного лица

phone*: string

Телефон контактного лица

country_phone_id*: integer

>=0 and <= 4

Идентификатор страны телефона контактного лица. 0-Россия, 1-Украина, 2-Казахстан, 3-Беларусь, 4-Другие

}]

schedule*:[{...}]

Список рабочих дней склада

time_from*: string

Время начала работы склада

time_to*: string

Время окончания работы склада

day_of_week*: integer

>=1 and <= 7

Идентификатор дня недели. 1-Понедельник, 2-Вторник, 3-Среда и т. д.

}]

}

CURL

Копировать

Пример ответа

Ответ

200 Возвращаются актуальные данные созданного или измененного склада

Развернуть все Свернуть все

Пример

Модель

{...}

"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

}

{...}

ok: boolean

result:{...}

warehouse:{...}

id: integer

Идентификатор склада

owner: integer

Идентификатор фирмы владельца склада

country_id: integer

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

region_id: integer

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

city_verbose: string

Название города

utc_offset: integer

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

date_creation: string

Дата создания склада

date_modified: string

Дата изменения склада

deleted: boolean

Флаг, показывающий удален склад или нет

is_test: boolean

Флаг, показывающий является ли склад тестовым

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

address: string

Адрес склада

city_id: integer

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

contacts:[{...}]

Контакты контактного лица/лиц склада

id: integer

Идентификатор контакта во временных окнах

name*: string

Имя контактного лица

phone*: string

Телефон контактного лица

country_phone_id*: integer

>=0 and <= 4

Идентификатор страны телефона контактного лица. 0-Россия, 1-Украина, 2-Казахстан, 3-Беларусь, 4-Другие

}]

schedule:[{...}]

Список рабочих дней склада

time_from*: string

Время начала работы склада

time_to*: string

Время окончания работы склада

day_of_week*: integer

>=1 and <= 7

Идентификатор дня недели. 1-Понедельник, 2-Вторник, 3-Среда и т. д.

}]

}

400 Ошибка валидации. Возникает, когда в какое-то из полей передано недопустимое значение

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"multiple_errors",

"error_list":[...],

{...},

"error":"non_field_errors",

"reason":"Ожидался list со значениями, но был получен "str"."

{...}

"error":"non_field_errors",

"reason":"Ожидался list со значениями, но был получен "str"."

}

"reason":"invalid"

}

ANY-OF

1:{...}

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

error: string

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

reason: string

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

}

2:{...}

Множественная ошибка

error: string

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

reason: string

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

error_list:[{...}]

Список возникших ошибок

error: string

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

reason: string

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

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

get

/gw/timeslots/api/v1/warehouse

CURL

Копировать

Пример ответа

Ответ

200 Возвращаются все склады пользователя

Развернуть все Свернуть все

Пример

Модель

{...}

"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

}

]

}

{...}

partners_warehouses_count: integer

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

partners_warehouses:[{...}]

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

id: integer

Идентификатор склада

owner: integer

Идентификатор фирмы владельца склада

country_id: integer

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

region_id: integer

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

city_verbose: string

Название города

utc_offset: integer

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

date_creation: string

Дата создания склада

date_modified: string

Дата изменения склада

deleted: boolean

Флаг, показывающий удален склад или нет

is_test: boolean

Флаг, показывающий является ли склад тестовым

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

address: string

Адрес склада

city_id: integer

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

contacts:[{...}]

Контакты контактного лица/лиц склада

id: integer

Идентификатор контакта во временных окнах

name*: string

Имя контактного лица

phone*: string

Телефон контактного лица

country_phone_id*: integer

>=0 and <= 4

Идентификатор страны телефона контактного лица. 0-Россия, 1-Украина, 2-Казахстан, 3-Беларусь, 4-Другие

}]

schedule:[{...}]

Список рабочих дней склада

time_from*: string

Время начала работы склада

time_to*: string

Время окончания работы склада

day_of_week*: integer

>=1 and <= 7

Идентификатор дня недели. 1-Понедельник, 2-Вторник, 3-Среда и т. д.

}]

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

warehouses:[{...}]

Список складов

id: integer

Идентификатор склада

owner: integer

Идентификатор фирмы владельца склада

country_id: integer

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

region_id: integer

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

city_verbose: string

Название города

utc_offset: integer

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

date_creation: string

Дата создания склада

date_modified: string

Дата изменения склада

deleted: boolean

Флаг, показывающий удален склад или нет

is_test: boolean

Флаг, показывающий является ли склад тестовым

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

address: string

Адрес склада

city_id: integer

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

contacts:[{...}]

Контакты контактного лица/лиц склада

id: integer

Идентификатор контакта во временных окнах

name*: string

Имя контактного лица

phone*: string

Телефон контактного лица

country_phone_id*: integer

>=0 and <= 4

Идентификатор страны телефона контактного лица. 0-Россия, 1-Украина, 2-Казахстан, 3-Беларусь, 4-Другие

}]

schedule:[{...}]

Список рабочих дней склада

time_from*: string

Время начала работы склада

time_to*: string

Время окончания работы склада

day_of_week*: integer

>=1 and <= 7

Идентификатор дня недели. 1-Понедельник, 2-Вторник, 3-Среда и т. д.

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

delete

/gw/timeslots/api/v1/warehouse

Развернуть все Свернуть все

body

object

{...}

warehouse_ids*: [integer]

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

}

CURL

Копировать

Пример ответа

Ответ

200 Возвращаются актуальные данные созданного или измененного склада

Развернуть все Свернуть все

Пример

Модель

{...}

"ok":true,

"result":{...}

"200":[...],

34823

"400":[],

"500":[]

}

{...}

ok: boolean

result:{...}

200: [integer]

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

400: [integer]

Список идентификаторов складов, при удалении которых возникли ошибки валидации

500: [integer]

Список идентификаторов складов, при удалении которых возникли ошибки сервера

}

400 Ошибка валидации. Возникает, когда в какое-то из полей передано недопустимое значение

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"bad request",

"reason":"Необходимо передать список warehouse_ids",

"details":null

}

ANY-OF

1:{...}

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

error: string

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

reason: string

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

}

2:{...}

Множественная ошибка

error: string

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

reason: string

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

error_list:[{...}]

Список возникших ошибок

error: string

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

reason: string

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

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

get

/gw/timeslots/api/v1/warehouse/{warehouse_id}

warehouse_id

integer

CURL

Копировать

Пример ответа

Ответ

200 Возвращается информация о складе с указанным идентификатором

Развернуть все Свернуть все

Пример

Модель

{...}

"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

}

{...}

ok: boolean

result:{...}

id: integer

Идентификатор склада

owner: integer

Идентификатор фирмы владельца склада

country_id: integer

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

region_id: integer

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

city_verbose: string

Название города

utc_offset: integer

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

date_creation: string

Дата создания склада

date_modified: string

Дата изменения склада

deleted: boolean

Флаг, показывающий удален склад или нет

is_test: boolean

Флаг, показывающий является ли склад тестовым

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

address: string

Адрес склада

city_id: integer

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

contacts:[{...}]

Контакты контактного лица/лиц склада

id: integer

Идентификатор контакта во временных окнах

name*: string

Имя контактного лица

phone*: string

Телефон контактного лица

country_phone_id*: integer

>=0 and <= 4

Идентификатор страны телефона контактного лица. 0-Россия, 1-Украина, 2-Казахстан, 3-Беларусь, 4-Другие

}]

schedule:[{...}]

Список рабочих дней склада

time_from*: string

Время начала работы склада

time_to*: string

Время окончания работы склада

day_of_week*: integer

>=1 and <= 7

Идентификатор дня недели. 1-Понедельник, 2-Вторник, 3-Среда и т. д.

}]

}

404 Склад не найден

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"not_found",

"reason":"Склад не найден",

"details":null

}

{...}

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

error: string

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

reason: string

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

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

get

/gw/timeslots/api/v1/warehouse/workload/{warehouse_id}

warehouse_id

integer

loading_type

string

Cоответствует типу загрузки площадки погрузки-выгрузки

CURL

Копировать

Пример ответа

Ответ

200 Возвращается информация о загруженности склада с указанным идентификатором и указанным типом загрузки

Развернуть все Свернуть все

Пример

Модель

{...}

"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

}

{...}

ok: boolean

result:{...}

workload:[{...}]

date: string

weekday: integer

>=1 and <= 7

Идентификатор дня недели. 1-Понедельник, 2-Вторник, 3-Среда и т. д.

possible_slots_count: integer

available_slots_count: integer

loading_level: enum

[low, middle, high]

}]

warehouse:{...}

id: integer

Идентификатор склада

owner: integer

Идентификатор фирмы владельца склада

country_id: integer

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

region_id: integer

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

city_verbose: string

Название города

utc_offset: integer

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

date_creation: string

Дата создания склада

date_modified: string

Дата изменения склада

deleted: boolean

Флаг, показывающий удален склад или нет

is_test: boolean

Флаг, показывающий является ли склад тестовым

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

address: string

Адрес склада

city_id: integer

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

contacts:[{...}]

Контакты контактного лица/лиц склада

id: integer

Идентификатор контакта во временных окнах

name*: string

Имя контактного лица

phone*: string

Телефон контактного лица

country_phone_id*: integer

>=0 and <= 4

Идентификатор страны телефона контактного лица. 0-Россия, 1-Украина, 2-Казахстан, 3-Беларусь, 4-Другие

}]

schedule:[{...}]

Список рабочих дней склада

time_from*: string

Время начала работы склада

time_to*: string

Время окончания работы склада

day_of_week*: integer

>=1 and <= 7

Идентификатор дня недели. 1-Понедельник, 2-Вторник, 3-Среда и т. д.

}]

}

404 Склад не найден

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"not_found",

"reason":"Склад не найден",

"details":null

}

{...}

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

error: string

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

reason: string

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

}

Загрузка...

Развернуть все Свернуть все

Загрузка...