VibeFox Correios for PrestaShop — सहायता

आवश्यकताएँ

PrestaShop: 8.0 से 9.x।

PHP: 8.0 या उसके बाद का संस्करण। मॉड्यूल पुराने PHP संस्करणों पर इंस्टॉल नहीं होगा।

Correios अनुबंध (केवल लाइव दामों के लिए): लाइव दाम Correios Web Services (CWS) प्राइस API का उपयोग करते हैं और इसके लिए posting card वाले Correios अनुबंध के क्रेडेंशियल चाहिए। आपको तीन मान चाहिए: आपका Meu Correios उपयोगकर्ता (आमतौर पर अनुबंध का CNPJ या CPF), API एक्सेस कोड और posting card नंबर। एक्सेस कोड Correios Web Services पोर्टल (cws.correios.com.br; होमोलोगेशन के लिए cwshom.correios.com.br) पर बनाएँ। आपको वह CEP भी चाहिए जहाँ से आप शिप करते हैं। क्रेडेंशियल के बिना मॉड्यूल केवल तय दामों के साथ काम करता है।

VibeFox लाइसेंस कुंजी: vibefox.net से खरीदी जाती है। एक कुंजी एक डोमेन पर काम करती है।

इंस्टॉलेशन

1. बैक ऑफिस में Modules > Module Manager पर जाएँ और Upload a module पर क्लिक करें। मॉड्यूल की ZIP फ़ाइल चुनें।

2. अपलोड पूरा होने पर Configure पर क्लिक करें, या बाद में मॉड्यूल सूची में VibeFox Correios ढूँढकर Configure पर क्लिक करें।

3. Configure पेज के ऊपर वाले लाइसेंस ब्लॉक में License key में अपनी VibeFox लाइसेंस कुंजी दर्ज करें और Activate पर क्लिक करें (देखें लाइसेंस कुंजी)।

4. Correios API उपयोगकर्ता, एक्सेस कोड, posting card नंबर, मूल CEP और सेवा दर्ज करें। यदि आपके स्टोर की डिफ़ॉल्ट मुद्रा BRL नहीं है, तो BRL दर दर्ज करें। अन्य देशों और विकल्प के लिए तय दाम भरें (देखें कॉन्फ़िगरेशन) और Save पर क्लिक करें।

इंस्टॉल होने पर मॉड्यूल Correios (Brazilian Post) डिलीवरी समय टेक्स्ट वाला Correios कैरियर बनाता है। कैरियर सभी ज़ोन और सभी ग्राहक समूहों को दिया जाता है। ज़ोन, ग्राहक समूह, डिलीवरी समय, लोगो और आकार सीमाएँ आप Shipping > Carriers में बदल सकते हैं। वहाँ दाम न लगाएँ: दाम हमेशा मॉड्यूल से आता है।

कॉन्फ़िगरेशन

सभी सेटिंग्स मॉड्यूल पेज पर हैं: Modules > Module Manager > VibeFox Correios > Configure। हर सेक्शन का अपना Save बटन है, जो पूरा पेज सहेजता है। हर सेव कैश्ड Correios दाम और API टोकन भी साफ़ करता है। संख्याएँ बिंदु या कॉमा के साथ लिखी जा सकती हैं।

जब लाइव दाम या कैरियर काम नहीं कर सकते, तो पेज चेतावनियाँ दिखाता है: तीन क्रेडेंशियल में से कुछ ही भरे हैं, मूल CEP नहीं है, किसी अन्य मुद्रा वाले स्टोर के लिए BRL दर नहीं है, या न क्रेडेंशियल हैं न तय दाम। हर चेतावनी बताती है कि इस बीच तय दाम लागू होंगे या कैरियर छिपा दिया जाएगा। यदि स्टोर की वज़न या आकार इकाई मॉड्यूल को ज्ञात नहीं है, तो भी चेतावनी आती है (तब उसे kg या cm माना जाता है); International > Localization (Local units) में kg, g, lb या oz और cm, mm, m या in सेट करें।

यदि मेथड का शीर्षक खाली या अमान्य है (अधिकतम 64 अक्षर), Country prices में कोई संख्या फ़ील्ड या दाम 0 या उससे अधिक की संख्या नहीं है, BRL दर 0 है, Min cart weight, Max cart weight से अधिक है, मूल CEP 8 अंकों का नहीं है, या अन्य सेवा कोड में 5 से अधिक अंक हैं, तो सेव एक संदेश के साथ अस्वीकार हो जाता है। मान ठीक करने तक कुछ भी सहेजा नहीं जाता।

सामान्य

Enable Correios: सभी ज़ोन में कैरियर को एक साथ चालू या बंद करता है। यह Shipping > Carriers में कैरियर की स्थिति वाला ही स्विच है।

Method title: कार्ट और चेकआउट में दिखने वाला कैरियर का नाम। डिफ़ॉल्ट: Correios। आवश्यक।

Tax: शिपिंग लागत पर जोड़ा जाने वाला टैक्स नियम, या No tax (डिफ़ॉल्ट)।

Correios API (ब्राज़ील में लाइव दाम)

ब्राज़ील के पतों के लिए दाम Correios प्राइस API से आता है। यदि API दाम नहीं देता (API बंद है, CEP सेवा में नहीं है, पार्सल बहुत बड़ा है), तो Country prices का तय दाम लिया जाता है, या अगर वह नहीं है तो कैरियर छिपा दिया जाता है। त्रुटि का विवरण लॉग में जाता है, ग्राहक को कभी नहीं दिखता।

API user: आपका Meu Correios पोर्टल लॉगिन, आमतौर पर अनुबंध का CNPJ या CPF।

Access code: Correios Web Services पोर्टल में बना API एक्सेस कोड (código de acesso)। यह पोर्टल का पासवर्ड नहीं है। सेव करने के बाद फ़ील्ड खाली रहता है और Saved — leave empty to keep it (empty the API user as well to remove it) दिखाता है। केवल बदलने के लिए नया मान लिखें। सहेजा हुआ कोड हटाने के लिए API user और Access code दोनों खाली करके सेव करें।

Posting card: आपके अनुबंध का posting card (cartão de postagem) नंबर: 10 अंक, आमतौर पर दो शून्य से शुरू होता है, जैसे 0012345678। छोटे नंबर आगे से शून्य लगाकर पूरे किए जाते हैं। यह नंबर Correios वेबसाइट के Correios Fácil पेज पर देखा जा सकता है।

Homologation: Correios के परीक्षण (होमोलोगेशन) वातावरण का उपयोग करता है: अनुरोध होमोलोगेशन एक्सेस कोड के साथ apihom.correios.com.br पर जाते हैं। लाइव स्टोर पर इसे बंद रखें।

Origin CEP: वह CEP (8 अंक) जहाँ से पार्सल भेजे जाते हैं, जैसे 01001-000।

Service: चेकआउट पर दाम लगाई जाने वाली Correios सेवा। रिटेल कोड: PAC (04510, डिफ़ॉल्ट), SEDEX (04014), SEDEX 12 (04782), SEDEX 10 (04790), SEDEX Hoje (04804)। अनुबंध कोड: PAC (03298), SEDEX (03220), SEDEX 12 (03140), SEDEX 10 (03158), SEDEX Hoje (03204), Correios Mini Envios (04227)। अनुबंध कोड के लिए उस अनुबंध का posting card चाहिए जिसमें सेवा शामिल हो।

Other service code: वैकल्पिक, आपके अनुबंध का 5 अंकों का सेवा कोड जो सूची में नहीं है, जैसे 03085। छोटा कोड आगे से शून्य लगाकर पूरा किया जाता है। भरा होने पर इसे Service की जगह उपयोग किया जाता है।

Package format: Correios को भेजी जाने वाली वस्तु का प्रकार।

Default product weight: kg में, हर उस उत्पाद के लिए Correios को भेजा जाता है जिसका वज़न नहीं है। डिफ़ॉल्ट: 0.3। उत्पादों के वज़न और आकार आपके स्टोर की इकाइयों से बदले जाते हैं (फ़ील्ड का विवरण उन्हें दिखाता है), और कार्ट को एक पार्सल के रूप में दाम दिया जाता है।

BRL → store currency rate: फ़ील्ड का नाम आपके स्टोर की डिफ़ॉल्ट मुद्रा दिखाता है, जैसे BRL → EUR rate। Correios के दाम BRL में हैं। यदि आपकी डिफ़ॉल्ट मुद्रा BRL नहीं है, तो लिखें कि एक BRL आपकी मुद्रा की कितनी इकाइयों के बराबर है, जैसे 0.17। इसके बिना लाइव दाम उपयोग नहीं होते। दर 0 से अधिक होनी चाहिए। यदि आपकी डिफ़ॉल्ट मुद्रा BRL है, तो इसे खाली छोड़ें।

तय दाम (ब्राज़ील के बाहर के देशों, API क्रेडेंशियल के बिना, और जब API दाम नहीं देता तब विकल्प के रूप में उपयोग होते हैं)

Country prices: देशों की तालिका, जिसमें स्टोर की डिफ़ॉल्ट मुद्रा में, कर के बिना, एक Base दाम और कार्ट वज़न के अनुसार दाम हैं: XS 1 kg तक, S 1–2 kg, M 2–3 kg, L 3–5 kg, XL 5 kg से अधिक। खाली या शून्य आकार-दाम होने पर Base दाम लिया जाता है। पंक्ति जोड़ने के लिए Add country पर क्लिक करें और पंक्ति हटाने के लिए क्रॉस पर। * Default (all other countries) पंक्ति उन सभी देशों के दाम तय करती है जिनकी अपनी पंक्ति नहीं है। जिस देश की पंक्ति नहीं है (और * भी नहीं), उसे तय दाम नहीं मिलता। बिना किसी दाम वाली पंक्ति सहेजी नहीं जाती। जो दाम संख्या नहीं है, या ऋणात्मक है, वह त्रुटि के साथ सेव रोक देता है। 0 का आधार दाम उस देश के लिए मुफ़्त शिपिंग है।

Fixed price per: Order दाम एक बार लेता है। Item (price × quantity) उसे कार्ट में आइटमों की संख्या से गुणा करता है। यह केवल तय दामों पर लागू होता है। लाइव दाम हमेशा पूरे पार्सल के लिए निकाले जाते हैं।

शर्तें

Min cart weight: kg में; इस कार्ट वज़न से नीचे कैरियर छिपाता है। 0 का मतलब कोई सीमा नहीं। यह Max cart weight से अधिक नहीं हो सकता।

Max cart weight: kg में; इस कार्ट वज़न से ऊपर कैरियर छिपाता है। डिफ़ॉल्ट: 30। 0 का मतलब कोई सीमा नहीं, और खाली फ़ील्ड का मतलब 30 kg। Correios PAC और SEDEX पार्सल 30 kg तक के हो सकते हैं।

Minimum order amount: कैरियर तभी दिखाता है जब कार्ट का उप-योग (शिपिंग वाले उत्पाद, छूट के बाद, टैक्स से पहले) इस राशि तक पहुँचता है। हमेशा दिखाने के लिए खाली छोड़ें।

Free shipping: नीचे दी गई राशि से मुफ़्त डिलीवरी चालू करता है।

Free shipping from: कार्ट का उप-योग (छूट के बाद, टैक्स से पहले) जिससे शिपिंग मुफ़्त है। इस स्थिति में कोई API अनुरोध नहीं भेजा जाता।

शिपिंग ज़ोन के बिना उपलब्धता

आम तौर पर कैरियर उन ज़ोन में दिखता है जो Shipping > Carriers में उसे सौंपे गए हैं।

Ignore shipping zones: नीचे दिए देशों के लिए कैरियर देता है, चाहे कोई भी ज़ोन मेल खाए। सेव करने पर कैरियर सभी ज़ोन में जुड़ जाता है। विकल्प बंद करने पर उसके जोड़े गए ज़ोन हट जाते हैं। विकल्प चालू रहते हुए बाद में बना ज़ोन अपने-आप जुड़ जाता है।

Countries: इस मोड के लिए गंतव्य देश। स्टोर के सभी सक्रिय देशों के लिए खाली छोड़ें। यह फ़ील्ड केवल तब उपयोग होता है जब Ignore shipping zones चालू हो।

उन्नत

Debug log: दाम की गणनाएँ मॉड्यूल फ़ोल्डर में logs/vfd_crr_debug.log.php में लिखता है। यह फ़ाइल वेब से नहीं खोली जा सकती। API त्रुटियाँ इस विकल्प के बंद होने पर भी हमेशा दर्ज होती हैं। API उपयोगकर्ता, एक्सेस कोड, posting card, टोकन और ग्राहक CEP लॉग में नहीं लिखे जाते।

Log: डिबग लॉग का आकार और नवीनतम प्रविष्टियाँ दिखाता है। खाली करने के लिए Clear log पर क्लिक करें।

Remove data on uninstall: चालू होने पर मॉड्यूल हटाने से सेटिंग्स, कैरियर, ऑर्डर सेवाएँ, कैश्ड दाम और लॉग हट जाते हैं। बंद होने पर दोबारा इंस्टॉल के लिए सब कुछ रखा जाता है।

चेकआउट पर कैसे काम करता है

शिपिंग चरण में PrestaShop मॉड्यूल से Correios का दाम माँगता है। केवल भौतिक उत्पाद गिने जाते हैं: वर्चुअल उत्पाद वज़न नहीं जोड़ते और ऑर्डर राशि में शामिल नहीं होते। मॉड्यूल पहले शर्तें जाँचता है: अनुमत देश (Ignore shipping zones के साथ), कार्ट का वज़न और न्यूनतम ऑर्डर राशि। यदि मुफ़्त शिपिंग लागू होती है, तो दाम 0 होता है और Correios को कोई अनुरोध नहीं जाता।

क्रेडेंशियल सेट होने पर ब्राज़ील के पते के लिए मॉड्यूल पहले आपके posting card के लिए API टोकन लेता है। टोकन से अनुबंध और क्षेत्रीय कार्यालय के नंबर भी मिलते हैं, इसलिए दाम आपके अनुबंध का दाम होता है। फिर वह मूल और गंतव्य CEP, ग्राम में पार्सल का वज़न और cm में पार्सल का आकार देकर चुनी गई सेवा का दाम माँगता है। दाम केवल तब माँगा जाता है जब गंतव्य CEP 8 अंकों का हो। जब सभी उत्पादों के आयाम हों, तो पार्सल का आकार उन्हीं से अनुमानित होता है; अन्यथा Correios का न्यूनतम आकार भेजा जाता है। 30 kg से भारी पार्सल API को नहीं भेजे जाते। BRL दाम आपकी दर से बदला जाता है। दाम आपके स्टोर की डिफ़ॉल्ट मुद्रा में निकाला जाता है और फिर ग्राहक की कार्ट मुद्रा में दिखाया जाता है।

हर दाम प्रति पार्सल 1 घंटे के लिए कैश होता है। विफल अनुरोध 10 मिनट के लिए कैश होता है, ताकि API बंद होने पर हर चेकआउट अपडेट धीमा न हो। टोकन समाप्त होने से थोड़ी देर पहले तक कैश रहता है और अपने-आप नवीनीकृत होता है; यदि Correios उसे अस्वीकार करे, तो नया टोकन माँगा जाता है और दाम का अनुरोध एक बार दोहराया जाता है। API का टाइमआउट 12 सेकंड है।

यदि API दाम नहीं देता, तो तय दाम लिया जाता है, या तय दाम न होने पर कैरियर छिपा दिया जाता है। ग्राहक को API त्रुटि का विवरण कभी नहीं दिखता; वह डिबग लॉग में जाता है।

यदि आप Shipping > Carriers में कैरियर को संपादित करते हैं और उसके ऑर्डर पहले से हैं, तो PrestaShop उसे कैरियर का नया संस्करण बनाकर सहेजता है। मॉड्यूल नए संस्करण का अपने-आप पालन करता है।

मॉड्यूल केवल दरें निकालता है। वह Correios के अंतरराष्ट्रीय दाम (Exporta Fácil, Packet), डिलीवरी समय का अनुमान, लेबल, प्री-पोस्टिंग, घोषणाएँ या ट्रैकिंग नहीं लाता। ग्राहक Correios एजेंसी या लॉकर नहीं चुन सकते। अतिरिक्त सेवाएँ (घोषित मूल्य, हाथों-हाथ सौंपना, प्राप्ति सूचना) नहीं जोड़ी जातीं। हर स्टोर के लिए एक Correios सेवा दिखती है, और मुद्रा दरें अपने-आप अपडेट नहीं होतीं।

ऑर्डर

Correios कैरियर से ऑर्डर देने पर मॉड्यूल सहेजता है कि उसका शिपिंग दाम कैसे निकाला गया था। बैक ऑफिस के ऑर्डर पेज पर फिर एक Correios ब्लॉक दिखता है, जिसमें Correios service (लाइव दाम के लिए, जैसे PAC — contract (03298)) और Price source होता है: Live price (Correios API), Fixed price या Free shipping।

लाइसेंस कुंजी

यह मॉड्यूल vibefox.net से मिली VibeFox लाइसेंस कुंजी से काम करता है। License — VibeFox Correios लाइसेंस ब्लॉक, Modules > Module Manager > VibeFox Correios > Configure में सेटिंग्स के ऊपर पहला ब्लॉक है। कुंजी को License key में डालें और Activate पर क्लिक करें। इसके बाद ब्लॉक में छिपी हुई कुंजी, स्थिति (जैसे वह तारीख जिस तक लाइसेंस सक्रिय है और आपका डोमेन) और ये बटन दिखते हैं: स्थिति फिर से जाँचने के लिए Check now, दूसरी कुंजी डालने के लिए Change key, और इस स्टोर से कुंजी हटाने के लिए Remove key। इनके नीचे Product: presta-shipping-correios वाली पंक्ति और लिंक Manage licenses and domains in your account है, जो आपका vibefox.net खाता खोलता है। केवल मॉड्यूल के लिए Configure अनुमति वाले कर्मचारी ही कुंजी बदल सकते हैं। ब्लॉक के टेक्स्ट बैक ऑफिस की भाषा का पालन करते हैं (अंग्रेज़ी और रूसी शामिल हैं)।

यदि कुंजी स्वीकार नहीं होती, तो ब्लॉक कारण बताता है, जैसे Key not found, This key belongs to another product, Domain limit reached या तारीख के साथ License expired on। स्टोर का पता बदलने के बाद, या अपने खाते में डोमेन स्लॉट खाली करने के बाद, Check now पर क्लिक करें। यदि लाइसेंस सर्वर तक पहुँच नहीं हो पाती, तो मॉड्यूल आखिरी ज्ञात स्थिति के आधार पर काम करता रहता है।

एक कुंजी एक डोमेन पर काम करती है: मुख्य स्टोर का डोमेन, मल्टीस्टोर सेटअप में भी। स्टोर से कुंजी हटाने पर उसका डोमेन स्लॉट मुक्त नहीं होता। स्लॉट अपने vibefox.net खाते में मुक्त करें।

सक्रिय कुंजी के बिना, चेकआउट पर ग्राहकों को Correios कैरियर नहीं दिखाया जाता और कोई दर नहीं निकाली जाती। PrestaShop स्टोरफ़्रंट को नहीं पता कि आप बैक ऑफिस में लॉग इन हैं, इसलिए कैरियर आपके लिए भी छिपा रहता है: आप कुंजी खरीदने से पहले मॉड्यूल सेट कर सकते हैं, पर चेकआउट पर उसे परख नहीं सकते। Modules > Module Manager में Alerts टैब पर एक अनुस्मारक दिखता है। मौजूदा ऑर्डर प्रभावित नहीं होते।

जब लाइसेंस की अवधि समाप्त होती है, मॉड्यूल चलता रहता है, पर अपडेट और सहायता के लिए नवीनीकरण चाहिए। बैक ऑफिस में काम करते समय स्थिति अपने-आप फिर से जाँची जाती है: कुंजी डालने के बाद पहले 14 दिनों तक रोज़ एक बार, फिर हर हफ़्ते एक बार। कोई cron जॉब नहीं चाहिए। मॉड्यूल को अनइंस्टॉल या रीसेट करने पर लाइसेंस कुंजी और लाइसेंस स्थिति हमेशा हट जाती है।

समस्या निवारण

चेकआउट पर Correios नहीं दिखता: जाँचें कि लाइसेंस सक्रिय है और Enable Correios चालू है। Shipping > Carriers में जाँचें कि कैरियर ग्राहक के देश के ज़ोन और ग्राहक के समूह को कवर करता है (या Ignore shipping zones चालू है और देश अनुमत है)। वज़न सीमाएँ और Minimum order amount जाँचें। लाइव दाम न होने पर, देश या * के लिए तय दाम होना चाहिए। उत्पाद पेज पर उत्पाद कुछ कैरियर तक सीमित भी हो सकते हैं।

कैरियर Correios दाम की जगह तय दाम दिखाता है: मॉड्यूल पेज पर Log फ़ील्ड देखें। Correios की त्रुटियाँ वहाँ दर्ज होती हैं: गलत एक्सेस कोड, सेवा आपके अनुबंध में नहीं, CEP सेवा में नहीं, 30 kg से भारी पार्सल या आकार सीमा से बड़ा पार्सल। यह भी जाँचें कि मूल CEP सेट है, ग्राहक का CEP 8 अंकों का है और यदि डिफ़ॉल्ट मुद्रा BRL नहीं है, तो BRL दर सेट है। हर गणना देखने के लिए Debug log चालू करें।

टोकन अनुरोध विफल होता है: API उपयोगकर्ता, एक्सेस कोड, posting card और वातावरण जाँचें। होमोलोगेशन एक्सेस कोड केवल Homologation चालू होने पर काम करता है, और उत्पादन कोड केवल उसके बंद होने पर।

बदलाव के बाद दरें पुरानी लगती हैं: मॉड्यूल पेज पर Save पर क्लिक करें। इससे कैश्ड दाम और API टोकन साफ़ हो जाते हैं।

पेज कहता है कि Correios कैरियर नहीं मिला: कैरियर Shipping > Carriers में हटाया गया था। उसे फिर बनाने के लिए Modules > Module Manager में मॉड्यूल रीसेट करें।

सेव करते समय अनुमति नहीं होने की सूचना आती है: आपकी कर्मचारी प्रोफ़ाइल मॉड्यूल देख सकती है, पर उसे कॉन्फ़िगर नहीं कर सकती। सेटिंग्स सहेजने और लॉग खाली करने के लिए मॉड्यूल की कॉन्फ़िगर अनुमति चाहिए।

अनइंस्टॉल

Modules > Module Manager पर जाएँ, VibeFox Correios के बगल वाला मेनू खोलें और Uninstall चुनें। लाइसेंस कुंजी, लाइसेंस स्थिति, कैश्ड दाम और टोकन हमेशा हटते हैं। यदि Remove data on uninstall चालू है, तो कैरियर हटा दिया जाता है (ऑर्डर अपना इतिहास रखते हैं) और सेटिंग्स, सहेजी गई ऑर्डर सेवाएँ और लॉग हटा दिए जाते हैं। यदि बंद है, तो कैरियर केवल निष्क्रिय होता है और सारी सेटिंग्स रहती हैं। मॉड्यूल फिर से इंस्टॉल करने पर कैरियर अपनी पिछली स्थिति के साथ लौट आता है।

Correios उसके संबंधित स्वामी का ट्रेडमार्क है। यह मॉड्यूल Correios से संबद्ध नहीं है और Correios द्वारा अनुमोदित नहीं है।