پرش به محتوای مستندات
محصولات
API Reference

محصولات

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

GET/api/v1/products

دریافت فهرست محصولات

محصولات را با اطلاعات پایه و صفحه‌بندی برمی‌گرداند. قیمت و پراپرتی‌های قابل سفارش در این پاسخ نیستند.

نیازمند API Key

پارامترها

4 مورد
page
numberاختیاری
شماره صفحه؛ مقدار پیش‌فرض ۱ است.
pageSize
numberاختیاری
تعداد آیتم در هر صفحه؛ مقدار پیش‌فرض ۱۰ است.
category
stringاختیاری
یکی از مقادیر GIFTCARD، PREMIUM، GAME یا APP.
search
stringاختیاری
جست‌وجو در نام، عنوان کارت و توضیحات محصول.

نمونه داده

پاسخ موفق
Responsejson
{
  "status": "success",
  "code": 200,
  "data": [
    {
      "id": 123,
      "name": "گیفت کارت استیم",
      "description": "خرید گیفت کارت استیم با تحویل آنی",
      "category": "GIFTCARD",
      "slug": "steam-giftcard",
      "image": "https://gift30t.ir/products/steam.png",
      "regions": [
        {
          "id": 1,
          "name": "Global",
          "flag": "global"
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 24,
      "page": 1,
      "pageSize": 10,
      "totalPages": 3
    }
  }
}
GET/api/v1/products/category/:id

محصولات یک دسته‌بندی

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

نیازمند API Key

پارامترها

3 مورد
id
stringالزامی
شناسه دسته‌بندی: GIFTCARD، PREMIUM، GAME یا APP.
page
numberاختیاری
شماره صفحه؛ مقدار پیش‌فرض ۱ است.
pageSize
numberاختیاری
تعداد آیتم در هر صفحه؛ مقدار پیش‌فرض ۱۰ است.

نمونه داده

پاسخ موفق
Responsejson
{
  "status": "success",
  "code": 200,
  "data": [
    {
      "id": 123,
      "name": "گیفت کارت استیم",
      "description": "خرید گیفت کارت استیم با تحویل آنی",
      "category": "GIFTCARD",
      "slug": "steam-giftcard",
      "image": "https://gift30t.ir/products/steam.png",
      "regions": [
        {
          "id": 1,
          "name": "Global",
          "flag": "global"
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 15,
      "page": 1,
      "pageSize": 10,
      "totalPages": 2
    },
    "category": "GIFTCARD"
  }
}
GET/api/v1/products/:id

دریافت جزئیات محصول

قیمت‌ها، موجودی، regionPropertyId، فیلدهای الزامی، FAQ و راهنمای فعال‌سازی یک محصول را برمی‌گرداند.

نیازمند API Key

پارامترها

1 مورد
id
numberالزامی
شناسه عددی محصول.

نمونه داده

پاسخ موفق
Responsejson
{
  "status": "success",
  "code": 200,
  "data": {
    "id": 123,
    "name": "گیفت کارت استیم",
    "description": "خرید گیفت کارت استیم با تحویل آنی",
    "category": "GIFTCARD",
    "slug": "steam-giftcard",
    "image": "https://gift30t.ir/products/steam.png",
    "content": "توضیحات کامل محصول",
    "regions": [
      {
        "id": 1,
        "name": "Global",
        "flag": "global",
        "properties": [
          {
            "id": 101,
            "title": "10 دلاری",
            "price": 490000,
            "originalPrice": 510000,
            "stock_status": "INSTOCK"
          }
        ]
      }
    ],
    "requiredFields": [
      {
        "id": 1,
        "fieldName": "ایمیل",
        "fieldType": "EMAIL"
      }
    ],
    "faq": [
      {
        "title": "چگونه محصول را فعال کنم؟",
        "description": "راهنمای کوتاه فعال‌سازی"
      }
    ],
    "redeemGuide": "راهنمای کامل فعال‌سازی محصول"
  }
}
GET/api/v1/products/categories

دریافت دسته‌بندی‌ها

تمام دسته‌بندی‌های قابل استفاده در API را همراه تعداد محصولات هر دسته برمی‌گرداند.

نیازمند API Key

نمونه داده

پاسخ موفق
Responsejson
{
  "status": "success",
  "code": 200,
  "data": [
    { "id": "GIFTCARD", "name": "گیفت کارت", "count": 15 },
    { "id": "PREMIUM", "name": "اشتراک پریمیوم", "count": 8 },
    { "id": "GAME", "name": "بازی", "count": 12 },
    { "id": "APP", "name": "اپلیکیشن", "count": 5 }
  ]
}