Товары

Операции с товарами. Товары существуют трех типов:

digital - Цифровой товар. Любое сообщение в Telegram с опциональными вложениями
custom - Товар на заказ. Контент по запросу, например, персонализированное видео-поздравление
physical - Физический товар. Мерч с доставкой, например, футболка с принтом

Все суммы указаны в минимальных единицах валюты (центы/копейки)

Получить список товаров

get

Возвращает постраничный список товаров

Authorizations

Api-KeystringRequired

API ключ для аутентификации.

Query parameters

pageinteger · min: 1Optional

Номер страницы

Default: 1

sizeinteger · min: 1 · max: 100Optional

Количество элементов на странице

Default: 20

typestring · enumOptional

Фильтр по типу товара

Possible values:

descbooleanOptional

Сортировка по ID в убывающем порядке

Default: false

Responses

200

Успешный ответ

application/json

400

Некорректный запрос

application/json

401

Неавторизован (неверный API ключ)

application/json

get/products

GET /api/v1/products HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Accept: */*

{
  "rows": [
    {
      "id": 2548,
      "type": "digital",
      "name": "Доступ к VPN на 1 месяц",
      "description": "Высокоскоростной VPN-сервис с неограниченным трафиком и 50+ серверами по всему миру",
      "amount": 499,
      "currency": "usd",
      "starsAmount": 100,
      "starsAmountEnabled": true,
      "status": "approved",
      "isCustom": false,
      "acceptCards": true,
      "acceptWalletPay": false,
      "protectContent": true,
      "created": "2025-08-25T10:30:00Z",
      "updated": "2025-08-25T10:30:00Z",
      "pendingOrders": 3,
      "imageUrl": "https://cdn.example.com/image.jpg",
      "link": "https://t.me/tribute_bot/app?startapp=pf6",
      "webLink": "https://web.tribute.tg/p/f6"
    }
  ],
  "meta": {
    "total": 1,
    "offset": 1,
    "limit": 1
  }
}

Получить товар по ID

get

Возвращает отдельный товар по его ID

Authorizations

Api-KeystringRequired

API ключ для аутентификации.

Path parameters

idintegerRequired

ID товара

Responses

200

Успешный ответ

application/json

idintegerRequired

ID товара

Example: 2548

typestring · enumRequired

Тип товара

Example: digitalPossible values:

namestringRequired

Название товара

Example: Доступ к VPN на 1 месяц

descriptionstringOptional

Описание товара

Example:

Высокоскоростной VPN-сервис с неограниченным трафиком и 50+ серверами по всему миру

amountinteger · int64Required

Цена товара в минимальных единицах валюты (центах для USD/EUR, копейках для RUB). Для физических товаров это стартовая цена — берётся по самому дешёвому варианту.

Example: 499

currencystring · enumRequired

Код валюты

Example: usdPossible values:

starsAmountintegerOptional

Цена в Telegram Stars

Example: 100

starsAmountEnabledbooleanOptional

Включена ли оплата через Stars

Example: true

statusstring · enumRequired

Статус товара

Example: approvedPossible values:

isCustombooleanRequired

Является ли товар кастомным

Example: false

acceptCardsbooleanRequired

Принимается ли оплата картой

Example: true

acceptWalletPaybooleanRequired

Принимается ли оплата через кошелек

Example: false

protectContentbooleanRequired

Включена ли защита контента

Example: true

createdstring · date-timeRequired

Дата создания товара

Example: 2025-08-25T10:30:00Z

updatedstring · date-timeRequired

Дата последнего обновления товара

Example: 2025-08-25T10:30:00Z

pendingOrdersintegerOptional

Количество ожидающих заказов (для кастомных товаров)

Example: 3

imageUrlstring · uriOptional

URL изображения товара

Example: https://cdn.example.com/image.jpg

linkstring · uriRequired

Прямая ссылка на товар в приложении Telegram

Example: https://t.me/tribute_bot/app?startapp=pf6

webLinkstring · uriRequired

Веб-ссылка на товар

Example: https://web.tribute.tg/p/f6

400

Некорректный запрос (неверный формат ID товара)

application/json

401

Неавторизован (неверный API ключ)

application/json

403

Доступ запрещен

application/json

404

Товар не найден

application/json

get/products/{id}

GET /api/v1/products/{id} HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Accept: */*

{
  "id": 2548,
  "type": "digital",
  "name": "Доступ к VPN на 1 месяц",
  "description": "Высокоскоростной VPN-сервис с неограниченным трафиком и 50+ серверами по всему миру",
  "amount": 499,
  "currency": "usd",
  "starsAmount": 100,
  "starsAmountEnabled": true,
  "status": "approved",
  "isCustom": false,
  "acceptCards": true,
  "acceptWalletPay": false,
  "protectContent": true,
  "created": "2025-08-25T10:30:00Z",
  "updated": "2025-08-25T10:30:00Z",
  "pendingOrders": 3,
  "imageUrl": "https://cdn.example.com/image.jpg",
  "link": "https://t.me/tribute_bot/app?startapp=pf6",
  "webLink": "https://web.tribute.tg/p/f6"
}

Отменить покупку цифрового товара

post

Отменяет покупку цифрового товара и выполняет возврат платежа.

Важно: Этот эндпоинт поддерживает возврат только для покупок, оплаченных Telegram Stars. Покупки, оплаченные другими способами, не могут быть возвращены через этот эндпоинт.

Authorizations

Api-KeystringRequired

API ключ для аутентификации.

Path parameters

purchaseIdintegerRequired

ID покупки цифрового товара (ProductPurchase.ID)

Example: 12345

Responses

200

Покупка успешно отменена, платёж возвращён

application/json

successbooleanRequired

Статус успешности операции

Example: true

purchaseIdintegerRequired

ID отменённой покупки

Example: 12345

messagestringRequired

Сообщение об успехе

Example: purchase cancelled and payment refunded

400

Некорректный запрос

application/json

401

Неавторизован (неверный API ключ)

application/json

403

Доступ запрещён (не владелец товара)

application/json

404

Покупка или пользователь не найден

application/json

500

Внутренняя ошибка сервера

application/json

post/products/purchases/{purchaseId}/cancel

POST /api/v1/products/purchases/{purchaseId}/cancel HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "purchaseId": 12345,
  "message": "purchase cancelled and payment refunded"
}

PreviousПодписки

NextВебхуки

Last updated 3 months ago