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

اعلام دریافت سفارش‌ها

پاتریس یار پس از ذخیره‌ی سفارش‌ها، شناسه‌ی آن‌ها را به POST /patris-yar/orders/delivered می‌فرستد. سایت باید این سفارش‌ها را «تحویل‌شده به پاتریس» علامت بزند تا در GET /patris-yar/orders دوباره نیایند.

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

  • پس از هر صفحه از GET /patris-yar/orders، با شناسه‌ی همه‌ی سفارش‌های همان صفحه.
  • در روش «دریافت از طریق سرور پاتریس»، پس از دریافت سفارش‌های این سایت از سرور. خطای این مرحله فقط در log پاتریس یار ثبت می‌شود.

پیش‌نیازها​

Endpoint​

POST /patris-yar/orders/delivered

هدرها​

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

پارامترها​

نامنوعالزامیتوضیح
idsstring[]بلهشناسه‌ی سفارش‌ها. پاتریس یار عددها را به صورت رشته می‌فرستد، مثل "1532".

نمونه درخواست و پیاده‌سازی​

اعلام دریافت
curl -X POST https://shop.example.com/patris-yar/orders/delivered \
-H "X-Payava-Key: YOUR_API_KEY" \
-H "Content-Type: application/json; charset=utf-8" \
-d '{"ids":["1532","1533"]}'

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

200 OK
{ "delivered": 2 }

پاتریس یار مقدار delivered را نمی‌خواند. فقط موفق بودن پاسخ (کد 2xx) مهم است.

کدهای خطا​

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

نکته‌ها​

idempotent باشد

یک سفارش ممکن است دوباره اعلام شود (مثلاً وقتی پاسخ قبلی به پاتریس یار نرسیده). سفارشی که قبلاً تحویل شده را بدون خطا رد کنید و زمان تحویل اول را تغییر ندهید.

  • شناسه‌ی ناشناخته را نادیده بگیرید و برای آن خطا ندهید.
  • می‌توانید هنگام علامت‌گذاری، یادداشت «سفارش برای پاتریس دریافت شد» را در تاریخچه‌ی سفارش ثبت کنید.