Skip to content
Для ИИ NEW Мои токены Поддержка
Для подтверждения действия введите пароль
Чтобы продолжить, введите пароль для пользователя
For LLMs and AI agents: canonical Markdown source of this documentation page (plain-text .md — fetch this URL to use the page content in tools and RAG). For LLMs and AI agents: developers documentation index in llms.txt format — ordered list of key documentation URLs for the developers section.

Методы для работы с площадками погрузки-выгрузки

Добавление или изменение площадки погрузки-выгрузки

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

Создаёт или изменяет площадку склада. Без ненулевого id создаёт площадку, с id изменяет существующую. Доступно только владельцу неудалённого склада. warehouse нельзя изменить. schedule и contacts обязательны и полностью заменяют прежние значения. Отсутствующий warehouse_cargo_types очищает принимаемые типы грузов. Типы грузов должны принадлежать переданному складу. Расписание использует локальное время склада: начало раньше конца, один рабочий интервал на день; перерывы внутри рабочего интервала без пересечений. Идентификатор склада можно получить через GET /api/v1/warehouse.
post /gw/timeslots/api/v1/terminal
Параметры
Параметров нет
Запрос
Модель
{...}

Создание или изменение площадки склада.

name*: string
От (1 до 280 символов)

Название площадки

loading_type: enum
[any, up, lateral]
  • any - Любая
  • up - Сверху
  • lateral - Боковая
deleted: boolean

Удален

is_test: boolean

Тестовый

warehouse*: integer

Идентификатор склада. Источник: GET /gw/timeslots/api/v1/warehouse, поле result.warehouses[].id или result.partners_warehouses[].id. При создании склада: POST /gw/timeslots/api/v1/warehouse, поле result.warehouse.id. Используйте неудалённый склад, доступный для выбранной операции.

warehouse_cargo_types: [uuid]

UUID типов груза из справочника склада, не числовые ID общего словаря грузов ATI. Уже назначенные площадкам типы доступны через GET /gw/timeslots/api/v1/terminal: result.terminals[].warehouse_cargo_types[].id или result.partners_terminals[].warehouse_cargo_types[].id. Это только типы выбранных площадок, не полный справочник склада. Используйте типы своего выбранного склада; если они не нужны, не передавайте поле. При изменении отсутствие поля или [] очищает типы площадки.

id: integer

Идентификатор изменяемой площадки. Без id или с 0 создаётся новая.

}
Пример запроса
curl 'https://api.ati.su/gw/timeslots/api/v1/terminal' \
-X 'POST' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '{"warehouse":101,"name":"Ворота № 2","schedule":[{"day_of_week":"1","time_from":"08:00:00","time_to":"18:00:00"}],"contacts":[]}'
Ответ
200
Модель
{...}

Успешный ответ.

ok: boolean

Признак успешного выполнения запроса.

}
Пример
{...}
"result":{...},
"terminal":{...}
"contacts":[...],
{...}
"name":"string",
"phone":"string",
"country_phone_id":"string"
}
],
"name":"string",
"loading_type":"any",
"deleted":false,
"is_test":false,
"warehouse":1
}
},
"ok":true
}
400 Некорректные поля, расписание или нет доступа к складу.
Модель
{...}

Ошибка запроса с подробностями по отдельным полям.

error*: string

Машиночитаемый код ошибки.

reason*: string

Описание причины ошибки.

}
Пример
{...}
"error":"bad_request",
"reason":"warehouse_ids должен быть списком",
"error_list":[...]
{...}
"error":"bad_request",
"reason":"warehouse_ids должен быть списком"
}
]
}
403 Контекст пользователя отсутствует или некорректен.
Модель
{...}

Ошибка API: код и причина.

error*: string

Машиночитаемый код ошибки.

reason*: string

Описание причины ошибки.

}
Пример
{...}
"error":"bad_request",
"reason":"warehouse_ids должен быть списком"
}
404 Площадка не найдена или недоступна пользователю.
Модель
{...}

Ошибка API: код и причина.

error*: string

Машиночитаемый код ошибки.

reason*: string

Описание причины ошибки.

}
Пример
{...}
"error":"bad_request",
"reason":"warehouse_ids должен быть списком"
}

Получение площадок погрузки-выгрузки

Возвращается список площадок погрузки и выгрузки пользователя.

Получает собственные и партнёрские площадки. terminals содержит площадки складов фирмы пользователя. partners_terminals — площадки чужих складов с принятой неудалённой связью со Справочниками фирмы. count учитывает только terminals. Пагинации и фильтров нет; порядок — от новых к старым. Удалённые площадки и площадки удалённых складов также могут присутствовать; проверяйте deleted. Полученный id используется для изменения или удаления площадки.
get /gw/timeslots/api/v1/terminal
Параметры
Параметров нет
Запрос
Пример запроса
curl 'https://api.ati.su/gw/timeslots/api/v1/terminal' \
-X 'GET' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200
Модель
{...}

Успешный ответ.

ok: boolean

Признак успешного выполнения запроса.

}
Пример
{...}
"result":{...},
"count":1,
"terminals":[...],
{...}
"contacts":[...],
{...}
"name":"string",
"phone":"string",
"country_phone_id":"string"
}
],
"name":"string",
"loading_type":"any",
"deleted":false,
"is_test":false,
"warehouse":1
}
],
"partners_terminals":[...]
{...}
"contacts":[...],
{...}
"name":"string",
"phone":"string",
"country_phone_id":"string"
}
],
"name":"string",
"loading_type":"any",
"deleted":false,
"is_test":false,
"warehouse":1
}
]
},
"ok":true
}
403 Контекст пользователя отсутствует или некорректен.
Модель
{...}

Ошибка API: код и причина.

error*: string

Машиночитаемый код ошибки.

reason*: string

Описание причины ошибки.

}
Пример
{...}
"error":"bad_request",
"reason":"warehouse_ids должен быть списком"
}

Удаление площадок погрузки-выгрузки

Удаляет площадки склада. Только владелец склада может удалить его неудалённую площадку. Последнюю неудалённую площадку склада удалить нельзя. Площадка помечается удалённой, её расписание, контакты и связи с типами груза очищаются; брони сохраняются. HTTP 200 возможен при частичном или полном отказе: проверяйте result['200'] и result['400']. ID обрабатываются последовательно, повторы не удаляются. При ошибке размера ID обработка прерывается с 400, ранее выполненные удаления сохраняются. Числовые строки допустимы и возвращаются строками.
delete /gw/timeslots/api/v1/terminal
Параметры
Параметров нет
Запрос
Модель
{...}

Список удаляемых площадок.

terminal_ids*: [integer]

Идентификаторы удаляемых площадок; допускаются числовые строки.

}
Пример запроса
curl 'https://api.ati.su/gw/timeslots/api/v1/terminal' \
-X 'DELETE' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '{"terminal_ids":[0]}'
Ответ
200
Модель
{...}

Успешный ответ.

ok: boolean

Признак успешного выполнения запроса.

}
Пример
{...}
"result":{...},
"200":[...],
null
],
"400":[...],
null
],
"500":[...]
null
]
},
"ok":true
}
400 Некорректный список или размер ID.
Модель
{...}

Ошибка запроса с подробностями по отдельным полям.

error*: string

Машиночитаемый код ошибки.

reason*: string

Описание причины ошибки.

}
Пример
{...}
"error":"bad_request",
"reason":"warehouse_ids должен быть списком"
}
403 Контекст пользователя отсутствует или некорректен.
Модель
{...}

Ошибка API: код и причина.

error*: string

Машиночитаемый код ошибки.

reason*: string

Описание причины ошибки.

}
Пример
{...}
"error":"bad_request",
"reason":"warehouse_ids должен быть списком"
}