How does it work

Store MyParcel connects Reinos Store to your MyParcel account. It has no template tags of its own: you keep using the regular Store tags (like the shipping_methods tag and the order tag). The settings are described on the CP Overview page; this page explains how it all works together.

In short:

1. Checkout: the rules you create are offered to the customer as shipping methods. The customer picks one and the order is saved with that shipping method.
2. Export: the order is sent to MyParcel as a concept shipment, by hand from the CP or automatically when the order is paid. It contains the address, the carrier, the package type, the weight of the order and the options (signature on delivery, only recipient, age check).
3. MyParcel: you print the label and hand the parcel to the carrier in your MyParcel account. The add-on does not print labels.
4. Sync: the status of the shipment (and the address) is copied back to the order in Store.

What changes in the Store module

When the add-on is installed:

• Shipping methods: the standard shipping method of Store (Shipping Label / Shipping Price in the Store settings) is no longer offered. Only the MyParcel rules are offered, plus the methods of Store Shipping and Store Pickup when those are installed. Shipping Label and Shipping Price in the Store settings have no effect anymore.
• Checkout: the customer must select a shipping method, otherwise Store shows the shipping_method_missing error.
• Manage Shipping Status: this Store setting is turned on once during the installation. You can turn it off again in the Store settings.
• Shipping status of MyParcel orders: the status comes from MyParcel (see Status synchronization) and is shown as e.g. "Myparcel - delivered" in the order overview, the order view and {order:shipping_status}. The Is shipped toggle in Edit order details is hidden for MyParcel orders, so you can't mark them as shipped by hand. Other orders keep the toggle.
• Order view in the CP: a MyParcel panel is added to the order. Every time you open an order that has a parcel, its status is updated from MyParcel.
• Store settings: Free shipping above, Always select the first shipping method, disable_shipping param, Default country and Allowed Countries can also be changed on the settings page of the add-on. These are the same settings as in Store, so a change in one place shows up in the other.

When you uninstall the module

• All data of the add-on is removed: settings, rules, parcels and logs. Your shipments in MyParcel are not touched.
• The Hook URL stops working. The standard Store shipping method is offered again (unless Store Shipping is installed), so check Shipping Label and Shipping Price in the Store settings.
• Store settings that were changed (Manage Shipping Status, free shipping, countries) keep their values.
• Existing orders keep their shipping method, carrier, address and last shipping status. The status is then shown as a raw value (e.g. my_parcel_delivered) and these orders still can't be marked as shipped by hand.

Shipping rules at checkout

The rules you create in the CP are offered as shipping methods, with the label of the rule as the title and the price of the rule as the price. A rule is offered when:

• it is for the shipping country of the cart. A new cart starts with the Default country of the Store. Without a country, or without a rule for that country, no MyParcel shipping method is offered;
• its weight threshold is equal to or lower than the total weight of the cart. The weight comes from the weight parameter of the add_to_cart tag. When the cart has no weight, only the rules with a weight threshold of 0 are offered;
• it is the rule with the highest weight threshold the cart reaches for its carrier. A cart of 12 kg with a PostNL rule from 0 kg and a PostNL rule from 10 kg only gets the 10 kg rule; a DPD rule from 0 kg is offered next to it.

Good to know:

• The rules are listed with the highest weight threshold first, before the methods of Store Pickup and Store Shipping. With Always select the first shipping method on, the first MyParcel rule is selected.
• Tax: enter the price of a rule the same way as your product prices (including or excluding tax, like the Tax Type of the Store). The tax on the shipping costs comes from the Store Tax add-on. Without Store Tax, no tax is added to the MyParcel shipping costs.
• Free shipping: when the cart gets free shipping (Free shipping above, the disable_shipping parameter, or a free shipping rule of Store Price Rule), the MyParcel rules are free as well.
• Always give your rules a label: the label is saved as the carrier of the order. Without a label, the carrier of the order stays empty.

List the shipping methods in your checkout with the shipping_methods tag of Store and post the selected one as shipping_method:

{exp:reinos_store:shipping_methods}
    <input {if shipping_methods:selected}checked{/if} id="{shipping_methods:name}" type="radio" name="shipping_method" value="{shipping_methods:name}" />
    <label for="{shipping_methods:name}">{shipping_methods:title} ({shipping_methods:price_plus_tax:formatted})</label>
{/exp:reinos_store:shipping_methods}

Exporting an order

Exporting an order creates a concept shipment in MyParcel (one per order). The order is used as it is at that moment: the customer name, company, e-mail and phone, the shipping address, the total weight and the shipping costs.

After the export, the shipping status of the order becomes "concept". The shipping address of the order stays as it is (see Address).

Manual export

Go to Parcels in the CP (or use the link in the MyParcel panel of the Store order view), open the order and create the parcel. You choose the carrier, the package type and the options. See Parcels Detail View.

This works for every order that is not cancelled and not marked as shipped, also for orders that were placed with another shipping method (e.g. Store Shipping or Store Pickup). After the export, the order becomes a MyParcel order with the selected carrier. A pickup order is then no longer a pickup order. An order that was placed with a MyParcel shipping method keeps its rule.

When the export fails, the error from MyParcel is shown on the page and no parcel is saved.

Automatic export

When Automatic export is set to "Shipment information only", a parcel is created as soon as an order is marked as paid (by the payment gateway, or by hand in Edit order details). This only happens when:

• the order was placed with a MyParcel shipping method, and that rule still exists,
• the order has no parcel yet.

The parcel uses the carrier and the package type of the rule and no extra options. Orders that were already paid before you turned the setting on are not exported; export them by hand.

Description on label

The Description on label setting is used as the reference and the label description of the shipment, with {order_id} replaced by the order ID. When it is empty, the label description is Order #{order_id}.

Address

MyParcel needs the street, house number and suffix separately, so the shipping address of the order is split up based on how addresses are written in that country (e.g. "Street 12A" in the Netherlands, "12 High Street" in the UK). Only the first address line is used; the second address line is not sent to MyParcel. Make sure customers put the house number in the first address line.

Status synchronization

The status of a parcel is updated from MyParcel:

• when MyParcel calls the Hook URL,
• when you open the parcel on the Parcels page in the CP,
• when you view the order in Store.

The MyParcel status (e.g. concept, registered, handed to carrier, delivered) is saved as the shipping status of the order and shown as e.g. "Myparcel - delivered". When you changed the address in MyParcel, the new address (street, house number, postal code, city and country) is copied to the order as well; the second address line and the state of the order are not changed.

When you delete the shipment in MyParcel, the MyParcel panel in the Store order view and the parcel page show that the shipment was not found. Delete the local parcel with the Delete local parcel button on the parcel page; the order is then set back to not shipped, so you can create a new parcel. The add-on never deletes it by itself, because the shipment can also belong to another MyParcel account (e.g. after changing the API key, or with another account per MSM site).

A MyParcel order never gets the regular Store status "shipped". Because of that, MyParcel orders stay in the Parcels overview (until they are cancelled), and Store Email templates that are sent when an order is shipped are never sent for MyParcel orders.

Combining with other add-ons

• Store Shipping: both work together. The rules of both add-ons are offered as shipping methods (MyParcel first). Store Shipping orders are not exported automatically, but you can export them by hand (they then become MyParcel orders). Both add-ons share the same Store settings (free shipping, countries).
• Store Pickup: the pickup locations are listed after the MyParcel rules. Pickup orders are not exported automatically. Only export a pickup order by hand when you really ship it: it then becomes a MyParcel order.
• Store Price Rule: a free shipping price rule makes the MyParcel rules free as well. When Store Price Rule is installed, Free shipping above is hidden on the settings page of this add-on, but the value in the Store settings is still used.
• Store Tax: adds tax to the MyParcel shipping costs. Without Store Tax, no tax is added.
• Store Email: "shipped" emails are not sent for MyParcel orders, see Status synchronization.

Common pitfalls

• No MyParcel shipping methods at checkout: there is no rule for the shipping country of the cart, the cart has no shipping country yet (set the Default country), or every rule for that country has a weight threshold above the cart weight.
• A rule is not offered: another rule of the same carrier with a higher weight threshold that the cart reaches wins, see Shipping rules at checkout.
• No tax on the shipping costs: Store Tax is not installed. The Shipping TAX percentage in the Store settings is not used for MyParcel rules.
• Empty carrier on the order: the rule has no label.
• Parcels page shows only a notice: the API key or Shop ID is not filled in.
• Export fails: check the error on the page or in the log (set the logging setting to "Everything" to also see successful exports and Hook URL calls). Common causes: a wrong API key, an address MyParcel can't split (no house number in the first address line), or a carrier that doesn't ship to that country. If the error appeared after MyParcel accepted the shipment, check MyParcel for a concept shipment and delete it before you try again, to avoid a duplicate.
• Automatic export didn't happen: the setting is "Do not export automatically", the order was placed with another shipping method, it already has a parcel, it was already paid when you turned the setting on, or the rule of the order was deleted ("no carrier found" in the log).
• The status doesn't update by itself: save the settings to register the Hook URL in MyParcel (check for a warning, the site needs https) and look for "MyParcel Webhook" lines in the log (with logging set to "Everything"). The status is always updated when you view the order in Store.
• The order address changed: the address was changed in MyParcel; the sync then copies the new address of the parcel to the order.
• The weight in MyParcel looks wrong: check the Weight unit setting; it must be the unit of the weight param of your products. The weight is sent to MyParcel in whole grams.
• The shipment was deleted in MyParcel but still shows: open the parcel page and click Delete local parcel, then you can create a new one.
• Error when viewing an order: viewing an order with a parcel contacts MyParcel. If you get an error there, check the log and contact support.