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