In this documentation you will read how to install and use our module ‘myCourierCenter’ for PrestaShop.

Documentation Content

• Installation
• Configuration
  • After first time install! Sync orders
  • Configuration Section I: Credentials and sync
  • Configuration Section II: Voucher Settings
  • Configuration Section III: CRON Settings
• Using the order options (single order)
  • Voucher Options
  • How to print a voucher
  • How to cancel a voucher
  • How to track a voucher
• Using the table options (multiple vouchers)
  • Voucher Options
  • How to print vouchers
  • How to cancel vouchers
  • How to track vouchers
• Email Files you might want to change
• Module Translation
• Contribute

Installation

• Upload it via Modules -> Add a new module -> Choose a file (v.X.X.X-mycouriercenter.zip) -> upload the module via PrestaShop Module Manager, or unzip and upload the mycouriercenter folder to your root/modules folder via FTP.
• Search the module under Modules by typing mycouriercenter.
• Click install and then configure it.

Configuration

To configure the module, navigate from the Back Office menu to Modules -> Module Manager and search for our module by typing mycouriercenter, then click the configure button.

Here you will find 3 sections (tabs), each section configures different things for the module.

After first time install! Sync orders

**MUST** After first installation, configure the module correctly and then use it.

There are two actions that must be completed before using it:

1. From the configuration page of the module click on Voucher Settings and choose the cash on delivery payment modules that you use in your PrestaShop. With Ctrl pressed you can choose more than one if you are using multiple COD modules. This is crucial because it helps the module understand when an order is cash on delivery and mark it correctly in the voucher.
2. After you save the COD modules, click on the Start Sync button from the Synchronize Orders section and wait until the progress bar is complete. This action will create all the required data in the mycouriercenter table so that the module can work properly, and it is also required for orders to appear in the myCourierCenter Vouchers table. New orders will be recorded automatically. This usually needs to be done only once, or again if some orders are missing.

Configuration Section I: Credentials and sync

All credentials are provided by Courier Center. You must request access to their web services / API.

Username, Password, API Key, and Billing Account are mandatory.

Before you click the sync button, first choose your payment modules from Voucher Settings so the module can correctly mark COD orders.

Configuration Section II: Voucher Settings

The first option controls whether the myCourierCenter section is shown inside the order page, so you can create vouchers directly from the order, cancel them, check status, and more. If you do not want this section and only want to use the myCourierCenter Vouchers table for mass actions, choose NO to hide it. Keep in mind that the order page section is very useful because it also shows data such as voucher number and delivery status.

Voucher Print Template lets you choose the format used by Courier Center when generating the PDF:

• A4 – up to 3 vouchers per page
• singlepdf – 100x205mm
• singleclean_100x150 – 100x150mm
• singleclean_100x170 – 100x170mm

Add order ID to voucher comment helps you automatically prefix the voucher comment with the PrestaShop order ID.

Cash on delivery option is one of the most important settings. It helps the module understand, according to the payment method of the order, when a voucher should be marked as cash on delivery. Choose all your COD payment modules here. With Ctrl pressed you can choose more than one.

Send email when voucher is printed sends an email to the customer with the voucher number and tracking information.

Choose the order status that should trigger a transit email lets you send the email with voucher number and tracking information automatically when an order changes to the selected status. Choose NONE if you do not want to use this.

Choose which carriers should show the voucher tools can help you a lot. You choose the carriers that should be considered as Courier Center orders. Only orders using one of those carriers will appear in the myCourierCenter Vouchers table and show the myCourierCenter tools inside the order page. Leave it blank to show all orders and show the tools for all orders.

Finally, choose whether you want to change the order status automatically when a voucher is created. Choose NONE if you do not want to use it.

Configuration Section III: CRON Settings

First of all, you must create a CRON task on your server.

For cPanel read here.

For Plesk read here.

Copy the Cronjob command shown in the module configuration page inside the highlighted box.

The CRON Settings tab contains all the options that define what the cron job will do.

The first option is to choose which orders you want to track. Select the order statuses to narrow down the orders you want to track. The fewer statuses you choose, the faster the process will be.

The next option filters which orders to track according to carrier. Select the carriers that the order must have. The fewer carriers you choose, the faster the process will be.

These first two options are important to set correctly so you can avoid timeout errors.

The next option helps the module characterize an order as late. For example, if you enter 4, then on the 5th day if an order is tracked and still not marked as delivered by Courier Center, the module can mark it as late by changing the order status. In the next option, choose the order status that should be assigned to late orders.

After that, choose the order status to assign to delivered orders.

Finally, you can choose to send a thank-you email to your customer when an order is marked as delivered by Courier Center.

Using the order options

This section is about the options shown inside the order page.

Any changes you make in these options will display a message informing you whether everything was saved successfully or not.

Voucher Options

1. Choose COD if this order is cash on delivery or not.
2. Parcels: enter more than one if one order has more than one box. For example, if one order has 2 boxes, enter 2 and the module will create the shipment with 2 parcel entries.
3. Total weight of all packages. This is calculated automatically if you have entered the weight on each product, but you can adjust it manually.
4. Comment to be shown on the delivery voucher. The order message is automatically placed here, but you can change it if you wish. Simply edit it and the module will save it.
5. The main button of this form creates the voucher and opens the voucher PDF in a new tab so you can print it.
6. Sends an email to the customer with the voucher number and tracking information.
7. Shows the voucher number created for the specific order.
8. Click to check and save the latest delivery status (recommended after you have handed the parcel to the courier).
9. The latest delivery state of the voucher is shown here.
10. Click this button if you wish to cancel the specific voucher.

How to print a voucher

First choose the options you want for the order (COD, parcels, weight, comment) and then click the PRINT VOUCHER button. A new tab will open with the voucher PDF, and then you can print it like any other PDF document.

How to cancel a voucher

When a voucher exists, a new button will be shown: CANCEL VOUCHER. Click it to cancel the voucher for that order.

How to track a voucher

When a voucher exists, you can click the CHECK button and the module will request tracking information from Courier Center. The latest data will be saved and shown under the CHECK button.

Using the table options

From the myCourierCenter Vouchers table you can choose multiple orders to print at once or cancel them.

Voucher Options

1. Parcels: enter more than one if one order has more than one box.
2. Choose COD if this order is cash on delivery or not.
3. Total weight of all packages. This is calculated automatically if you have entered the weight on each product.
4. Comment to be shown on the delivery voucher. The order comment is automatically placed here but you can change it. A message will be shown that says SAVED.
5. Click to check and save the delivery state of the voucher.

How to print vouchers

First choose each order you want to print by clicking the checkbox next to the order ID. Then at the bottom of the page click Bulk Actions and choose Courier Center – Print Selected Orders. The module will generate one merged PDF file for easier printing.

How to cancel vouchers

Same as printing, but from Bulk Actions choose Courier Center – Cancel Selected Orders.

How to track vouchers

Click the CHECK button inside the order row you are interested in.

For mass tracking, set up the cron job and let the CRON process update delivery statuses automatically.

Email Files you might want to change

There are email template files that you might want to adjust to your standards.

1. root/modules/mycouriercenter/mails/{language}/in_transit_cc.html (email for the voucher number / tracking update)
2. root/modules/mycouriercenter/mails/{language}/thankyou.html (email sent by CRON when an order is marked as delivered)

Variables to use in in_transit_cc.html:

{shop_name}

{shop_logo}

{firstname}

{lastname}

{order_name}

{shipping_number}

Variables to use in thankyou.html:

{shop_name}

{shop_logo}

{firstname}

{lastname}

{order_name}

Module Translation

To translate the module, navigate from the Back Office menu to International -> Translations. In the Modify Translations section choose:

• Type of translation -> Installed modules translations
• Select your module -> myCourierCenter
• Select your language -> The language you want to translate to

Then click modify.

Now translate each field and click Save or Save and Stay.

Contribute

Contribute by letting us know about any flaws in the module, or suggestions you have so we can improve it.

Please feel free to open a ticket if you have any difficulty or want to contribute on addons.prestashop.com (do not forget to login with the account you used to purchase the module first).

Happy sales!