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

Информация о заказе

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

Ссылка на API

https://your_site/api/order/info

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

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

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

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

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

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

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

ПолеТипОбязательноеОписание
successBooleanДаtrue при успешном JSON-ответе; false при ошибке.
errorArray / ObjectДаПустой массив либо объект ошибки.
error.codeIntegerНетКод ошибки.
error.messageStringНетТекст ошибки.
data.idIntegerДаID заказа в TCS.
data.numberStringНетМожет отсутствовать. Внешний номер заказа, если он был присвоен.
data.statusIntegerДаID текущего статуса заказа.
data.paymentMethodIntegerДаID выбранного способа оплаты.
data.dateCreateStringДаДата и время создания заказа.
data.paidIntegerДаПризнак оплаты: 0 - не оплачен, 1 - оплачен.
data.trustedIntegerДаПризнак доверенного заказа: 0 - нет, 1 - да.
data.sumNumberДаПолная стоимость заказа вместе с доставкой.
data.paymentsSumNumberДаСумма всех зарегистрированных платежей.
data.sumToPayNumberДаСумма, остающаяся к оплате.
data.clientObjectНетМожет отсутствовать. Клиент физического лица.
data.client.nameStringНетМожет отсутствовать. Имя клиента.
data.client.surnameStringНетМожет отсутствовать. Фамилия клиента.
data.client.patronymicStringНетМожет отсутствовать. Отчество клиента.
data.client.emailStringНетМожет отсутствовать. E-mail клиента.
data.client.phoneStringНетМожет отсутствовать. Телефон клиента.
data.deliveryObjectНетМожет отсутствовать. Выбранный способ доставки.
data.delivery.nameStringНетМожет отсутствовать. Полное наименование службы/способа доставки.
data.delivery.sumNumberНетМожет отсутствовать. Фактическая стоимость доставки.
data.delivery.deliveryTrackStringНетМожет отсутствовать. Трек-номер отправления.
data.delivery.pointNameStringНетМожет отсутствовать. Название пункта выдачи.
data.delivery.pointAddressStringНетМожет отсутствовать. Адрес пункта выдачи.
data.payerObjectНетМожет отсутствовать. Плательщик, на которого оформляются документы.
data.payer.nameStringНетМожет отсутствовать. Наименование или ФИО плательщика.
data.payer.innStringНетМожет отсутствовать. ИНН плательщика.
data.payer.kppStringНетМожет отсутствовать. КПП плательщика.
data.payer.addressStringНетМожет отсутствовать. Юридический адрес.
data.payer.mailingAddressStringНетМожет отсутствовать. Почтовый адрес.
data.payer.taxBooleanНетМожет отсутствовать. Признак применения НДС.
data.payer.selsdIntegerНетМожет отсутствовать. Признак подключения к ЭДО: 0 или 1.
data.recipientObjectНетМожет отсутствовать. Получатель заказа.
data.recipient.nameStringНетМожет отсутствовать. Имя/наименование получателя.
data.recipient.phoneStringНетМожет отсутствовать. Телефон получателя.
data.addressObjectНетМожет отсутствовать. Адрес доставки курьером.
data.address.cityStringНетМожет отсутствовать. Город доставки.
data.address.addressStringНетМожет отсутствовать. Адрес доставки.
data.payments[]Array<Object>ДаЗарегистрированные платежи.
data.payments[].idIntegerДаID платежа.
data.payments[].sumNumberДаСумма платежа.
data.payments[].paymentMethodIntegerДаID способа оплаты платежа.
data.payments[].dateStringДаДата платежа.
data.documents[]Array<Object>НетСозданные бухгалтерские документы.
data.documents[].numberStringДаНомер документа.
data.documents[].dateStringДаДата документа.
data.documents[].typeStringДаТип бухгалтерского документа.
data.managerObjectНетМожет отсутствовать. Назначенный менеджер.
data.manager.nameStringНетМожет отсутствовать. Имя менеджера.
data.manager.surnameStringНетМожет отсутствовать. Фамилия менеджера.
data.manager.patronymicStringНетМожет отсутствовать. Отчество менеджера.
data.manager.emailStringНетМожет отсутствовать. E-mail менеджера.
data.manager.phoneStringНетМожет отсутствовать. Телефон менеджера.
data.products[]Array<Object>ДаПозиции заказа; подробный контракт - /api/orderProduct/info.

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

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