موجودی#

GET /api/v2/stock رشته‌های موجودی را برمی‌گرداند: یک رکورد به ازای هر واریانت محصول در هر مکان شعبه. این نقطه پایانی مورد استفاده برای دسترس‌پذیری، تأمین مجدد و مغایرت‌گیری انبار است.

اجازه#

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

موجودی جستجو یا فیلتر تاریخ ندارد. با X-Business-Branch به شعبه تنگ کنید، یا رشته‌های برگشتی را در سمت کلاینت فیلتر نمایید.

درخواست#

curl -s "https://app.example.com/api/v2/stock?per_page=100" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-Business-Branch: 4" \
  -H "Accept: application/json"

پاسخ#

{
  "data": [
    {
      "id": 5512,
      "business_branch_id": 4,
      "product_id": 128,
      "product_code": "NET-0042",
      "product_model": "AX3000",
      "product_name": "Router AX3000",
      "sku": "AX3000-BLK",
      "available_quantity": 12,
      "received_quantity": 20,
      "reserved_quantity": 8,
      "is_available": true,
      "expiry_date": null
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 100,
    "total": 1
  }
}

فیلدها#

مقدارها به‌صورت عدد برگردانده می‌شوند و ممکن است اعشار داشته باشند. فرض عدد صحیح نکنید.

خواندن مقدارها#

دسترس‌پذیر همان عددی است که جریان فروش به آن اعتماد می‌کند. رزورشده حتی اگر فیزیکاً موجود باشد، دوباره قابل فروش نیست.

ترتیب و صفحه‌بندی#

رشته‌ها بر اساس id موجودی صعودی مرتب‌اند. اندازه صفحه پیش‌فرض 25 و حداکثر 100 است، بنابراین یک انبار کامل به صفحه‌بندی نیاز دارد.

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

محدودیت‌ها#

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

صفحات مرتبط#

• محصولات
• نمای کلی موجودی
• مرجع نقاط پایانی