پرش به مطلب اصلی

دریافت قیمت و موجودی کالاها

پاتریس یار تغییرات کالاهای پاتریس را با POST /wp-json/payava-patris/v1/products به سایت می‌فرستد. سایت این ردیف‌ها را ذخیره می‌کند و قیمت و موجودی محصولاتی را که به کد پاتریس متصل‌اند به‌روز می‌کند.

این endpoint کی صدا زده می‌شود؟​

  • وقتی گزینه‌ی «به‌روزرسانی قیمت و موجودی» برای این سایت در پاتریس یار روشن باشد.
  • در هر دور همگام‌سازی، فقط ردیف‌هایی که از ارسال قبلی تغییر کرده‌اند.
  • در دسته‌هایی به اندازه‌ی «تعداد در هر ارسال» (پیش‌فرض ۱۰۰ و حداکثر ۵۰۰۰ ردیف)، تا ۵۰ دسته در هر دور.

پیش‌نیازها​

Endpoint​

POST /wp-json/payava-patris/v1/products

هدرها​

نامنوعالزامیتوضیح
X-Payava-Keystringبلهکلید API حساب پاتریس.
Content-Typestringبلهapplication/json; charset=utf-8

پارامترها​

بدنه یک شیء با آرایه‌ی products است. هر عضو یک ردیف «کالا در یک انبار» است:

نامنوعالزامیتوضیح
codeintegerبلهکد کالا در پاتریس.
anbarintegerبلهکد انبار. -1 یعنی جمع موجودی همه‌ی انبارها.
actionstringبلهUpdateProduct برای افزودن یا به‌روزرسانی، DeleteProduct برای حذف کالا در پاتریس.
namestringخیرنام کالا در پاتریس.
unitstringخیرواحد کالا، مثل «عدد».
pricenumberبلهقیمت اصلی، به واحد پاتریس.
price1numberبلهقیمت سطح ۱، به واحد پاتریس.
price2numberبلهقیمت سطح ۲، به واحد پاتریس.
price3numberبلهقیمت سطح ۳، به واحد پاتریس.
price_wgnumberبلهقیمت عمده، به واحد پاتریس.
inventorynumberبلهموجودی این انبار.

سایت با هر ردیف چه کند؟​

  1. ردیف را با کلید code و anbar ذخیره یا جایگزین کند. DeleteProduct را فقط علامت «حذف‌شده» بزنید.
  2. محصولات و متغیرهای ووکامرس با meta _pip برابر همین code را پیدا کند.
  3. قیمت را از سطح قیمت انتخابی (مثلاً price) بخواند، بر ضریب واحد تقسیم کند و اگر بزرگ‌تر از صفر بود، روی محصول بگذارد.
  4. موجودی را از انبار انتخابی بگذارد. اگر انبار خاصی انتخاب نشده، ردیف anbar برابر -1 را به کار ببرد.

پیاده‌سازی در وردپرس​

POST /products
function my_patris_products(WP_REST_Request $request)
{
$factor = (float) get_option('my_patris_price_factor', 1) ?: 1.0; // e.g. 10: shop in Toman, Patris in Rial
$stored = $updated = $notFound = 0;
foreach ((array) $request->get_param('products') as $row) {
$code = (int) ($row['code'] ?? 0);
if ($code <= 0) {
continue;
}
$stored++; // keep the row in your own table if you need warehouses / a catalog
if (($row['action'] ?? '') === 'DeleteProduct') {
continue; // never delete WooCommerce products automatically
}
$ids = get_posts(['post_type' => ['product', 'product_variation'], 'post_status' => 'any', 'fields' => 'ids',
'posts_per_page' => -1, 'meta_key' => '_pip', 'meta_value' => (string) $code]);
if (!$ids) {
$notFound++;
continue;
}
foreach ($ids as $id) {
$product = wc_get_product($id);
$price = (float) ($row['price'] ?? 0);
if ($price > 0) {
$product->set_regular_price(wc_format_decimal($price / $factor, wc_get_price_decimals()));
}
if ((int) ($row['anbar'] ?? 0) === -1) { // -1 = total of all warehouses
$product->set_manage_stock(true);
$product->set_stock_quantity(wc_stock_amount((float) ($row['inventory'] ?? 0)));
}
$product->save();
$updated++;
}
}
return ['stored' => $stored, 'updated' => $updated, 'not_found' => $notFound, 'skipped' => 0];
}

نمونه پاسخ موفق​

200 OK
{ "stored": 1, "updated": 1, "not_found": 0, "skipped": 0 }
نامنوعالزامیتوضیح
storedintegerخیرتعداد ردیف‌های ذخیره‌شده.
updatedintegerخیرتعداد محصولات سایت که تغییر کردند. پاتریس یار این عدد را در log خود ثبت می‌کند.
not_foundintegerخیرتعداد کدهایی که محصول متصل در سایت نداشتند.
skippedintegerخیرتعداد کدهای ردشده.

کدهای خطا​

نامنوعالزامیتوضیح
401payava_patris_unauthorized—کلید نادرست است.
400invalid_json—بدنه‌ی درخواست JSON معتبر نیست.
413——بدنه از حد مجاز سرور بزرگ‌تر است. حد سرور را بالا ببرید یا «تعداد در هر ارسال» را در پاتریس یار کم کنید.

نکته‌ها​

ردیف‌ها فقط پس از پاسخ موفق ارسال‌شده حساب می‌شوند

اگر پاسخ موفق نباشد، پاتریس یار همان ردیف‌ها را در دور بعد دوباره می‌فرستد. پس ذخیره را با کلید code و anbar و به صورت جایگزینی بنویسید تا تکرار مشکلی ایجاد نکند.

  • محصولی را که در پاتریس حذف شده (DeleteProduct)، در سایت حذف نکنید. ردیف را علامت بزنید و تصمیم درباره‌ی محصول را به مدیر سایت بسپارید.
  • قیمت 0 یعنی پاتریس برای آن سطح قیمت ندارد. قیمت محصول سایت را با 0 بازنویسی نکنید.
  • دسته‌ی ۵۰۰۰ ردیفی چند مگابایت حجم دارد. post_max_size در PHP و حد اندازه‌ی بدنه در وب‌سرور یا فایروال باید برای آن کافی باشد.