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

Скачать УПД в XML

Возвращает универсальный передаточный документ заказа XML-файлом. Документ не создаёт: УПД уже должен быть у заказа. Если заказа нет, он удалён, УПД не найден или у документа нет реквизитов продавца, API возвращает JSON-ошибку с кодом 2.

Ссылка на API

https://your_site/api/order/downloadUpdXml

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

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

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

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

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

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

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

successBooleanДаtrue при успешном JSON-ответе; false при ошибке.
errorArray / ObjectДаПустой массив либо объект ошибки.
codeIntegerНетКод ошибки.
messageStringНетТекст ошибки.
bodyXML fileДаУспешный ответ — файл, не JSON. Content-Type: application/xml, кодировка Windows-1251. Имя файла — номер заказа с расширением .xml. Формат ФНС 5.03, КНД 1115131. При ошибке возвращается стандартный JSON.

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

Успешный ответ — файл, не JSON. Метод вызывается только через POST.

Content-Type: application/xml; charset=Windows-1251
Content-Disposition: attachment; filename="1024.xml"

XML универсального передаточного документа.
Формат ФНС 5.03, КНД 1115131.
Функция документа: СЧФДОП, если продавец с НДС, иначе ДОП.
Ошибки: API может вернуть коды 1 - авторизация, 2 - данные не найдены, 3 - сохранение, 4 - недостаточно данных, 5 - неверный формат, 6 - валидация, 7 - доступ, 8 - не указан менеджер.