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

قالب سفارش

این صفحه قالب JSON یک سفارش را توضیح می‌دهد. همین قالب در GET /patris-yar/orders، GET /patris-yar/orders/:id و ارسال سفارش به سرور پاتریس به کار می‌رود.

یک سفارش کامل چه شکلی دارد؟​

نمونه‌ی سفارش
{
"id": 1532,
"number": "1532",
"status": "processing",
"created": "2026-11-07T10:42:13+03:30",
"customer_name": "علی رضایی",
"username": "ali.rezaei",
"user_mobile": "09120000000",
"phone": "09120000000",
"email": "customer@example.com",
"country": "IR",
"state": "تهران",
"city": "تهران",
"address": "خیابان نمونه، پلاک ۱",
"postcode": "1234567890",
"subtotal": 2700000,
"discount": 200000,
"shipping": 300000,
"total": 2800000,
"transaction_id": "A00000000000000000000000000123456",
"order_key": "ord_8f3a2c",
"note": "لطفاً قبل از ارسال تماس بگیرید.",
"visitor_code": 0,
"visitor_name": "",
"lines": [
{
"pip": "101009001",
"sku": "BRK-001",
"name": "لنت ترمز جلو",
"quantity": 2,
"unit_price": 1200000,
"discount": 200000
},
{
"pip": "",
"sku": "101009007",
"name": "روغن موتور",
"quantity": 1,
"unit_price": 300000,
"discount": 0
}
]
}

فیلدهای سفارش​

نامنوعالزامیتوضیح
idintegerبلهشناسه‌ی یکتای سفارش در سایت. باید عدد صحیح مثبت باشد، چون در مسیر /patris-yar/orders/:id هم استفاده می‌شود.
numberstringبلهشماره‌ی سفارش که به مشتری نشان می‌دهید.
statusstringبلهوضعیت سفارش. processing و completed یعنی پرداخت‌شده. جدول وضعیت‌ها را پایین‌تر ببینید.
createdstringبلهزمان ثبت سفارش با قالب ISO 8601 و منطقه‌ی زمانی، مثل 2026-11-07T10:42:13+03:30.
customer_namestringخیرنام و نام خانوادگی خریدار.
usernamestringخیرنام کاربری خریدار در سایت. برای مهمان خالی بگذارید.
user_mobilestringخیرموبایل ثبت‌شده در حساب کاربری. فقط وقتی phone موبایل نیست استفاده می‌شود.
phonestringخیرتلفن صورت‌حساب. اگر موبایل ایران باشد، مشتری با همین موبایل شناخته می‌شود.
emailstringخیرایمیل خریدار.
countrystringخیرکد کشور، مثل IR.
statestringخیرنام استان.
citystringخیرنام شهر.
addressstringخیرنشانی کامل در یک خط.
postcodestringخیرکد پستی.
subtotalnumberبلهجمع مبلغ اقلام پیش از تخفیف، به واحد پاتریس.
discountnumberبلهجمع تخفیف سفارش، به واحد پاتریس.
shippingnumberبلههزینه‌ی ارسال، به واحد پاتریس.
totalnumberبلهمبلغ نهایی سفارش، به واحد پاتریس.
transaction_idstringخیرکد پیگیری پرداخت.
order_keystringخیرکلید یا کد مرجع داخلی سفارش.
notestringخیریادداشت خریدار.
visitor_codeintegerخیرکد بازاریاب در پاتریس. نبودِ بازاریاب را با 0 بفرستید.
visitor_namestringخیرنام بازاریاب. نبودِ بازاریاب را با رشته‌ی خالی بفرستید.
linesarrayبلهاقلام سفارش. جدول بعد را ببینید.

فیلدهای هر قلم سفارش​

نامنوعالزامیتوضیح
pipstringبلهکد کالا در پاتریس. اگر کالا کد پاتریس ندارد، رشته‌ی خالی بفرستید.
skustringخیرSKU کالا در سایت. اگر pip خالی باشد و sku عدد باشد، پاتریس یار آن را کد کالای پاتریس فرض می‌کند.
namestringبلهنام کالا.
quantitynumberبلهتعداد. عدد اعشاری مجاز است.
unit_pricenumberبلهقیمت واحد پیش از تخفیف قلم، به واحد پاتریس.
discountnumberبلهجمع تخفیف این قلم (نه تخفیف هر واحد)، به واحد پاتریس.

وضعیت‌های سفارش​

پاتریس یار نام وضعیت‌های ووکامرس را می‌شناسد. وضعیت‌های سایت خود را به این مقدارها نگاشت کنید:

نامنوعالزامیتوضیح
pendingstringخیردر انتظار پرداخت.
on-holdstringخیردر انتظار بررسی (مثلاً پرداخت کارت‌به‌کارت).
processingstringخیرپرداخت‌شده و در حال آماده‌سازی. پاتریس یار سفارش را پرداخت‌شده ثبت می‌کند.
completedstringخیرتکمیل‌شده. پاتریس یار سفارش را پرداخت‌شده ثبت می‌کند.
cancelledstringخیرلغوشده.

تعیین کنید کدام وضعیت‌ها به پاتریس برسند. پیشنهاد ما processing و on-hold است.

مبلغ‌ها با چه واحدی ارسال شوند؟​

همه‌ی مبلغ‌ها باید به واحد پاتریس باشند. اگر سایت با تومان کار می‌کند و پاتریس با ریال، هر مبلغ را در 10 ضرب کنید. این ضریب را در تنظیمات سایت نگه دارید، چون قیمت‌هایی که پاتریس به POST /patris-yar/products می‌فرستد هم به واحد پاتریس هستند و باید بر همین ضریب تقسیم شوند.

مشتری چطور شناخته می‌شود؟​

  • اگر phone موبایل ایران باشد، مشتری با همین موبایل شناخته می‌شود.
  • در غیر این صورت user_mobile به کار می‌رود و phone تلفن ثابت فرض می‌شود.
  • اگر هیچ‌کدام موبایل نباشد، username نام کاربری مشتری در پاتریس می‌شود.

پاتریس یار موبایل را با ارقام فارسی، +98 و 0098 هم می‌پذیرد، ولی بهتر است شکل 09xxxxxxxxx را بفرستید.

نکته‌ها​

کد کالای پاتریس

پاتریس قلم سفارش را با کد کالا می‌شناسد. اگر قلمی کد نداشته باشد، با کد 0 و یادداشت «کد پاتریس (PIP) این محصول در سایت ثبت نشده» ثبت می‌شود. بعداً اگر کد را در سایت ثبت کنید، پاتریس یار سفارش را با GET /patris-yar/orders/:id دوباره می‌خواند و کدها را کامل می‌کند.

  • id و تعداد و ترتیب lines یک سفارش را پس از ارسال تغییر ندهید. تکمیل کد کالا بر اساس جایگاه قلم انجام می‌شود.
  • حجم JSON یک سفارش برای سرور پاتریس حداکثر ۲۵۶ هزار کاراکتر است.
  • فیلدهای اضافه را پاتریس یار نادیده می‌گیرد.