API web-to-print TCSДокументация для разработчиков
Поиск по заказам
Ищет активные заказы. В выдаче не более 1000 записей.
Ссылка на API
https://your_site/api/order/searchПараметры запроса
Метод вызывается через POST. Поле key передаётся на верхнем уровне, а параметры метода - в объекте data.
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
key | String | Да | Секретный API-ключ, выданный для сайта. |
data | Object | Да | Контейнер параметров конкретного метода. |
data.status | integer | Нет | integer, необязательный |
data.dateCreateFrom | string | Нет | string, необязательный, дата от |
data.dateCreateTo | string | Нет | string, необязательный, дата до. |
Пример запроса
POST /api/order/search
Content-Type: application/json
{
"key": "ваш-api-ключ",
"data": {
"status": 1
}
}Параметры ответа
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
success | Boolean | Да | true при успешном JSON-ответе; false при ошибке. |
error | Array / Object | Да | Пустой массив либо объект ошибки. |
error.code | Integer | Нет | Код ошибки. |
error.message | String | Нет | Текст ошибки. |
data[] | Array<Object> | Да | До 1000 активных заказов. |
data[].id | Integer | Да | ID заказа в TCS. |
data[].status | Integer | Да | ID текущего статуса. |
data[].sum | Number | Да | Итоговая сумма с доставкой. |
data[].dateCreate | String | Да | Дата создания заказа. |
Пример успешного ответа
{
"success": true,
"error": [],
"data": [
"..."
]
}