اعلام دریافت سفارشها
پاتریس یار پس از ذخیرهی سفارشها، شناسهی آنها را به POST /wp-json/payava-patris/v1/orders/delivered میفرستد. سایت باید این سفارشها را «تحویلشده به پاتریس» علامت بزند تا در GET /wp-json/payava-patris/v1/orders دوباره نیایند.
این endpoint کی صدا زده میشود؟
- پس از هر صفحه از
GET /wp-json/payava-patris/v1/orders، با شناسهی همهی سفارشهای همان صفحه. - در روش «دریافت از طریق سرور پاتریس»، پس از دریافت سفارشهای این سایت از سرور. خطای این مرحله فقط در log پاتریس یار ثبت میشود.
پیشنیازها
- مسیرها و احراز هویت در وردپرس
- یک meta سفارش برای زمان تحویل به پاتریس (در نمونه
_my_patris_delivered).
Endpoint
POST /wp-json/payava-patris/v1/orders/delivered
هدرها
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
X-Payava-Key | string | بله | کلید API حساب پاتریس. |
Content-Type | string | بله | application/json; charset=utf-8 |
پارامترها
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
ids | string[] | بله | شناسهی سفارشها. پاتریس یار عددها را به صورت رشته میفرستد، مثل "1532". |
پیادهسازی در وردپرس
POST /orders/delivered
function my_patris_delivered(WP_REST_Request $request)
{
$done = 0;
foreach ((array) $request->get_param('ids') as $id) { // ids arrive as strings: "1532"
$order = wc_get_order((int) $id);
if (!$order || $order->get_meta('_my_patris_delivered')) {
continue; // unknown or already delivered: no error
}
$order->update_meta_data('_my_patris_delivered', current_time('mysql'));
$order->add_order_note('سفارش برای پاتریس دریافت شد (پاتریس یار).');
$order->save();
$done++;
}
return ['delivered' => $done];
}
نمونه پاسخ موفق
200 OK
{ "delivered": 2 }
پاتریس یار مقدار delivered را نمیخواند. فقط موفق بودن پاسخ (کد 2xx) مهم است.
کدهای خطا
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
401 | payava_patris_unauthorized | — | کلید نادرست است. |
400 | invalid_json | — | بدنهی درخواست JSON معتبر نیست. |
نکتهها
idempotent باشد
یک سفارش ممکن است دوباره اعلام شود (مثلاً وقتی پاسخ قبلی به پاتریس یار نرسیده). سفارشی که قبلاً تحویل شده را بدون خطا رد کنید و زمان تحویل اول را تغییر ندهید.
- شناسهی ناشناخته را نادیده بگیرید و برای آن خطا ندهید.
- میتوانید هنگام علامتگذاری، یادداشت «سفارش برای پاتریس دریافت شد» را در تاریخچهی سفارش ثبت کنید.