मुख्य सामग्री के लिए छोड़ें
संस्करण: 1.x

रसीद डेटा संदर्भ

WCPOS लॉजिकलेस HTML टेम्पलेट और थर्मल XML टेम्पलेट एक ही कैनोनिकल रसीद पेलोड से रेंडर होते हैं। 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[].dateorder.printed रेंडर समय पर रिफ़्रेश होता है, जो पुनर्मुद्रण के लिए उपयोगी है।

शीर्ष-स्तरीय अनुभाग

अनुभागप्रकारविवरण
orderobjectऑर्डर पहचान, स्थिति, तिथियाँ, नोट, और भुगतान URL जानकारी
storeobjectस्टोर पहचान, पता, संपर्क विवरण, कर ID, लोगो, समय, और फ़ुटर टेक्स्ट
cashierobjectवह उपयोगकर्ता जिसने ऑर्डर प्रोसेस किया
customerobjectग्राहक प्रदर्शन नाम, पते, और कर ID
linesarrayउत्पाद लाइन आइटम
feesarrayशुल्क पंक्तियाँ
shippingarrayशिपिंग पंक्तियाँ
discountsarrayकूपन/छूट पंक्तियाँ
totalsobjectऑर्डर कुल, भुगतान कुल, रिफ़ंड सारांश, और आइटम गणना
taxobjectसेक्शन गार्ड के लिए कर प्रदर्शन मोड फ़्लैग
tax_summaryarrayप्रति-दर कर सारांश पंक्तियाँ
has_tax_summarybooleantax_summary के लिए सुविधा गार्ड
paymentsarrayभुगतान पंक्तियाँ
refundsarrayऑर्डर पर लागू रिफ़ंड रिकॉर्ड
fiscalobjectफ़िस्कल एकीकरण द्वारा भरे गए फ़िस्कल स्नैपशॉट फ़ील्ड
presentation_hintsobjectफ़ॉर्मेटिंग और रेंडरर संकेत
i18nobjectबंडल और कस्टम टेम्पलेट्स के लिए अनुवादित लेबल

order

फ़ील्डप्रकारउदाहरण / विवरण
order.idnumber1234
order.numberstringउपयोगकर्ता को दिखने वाला ऑर्डर नंबर, जैसे "10045"
order.currencystringISO मुद्रा कोड, जैसे "USD"
order.customer_notestringग्राहक/ऑर्डर नोट
order.wc_statusstringWooCommerce की रॉ स्टेटस स्लग, जैसे "processing"
order.status_labelstringस्थानीयकृत स्थिति लेबल, कस्टम स्थितियों सहित
order.created_viastringस्रोत/चैनल, जैसे "woocommerce-pos"
order.needs_paymentbooleanभुगतान अनुभाग दिखाया जाना चाहिए या नहीं
order.payment_urlstringउपलब्ध होने पर ऑर्डर भुगतान URL
order.createddate objectऑर्डर निर्माण तिथि
order.paiddate objectभुगतान तिथि, भुगतान न होने पर खाली स्ट्रिंग
order.completeddate objectपूर्ण होने की तिथि, अपूर्ण होने पर खाली स्ट्रिंग
order.printeddate objectरेंडर-टाइम प्रिंट/रीप्रिंट टाइमस्टैम्प

स्टोर

फ़ील्डप्रकारउदाहरण / विवरण
store.idnumberस्टोर ID, या हटाए गए स्टोर के लिए ऐतिहासिक ID
store.namestringस्टोर प्रदर्शन नाम
store.address.address_1stringसड़क का पता पंक्ति 1
store.address.address_2stringसुइट/यूनिट पंक्ति
store.address.citystringशहर/स्थानीयता
store.address.statestringराज्य/क्षेत्र
store.address.postcodestringपिन कोड
store.address.countrystringISO देश कोड
store.address_linesarrayपूर्व-स्वरूपित पता पंक्तियाँ; अधिकांश टेम्पलेट्स के लिए अनुशंसित
store.tax_idsarrayसंरचित व्यापार कर ID; एकल कर ID के बजाय इसे लूप करें
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कानूनी फुटर इम्प्रिंट

कर ID ऑब्जेक्ट

store.tax_ids और customer.tax_ids में समान संरचना वाले ऑब्जेक्ट होते हैं:

फ़ील्डप्रकारविवरण
typestringपहचानकर्ता जैसे eu_vat, de_steuernummer, au_abn, br_cpf, us_ein, या other
valuestringप्रिंट करने के लिए कर ID मान
countrystring/nullज्ञात होने पर ISO देश कोड
labelstring/nullस्थानीयकृत प्रदर्शन लेबल, रेंडरिंग से पहले रिज़ॉल्व किया गया

उदाहरण:

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

cashier

फ़ील्डप्रकारउदाहरण / विवरण
cashier.idnumberWordPress उपयोगकर्ता ID, अज्ञात होने पर 0
cashier.namestringकैशियर का प्रदर्शन नाम

customer

फ़ील्डप्रकारउदाहरण / विवरण
customer.idnumber/nullग्राहक ID, या अतिथि के लिए null
customer.namestringग्राहक का प्रदर्शन नाम, या अतिथि लेबल
customer.billing_address.*objectWooCommerce बिलिंग पता फ़ील्ड
customer.shipping_address.*objectWooCommerce शिपिंग पता फ़ील्ड
customer.tax_idsarrayऑर्डर से स्नैपशॉट किए गए संरचित ग्राहक कर ID

सामान्य पता कुंजियों में first_name, last_name, company, address_1, address_2, city, state, postcode, country, email, और phone शामिल हैं।

lines

{{#lines}}...{{/lines}} के साथ लूप करें।

फ़ील्डप्रकारविवरण
keystringस्थिर लाइन कुंजी/ऑर्डर आइटम ID
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शिपिंग विधि ID (केवल शिपिंग)
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जब कीमतें कर सहित प्रदर्शित होती हैं तो True
tax.display_exclbooleanजब कीमतें कर रहित प्रदर्शित होती हैं तो True
tax.breakdownstringhidden, single, या itemized
tax.breakdown_hiddenbooleanजब कर पंक्तियाँ छिपी होनी चाहिए तो True
tax.breakdown_singlebooleanजब एकल कर कुल योग प्राथमिक हो तो True
tax.breakdown_itemizedbooleanजब प्रति-दर पंक्तियाँ प्राथमिक हों तो True
has_tax_summarybooleanजब tax_summary में पंक्तियाँ हों तो True

tax_summary को {{#tax_summary}}...{{/tax_summary}} के साथ लूप करें।

फ़ील्डप्रकारविवरण
codestringकर दर ID/कोड
ratenumber/nullहल होने पर दर प्रतिशत
labelstringकर दर लेबल
compoundbooleanक्या दर संयुक्त (compounded) है
taxable_amount_exclnumber/nullकर-रहित कर योग्य आधार
tax_amountnumberएकत्रित कर
taxable_amount_inclnumber/nullकर-सहित कर योग्य आधार

स्वरूपित (formatted) संस्करण: taxable_amount_excl_display, tax_amount_display, और taxable_amount_incl_display

भुगतान

{{#payments}}...{{/payments}} के साथ लूप करें।

फ़ील्डप्रकारविवरण
method_idstringभुगतान विधि पहचानकर्ता
method_titlestringभुगतान विधि प्रदर्शन शीर्षक
amountnumberऑर्डर पर लागू की गई राशि
transaction_idstringगेटवे ट्रांज़ैक्शन ID
tenderednumberउपलब्ध होने पर दी गई नकद राशि
changenumberउपलब्ध होने पर लौटाई गई नकद शेष राशि

स्वरूपित वेरिएंट: amount_display, tendered_display, और change_display

रिफ़ंड

{{#refunds}}...{{/refunds}} के साथ लूप करें। रिफ़ंड राशियाँ धनात्मक परिमाण होती हैं; टेम्पलेट यह तय करते हैं कि ऋण चिह्न लगाना है या एक अलग लौटाई-गई-वस्तुओं का ब्लॉक प्रदर्शित करना है।

फ़ील्डप्रकारविवरण
idnumberरिफ़ंड रिकॉर्ड ID
datedate objectरिफ़ंड निर्माण तिथि
amountnumberरिफ़ंड कुल
subtotalnumberरिफंड की गई लाइन उप-कुल
tax_totalnumberरिफंड किया गया कर
shipping_totalnumberरिफंड की गई शिपिंग राशि
shipping_taxnumberरिफंड किया गया शिपिंग कर
reasonstringरिफंड का कारण
refunded_by_idnumber/nullरिफंड जारी करने वाले उपयोगकर्ता का ID
refunded_by_namestringरिफंड जारी करने वाले उपयोगकर्ता का प्रदर्शन नाम
refunded_paymentbooleanक्या भुगतान गेटवे के माध्यम से रिफंड किया गया
destinationstringoriginal_method, cash, या manual
gateway_idstringरिफंड के लिए उपयोग किया गया गेटवे ID
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 का उपयोग करती हैं। कुल और कर राशियों के लिए प्रदर्शन वेरिएंट जोड़े जाते हैं।

फ़िस्कल

फ़िस्कल फ़ील्ड डिफ़ॉल्ट रूप से खाली होती हैं और फ़िस्कल एकीकरण या 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_modestringWooCommerce कर राउंडिंग सेटिंग
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_suffixstringWooCommerce मूल्य प्रदर्शन प्रत्यय
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, और tax-ID लेबल कुंजियाँ जैसे store_tax_id_label_eu_vat और customer_tax_id_label_other शामिल हैं। एक्सटेंशन द्वारा अतिरिक्त कुंजियाँ जोड़ी जा सकती हैं।