StardDevelopersداشبورد

وضعیت سفارش بوست

GET/api/v1/boosts/orders/{id}
scope: orders:readاحراز هویت: Bearerlive و test

وضعیت سفارش بوست به‌همراه پیشرفت تحویل.

درخواست

ناممحلنوعتوضیح
AuthorizationheaderstringالزامیBearer sk_live_… یا Bearer sk_test_…
idpathstringالزامیکد پیگیری سفارش (ord_… یا کد live)

نمونه

curl "https://stard-market.ir/api/v1/boosts/orders/ord_test_gGToQWxqOw89ssiL" \
  -H "Authorization: Bearer $STARD_API_KEY"
پاسخ — 200
{
  "object": "order",
  "id": "ord_test_filwZurNgDCrQ9fD",
  "order_id": null,
  "environment": "test",
  "status": "pending",
  "raw_status": "pending",
  "title": "🚀 10 بوست 7 روزه برای @your_channel (test)",
  "product_id": null,
  "product_tag": null,
  "type": "boost",
  "quantity": 10,
  "recipient": "@your_channel",
  "amount": {
    "amount": 132000,
    "currency": "IRT"
  },
  "paid": {
    "amount": 132000,
    "currency": "IRT"
  },
  "failure_reason": null,
  "metadata": {
    "invoice": "INV-2001"
  },
  "created_at": "2026-10-02T17:43:23Z",
  "updated_at": "2026-10-02T17:43:23Z"
}
هدرهای پاسخ
content-type: application/json
x-request-id: req_66D4PvmtsgQ61vPdzgKs
x-ratelimit-limit: 1000
x-ratelimit-remaining: 991

کاربرد و نکته‌ها

کی به کار می‌آید؟ برای نشان دادن پیشرفت تحویل بوست به مشتری. فیلدهای مهم پاسخ: status (وضعیت کلی سفارش)، quantity و duration (تعداد و مدت سفارش)، و پیشرفت تحویل در boost.delivered / boost.remaining.

  • تا وقتی status نهایی نشده (completed، failed، refunded یا cancelled)، هر چند دقیقه یک بار بخوان یا منتظر وب‌هوک order.* بمان.
  • اگر بخشی تحویل نشد، مبلغ آن بخش خودکار برمی‌گردد و در وضعیت بازپرداخت دیده می‌شود.
  • همین سفارش در GET /orders هم با type: "boost" می‌آید.

خطاها

HTTPcodeکی
404order_not_foundسفارش بوست پیدا نشد
403insufficient_scopeکلید scope orders:read را ندارد
401invalid_api_key / missing_api_key / api_key_revoked / api_key_expiredکلید نیامده، نامعتبر، باطل یا منقضی است
429rate_limit_exceededسقف درخواست در دقیقه پر شده؛ بعد از Retry-After ثانیه دوباره بفرست

محدودیت نرخ

پیش‌فرض ۶۰ درخواست در دقیقه برای هر کلید (قابل تنظیم در داشبورد). وضعیت در هدرهای X-RateLimit-* برمی‌گردد — جزئیات.