API web-to-print TCSДокументация для разработчиков
Информация о списке заказов
Возвращает полные данные сразу по нескольким заказам.
Ссылка на API
https://your_site/api/order/arrayInfoПараметры запроса
Метод вызывается через POST. Поле key передаётся на верхнем уровне, а параметры метода - в объекте data.
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
key | String | Да | Секретный API-ключ, выданный для сайта. |
data | Object | Да | Контейнер параметров конкретного метода. |
data.ids | array, обязательный | Да | массив числовых ID. |
Пример запроса
POST /api/order/arrayInfo
Content-Type: application/json
{
"key": "ваш-api-ключ",
"data": {
"ids": [
1024,
1025
]
}
}Параметры ответа
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
success | Boolean | Да | true при успешном JSON-ответе; false при ошибке. |
error | Array / Object | Да | Пустой массив либо объект ошибки. |
error.code | Integer | Нет | Код ошибки. |
error.message | String | Нет | Текст ошибки. |
data.orders[] | Array<Object> | Да | Карточки найденных заказов в формате /api/order/info. |
data.errors[] | Array | Нет | Ошибки обработки отдельных ID. |
Пример успешного ответа
{
"success": true,
"error": [],
"data": [
"..."
]
}