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