CP Overview

The add-on has four pages in the CP: Parcels, Rules, Settings and Logging. The Parcels page shows a notice and links to the settings page as long as the API key and Shop ID are not filled in.

Parcels

This is where you can track your orders and their MyParcel parcels. The overview lists the orders of the current site that are not cancelled and not marked as shipped, with the same layout as the order overview of Store: the order ID with the order status, the customer with the email address, the order date and time, whether the order is paid with the payment method, the MyParcel status of the parcel (a dash when there is no parcel yet) and the order total. All orders are listed, also orders placed with another shipping method. MyParcel orders never get the Store status "shipped", so they stay in this list until they are cancelled.

Click a row to open the parcel. The actions menu of a row also links to the order in Store.

Available from v2.0.0

Filter the orders on the MyParcel status of the parcel (or "Not Created" for orders without a parcel), the order date (a period or a custom range) and a keyword, and set the number of orders per page. The keyword searches the order number (with or without #), the name, company and email address of the customer. The filters stay active when you sort or go to another page.

Parcels Detail View

When you click on an order in the overview, you will be taken to the detail view. It has the same layout as the order page of Store, with the order status, payment and MyParcel status at the top and cards for the order details (order date and payment method), the customer, the shipping address and the ordered items with their weight, quantity and the total weight. When a parcel exists, a Parcel card shows the carrier, the shipment type, the options and the track & trace code, with a link to open the shipment in the MyParcel backoffice. The Print button prints the order, invoice or packing slip, and the Actions menu links to the order in Store and to the shipment in MyParcel.

Every time you open this page, the parcel is synced with MyParcel. When that fails, the error is shown at the top of the page. When the shipment is not found in MyParcel, the warning has a Delete local parcel button: it removes the parcel from the order and sets the order back to not shipped, so you can create a new one. The parcel is never removed by itself, because the shipment can also belong to another MyParcel account (e.g. after changing the API key).

If no parcel has been created yet, the page shows the suggested shipping method (the one the customer selected at checkout) and a form to create the parcel (export the order to MyParcel). Before you create the parcel you can still edit the customer details and the shipping address of the order. Once the parcel is created, it can't be changed here anymore; edit it in MyParcel instead.

The parcel is created in MyParcel as a concept shipment. Printing the label and handing the parcel to the carrier is done in MyParcel.

Carrier

Select the shipping carrier for this parcel. Supported carriers are PostNL, DPD, DHL for You, UPS Standard and UPS Express Saver. When the order was placed with a MyParcel shipping method, the carrier of that rule is selected by default.

Package Type

Choose the type of package for this parcel: Package, Mailbox Package, Letter, Digital Stamp, Pallet or Small Package. When the order was placed with a MyParcel shipping method, the package type of that rule is selected by default. When the selected carrier doesn't support the package type, the parcel is sent as a Package.

Options

Select any additional shipping options for this parcel: signature on delivery, only recipient (recipient-only delivery) and age check (18+).

MyParcel panel in the Store order view

When you view an order in Store, a MyParcel panel is added to the order. It shows the MyParcel status, the carrier, the shipment type and the track & trace code of the parcel, with a link to the parcel and to the shipment in the MyParcel backoffice, or a link to create a parcel when there is none yet. The panel is hidden for orders that are shipped or cancelled. When the shipment is not found in MyParcel, the panel shows a warning with a link to the parcel page, where you can delete the local parcel.

The Actions menu of the order also gets a View parcel or Create parcel link (Store 4.0.0 and later).

Rules

This is where you can create and manage your Carrier / shipping method rules. Every rule is shown as a shipping method at checkout when it matches the shipping country and the weight of the cart. See How does it work.

Available from v2.0.0

Filter the rules on country (only the countries that are used in a rule) and carrier, and set the number of rules per page. The filters stay active when you sort or go to another page.

Creating a New Rule

Label

The label of the rule. It identifies the rule and is shown to customers as the name of the shipping method during checkout. When it is empty, the name of the carrier is used in the list of shipping methods, but the order gets an empty shipping carrier, so always fill in a label.

Country Name

The country to which this rule applies. Select from the list of countries.

Carrier

The shipping carrier for this rule: PostNL, DPD, DHL for You, UPS Standard or UPS Express Saver. The carrier must be available for the selected country, otherwise the rule can't be saved.

Package Type

Available from v2.0.0

The package type of the parcel when an order with this rule is exported automatically, and the default package type when you create a parcel by hand: Package, Mailbox Package, Letter, Digital Stamp, Pallet or Small Package. The carrier must support the package type, otherwise the rule can't be saved. Rules saved before v2.0.0 use Package.

Price

The shipping price associated with this rule, entered like your product prices (the Tax Type of the Store). The tax rate comes from the Store Tax add-on; without Store Tax no tax is added. See How does it work.

Weight threshold

The weight from which this rule applies, e.g. 10kg would be entered as 10, or 9.5lbs would be entered as 9.5. The rule is offered when the total weight of the cart is equal to or higher than this value, and per carrier only the rule with the highest threshold the cart reaches is offered. Enter 0 to offer the rule from any weight (also for a cart without weight). The combination of country, carrier and weight threshold must be unique.

Settings

API Key

Enter your MyParcel API key to enable communication between your store and MyParcel services.

Shop ID

Your MyParcel Shop ID.

Description on label

This description will appear on the shipping label for all parcels exported through this integration. Use {order_id} for the order ID, e.g. #{order_id} (the default) becomes #1008.

Weight unit

Available from v2.0.0

The unit of the weight of your products, the weight param of the add_to_cart tag: Kilogram (the default), Gram or Pound. The total weight of an order is converted to whole grams for MyParcel, e.g. 2.5 kg becomes 2500 g. The weight thresholds of the rules use the same unit as your products.

Hook URL

The webhook URL to receive shipment status updates from MyParcel, e.g. https://example.com/index.php/reinos-store-my-parcel-webhook. When you save the settings with an API key, the URL is registered in your MyParcel account (a webhook subscription for shipment_status_change), unless it is already registered. MyParcel only calls a https URL, so on a site without https (or a local site MyParcel can't reach) the webhook doesn't work; a warning is shown when registering fails. The URL is read-only.

Automatic export

Choose if and when orders should be automatically exported to MyParcel. Options include:

• Do not export automatically
• Shipment information only: exports all information for creating domestic and foreign shipments.

With "Shipment information only", a parcel is created as soon as an order that was placed with a MyParcel shipping method is marked as paid. See How does it work.

Default settings

These settings are Store settings: changing them here also changes them in Store.

Free shipping above

Free shipping when the subtotal of the cart is above this amount; the MyParcel rules then cost 0. If 0 is given, it will not calculate free shipping. This setting is hidden here when the Store Price Rule add-on is installed, but its value is still used; it can still be changed in the Store settings.

Always select the first shipping method

When you have multiple shipping methods that match the cart and none is selected yet, the first one is selected when this setting is on. The MyParcel rules come first, sorted by weight threshold (highest first).

disable_shipping param

Determines how the disable_shipping="yes" parameter of the add_to_cart tag works. When this setting is on (the default), the shipping is only free when all items in the cart have disable_shipping="yes". When it is off, one item with disable_shipping="yes" already makes the shipping free.

Default country

What is the default shipping country.

Allowed Countries

What are the countries to ship to.

Logging settings

What should be logged: only errors (default), everything or nothing.

Logging

This is where you can find the logs of the add-on, e.g. failed automatic exports (errors) and successful automatic exports and webhook calls (notices). What is logged depends on the logging setting; notices are only logged when it is set to "Everything". The results of an automatic export are also added to the log of the order in Store. Use "Delete all logs" to clear the log of the current site.

Available from v2.0.0

• Filters: filter the logs on severity (error or notice), date (a period or a custom range) and a keyword in the message, and set the number of logs per page. The filters stay active when you sort or go to another page.
• Bulk delete: select logs with the checkboxes and choose "Delete" in the "with selected" bar.
• Export logs: download the logs as a CSV file (separated by ;). The export uses the active filters, so only the filtered logs are exported.