قالب سفارش
این صفحه قالب 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
}
]
}
فیلدهای سفارش
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
id | integer | بله | شناسهی یکتای سفارش در سایت. باید عدد صحیح مثبت باشد، چون در مسیر /patris-yar/orders/:id هم استفاده میشود. |
number | string | بله | شمارهی سفارش که به مشتری نشان میدهید. |
status | string | بله | وضعیت سفارش. processing و completed یعنی پرداختشده. جدول وضعیتها را پایینتر ببینید. |
created | string | بله | زمان ثبت سفارش با قالب ISO 8601 و منطقهی زمانی، مثل 2026-11-07T10:42:13+03:30. |
customer_name | string | خیر | نام و نام خانوادگی خریدار. |
username | string | خیر | نام کاربری خریدار در سایت. برای مهمان خالی بگذارید. |
user_mobile | string | خیر | موبایل ثبتشده در حساب کاربری. فقط وقتی phone موبایل نیست استفاده میشود. |
phone | string | خیر | تلفن صورتحساب. اگر موبایل ایران باشد، مشتری با همین موبایل شناخته میشود. |
email | string | خیر | ایمیل خریدار. |
country | string | خیر | کد کشور، مثل IR. |
state | string | خیر | نام استان. |
city | string | خیر | نام شهر. |
address | string | خیر | نشانی کامل در یک خط. |
postcode | string | خیر | کد پستی. |
subtotal | number | بله | جمع مبلغ اقلام پیش از تخفیف، به واحد پاتریس. |
discount | number | بله | جمع تخفیف سفارش، به واحد پاتریس. |
shipping | number | بله | هزینهی ارسال، به واحد پاتریس. |
total | number | بله | مبلغ نهایی سفارش، به واحد پاتریس. |
transaction_id | string | خیر | کد پیگیری پرداخت. |
order_key | string | خیر | کلید یا کد مرجع داخلی سفارش. |
note | string | خیر | یادداشت خریدار. |
visitor_code | integer | خیر | کد بازاریاب در پاتریس. نبودِ بازاریاب را با 0 بفرستید. |
visitor_name | string | خیر | نام بازاریاب. نبودِ بازاریاب را با رشتهی خالی بفرستید. |
lines | array | بله | اقلام سفارش. جدول بعد را ببینید. |
فیلدهای هر قلم سفارش
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
pip | string | بله | کد کالا در پاتریس. اگر کالا کد پاتریس ندارد، رشتهی خالی بفرستید. |
sku | string | خیر | SKU کالا در سایت. اگر pip خالی باشد و sku عدد باشد، پاتریس یار آن را کد کالای پاتریس فرض میکند. |
name | string | بله | نام کالا. |
quantity | number | بله | تعداد. عدد اعشاری مجاز است. |
unit_price | number | بله | قیمت واحد پیش از تخفیف قلم، به واحد پاتریس. |
discount | number | بله | جمع تخفیف این قلم (نه تخفیف هر واحد)، به واحد پاتریس. |
وضعیتهای سفارش
پاتریس یار نام وضعیتهای ووکامرس را میشناسد. وضعیتهای سایت خود را به این مقدارها نگاشت کنید:
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
pending | string | خیر | در انتظار پرداخت. |
on-hold | string | خیر | در انتظار بررسی (مثلاً پرداخت کارتبهکارت). |
processing | string | خیر | پرداختشده و در حال آمادهسازی. پاتریس یار سفارش را پرداختشده ثبت میکند. |
completed | string | خیر | تکمیلشده. پاتریس یار سفارش را پرداختشده ثبت میکند. |
cancelled | string | خیر | لغوشده. |
تعیین کنید کدام وضعیتها به پاتریس برسند. پیشنهاد ما 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 یک سفارش برای سرور پاتریس حداکثر ۲۵۶ هزار کاراکتر است.
- فیلدهای اضافه را پاتریس یار نادیده میگیرد.