API web-to-print TCSДокументация для разработчиков
История изменения по заказам
Возвращает изменения статусов и признака оплаты за интервал.
Ссылка на API
https://your_site/api/order/historyПараметры запроса
Метод вызывается через POST. Поле key передаётся на верхнем уровне, а параметры метода - в объекте data.
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
key | String | Да | Секретный API-ключ, выданный для сайта. |
data | Object | Да | Контейнер параметров конкретного метода. |
data.dateFrom | string, обязательный | Да | string, обязательный |
data.dateTo | string, обязательный. | Да | string, обязательный. |
Пример запроса
POST /api/order/history
Content-Type: application/json
{
"key": "ваш-api-ключ",
"data": {
"dateFrom": "2025-01-01",
"dateTo": "2025-01-31"
}
}Параметры ответа
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
success | Boolean | Да | true при успешном JSON-ответе; false при ошибке. |
error | Array / Object | Да | Пустой массив либо объект ошибки. |
error.code | Integer | Нет | Код ошибки. |
error.message | String | Нет | Текст ошибки. |
data[] | Array<Object> | Да | Изменения за период. |
data[].id | Integer | Да | ID заказа. |
data[].changedFields[] | Array<Object> | Да | Изменённые поля. |
data[].changedFields[].field | String | Да | status или paid. |
data[].changedFields[].oldValue | Mixed | Нет | Может отсутствовать. Значение до изменения. |
data[].changedFields[].value | Mixed | Да | Новое значение. |
Пример успешного ответа
{
"success": true,
"error": [],
"data": [
"..."
]
}