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

دریافت سفارش‌های جدید

پاتریس یار با GET /patris-yar/orders سفارش‌هایی را می‌گیرد که هنوز به پاتریس تحویل نشده‌اند. سایت باید فقط سفارش‌های تحویل‌نشده را، از قدیمی به جدید، برگرداند.

پاتریس یار سفارش‌ها را چطور می‌گیرد؟​

  1. پاتریس یار GET /patris-yar/orders?limit=50 را صدا می‌زند.
  2. سفارش‌ها را در پاتریس ذخیره می‌کند.
  3. شناسه‌ی همه‌ی سفارش‌های دریافتی را به POST /patris-yar/orders/delivered می‌فرستد.
  4. اگر پاسخ خالی نبود، دوباره از مرحله‌ی ۱ شروع می‌کند (حداکثر ۲۰ صفحه در هر دور).

این کار وقتی روش اتصال در پاتریس یار «دریافت مستقیم از همین اتصال» است، در فاصله‌ی زمانی تنظیم‌شده انجام می‌شود.

پیش‌نیازها​

Endpoint​

GET /patris-yar/orders?limit=50

هدرها​

نامنوعالزامیتوضیح
X-Payava-Keystringبلهکلید API حساب پاتریس.

پارامترها​

نامنوعالزامیتوضیح
limitinteger (query)خیرحداکثر تعداد سفارش در پاسخ. پاتریس یار 50 می‌فرستد. مقدار را بین 1 و 100 محدود کنید.

کدام سفارش‌ها برگردانده شوند؟​

  • سفارش‌هایی که هنوز با POST /patris-yar/orders/delivered تحویل نشده‌اند.
  • فقط وضعیت‌هایی که می‌خواهید به پاتریس برسند، مثلاً processing و on-hold.
  • فقط سفارش‌های ثبت‌شده پس از تاریخ شروع اتصال، تا کل سفارش‌های قدیمی به پاتریس نرود.
  • مرتب‌شده بر اساس زمان ثبت، از قدیمی به جدید.

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

دریافت سفارش‌ها
curl "https://shop.example.com/patris-yar/orders?limit=50" \
-H "X-Payava-Key: YOUR_API_KEY"

تابع to_patris_order (یا PatrisOrderMapper.ToPatris، toPatrisOrder) سفارش سایت را به قالب سفارش تبدیل می‌کند و مبلغ‌ها را به واحد پاتریس می‌برد.

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

200 OK
{
"orders": [
{
"id": 1532,
"number": "1532",
"status": "processing",
"created": "2026-11-07T10:42:13+03:30",
"customer_name": "علی رضایی",
"username": "",
"user_mobile": "",
"phone": "09120000000",
"email": "",
"country": "IR",
"state": "تهران",
"city": "تهران",
"address": "خیابان نمونه، پلاک ۱",
"postcode": "1234567890",
"subtotal": 2400000,
"discount": 200000,
"shipping": 300000,
"total": 2500000,
"transaction_id": "",
"order_key": "",
"note": "",
"visitor_code": 0,
"visitor_name": "",
"lines": [
{ "pip": "101009001", "sku": "", "name": "لنت ترمز جلو", "quantity": 2, "unit_price": 1200000, "discount": 200000 }
]
}
]
}

سفارش جدیدی نیست؟ آرایه‌ی خالی برگردانید:

200 OK
{ "orders": [] }

کدهای خطا​

نامنوعالزامیتوضیح
401payava_patris_unauthorized—کلید نادرست است.
429——سایت درخواست را محدود کرده است. پاتریس یار دور بعد دوباره تلاش می‌کند.
500——خطای سایت. پاتریس یار متن message را نشان می‌دهد و دور بعد دوباره تلاش می‌کند.

نکته‌ها​

سفارش تحویل‌شده را دوباره برنگردانید

اگر سایت پس از POST /patris-yar/orders/delivered همان سفارش‌ها را دوباره برگرداند، پاتریس یار در هر دور ۲۰ بار همان صفحه را می‌خواند. پاتریس سفارش تکراری ثبت نمی‌کند، ولی بار بی‌دلیل روی سایت می‌ماند.

  • در روش «دریافت از طریق سرور پاتریس» هم این endpoint را نگه دارید. اگر سرور در دسترس نباشد، با گذاشتن اتصال روی «دریافت مستقیم از همین اتصال» سفارش‌ها از همین endpoint گرفته می‌شوند.
  • برای کارایی، روی ستون‌های وضعیت، زمان ثبت و علامت تحویل index بگذارید.