مستندات API: لیست محصولات

اطلاعات پایه

GET

/giftcard/product-list

نام API: لیست محصولات
آدرس پایه: /giftcard/product-list
متد: GET

پارامترهای درخواست

هدرها

کلید	مقدار	توضیحات
Authorization	Bearer {token}	توکن احراز هویت

پارامترهای URL

پارامتر	نوع	اجباری	توضیحات
category_sku	string	بله	شناسه دسته‌بندی برای دریافت محصولات
page	integer	خیر	شماره صفحه (پیش‌فرض: 1)
page_size	integer	خیر	تعداد آیتم در هر صفحه (پیش‌فرض: 10، حداکثر: 50)

پاسخ‌های ممکن

موفقیت (200 OK)

				
					{
  "total": 100,
  "page": 1,
  "page_size": 10,
  "products": [
    {
      "name": "نام محصول",
      "sku": "PRODUCT-SKU",
      "url": "https://example.com/product",
      "image_url": "https://example.com/image.jpg",
      "variant_count": 5
    }
  ]
}

خطاها

400 Bad Request - پارامترهای ناقص

				
					{
  "code": "rest_missing_parameters",
  "message": "پارامترهای الزامی وجود ندارد",
  "data": {
    "status": 400
  }
}

401 Unauthorized - توکن نامعتبر

				
					{
  "error": "توکن احراز هویت نامعتبر است"
}

404 Not Found - دسته‌بندی یافت نشد

				
					{
  "error": "دسته‌بندی یافت نشد",
  "sku": "CATEGORY-SKU"
}

مثال‌های کد

cURL

				
					curl -X GET \
  '{base_url}/giftcard/product-list?category_sku=CATEGORY-SKU&page=1&page_size=10' \
  -H 'Authorization: Bearer {token}'

PHP

				
					$ch = curl_init('{base_url}/giftcard/product-list?category_sku=CATEGORY-SKU&page=1&page_size=10');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer {token}'
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);

Python

				
					import requests

headers = {
    'Authorization': 'Bearer {token}'
}

params = {
    'category_sku': 'CATEGORY-SKU',
    'page': 1,
    'page_size': 10
}

response = requests.get('{base_url}/giftcard/product-list',
    headers=headers,
    params=params)
data = response.json()

Node.js

				
					const axios = require("axios");

const response = await axios.get("{base_url}/giftcard/product-list", {
  headers: {
    Authorization: "Bearer {token}",
  },
  params: {
    category_sku: "CATEGORY-SKU",
    page: 1,
    page_size: 10,
  },
});

const data = response.data;