مستندات API محصولات آوای باران
مقدمه
این API به منظور نمایش محصولات طراحی شده است.
تمام دادهها در قالب JSON برگردانده میشوند و قابلیت استفاده در وبسایتها، اپلیکیشنهای موبایل و نرمافزارهای مدیریت سفارش را دارند.
مشخصات کلی API
آدرس پایه (Base URL):
https://avayebaran.ir/api/
فرمت دادهها: JSON
متدهای پشتیبانی: GET
دریافت لیست محصولات
آدرس (URL):
https://avayebaran.ir/api/products/
توضیح: دریافت لیست محصولات فعال همراه با صفحهبندی (Pagination).
ساختار پاسخ:
{
"count": 471,
"next": "https://avayebaran.ir/api/products/?page=2",
"previous": null,
"results": [ ... ]
}
توضیح فیلدها:
count | تعداد کل محصولات موجود در پایگاه داده |
next | لینک صفحه بعد (در صورت وجود) |
previous | لینک صفحه قبل (در صورت وجود) |
results | آرایهای از محصولات در این صفحه |
نمونه آیتم در results:
{
"sku": "146461",
"name": "جوکر",
"price": 750000,
"stock_status": "in_stock",
"quantity_per_carton": 12,
"primary_image": "https://avayebaran.ir/media/product_images/IMG_8007.jpg",
"web_url": "https://avayebaran.ir/product/جوکر/",
"short_url": "https://avayebaran.ir/p/146461/",
"api_url": "https://avayebaran.ir/api/products/146461/"
}
دریافت جزئیات محصول
آدرس (URL):
https://avayebaran.ir/api/products/{sku}/
مثال:
https://avayebaran.ir/api/products/146461/
نمونه پاسخ
{
"name": "جوکر",
"short_description": "جوکر آخر خنده، آخر دورهمیهای با حال...",
"description": "",
"brand": "بازی تا",
"categories": ["کارتی"],
"tags": [],
"price": 750000,
"age_from": 168,
"age_range_display": "از 14 سال به بالا",
"is_active": true,
"created_at": "1404-06-03T12:06:42.784519+0330",
"primary_image_url": "/media/product_images/IMG_8007.jpg",
"images": [
"/media/product_images/IMG_7999.jpg",
"/media/product_images/IMG_8025.jpg",
"/media/product_images/IMG_8039.jpg"
],
"packages": [
{
"sku": "146461",
"quantity_per_carton": 12,
"stock_status": "in_stock",
"is_primary": true,
"pack_price": 9000000
}
],
"average_rating": 0.0,
"web_url": "https://avayebaran.ir/product/جوکر/",
"short_url": "https://avayebaran.ir/p/146461/",
"api_url": "https://avayebaran.ir/api/products/146461/"
}
توضیح فیلدها:
name | لینک صفحه نام محصول |
short_description | توضیح کوتاه |
description | توضیحات کامل |
brand | برند محصول |
categories | دستهبندیها |
tags | تگها |
price | قیمت (تومان) |
age_from | حداقل سن (ماه) |
age_to | حداکثر سن (ماه) |
age_range_display | نمایش بازه سنی (متن آماده) |
width | عرض محصول (سانتیمتر) |
height | ارتفاع محصول (سانتیمتر) |
depth | عمق محصول (سانتیمتر) |
weight | وزن محصول (گرم) |
is_active | وضعیت فعال بودن محصول |
is_featured | آیا محصول ویژه است یا خیر |
created_at | تاریخ ثبت محصول |
updated_at | تاریخ آخرین بروزرسانی محصول |
primary_image_url | تصویر اصلی محصول |
images | آرایهای از تصاویر بیشتر |
videos | آرایهای از ویدیوهای مرتبط |
attributes | ویژگیهای خاص محصول (در صورت تعریف) |
packages | اطلاعات بستهبندی و کارتن |
sku | کد یکتای محصول |
quantity_per_carton | تعداد در هر کارتن |
stock_status | وضعیت موجودی (in_stock / out_of_stock) |
is_primary | آیا این پکیج، اصلیترین بسته محصول است؟ |
pack_price | قیمت هر کارتن |
average_rating | امتیاز کاربران |
web_url | لینک نمایش در سایت |
short_url | لینک کوتاه |
api_url | لینک API جزئیات محصول |