تجاوز إلى المحتوى الرئيسي
الإصدار: 1.x

مرجع بيانات الإيصال

تُعرض قوالب HTML بدون منطق وقوالب XML الحرارية في WCPOS من نفس حمولة بيانات الإيصال القياسية. استخدم مسارات Mustache النقطية مثل {{order.number}} و{{store.name}} و{{totals.total_display}}. تُعرض المصفوفات باستخدام الأقسام:

{{#lines}}
{{name}} x {{qty}} — {{line_total_display}}
{{/lines}}

يُنتَج العقد القياسي بواسطة منشئ بيانات الإيصال في WCPOS على الخادم ويُنسخ بواسطة عارض الإيصالات في وضع عدم الاتصال داخل التطبيق. تُفتح الإيصالات فورًا من البيانات المحلية، ثم تُحدَّث باستجابة الخادم عند توفرها، لذا يجب أن تستخدم القوالب المخصصة الحقول أدناه بدلاً من دوال طلبات PHP.

قواعد العرض

حقول العملة

تُحفظ حقول المبالغ الرقمية كأرقام ويُضيف العارض حقول _display المتوافقة مع الإعدادات المحلية لمخرجات القالب:

الحقل الرقميحقل العرض
totals.totaltotals.total_display
lines[].line_totallines[].line_total_display
payments[].amountpayments[].amount_display
tax_summary[].tax_amounttax_summary[].tax_amount_display

يُفضَّل استخدام حقول _display عند طباعة الإيصالات. تُستخدَم الحقول الرقمية فقط للأقسام الشرطية أو المخرجات القابلة للقراءة آليًا.

حقول العرض المتوافقة مع الضريبة

تتوفر لعدة حقول صيغ شاملة وحصرية للضريبة بالإضافة إلى قيمة عرض مُيسَّرة. تتبع قيمة العرض المُيسَّرة إعداد عرض ضريبة سلة التسوق في المتجر.

الحقل المُيسَّرالحقل الشامل للضريبةالحقل الحصري للضريبة
lines[].unit_pricelines[].unit_price_incllines[].unit_price_excl
lines[].unit_subtotallines[].unit_subtotal_incllines[].unit_subtotal_excl
lines[].line_subtotallines[].line_subtotal_incllines[].line_subtotal_excl
lines[].discountslines[].discounts_incllines[].discounts_excl
lines[].line_totallines[].line_total_incllines[].line_total_excl
fees[].totalfees[].total_inclfees[].total_excl
shipping[].totalshipping[].total_inclshipping[].total_excl
discounts[].totaldiscounts[].total_incldiscounts[].total_excl
totals.subtotaltotals.subtotal_incltotals.subtotal_excl
totals.discount_totaltotals.discount_total_incltotals.discount_total_excl
totals.totaltotals.total_incltotals.total_excl

كائنات التاريخ

حقول التاريخ هي كائنات تحتوي على عدة صيغ منسّقة مسبقًا. يتيح ذلك تجنّب تنسيق التاريخ داخل Mustache.

الحقلالوصف
datetime، date، timeسلاسل التاريخ/الوقت الافتراضية
datetime_short، datetime_long، datetime_fullصيغ مُجمَّعة مُراعية للإعدادات المحلية
date_short, date_long, date_fullتنسيقات التاريخ فقط حسب الإعدادات المحلية
date_ymd, date_dmy, date_mdyتنسيقات التاريخ بترتيب ثابت
weekday_short, weekday_longأسماء الأيام
day, month, month_short, month_long, yearأجزاء التاريخ الفردية

كائنات التاريخ المتاحة: order.created وorder.paid وorder.completed وorder.printed وrefunds[].date. يتم تحديث order.printed في وقت العرض، وهو مفيد لإعادة الطباعة.

الأقسام الرئيسية

القسمالنوعالوصف
orderكائنهوية الطلب وحالته وتواريخه وملاحظاته ومعلومات رابط الدفع
storeكائنهوية المتجر وعنوانه وبيانات الاتصال والأرقام الضريبية والشعار وساعات العمل ونص التذييل
cashierكائنالمستخدم الذي قام بمعالجة الطلب
customerكائنالاسم المعروض للعميل والعناوين والأرقام الضريبية
linesarrayعناصر بنود المنتجات
feesarrayصفوف الرسوم
shippingarrayصفوف الشحن
discountsarrayصفوف القسائم/الخصومات
totalsobjectإجماليات الطلب، وإجماليات الدفع، وملخص الاسترداد، وعدد العناصر
taxobjectعلامات وضع عرض الضريبة لحراسة الأقسام
tax_summaryarrayصفوف ملخص الضريبة حسب المعدل
has_tax_summarybooleanحارس مختصر لـ tax_summary
paymentsarrayصفوف المدفوعات
refundsarrayسجلات الاسترداد المطبّقة على الطلب
fiscalobjectحقول اللقطة المالية التي تملؤها تكاملات الضرائب
presentation_hintsobjectتلميحات التنسيق والعرض
i18nobjectتسميات مترجمة للقوالب المُضمّنة والمخصصة

order

الحقلالنوعمثال / وصف
order.idnumber1234
order.numberstringرقم الطلب الظاهر للعميل، مثال: "10045"
order.currencystringرمز العملة وفق معيار ISO، مثال: "USD"
order.customer_notestringملاحظة العميل/الطلب
order.wc_statusstringرمز حالة WooCommerce الأصلي، مثال: "processing"
order.status_labelstringتسمية الحالة المترجمة، بما في ذلك الحالات المخصصة
order.created_viastringالمصدر/القناة، مثال: "woocommerce-pos"
order.needs_paymentbooleanما إذا كان يجب عرض قسم الدفع
order.payment_urlstringرابط دفع الطلب عند توفره
order.createddate objectتاريخ إنشاء الطلب
order.paiddate objectتاريخ الدفع، سلاسل نصية فارغة عند عدم الدفع
order.completeddate objectتاريخ الإكمال، سلاسل نصية فارغة عند عدم الإكمال
order.printeddate objectالطابع الزمني للطباعة/إعادة الطباعة عند العرض

المتجر

الحقلالنوعمثال / وصف
store.idnumberمعرّف المتجر، أو المعرّف السابق للمتاجر المحذوفة
store.namestringاسم المتجر المعروض
store.address.address_1stringسطر العنوان 1
store.address.address_2stringسطر الجناح/الوحدة
store.address.citystringالمدينة/المنطقة المحلية
store.address.statestringالولاية/المنطقة
store.address.postcodestringالرمز البريدي
store.address.countrystringرمز الدولة بتنسيق ISO
store.address_linesarrayأسطر العنوان المنسّقة مسبقًا؛ يُوصى باستخدامها في معظم القوالب
store.tax_idsarrayمعرّفات الضريبة المنظّمة للنشاط التجاري؛ يُنصح بالتكرار عبر هذه المصفوفة بدلاً من استخدام معرّف ضريبي واحد
store.phonestringهاتف المتجر
store.emailstringالبريد الإلكتروني للمتجر
store.logostring/nullعنوان URL لشعار المتجر أو معرّف URI للبيانات
store.opening_hoursstring/nullنص مختصر لساعات العمل
store.opening_hours_verticalstring/nullكتلة ساعات العمل متعددة الأسطر
store.opening_hours_inlinestring/nullنص ساعات العمل مفصول بفواصل
store.opening_hours_notesstring/nullملاحظات نصية حرة حول ساعات العمل
store.personal_notesstring/nullملاحظة شخصية / تذييل الإيصال
store.policies_and_conditionsstring/nullنص الاسترجاع أو الإرجاع أو الشروط
store.footer_imprintstring/nullالبصمة القانونية في التذييل

كائنات المعرّف الضريبي

يحتوي store.tax_ids وcustomer.tax_ids على كائنات بنفس البنية:

الحقلالنوعالوصف
typestringمعرّف مثل eu_vat أو de_steuernummer أو au_abn أو br_cpf أو us_ein أو other
valuestringقيمة المعرّف الضريبي المراد طباعتها
countrystring/nullرمز الدولة وفق معيار ISO عند توفره
labelstring/nullتسمية العرض المحلية، تُحَلّ قبل العرض

مثال:

{{#store.tax_ids}}
{{label}}: {{value}}
{{/store.tax_ids}}

أمين الصندوق

الحقلالنوعمثال / وصف
cashier.idnumberمعرّف مستخدم WordPress، 0 عندما يكون غير معروف
cashier.namestringالاسم المعروض لأمين الصندوق

العميل

الحقلالنوعمثال / وصف
customer.idnumber/nullمعرّف العميل، أو null للزوار
customer.namestringالاسم المعروض للعميل، أو تسمية الزائر
customer.billing_address.*objectحقول عنوان الفوترة في WooCommerce
customer.shipping_address.*objectحقول عنوان الشحن في WooCommerce
customer.tax_idsarrayمعرّفات الضريبة المنظمة للعميل المأخوذة كلقطة من الطلب

تشمل مفاتيح العنوان الشائعة first_name وlast_name وcompany وaddress_1 وaddress_2 وcity وstate وpostcode وcountry وemail وphone.

lines

يتم التكرار باستخدام {{#lines}}...{{/lines}}.

الحقلالنوعالوصف
keystringمفتاح البند الثابت / معرّف عنصر الطلب
skustringرمز SKU للمنتج
namestringاسم العرض للمنتج أو البند
qtynumberالكمية المباعة
qty_refundednumberالكمية المستردة لهذا البند
unit_subtotal / _incl / _exclnumberسعر الوحدة قبل الخصم
unit_price / _incl / _exclnumberسعر الوحدة بعد الخصم
line_subtotal / _incl / _exclnumberالمجموع الفرعي للسطر قبل الخصم
discounts / _incl / _exclnumberمبلغ الخصم كقيمة موجبة
line_total / _incl / _exclnumberإجمالي السطر النهائي
total_refundednumberإجمالي المبلغ المسترد لهذا السطر كقيمة موجبة
taxesarrayصفوف الضريبة حسب المعدل لهذا السطر
metaarrayبيانات وصفية لعنصر الطلب كأزواج {key, value}
attributesarrayسمات المنتج/التنويعة كأزواج {key, value}

تتضمن المتغيرات المنسّقة unit_subtotal_display وunit_price_display وline_subtotal_display وdiscounts_display وline_total_display، بالإضافة إلى متغيرات _display الشاملة والحصرية للضريبة.

الرسوم والشحن

استخدم الحلقة التكرارية {{#fees}}...{{/fees}} و{{#shipping}}...{{/shipping}}.

الحقلالنوعالوصف
labelstringتسمية الرسوم أو اسم طريقة الشحن
method_idstringمعرّف طريقة الشحن (للشحن فقط)
total / _incl / _exclnumberالإجماليات المعروضة، شاملة الضريبة، وغير شاملة الضريبة
taxesarrayصفوف الضرائب حسب المعدل
metaarrayأزواج بيانات وصفية بصيغة {key, value}

المتغيرات المنسّقة: total_display وtotal_incl_display وtotal_excl_display.

الخصومات

التكرار باستخدام {{#discounts}}...{{/discounts}}.

الحقلالنوعالوصف
labelstringوصف القسيمة أو الرمز كقيمة بديلة
codestringرمز القسيمة
codesstringقيمة بديلة قديمة/للعرض للرموز المدمجة
total / _incl / _exclnumberمبلغ الخصم كقيمة موجبة

المتغيرات المنسّقة: total_display وtotal_incl_display وtotal_excl_display. أضف علامة السالب الخاصة بك في القالب إذا كنت تريد عرض الخصومات كصفوف سالبة.

الإجماليات

الحقلالنوعالوصف
totals.subtotal / _incl / _exclnumberالمجموع الفرعي للطلب قبل الخصومات
totals.discount_total / _incl / _exclnumberإجمالي خصم الطلب كقيمة موجبة
totals.tax_totalnumberإجمالي مبلغ الضريبة
totals.total / _incl / _exclnumberالمجموع الإجمالي للطلب
totals.paid_totalnumberالمبلغ المدفوع/المُطبَّق
totals.change_totalnumberالباقي المُعاد للعميل
totals.refund_totalnumberإجمالي المبلغ المُسترد كقيمة موجبة
totals.net_totalnumbertotal - refund_total، مع تقييد الحد الأدنى بالصفر
totals.total_qtynumberمجموع كميات بنود الطلب
totals.line_countnumberعدد صفوف بنود المنتجات

تتضمن المتغيرات المنسَّقة subtotal_display وdiscount_total_display وtax_total_display وtotal_display وpaid_total_display وchange_total_display وrefund_total_display وnet_total_display، بالإضافة إلى متغيرات شاملة/غير شاملة للضريبة حيثما ينطبق ذلك.

tax و tax_summary

استخدم tax للتحقق من وضع العرض وtax_summary لصفوف معدلات الضريبة المفصَّلة.

حقل الضريبةالنوعالوصف
tax.displaystringincl أو excl
tax.display_inclbooleanصحيح عندما تُعرض الأسعار شاملة الضريبة
tax.display_exclbooleanصحيح عندما تُعرض الأسعار غير شاملة الضريبة
tax.breakdownstringhidden أو single أو itemized
tax.breakdown_hiddenbooleanصحيح عندما يجب إخفاء صفوف الضريبة
tax.breakdown_singlebooleanصحيح عندما يُفضَّل عرض إجمالي ضريبة واحد
tax.breakdown_itemizedbooleanصحيح عندما يُفضَّل عرض صفوف لكل معدل ضريبي
has_tax_summarybooleanصحيح عندما يحتوي tax_summary على صفوف

كرّر tax_summary باستخدام {{#tax_summary}}...{{/tax_summary}}.

الحقلالنوعالوصف
codestringمعرّف/رمز معدل الضريبة
ratenumber/nullالنسبة المئوية للمعدل عند تحديدها
labelstringتسمية معدل الضريبة
compoundbooleanما إذا كان المعدل مركبًا
taxable_amount_exclnumber/nullالوعاء الضريبي بدون الضريبة
tax_amountnumberالضريبة المحصّلة
taxable_amount_inclnumber/nullالوعاء الضريبي شاملًا الضريبة

المتغيرات المنسّقة: taxable_amount_excl_display وtax_amount_display وtaxable_amount_incl_display.

المدفوعات

التكرار باستخدام {{#payments}}...{{/payments}}.

الحقلالنوعالوصف
method_idstringمعرّف طريقة الدفع
method_titlestringالاسم المعروض لطريقة الدفع
amountnumberالمبلغ المطبّق على الطلب
transaction_idstringمعرّف معاملة بوابة الدفع
tenderednumberالمبلغ النقدي المقدَّم عند توفّره
changenumberباقي المبلغ النقدي المُعاد عند توفّره

المتغيّرات المنسَّقة: amount_display وtendered_display وchange_display.

المبالغ المستردّة

يتمّ التكرار باستخدام {{#refunds}}...{{/refunds}}. مبالغ الاسترداد هي قيم مطلقة موجبة؛ تحدّد القوالب ما إذا كان يُضاف رمز سالب أو يُعرَض قسم منفصل للأصناف المُعادة.

الحقلالنوعالوصف
idnumberمعرّف سجلّ الاسترداد
datedate objectتاريخ إنشاء الاسترداد
amountnumberإجمالي الاسترداد
subtotalnumberالمجموع الفرعي للبند المسترد
tax_totalnumberالضريبة المستردة
shipping_totalnumberمبلغ الشحن المسترد
shipping_taxnumberضريبة الشحن المستردة
reasonstringسبب الاسترداد
refunded_by_idnumber/nullمعرّف المستخدم الذي أصدر الاسترداد
refunded_by_namestringالاسم المعروض للمستخدم الذي أصدر الاسترداد
refunded_paymentbooleanما إذا تم استرداد الدفعة عبر بوابة الدفع
destinationstringoriginal_method أو cash أو manual
gateway_idstringمعرّف بوابة الدفع المستخدمة للاسترداد
gateway_titlestringالعنوان المعروض لبوابة الدفع
processing_modestringوضع المعالجة عبر المزوّد/يدوي
linesarrayصفوف المنتجات المستردة
feesarrayصفوف الرسوم المستردة
shippingarrayصفوف الشحن المستردة

تتضمن حقول بند الاسترداد name وsku وqty وtotal وtotal_incl وtotal_excl وline_total وunit_total وtaxes. تستخدم صفوف الرسوم والشحن المستردة label وtotal وtotal_incl وtotal_excl وtaxes. تُضاف صيغ عرض بديلة للإجماليات ومبالغ الضرائب.

fiscal

تكون الحقول المالية فارغة افتراضيًا ويتم ملؤها بواسطة تكاملات الفوترة المالية أو إثراء لقطات WCPOS Pro.

الحقلالنوعالوصف
fiscal.immutable_idstringالمعرّف المالي الثابت
fiscal.receipt_numberstringرقم الإيصال المالي
fiscal.sequencenumber/nullعدّاد التسلسل
fiscal.hashstringقيمة التجزئة/التوقيع
fiscal.qr_payloadstringحمولة رمز QR للتحقق الضريبي
fiscal.tax_agency_codestringرمز الجهة الضريبية
fiscal.signed_atstringالطابع الزمني للتوقيع الضريبي
fiscal.signature_excerptstringمقتطف التوقيع المختصر للعرض
fiscal.document_labelstringتسمية المستند، مثل فاتورة ضريبية
fiscal.is_reprintbooleanما إذا كان هذا العرض إعادة طباعة
fiscal.reprint_countnumberعدد مرات إعادة الطباعة
fiscal.extra_fieldsarray/objectقيم خاصة بالولاية القضائية

presentation_hints

تُستهلك هذه الحقول بشكل أساسي بواسطة المُصيِّر والمُنسِّق. وهي متاحة للقوالب عند الحاجة.

الحقلالنوعالوصف
presentation_hints.display_taxstringincl، excl، hidden، itemized، أو single
presentation_hints.prices_entered_with_taxbooleanما إذا كانت أسعار الكتالوج تشمل الضريبة
presentation_hints.rounding_modestringإعداد تقريب الضريبة في WooCommerce
presentation_hints.localestringالإعدادات المحلية المستخدمة للتنسيق
presentation_hints.timezonestringالمنطقة الزمنية للإيصال
presentation_hints.currency_positionstringموضع رمز العملة
presentation_hints.currency_symbolstringرمز العملة
presentation_hints.price_thousand_separatorstringفاصل الآلاف
presentation_hints.price_decimal_separatorstringالفاصل العشري
presentation_hints.price_num_decimalsnumberعدد المنازل العشرية
presentation_hints.price_display_suffixstringلاحقة عرض السعر في WooCommerce
presentation_hints.order_barcode_typestringنوع الباركود المستخدم في قوالب المعرض

i18n

استخدم تسميات i18n بدلاً من كتابة النصوص مباشرةً في الكود كلما أمكن ذلك:

{{i18n.order}} #{{order.number}}
{{i18n.cashier}}: {{cashier.name}}
{{i18n.total}}: {{totals.total_display}}

تتضمن المفاتيح الشائعة order وdate وcashier وcustomer وitem وsku وqty وunit_price وdiscount وsubtotal وtotal وtax وpaid وtendered وchange وtax_summary وrefunded وnet_total وcustomer_note وthank_you_purchase وopening_hours، ومفاتيح تسميات المعرّف الضريبي مثل store_tax_id_label_eu_vat وcustomer_tax_id_label_other. يمكن أن تُضيف الإضافات مفاتيح إضافية.