# Методы
Методы для управления заказами и подписками.
### Способы оплаты
Доступные способы оплаты зависят от конфигурации заказа:
**Стандартные заказы** (`onlyStars: false`):
| Способ | Доступность |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Банковские карты | Всегда доступны |
| СБП | Доступен, когда у продавца включён СБП (можно включить по запросу в поддержке Tribute). Только для разовых заказов (`period: "onetime"`) |
| Wallet Pay (TON) | Всегда доступен |
| Telegram Stars | Только при `starsAmount > 0`, период `onetime` или `monthly`, и `tokenCharging` выключен |
**Заказы только за Stars** (`onlyStars: true`, `tokenCharging` выключен, только периоды `onetime` и `monthly`):
| Способ | Доступность |
| ---------------- | ------------------------------------------------------------- |
| Telegram Stars | Всегда доступен |
| Банковские карты | Оплата картой через Stars. Доступна когда `starsAmount >= 50` |
> **Примечание:** Pix и PayPal **недоступны** для заказов магазина.
## Получить магазин
> Возвращает информацию о магазине для аутентифицированного пользователя
```json
{"openapi":"3.1.0","info":{"title":"Tribute Shop API","version":"1.0.0"},"tags":[{"name":"Methods","description":"Методы для управления заказами и подписками.\n\n## Способы оплаты\n\nДоступные способы оплаты зависят от конфигурации заказа:\n\n**Стандартные заказы** (`onlyStars: false`):\n| Способ | Доступность |\n|-------|------------|\n| Банковские карты | Всегда доступны |\n| СБП | Доступен, когда у продавца включён СБП (можно включить по запросу в поддержке Tribute). Только для разовых заказов (`period: \"onetime\"`) |\n| Wallet Pay (TON) | Всегда доступен |\n| Telegram Stars | Только при `starsAmount > 0`, период `onetime` или `monthly`, и `tokenCharging` выключен |\n\n**Заказы только за Stars** (`onlyStars: true`, `tokenCharging` выключен, только периоды `onetime` и `monthly`):\n| Способ | Доступность |\n|-------|------------|\n| Telegram Stars | Всегда доступен |\n| Банковские карты | Оплата картой через Stars. Доступна когда `starsAmount >= 50` |\n\n> **Примечание:** Pix и PayPal **недоступны** для заказов магазина.\n"}],"servers":[{"url":"https://tribute.tg/api/v1","description":"Tribute API v1"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Api-Key","description":"API ключ для аутентификации."}},"schemas":{"Error":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Код ошибки","enum":["error_bad_request","error_not_found","error_not_permitted","no_access"]},"message":{"type":"string","description":"Описание ошибки"}}}}},"paths":{"/shop":{"get":{"summary":"Получить магазин","description":"Возвращает информацию о магазине для аутентифицированного пользователя","tags":["Methods"],"responses":{"200":{"description":"Успешный ответ","content":{"application/json":{"schema":{"type":"object","required":["id","userId","name","link","callbackUrl","recurrent","onlyStars","status"],"properties":{"id":{"type":"integer","format":"uint64","description":"ID магазина"},"userId":{"type":"integer","description":"ID владельца магазина"},"name":{"type":"string","description":"Название магазина"},"link":{"type":"string","description":"Ссылка/slug магазина"},"callbackUrl":{"type":"string","format":"uri","description":"URL вебхука для уведомлений о заказах"},"recurrent":{"type":"boolean","description":"Доступны ли рекуррентные платежи"},"onlyStars":{"type":"boolean","description":"Принимаются ли только платежи через Telegram Stars"},"tokenCharging":{"type":"boolean","description":"Включены ли списания по токенам (merchant-initiated)"},"status":{"type":"integer","description":"Статус магазина (0 = неактивен, 1 = активен)","enum":[0,1]}}}}}},"401":{"description":"Неавторизован (неверный API ключ)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Магазин не найден","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```
## Получить заказы магазина
> Возвращает список заказов магазина, отсортированных по убыванию ID (сначала новые). Опционально можно фильтровать по диапазону дат.
```json
{"openapi":"3.1.0","info":{"title":"Tribute Shop API","version":"1.0.0"},"tags":[{"name":"Methods","description":"Методы для управления заказами и подписками.\n\n## Способы оплаты\n\nДоступные способы оплаты зависят от конфигурации заказа:\n\n**Стандартные заказы** (`onlyStars: false`):\n| Способ | Доступность |\n|-------|------------|\n| Банковские карты | Всегда доступны |\n| СБП | Доступен, когда у продавца включён СБП (можно включить по запросу в поддержке Tribute). Только для разовых заказов (`period: \"onetime\"`) |\n| Wallet Pay (TON) | Всегда доступен |\n| Telegram Stars | Только при `starsAmount > 0`, период `onetime` или `monthly`, и `tokenCharging` выключен |\n\n**Заказы только за Stars** (`onlyStars: true`, `tokenCharging` выключен, только периоды `onetime` и `monthly`):\n| Способ | Доступность |\n|-------|------------|\n| Telegram Stars | Всегда доступен |\n| Банковские карты | Оплата картой через Stars. Доступна когда `starsAmount >= 50` |\n\n> **Примечание:** Pix и PayPal **недоступны** для заказов магазина.\n"}],"servers":[{"url":"https://tribute.tg/api/v1","description":"Tribute API v1"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Api-Key","description":"API ключ для аутентификации."}},"schemas":{"ShopOrder":{"type":"object","required":["uuid","shopId","amount","currency","title","description","status","successUrl","failUrl","paymentUrl","createdAt","period"],"properties":{"uuid":{"type":"string","format":"uuid","description":"UUID заказа"},"shopId":{"type":"integer","format":"uint64","description":"ID магазина, к которому относится заказ"},"amount":{"type":"integer","format":"int64","description":"Сумма заказа в минимальных единицах валюты (центы/копейки)"},"currency":{"type":"string","description":"Код валюты (в нижнем регистре)","enum":["eur","rub","usd"]},"title":{"type":"string","description":"Название заказа (макс 100 символов UTF-16)"},"description":{"type":"string","description":"Описание заказа (макс 300 символов UTF-16)"},"status":{"type":"string","description":"Статус заказа","enum":["pending","paid","failed"]},"email":{"type":"string","format":"email","description":"Email клиента (опционально)"},"successUrl":{"type":"string","format":"uri","description":"URL редиректа при успешной оплате"},"failUrl":{"type":"string","format":"uri","description":"URL редиректа при неудачной оплате"},"paymentUrl":{"type":"string","format":"uri","nullable":true,"description":"Веб-URL для завершения оплаты клиентом в браузере.\n`null` для заказов OnlyStars — их можно оплатить только внутри Telegram через `webappPaymentUrl`.\n"},"webappPaymentUrl":{"type":"string","format":"uri","description":"URL для оплаты через Telegram WebApp"},"createdAt":{"type":"string","format":"date-time","description":"Время создания заказа в формате ISO 8601"},"comment":{"type":"string","description":"Комментарий к заказу (опционально)"},"period":{"type":"string","description":"Период оплаты для рекуррентных заказов","enum":["onetime","weekly","monthly","quarterly","halfyearly","yearly"]},"memberStatus":{"type":"string","description":"Статус рекуррентной подписки (только для рекуррентных заказов)","enum":["active","cancelled"]},"memberExpiresAt":{"type":"string","format":"date-time","description":"Дата окончания рекуррентной подписки в формате ISO 8601 (только для рекуррентных заказов)"},"lastPaidTransactionAt":{"type":"string","format":"date-time","nullable":true,"description":"Дата последней оплаченной транзакции в формате ISO 8601. Null, если транзакций нет."},"starsAmount":{"type":"integer","format":"int64","description":"Фиксированная сумма в Telegram Stars (0 если не задано)"},"onlyStars":{"type":"boolean","description":"Принимает ли заказ только оплату через Telegram Stars"},"image":{"type":"object","nullable":true,"description":"Изображение заказа, отображается в счетах и транзакциях Telegram Stars. Null, если изображение не задано.","properties":{"id":{"type":"integer","description":"ID изображения"},"path":{"type":"string","format":"uri","description":"URL изображения"},"thumbnail":{"type":"string","description":"Миниатюра в формате Base64"},"width":{"type":"integer","description":"Ширина изображения в пикселях"},"height":{"type":"integer","description":"Высота изображения в пикселях"},"fileType":{"type":"string","description":"Тип файла","enum":["image","video"]}}}}},"Error":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Код ошибки","enum":["error_bad_request","error_not_found","error_not_permitted","no_access"]},"message":{"type":"string","description":"Описание ошибки"}}}}},"paths":{"/shop/orders":{"get":{"summary":"Получить заказы магазина","description":"Возвращает список заказов магазина, отсортированных по убыванию ID (сначала новые). Опционально можно фильтровать по диапазону дат.","tags":["Methods"],"parameters":[{"name":"dateFrom","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Начальная дата (включительно) в UTC, формат yyyy-mm-dd"},{"name":"dateTo","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Конечная дата (включительно) в UTC, формат yyyy-mm-dd"}],"responses":{"200":{"description":"Успешный ответ","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ShopOrder"}}}}},"401":{"description":"Неавторизован (неверный API ключ)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Магазин не найден","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```
## Создать заказ в магазине
> Создает новый заказ в магазине и возвращает ссылку для оплаты клиенту. Поддерживает разовые и рекуррентные платежи.
```json
{"openapi":"3.1.0","info":{"title":"Tribute Shop API","version":"1.0.0"},"tags":[{"name":"Methods","description":"Методы для управления заказами и подписками.\n\n## Способы оплаты\n\nДоступные способы оплаты зависят от конфигурации заказа:\n\n**Стандартные заказы** (`onlyStars: false`):\n| Способ | Доступность |\n|-------|------------|\n| Банковские карты | Всегда доступны |\n| СБП | Доступен, когда у продавца включён СБП (можно включить по запросу в поддержке Tribute). Только для разовых заказов (`period: \"onetime\"`) |\n| Wallet Pay (TON) | Всегда доступен |\n| Telegram Stars | Только при `starsAmount > 0`, период `onetime` или `monthly`, и `tokenCharging` выключен |\n\n**Заказы только за Stars** (`onlyStars: true`, `tokenCharging` выключен, только периоды `onetime` и `monthly`):\n| Способ | Доступность |\n|-------|------------|\n| Telegram Stars | Всегда доступен |\n| Банковские карты | Оплата картой через Stars. Доступна когда `starsAmount >= 50` |\n\n> **Примечание:** Pix и PayPal **недоступны** для заказов магазина.\n"}],"servers":[{"url":"https://tribute.tg/api/v1","description":"Tribute API v1"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Api-Key","description":"API ключ для аутентификации."}},"schemas":{"Error":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Код ошибки","enum":["error_bad_request","error_not_found","error_not_permitted","no_access"]},"message":{"type":"string","description":"Описание ошибки"}}}}},"paths":{"/shop/orders":{"post":{"summary":"Создать заказ в магазине","description":"Создает новый заказ в магазине и возвращает ссылку для оплаты клиенту. Поддерживает разовые и рекуррентные платежи.","tags":["Methods"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["amount","currency","title","description"],"properties":{"shopId":{"type":"integer","format":"uint64","description":"ID магазина для создания заказа. Если не указан, заказ создаётся для первого (самого раннего) магазина аутентифицированного пользователя."},"amount":{"type":"integer","format":"int64","description":"Сумма заказа в минимальных единицах валюты (центы для EUR/USD, копейки для RUB)"},"currency":{"type":"string","description":"Код валюты (в нижнем регистре)","enum":["eur","rub","usd"]},"title":{"type":"string","description":"Название заказа (обязательно, макс 100 символов UTF-16)"},"description":{"type":"string","description":"Описание заказа (обязательно, макс 300 символов UTF-16)"},"successUrl":{"type":"string","format":"uri","description":"URL редиректа при успешной оплате (опционально, должен быть валидным URL)"},"failUrl":{"type":"string","format":"uri","description":"URL редиректа при неудачной оплате (опционально, должен быть валидным URL)"},"email":{"type":"string","format":"email","description":"Email клиента (опционально, валидируется если указан)"},"comment":{"type":"string","description":"Комментарий к заказу (опционально)"},"customerId":{"type":"string","description":"Уникальный идентификатор клиента","maxLength":256},"period":{"type":"string","description":"Период оплаты. По умолчанию \"onetime\". Рекуррентные периоды требуют shop.recurrent = true. Магазины с OnlyStars поддерживают только \"onetime\" и \"monthly\" (подписки Telegram Stars — 30-дневные циклы).","enum":["onetime","weekly","monthly","quarterly","halfyearly","yearly"],"default":"onetime"},"starsAmount":{"type":"integer","format":"int64","description":"Фиксированная сумма в Telegram Stars. Обязательна для магазинов OnlyStars. При установке включает оплату Stars. Поддерживается только для периодов `onetime` или `monthly`. Для ежемесячных заказов создаёт подписку Telegram Stars.","minimum":1},"imageUrl":{"type":"string","format":"uri","description":"URL изображения для заказа. Будет отображаться в счетах и транзакциях Telegram Stars. При указании изображение загружается и сохраняется; если изображение с таким URL уже существует, оно используется повторно."}}}}}},"responses":{"200":{"description":"Заказ успешно создан","content":{"application/json":{"schema":{"type":"object","required":["uuid","shopId","paymentUrl","webappPaymentUrl"],"properties":{"uuid":{"type":"string","format":"uuid","description":"UUID заказа"},"shopId":{"type":"integer","format":"uint64","description":"ID магазина, в котором создан заказ"},"paymentUrl":{"type":"string","format":"uri","nullable":true,"description":"Веб-URL для завершения оплаты клиентом в браузере.\n`null` для заказов OnlyStars — их можно оплатить только внутри Telegram через `webappPaymentUrl`.\n"},"webappPaymentUrl":{"type":"string","format":"uri","description":"URL для оплаты через Telegram WebApp"}}}}}},"400":{"description":"Некорректный запрос","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Неавторизован (неверный API ключ)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Доступ запрещён (shopId принадлежит другому пользователю)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Магазин не найден","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```
## Получить заказы магазина по статусу
> Возвращает заказы магазина, сгруппированные по статусу, с поддержкой пагинации и количеством заказов.\
> \
> \*\*Три режима использования:\*\*\
> \
> 1\. \*\*Начальная загрузка\*\* (без \`page\`, без \`status\`): Возвращает первую страницу заказов для каждого статуса (\`all\`, \`pending\`, \`paid\`, \`failed\`) и общее количество. Используйте при первой загрузке экрана.\
> 2\. \*\*Пагинация «все»\*\* (\`page\` указан, без \`status\` или \`status=all\`): Возвращает конкретную страницу всех заказов под ключом \`all\`.\
> 3\. \*\*Пагинация по статусу\*\* (\`page\` и \`status\` указаны): Возвращает конкретную страницу заказов для данного статуса под соответствующим ключом.\
> \
> Заказы отсортированы по убыванию ID (сначала новые).
```json
{"openapi":"3.1.0","info":{"title":"Tribute Shop API","version":"1.0.0"},"tags":[{"name":"Methods","description":"Методы для управления заказами и подписками.\n\n## Способы оплаты\n\nДоступные способы оплаты зависят от конфигурации заказа:\n\n**Стандартные заказы** (`onlyStars: false`):\n| Способ | Доступность |\n|-------|------------|\n| Банковские карты | Всегда доступны |\n| СБП | Доступен, когда у продавца включён СБП (можно включить по запросу в поддержке Tribute). Только для разовых заказов (`period: \"onetime\"`) |\n| Wallet Pay (TON) | Всегда доступен |\n| Telegram Stars | Только при `starsAmount > 0`, период `onetime` или `monthly`, и `tokenCharging` выключен |\n\n**Заказы только за Stars** (`onlyStars: true`, `tokenCharging` выключен, только периоды `onetime` и `monthly`):\n| Способ | Доступность |\n|-------|------------|\n| Telegram Stars | Всегда доступен |\n| Банковские карты | Оплата картой через Stars. Доступна когда `starsAmount >= 50` |\n\n> **Примечание:** Pix и PayPal **недоступны** для заказов магазина.\n"}],"servers":[{"url":"https://tribute.tg/api/v1","description":"Tribute API v1"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Api-Key","description":"API ключ для аутентификации."}},"schemas":{"ShopOrder":{"type":"object","required":["uuid","shopId","amount","currency","title","description","status","successUrl","failUrl","paymentUrl","createdAt","period"],"properties":{"uuid":{"type":"string","format":"uuid","description":"UUID заказа"},"shopId":{"type":"integer","format":"uint64","description":"ID магазина, к которому относится заказ"},"amount":{"type":"integer","format":"int64","description":"Сумма заказа в минимальных единицах валюты (центы/копейки)"},"currency":{"type":"string","description":"Код валюты (в нижнем регистре)","enum":["eur","rub","usd"]},"title":{"type":"string","description":"Название заказа (макс 100 символов UTF-16)"},"description":{"type":"string","description":"Описание заказа (макс 300 символов UTF-16)"},"status":{"type":"string","description":"Статус заказа","enum":["pending","paid","failed"]},"email":{"type":"string","format":"email","description":"Email клиента (опционально)"},"successUrl":{"type":"string","format":"uri","description":"URL редиректа при успешной оплате"},"failUrl":{"type":"string","format":"uri","description":"URL редиректа при неудачной оплате"},"paymentUrl":{"type":"string","format":"uri","nullable":true,"description":"Веб-URL для завершения оплаты клиентом в браузере.\n`null` для заказов OnlyStars — их можно оплатить только внутри Telegram через `webappPaymentUrl`.\n"},"webappPaymentUrl":{"type":"string","format":"uri","description":"URL для оплаты через Telegram WebApp"},"createdAt":{"type":"string","format":"date-time","description":"Время создания заказа в формате ISO 8601"},"comment":{"type":"string","description":"Комментарий к заказу (опционально)"},"period":{"type":"string","description":"Период оплаты для рекуррентных заказов","enum":["onetime","weekly","monthly","quarterly","halfyearly","yearly"]},"memberStatus":{"type":"string","description":"Статус рекуррентной подписки (только для рекуррентных заказов)","enum":["active","cancelled"]},"memberExpiresAt":{"type":"string","format":"date-time","description":"Дата окончания рекуррентной подписки в формате ISO 8601 (только для рекуррентных заказов)"},"lastPaidTransactionAt":{"type":"string","format":"date-time","nullable":true,"description":"Дата последней оплаченной транзакции в формате ISO 8601. Null, если транзакций нет."},"starsAmount":{"type":"integer","format":"int64","description":"Фиксированная сумма в Telegram Stars (0 если не задано)"},"onlyStars":{"type":"boolean","description":"Принимает ли заказ только оплату через Telegram Stars"},"image":{"type":"object","nullable":true,"description":"Изображение заказа, отображается в счетах и транзакциях Telegram Stars. Null, если изображение не задано.","properties":{"id":{"type":"integer","description":"ID изображения"},"path":{"type":"string","format":"uri","description":"URL изображения"},"thumbnail":{"type":"string","description":"Миниатюра в формате Base64"},"width":{"type":"integer","description":"Ширина изображения в пикселях"},"height":{"type":"integer","description":"Высота изображения в пикселях"},"fileType":{"type":"string","description":"Тип файла","enum":["image","video"]}}}}},"Error":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Код ошибки","enum":["error_bad_request","error_not_found","error_not_permitted","no_access"]},"message":{"type":"string","description":"Описание ошибки"}}}}},"paths":{"/shop/orders_by_status":{"get":{"summary":"Получить заказы магазина по статусу","description":"Возвращает заказы магазина, сгруппированные по статусу, с поддержкой пагинации и количеством заказов.\n\n**Три режима использования:**\n\n1. **Начальная загрузка** (без `page`, без `status`): Возвращает первую страницу заказов для каждого статуса (`all`, `pending`, `paid`, `failed`) и общее количество. Используйте при первой загрузке экрана.\n2. **Пагинация «все»** (`page` указан, без `status` или `status=all`): Возвращает конкретную страницу всех заказов под ключом `all`.\n3. **Пагинация по статусу** (`page` и `status` указаны): Возвращает конкретную страницу заказов для данного статуса под соответствующим ключом.\n\nЗаказы отсортированы по убыванию ID (сначала новые).\n","tags":["Methods"],"parameters":[{"name":"status","in":"query","description":"Фильтр по статусу заказа. Если не указан и `page` не задан, возвращает все статусы.\nЕсли установлен `all` или не указан вместе с `page`, возвращает все заказы.\n","required":false,"schema":{"type":"string","enum":["all","pending","paid","failed"]}},{"name":"page","in":"query","description":"Номер страницы (начиная с 1). Если не указан, выполняется начальная группированная загрузка.","required":false,"schema":{"type":"integer","minimum":1}},{"name":"size","in":"query","description":"Количество заказов на странице (по умолчанию 20, макс 100)","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"dateFrom","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Начальная дата (включительно) в UTC, формат yyyy-mm-dd"},{"name":"dateTo","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Конечная дата (включительно) в UTC, формат yyyy-mm-dd"}],"responses":{"200":{"description":"Успешный ответ","content":{"application/json":{"schema":{"type":"object","required":["counts","orders","nextFrom"],"properties":{"counts":{"type":"object","description":"Общее количество заказов по статусам","required":["all","pending","paid","failed"],"properties":{"all":{"type":"integer","format":"int64","description":"Общее количество заказов по всем статусам"},"pending":{"type":"integer","format":"int64","description":"Количество ожидающих заказов"},"paid":{"type":"integer","format":"int64","description":"Количество оплаченных заказов"},"failed":{"type":"integer","format":"int64","description":"Количество неоплаченных заказов"}}},"orders":{"type":"object","description":"Заказы, сгруппированные по ключу статуса. При начальной загрузке содержит ключи `all`, `pending`, `paid`, `failed`.\nПри запросе с пагинацией содержит только запрошенный ключ статуса (например, `all` или `paid`).\n","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ShopOrder"}}},"nextFrom":{"type":"string","description":"Номер следующей страницы в виде строки. Пустая строка, если страниц больше нет."}}}}}},"400":{"description":"Некорректный запрос (неверный параметр status)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Неавторизован (неверный API ключ)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Магазин не найден","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```
## Получить заказ
> Возвращает полные данные конкретного заказа магазина по его UUID. Включает статус подписки и изображение. Доступно только владельцу магазина.
```json
{"openapi":"3.1.0","info":{"title":"Tribute Shop API","version":"1.0.0"},"tags":[{"name":"Methods","description":"Методы для управления заказами и подписками.\n\n## Способы оплаты\n\nДоступные способы оплаты зависят от конфигурации заказа:\n\n**Стандартные заказы** (`onlyStars: false`):\n| Способ | Доступность |\n|-------|------------|\n| Банковские карты | Всегда доступны |\n| СБП | Доступен, когда у продавца включён СБП (можно включить по запросу в поддержке Tribute). Только для разовых заказов (`period: \"onetime\"`) |\n| Wallet Pay (TON) | Всегда доступен |\n| Telegram Stars | Только при `starsAmount > 0`, период `onetime` или `monthly`, и `tokenCharging` выключен |\n\n**Заказы только за Stars** (`onlyStars: true`, `tokenCharging` выключен, только периоды `onetime` и `monthly`):\n| Способ | Доступность |\n|-------|------------|\n| Telegram Stars | Всегда доступен |\n| Банковские карты | Оплата картой через Stars. Доступна когда `starsAmount >= 50` |\n\n> **Примечание:** Pix и PayPal **недоступны** для заказов магазина.\n"}],"servers":[{"url":"https://tribute.tg/api/v1","description":"Tribute API v1"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Api-Key","description":"API ключ для аутентификации."}},"schemas":{"ShopOrder":{"type":"object","required":["uuid","shopId","amount","currency","title","description","status","successUrl","failUrl","paymentUrl","createdAt","period"],"properties":{"uuid":{"type":"string","format":"uuid","description":"UUID заказа"},"shopId":{"type":"integer","format":"uint64","description":"ID магазина, к которому относится заказ"},"amount":{"type":"integer","format":"int64","description":"Сумма заказа в минимальных единицах валюты (центы/копейки)"},"currency":{"type":"string","description":"Код валюты (в нижнем регистре)","enum":["eur","rub","usd"]},"title":{"type":"string","description":"Название заказа (макс 100 символов UTF-16)"},"description":{"type":"string","description":"Описание заказа (макс 300 символов UTF-16)"},"status":{"type":"string","description":"Статус заказа","enum":["pending","paid","failed"]},"email":{"type":"string","format":"email","description":"Email клиента (опционально)"},"successUrl":{"type":"string","format":"uri","description":"URL редиректа при успешной оплате"},"failUrl":{"type":"string","format":"uri","description":"URL редиректа при неудачной оплате"},"paymentUrl":{"type":"string","format":"uri","nullable":true,"description":"Веб-URL для завершения оплаты клиентом в браузере.\n`null` для заказов OnlyStars — их можно оплатить только внутри Telegram через `webappPaymentUrl`.\n"},"webappPaymentUrl":{"type":"string","format":"uri","description":"URL для оплаты через Telegram WebApp"},"createdAt":{"type":"string","format":"date-time","description":"Время создания заказа в формате ISO 8601"},"comment":{"type":"string","description":"Комментарий к заказу (опционально)"},"period":{"type":"string","description":"Период оплаты для рекуррентных заказов","enum":["onetime","weekly","monthly","quarterly","halfyearly","yearly"]},"memberStatus":{"type":"string","description":"Статус рекуррентной подписки (только для рекуррентных заказов)","enum":["active","cancelled"]},"memberExpiresAt":{"type":"string","format":"date-time","description":"Дата окончания рекуррентной подписки в формате ISO 8601 (только для рекуррентных заказов)"},"lastPaidTransactionAt":{"type":"string","format":"date-time","nullable":true,"description":"Дата последней оплаченной транзакции в формате ISO 8601. Null, если транзакций нет."},"starsAmount":{"type":"integer","format":"int64","description":"Фиксированная сумма в Telegram Stars (0 если не задано)"},"onlyStars":{"type":"boolean","description":"Принимает ли заказ только оплату через Telegram Stars"},"image":{"type":"object","nullable":true,"description":"Изображение заказа, отображается в счетах и транзакциях Telegram Stars. Null, если изображение не задано.","properties":{"id":{"type":"integer","description":"ID изображения"},"path":{"type":"string","format":"uri","description":"URL изображения"},"thumbnail":{"type":"string","description":"Миниатюра в формате Base64"},"width":{"type":"integer","description":"Ширина изображения в пикселях"},"height":{"type":"integer","description":"Высота изображения в пикселях"},"fileType":{"type":"string","description":"Тип файла","enum":["image","video"]}}}}},"Error":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Код ошибки","enum":["error_bad_request","error_not_found","error_not_permitted","no_access"]},"message":{"type":"string","description":"Описание ошибки"}}}}},"paths":{"/shop/orders/{orderUuid}":{"get":{"summary":"Получить заказ","description":"Возвращает полные данные конкретного заказа магазина по его UUID. Включает статус подписки и изображение. Доступно только владельцу магазина.","tags":["Methods"],"parameters":[{"name":"orderUuid","in":"path","description":"UUID заказа","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Успешный ответ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShopOrder"}}}},"401":{"description":"Неавторизован (неверный API ключ)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Запрещено (заказ принадлежит другому магазину)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Заказ или магазин не найден","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```
## Получить статус заказа
> Возвращает текущий статус конкретного заказа магазина по его UUID. Доступно только владельцу магазина.
```json
{"openapi":"3.1.0","info":{"title":"Tribute Shop API","version":"1.0.0"},"tags":[{"name":"Methods","description":"Методы для управления заказами и подписками.\n\n## Способы оплаты\n\nДоступные способы оплаты зависят от конфигурации заказа:\n\n**Стандартные заказы** (`onlyStars: false`):\n| Способ | Доступность |\n|-------|------------|\n| Банковские карты | Всегда доступны |\n| СБП | Доступен, когда у продавца включён СБП (можно включить по запросу в поддержке Tribute). Только для разовых заказов (`period: \"onetime\"`) |\n| Wallet Pay (TON) | Всегда доступен |\n| Telegram Stars | Только при `starsAmount > 0`, период `onetime` или `monthly`, и `tokenCharging` выключен |\n\n**Заказы только за Stars** (`onlyStars: true`, `tokenCharging` выключен, только периоды `onetime` и `monthly`):\n| Способ | Доступность |\n|-------|------------|\n| Telegram Stars | Всегда доступен |\n| Банковские карты | Оплата картой через Stars. Доступна когда `starsAmount >= 50` |\n\n> **Примечание:** Pix и PayPal **недоступны** для заказов магазина.\n"}],"servers":[{"url":"https://tribute.tg/api/v1","description":"Tribute API v1"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Api-Key","description":"API ключ для аутентификации."}},"schemas":{"Error":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Код ошибки","enum":["error_bad_request","error_not_found","error_not_permitted","no_access"]},"message":{"type":"string","description":"Описание ошибки"}}}}},"paths":{"/shop/orders/{orderUuid}/status":{"get":{"summary":"Получить статус заказа","description":"Возвращает текущий статус конкретного заказа магазина по его UUID. Доступно только владельцу магазина.","tags":["Methods"],"parameters":[{"name":"orderUuid","in":"path","description":"UUID заказа","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Успешный ответ","content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"Статус заказа","enum":["pending","paid","failed"]}}}}}},"401":{"description":"Неавторизован (неверный API ключ)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Запрещено (заказ принадлежит другому магазину)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Заказ или магазин не найден","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```
## Отменить рекуррентный заказ
> Отменяет рекуррентную подписку на заказ магазина. Доступно только владельцу магазина или авторизованным менеджерам.
```json
{"openapi":"3.1.0","info":{"title":"Tribute Shop API","version":"1.0.0"},"tags":[{"name":"Methods","description":"Методы для управления заказами и подписками.\n\n## Способы оплаты\n\nДоступные способы оплаты зависят от конфигурации заказа:\n\n**Стандартные заказы** (`onlyStars: false`):\n| Способ | Доступность |\n|-------|------------|\n| Банковские карты | Всегда доступны |\n| СБП | Доступен, когда у продавца включён СБП (можно включить по запросу в поддержке Tribute). Только для разовых заказов (`period: \"onetime\"`) |\n| Wallet Pay (TON) | Всегда доступен |\n| Telegram Stars | Только при `starsAmount > 0`, период `onetime` или `monthly`, и `tokenCharging` выключен |\n\n**Заказы только за Stars** (`onlyStars: true`, `tokenCharging` выключен, только периоды `onetime` и `monthly`):\n| Способ | Доступность |\n|-------|------------|\n| Telegram Stars | Всегда доступен |\n| Банковские карты | Оплата картой через Stars. Доступна когда `starsAmount >= 50` |\n\n> **Примечание:** Pix и PayPal **недоступны** для заказов магазина.\n"}],"servers":[{"url":"https://tribute.tg/api/v1","description":"Tribute API v1"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Api-Key","description":"API ключ для аутентификации."}},"schemas":{"Error":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Код ошибки","enum":["error_bad_request","error_not_found","error_not_permitted","no_access"]},"message":{"type":"string","description":"Описание ошибки"}}}}},"paths":{"/shop/orders/{orderUuid}/cancel":{"post":{"summary":"Отменить рекуррентный заказ","description":"Отменяет рекуррентную подписку на заказ магазина. Доступно только владельцу магазина или авторизованным менеджерам.","tags":["Methods"],"parameters":[{"name":"orderUuid","in":"path","description":"UUID заказа","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Заказ успешно отменен","content":{"application/json":{"schema":{"type":"object","required":["success","message"],"properties":{"success":{"type":"boolean","description":"Успешность операции"},"message":{"type":"string","description":"Сообщение об успехе"}}}}}},"400":{"description":"Некорректный запрос","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Неавторизован (неверный API ключ)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Запрещено (доступ запрещен)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Заказ, магазин или рекуррентная подписка не найдены","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```
## Получить транзакции заказа
> Возвращает постраничный список транзакций для конкретного заказа магазина. Доступно только владельцу магазина или авторизованным менеджерам.
```json
{"openapi":"3.1.0","info":{"title":"Tribute Shop API","version":"1.0.0"},"tags":[{"name":"Methods","description":"Методы для управления заказами и подписками.\n\n## Способы оплаты\n\nДоступные способы оплаты зависят от конфигурации заказа:\n\n**Стандартные заказы** (`onlyStars: false`):\n| Способ | Доступность |\n|-------|------------|\n| Банковские карты | Всегда доступны |\n| СБП | Доступен, когда у продавца включён СБП (можно включить по запросу в поддержке Tribute). Только для разовых заказов (`period: \"onetime\"`) |\n| Wallet Pay (TON) | Всегда доступен |\n| Telegram Stars | Только при `starsAmount > 0`, период `onetime` или `monthly`, и `tokenCharging` выключен |\n\n**Заказы только за Stars** (`onlyStars: true`, `tokenCharging` выключен, только периоды `onetime` и `monthly`):\n| Способ | Доступность |\n|-------|------------|\n| Telegram Stars | Всегда доступен |\n| Банковские карты | Оплата картой через Stars. Доступна когда `starsAmount >= 50` |\n\n> **Примечание:** Pix и PayPal **недоступны** для заказов магазина.\n"}],"servers":[{"url":"https://tribute.tg/api/v1","description":"Tribute API v1"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Api-Key","description":"API ключ для аутентификации."}},"schemas":{"Transaction":{"type":"object","required":["id","type","amount","currency","createdAt","total"],"properties":{"id":{"type":"integer","format":"uint64","description":"ID транзакции"},"type":{"type":"string","description":"Тип транзакции"},"objectId":{"type":"integer","format":"uint64","description":"ID связанного объекта"},"amount":{"type":"number","format":"double","description":"Сумма транзакции в единицах валюты (например, EUR, RUB)"},"currency":{"type":"string","description":"Код валюты (в нижнем регистре)","enum":["eur","rub","usd"]},"createdAt":{"type":"integer","format":"int64","description":"Время создания транзакции (Unix timestamp в секундах)"},"serviceFee":{"type":"number","format":"double","description":"Сумма комиссии сервиса"},"total":{"type":"number","format":"double","description":"Итоговая сумма за вычетом комиссий"},"paymentMethod":{"type":"string","description":"Использованный способ оплаты"},"isRefunded":{"type":"boolean","description":"Был ли выполнен возврат по транзакции"},"isRefundable":{"type":"boolean","description":"Возможен ли возврат по транзакции"},"isRecurring":{"type":"boolean","description":"Является ли транзакция рекуррентным платежом"},"shopOrder":{"type":"object","description":"Детали связанного заказа магазина (включается для транзакций заказов магазина)","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID заказа"},"title":{"type":"string","description":"Название заказа"},"description":{"type":"string","description":"Описание заказа"},"amount":{"type":"number","format":"double","description":"Сумма заказа в единицах валюты"},"currency":{"type":"string","description":"Код валюты (в нижнем регистре)"},"status":{"type":"string","description":"Статус заказа","enum":["pending","paid","failed"]},"email":{"type":"string","format":"email","description":"Email клиента (опционально)"},"successUrl":{"type":"string","format":"uri","description":"URL редиректа при успешной оплате"},"failUrl":{"type":"string","format":"uri","description":"URL редиректа при неудачной оплате"},"createdAt":{"type":"integer","format":"int64","description":"Время создания заказа (Unix timestamp в секундах)"},"comment":{"type":"string","description":"Комментарий к заказу (опционально)"},"period":{"type":"string","description":"Период оплаты","enum":["onetime","weekly","monthly","quarterly","halfyearly","yearly"]},"shopName":{"type":"string","description":"Название магазина"},"starsAmount":{"type":"integer","format":"int64","description":"Фиксированная сумма в Telegram Stars (0 если не задано)"},"onlyStars":{"type":"boolean","description":"Принимает ли заказ только оплату через Telegram Stars"}}}}},"Error":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Код ошибки","enum":["error_bad_request","error_not_found","error_not_permitted","no_access"]},"message":{"type":"string","description":"Описание ошибки"}}}}},"paths":{"/shop/orders/{orderUuid}/transactions":{"get":{"summary":"Получить транзакции заказа","description":"Возвращает постраничный список транзакций для конкретного заказа магазина. Доступно только владельцу магазина или авторизованным менеджерам.","tags":["Methods"],"parameters":[{"name":"orderUuid","in":"path","description":"UUID заказа","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"startFrom","in":"query","description":"Смещение пагинации (количество записей для пропуска)","required":false,"schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Успешный ответ","content":{"application/json":{"schema":{"type":"object","required":["transactions","nextFrom"],"properties":{"transactions":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"}},"nextFrom":{"type":"string","description":"Смещение для следующей страницы. Пустая строка если страниц больше нет"}}}}}},"401":{"description":"Неавторизован (неверный API ключ)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Запрещено (доступ запрещен)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Заказ или магазин не найден","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```
## Возврат по транзакции заказа
> Инициирует возврат по конкретной транзакции заказа магазина. Доступно только владельцу магазина или авторизованным менеджерам. Возврат возможен только для транзакций продажи по оплаченным заказам.
```json
{"openapi":"3.1.0","info":{"title":"Tribute Shop API","version":"1.0.0"},"tags":[{"name":"Methods","description":"Методы для управления заказами и подписками.\n\n## Способы оплаты\n\nДоступные способы оплаты зависят от конфигурации заказа:\n\n**Стандартные заказы** (`onlyStars: false`):\n| Способ | Доступность |\n|-------|------------|\n| Банковские карты | Всегда доступны |\n| СБП | Доступен, когда у продавца включён СБП (можно включить по запросу в поддержке Tribute). Только для разовых заказов (`period: \"onetime\"`) |\n| Wallet Pay (TON) | Всегда доступен |\n| Telegram Stars | Только при `starsAmount > 0`, период `onetime` или `monthly`, и `tokenCharging` выключен |\n\n**Заказы только за Stars** (`onlyStars: true`, `tokenCharging` выключен, только периоды `onetime` и `monthly`):\n| Способ | Доступность |\n|-------|------------|\n| Telegram Stars | Всегда доступен |\n| Банковские карты | Оплата картой через Stars. Доступна когда `starsAmount >= 50` |\n\n> **Примечание:** Pix и PayPal **недоступны** для заказов магазина.\n"}],"servers":[{"url":"https://tribute.tg/api/v1","description":"Tribute API v1"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Api-Key","description":"API ключ для аутентификации."}},"schemas":{"Error":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Код ошибки","enum":["error_bad_request","error_not_found","error_not_permitted","no_access"]},"message":{"type":"string","description":"Описание ошибки"}}}}},"paths":{"/shop/orders/{orderUuid}/transactions/{txId}/refund":{"post":{"summary":"Возврат по транзакции заказа","description":"Инициирует возврат по конкретной транзакции заказа магазина. Доступно только владельцу магазина или авторизованным менеджерам. Возврат возможен только для транзакций продажи по оплаченным заказам.","tags":["Methods"],"parameters":[{"name":"orderUuid","in":"path","description":"UUID заказа","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"txId","in":"path","description":"ID транзакции (должна быть транзакцией продажи)","required":true,"schema":{"type":"integer","format":"uint64"}}],"responses":{"200":{"description":"Возврат успешно инициирован","content":{"application/json":{"schema":{"type":"object","required":["success","message","status"],"properties":{"success":{"type":"boolean","description":"Успешность операции"},"message":{"type":"string","description":"Сообщение об успехе"},"status":{"type":"string","description":"Статус возврата","enum":["initiated"]}}}}}},"400":{"description":"Некорректный запрос","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Неавторизован (неверный API ключ)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Запрещено (доступ запрещен)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Заказ, магазин или транзакция не найдены","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Внутренняя ошибка сервера (ошибка обработки возврата)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://wiki.tribute.tg/ru/for-shops/api-magazina/metody.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.