StardDevelopersداشبورد

لغو سفارش

POST/api/v1/orders/{id}/cancel
scope: orders:writeاحراز هویت: Bearerlive و test

فقط سفارشی که هنوز انجامش شروع نشده (pending) لغو می‌شود و مبلغ کامل به همان کیف پول برمی‌گردد. اگر ربات خرید را شروع کرده باشد، لغو پذیرفته نمی‌شود.

درخواست

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

نمونه

curl -X POST "https://stard-market.ir/api/v1/orders/ord_test_gGToQWxqOw89ssiL/cancel" \
  -H "Authorization: Bearer $STARD_API_KEY"
پاسخ — 200
{
  "object": "order",
  "id": "ord_test_gGToQWxqOw89ssiL",
  "order_id": null,
  "environment": "test",
  "status": "cancelled",
  "raw_status": "cancelled",
  "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"
}
هدرهای پاسخ
x-request-id: req_mu2QDMdXrXixTsWPwpRr
x-ratelimit-limit: 60
x-ratelimit-remaining: 39
x-ratelimit-reset: 1790850720

خطاها

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

محدودیت نرخ

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