StardDevelopersداشبورد

فهرست سفارش‌ها

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

سفارش‌هایی که از طریق API و در همین پروژه ثبت شده‌اند (کلیدهای پروژه‌های دیگر و سفارش‌های مینی‌اپ دیده نمی‌شوند).

درخواست

ناممحلنوعتوضیح
AuthorizationheaderstringالزامیBearer sk_live_… یا Bearer sk_test_…
statusquerystringاختیاریpending، processing، completed، cancelled، refunded، failed
limitqueryintegerاختیاریتعداد نتیجه در هر صفحه، ۱ تا ۱۰۰ (پیش‌فرض ۲۰)
offsetqueryintegerاختیاریچند ردیف رد شود (پیش‌فرض ۰)؛ برای صفحه‌ی بعد از next_offset استفاده کن

نمونه

curl "https://stard-market.ir/api/v1/orders?limit=2" \
  -H "Authorization: Bearer $STARD_API_KEY"
پاسخ — 200
{
  "object": "list",
  "data": [
    {
      "object": "order",
      "id": "ord_test_TyrINakBwx0N66kV",
      "order_id": null,
      "environment": "test",
      "status": "pending",
      "raw_status": "pending",
      "title": "⭐ 500 استارز برای @durov (test)",
      "product_id": null,
      "product_tag": null,
      "type": "stars",
      "quantity": 500,
      "recipient": "@durov",
      "amount": {
        "amount": 2191000,
        "currency": "IRT"
      },
      "paid": {
        "amount": 2191000,
        "currency": "IRT"
      },
      "failure_reason": null,
      "metadata": {},
      "created_at": "2026-10-01T10:31:49Z",
      "updated_at": "2026-10-01T10:31:49Z"
    },
    {
      "object": "order",
      "id": "ord_test_gGToQWxqOw89ssiL",
      "order_id": null,
      "environment": "test",
      "status": "pending",
      "raw_status": "pending",
      "title": "پریمیوم ۳ ماهه (test)",
      "product_id": 4518,
      "product_tag": null,
      "type": "product",
      "quantity": 1,
      "recipient": null,
      "amount": {
        "amount": 3788624,
        "currency": "IRT"
      },
      "paid": {
        "amount": 3788624,
        "currency": "IRT"
      },
      "failure_reason": null,
      "metadata": {
        "invoice": "INV-1042"
      },
      "created_at": "2026-10-01T10:31:49Z",
      "updated_at": "2026-10-01T10:31:49Z"
    }
  ],
  "has_more": false,
  "next_offset": null
}
هدرهای پاسخ
x-request-id: req_RU9oUhGcunV1Q8i3frYJ
x-ratelimit-limit: 60
x-ratelimit-remaining: 42
x-ratelimit-reset: 1790850720

خطاها

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

محدودیت نرخ

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