API web-to-print TCSДокументация для разработчиков
Главная / Товары

Информация о товаре

Возвращает полную карточку позиции, связанного заказа, параметров производства и макетов.

Ссылка на API

https://your_site/api/orderProduct/info

Параметры запроса

Метод вызывается через POST. Поле key передаётся на верхнем уровне, а параметры метода - в объекте data.

ПолеТипОбязательноеОписание
keyStringДаСекретный API-ключ, выданный для сайта.
dataObjectДаКонтейнер параметров конкретного метода.
data.idIntegerНетID товарной позиции заказа в TCS. Передайте либо id, либо number.
data.numberStringНетВнешний номер сущности в подключённой системе. Передайте либо number, либо id.

Пример запроса

POST /api/orderProduct/info
Content-Type: application/json

{
    "key": "ваш-api-ключ",
    "data": {
        "id": 1024
    }
}

Параметры ответа

ПолеТипОбязательноеОписание
successBooleanДаtrue при успешном JSON-ответе; false при ошибке.
errorArray / ObjectДаПустой массив либо объект ошибки.
error.codeIntegerНетКод ошибки.
error.messageStringНетТекст ошибки.
data.idIntegerДаID товарной позиции.
data.numberStringНетМожет отсутствовать. Номер позиции.
data.statusIntegerДаID статуса.
data.sumNumberДаИтоговая стоимость позиции.
data.quantityIntegerДаКоличество.
data.weightNumberДаВес.
data.productionDateStringДаДата производства.
data.productObjectДаid, name, vendorCode и подключённые SKU.
data.layoutObjectНетstatus и ссылки/архивы подготовленного либо исходного макета.
data.productParametersObjectДаsize, parts, press, postPress, accessories, souvenirGoods, additionalServices, packaging.
data.orderObjectДаКарточка заказа в формате /api/order/info.

Пример успешного ответа

{
    "success": true,
    "error": [],
    "data": [
        "..."
    ]
}
Ошибки: API может вернуть коды 1 - авторизация, 2 - данные не найдены, 3 - сохранение, 4 - недостаточно данных, 5 - неверный формат, 6 - валидация, 7 - доступ, 8 - не указан менеджер.