سرویس محصول

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

پیش‌نیازها

برای استفاده از سرویس‌های تعریف شده، نیاز به ارسال Bearer توکن است. از طریق ارتباط با پشتیبانی می‌توانید توکن دسترسی را دریافت کنید.

آدرس پایه ارسال درخواست‌ها

https://core.affili.ir/services/products

API محصولات

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

نوع عملیات	نوع درخواست	توضیحات	uri
درون‌ریزی	POST	درون‌ریزی محصولات؛ می‌توانید حداکثر ۱۰۰۰ محصول را در هر بار فراخوانی سرویس  درون‌ریزی کنید.	/

درون‌ریزی محصولات

آدرس ارسال درخواست

POST https://core.affili.ir/services/products

قالب درخواست درون‌ریزی

{
  "products": [
  	object (Product),
    ...
  ]
}

پارامترها

نام	اجباری	توضیحات
products	بلی	Array of Product Object لیست محصولات

 

موجودیت‌ها

product

قالب JSON

{
  "pid": string,
  "name": string,
  "url": string,
  "price": double,
  "old_price": double,
  "in_stock": boolean,
  "images": [
    string,
    ...
  ],
  "categories": [
    object (Category)
  ],
  "last_update": dateTime
}

پارامترها

pid	String شناسه یکتای محصول در وبسایت فروشگاه
name	String نام محصول
url	String آدرس صفحه محصول در وبسایت فروشگاه
price	Double قیمت محصول
old_price	Double قیمت قدیمی محصولی؛ در صورتی که محصول قیمت قدیمی ندارد مقدار این پارامتر برابر با null می‌شود.
in_stock	Boolean وضعیت موجود بودن محصول؛ که می‌تواند یکی از مقادیر 0، 1، true یا false را داشته باشد.
images	Array آرایه‌ای از آدرس عکس‌های محصول
categories	Array of Category Object لیست دسته‌بندی‌های محصول

Category

قالب JSON

{
  "cid": string,
  "name": string,
  "url": string,
  "parent_cid": string,
  "is_primary": boolean
}

پارامترها

cid	String شناسه یکتای دسته‌بندی در وبسایت فروشگاه
name	String نام دسته‌بندی
url	String آدرس صفحه دسته‌بندی در وبسایت فروشگاه
parent_cid	String دسته والد؛ در صورتی که دسته‌بندی، دسته والد ندارد مقدار این پارامتر برابر با null می‌شود.
is_primary	Boolean دسته‌بندی شاخص؛ در صورتی که این دسته‌بندی، دسته‌بندی شاخص محصول است مقدار این پارامتر برابر با ۱ یا true و در غیر این صورت برابر با ۰ یا false می‌شود.