سفارش‌ها#

GET /api/v2/orders سفارش‌های بین‌شعبه‌ای دیدنی برای تجارت را برمی‌گرداند. یک سفارش سندی است که یک خرید یا فروش میان شعبه‌ها را پیش می‌گیرد؛ یک وضعیت، یک شماره پیگیری و مجموع‌های فاکتور را حمل می‌کند.

اجازه#

پارامترهای کوئری#

مقدارهای وضعیت پشتیبانی‌شده: pending، deleted، shipped، completed، approved، denied. هر مقدار دیگر با 422 رد می‌شود.

درخواست#

curl -s "https://app.example.com/api/v2/orders?status=pending&from=2026-10-01" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-Business-Branch: 4" \
  -H "Accept: application/json"

پاسخ#

{
  "data": [
    {
      "id": 88,
      "business_branch_id": 4,
      "order_number": "ORD-2026-0088",
      "tracking_number": "TRK-99120",
      "status": "pending",
      "invoice_number": "INV-2026-7781",
      "grand_total": 18500,
      "paid_amount": 0,
      "created_at": "2026-10-24 09:02:11"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 25,
    "total": 1
  }
}

فیلدها#

پاسخ اقلام سفارش را دربر ندارد. برای جزئیات سطح قلم از رابط وب یا نقاط پایانی خرید و فروش استفاده کنید.

معنای وضعیت‌ها#

deleted فقط وقتی ظاهر می‌شود که صریحاً درخواست شود. آن سفارشی را نمایندت می‌کند که از استفاده فعال بیرون رفته است؛ آن را یک حالت تکمیل تلقی نکنید.

هم‌خوانی شعبه#

یک سفارش وقتی برگردانده می‌شود که یکی از طرف‌ها به یک شعبه دیدنی تعلق داشته باشد:

• فاکتور توسط یک شعبه دیدنی صادر شده، یا
• فاکتور به یک شعبه دیدنی نشانی رفته است.

business_branch_id شعبه طرف شما را گزارش می‌کند. وقتی یک اعتبارنامه به یک شعبه محدود شده، فقط سفارش‌های درگیر همان شعبه ظاهر می‌شوند.

ترتیب#

سفارش‌ها جدیدترین اول بر اساس زمان ایجاد برگردانده می‌شوند، که همگام‌سازی تدریجی را ساده می‌سازد: صفحه اول را درخواست کنید و وقتی به سفارشی رسیدید که از قبل ذخیره‌اش دارید متوقف شوید.

استفاده‌های رایج#

محدودیت‌ها#

• فقط‌خواندنی: سفارش‌ها از طریق API نمی‌توانند ایجاد، پذیرفته یا حذف شوند.
• اقلام سفارش دربر گرفته نمی‌شوند.
• مبلغ‌ها به ارز فاکتور و بدون تبدیل‌اند.
• سفارش‌های بیرون از دامنه شعبه دیدنی به‌طور کامل مستثنا می‌شوند.

صفحات مرتبط#

• خریدها
• فروش‌ها
• سفارش‌های فروش
• مرجع نقاط پایانی