Shipbeat Magento Module. Installation and user guide

(1)

Shipbeat Magento Module

Installation and user guide

(2)

This guide explains how the Shipbeat Magento Module is installed, used and uninstalled from your Magento Community Store.

If you have questions or need support to get the extension to work as intended in your magento shop please reach out to us via email [email protected] or via phone +45 7060 5021.

Installation flow: Production

1. Upload plugin file via System > Magento Connect > Magento Connect Manager

2. Return to admin

The Shipbeat menu will now appear in “System” menu.

3. Configure Shipbeat shipping method (System > Configuration > Shipping Methods > Shipbeat)

a. Enter token

b. Make sure the “Mode” is set to “Production”

c. Enter a title which is relevant for your customers in “Title”

d. Disable other shipping methods (like TRIC Pacsoft and GLS) while in this view 4. Go to System > Shipbeat > Shipment configuration to configure store settings This step completes the installation of the module. The next step is configuring the extension with the delivery options you wish to offer your customers.

Configuring your shop

Configuring your shop is easy. The Shipbeat support employee will help you create a shop(s) in the Shipbeat system and create the shipping options for your shop.

(4)

In the following steps you will learn how to map Shipbeat shops to your Magento stores, and how to configure shipping methods.

Mapping Shipbeat shop to Magento store

In Shipbeat > Shipment configuration select the shop that you want to setup and edit. From the drop-down select the shop that is created for you in the Shipbeat system. When done, click “Save Shipbeat shop”. Available delivery methods will appear.

Select standard weight and dimensions for your shop

Once you have mapped a Shipbeat shop to a Magento store, available delivery methods and packaging types will appear. You can now select packaging type that you will use with your shop. By default, your account will be setup with a few packaging types that you can pick from. They should fit the dimensions and weights for the shipments you generally have. If you need an additional templates that fit your shipments better please contact

(5)

Available shipping methods

You Shipbeat account comes with several delivery methods configured based on your carrier agreement. Usually it will contain Home, Business, Delivery Point and Return delivery

methods.

Shipbeat Magento Module allows you to further customize information visible to your customers, such as method name, description, price and car value over which the method should become free.

(6)

Customizing shipping methods available to your customers

Shipbeat Magento Module allows you to customize what’s visible for your customers. You can change shipping method name, description, pricing and configure when an option should become free.

(7)

In the “Name” field you can edit the name presented to your customer for that specific delivery method. In “Description” you can also describe how that delivery method works in detail to address the questions your customer may have. E.g. “Delivery to your private address during business hours.”

Price and Condition for free shipping

Shipbeat Magento Module allows you to set the conditions for free shipping including the shipping fee the customer has to pay in your checkout for the shipping if the free condition is not met.

In Condition for Free shipping you are able to set the minimum value an order has to have to obtain free shipping.

Shipping method “Delivery point”

Delivery point shipping methods include special functionality in your frontend. Once your customer clicks on a delivery method, a map with available delivery point destinations will appear.

(8)

This overlay is fully responsive and will adjust itself to your customer’s screen resolution, be they on a PC, laptop, tablet or mobile.

(9)

Handling orders

Once your customers place orders, they are ready to be processed by Shipbeat. Shipbeat Magento Module seamlessly integrates with the Order Information page, providing extra functionality to print various labels, track the order or register a delivery without downloading the label.

You can access these actions via the top button toolbar or the action bar in the “Shipping & Handling Information”.

“Register delivery” and “Print label” buttons are added by Shipbeat Magento Module to the “Order Information” page to help make shipping frictionless.

More actions are available from the “Shipping & Handling Information” section in the “Order Information” page.

The actions available are: Print label, Create a return label, Create an additional label,

Register delivery and Track order.

“Track order” is only visible after the delivery has been registered.

Printing labels

Shipbeat Magento Module makes it really easy to print the labels for your orders. Simply click the “Print label” action and your browser will begin downloading a PDF that you can later print.

Return deliveries

There are times, when for some reason your customer needs to return a package back to you. In those cases, you can generate a return label, that you can e-mail (or print and send via post) to your customer.

(10)

Creating additional labels

Sometimes you will need to split your order into multiple packages. In those cases, you can use “Create an additional label” action. An extra label will be generated and downloaded by your web browser. It will also appear in an “Additional labels” section of “Shipping &

Handling Information” once you refresh the page.

The following image shows a table containing one return and two extra outbound labels available for download.

Register delivery

Registering a delivery is a way of telling Shipbeat that you want to formalize a given delivery with a carrier. Once you register a delivery, the carrier will receive a notification that they need to pick up a package from your warehouse. It is your duty to print the label and get the package ready in time for the carrier to pick it up.

When you choose one of the Print actions, the delivery will be registered in the background for you. If you don’t need to print the label but want to notify the carrier that they should pickup the order, then Register Delivery is what you want to use.

Tracking orders

If the Track & Trace service is applicable to this order, the “Track Order” action will allow you to see the tracking information for this order. If you click on it, a popup will appear displaying the tracking information provided by Shipbeat.

(11)

(12)

Mass actions

Shipbeat Magento Module adds mass actions to “All Orders Grid” page. Mass actions allow you to perform a certain task for multiple orders, like printing labels for orders that have been placed in the last 12 hours.

Shipbeat specific mass actions.

Please refer to the “Handling orders” section in order to learn more about what each mass action does.

(13)

Emails

Adding delivery point address

Shipbeat Magento Module allows you to insert delivery point address into transactional emails.

In your email template, add the following code where you want the delivery point address to be displayed:

If the order was not created for the delivery point, nothing will be shown, otherwise a delivery point address will be displayed.

Adding tracking link

You can add tracking URL to your transactional emails using the following format template:

<a href=”http://www.my-store-url.com/shipment/tracking/?order={{var order.increment_id}}”>Track your order</a>

Cronjob

Shipbeat Magento Module adds a cronjob to your Magento Cronjobs queue, which allows it to speed up Mass Label Printing action. This cronjob downloads labels for all registered deliveries and saves them in the database. This helps you to generate labels much faster when doing it from the Mass Action toolbar in the All Order Grid.

(14)

Track & Trace

Shipbeat Magento Module adds a Track & Trace page on your webshop. You and your customers may access it on www.myshop.com/shipment/tracking. Tracking information can be displayed by entering order number into the “Order number” field.

(15)

Supported checkout modules

Shipbeat Magento Module currently officially supports two checkout methods: Magento’s Default Onepage Checkout and OneStepCheckout (4.1.3) from www.onestepcheckout.com. You can check what version of OneStepCheckout you are using in the following file:

app/code/local/Idev/OneStepCheckout/etc/config.xml

If you have any further questions regarding support for checkout modules, don’t hesitate to contact us at [email protected].

Recommended configuration for OneStepCheckout

Shipbeat Magento Module is fully compatible with OneStepCheckout, but there are certain configuration options that you need to set in OneStepCheckout settings. Go to System > Configuration > Sales > OneStepCheckout.

Under general settings

● Ensure that default country is set (e.g. Denmark) ● Select shipping method if only one available: Yes ● Hide shipping method: No

Under AJAX update shipping/payment methods ● Enable AJAX save billing: Yes

● AJAX save billing fields: Country, Postcode

(16)

Changelog

Various fixes - 0.6.2 - 2015 07 13

● Updated Shipbeat PHP wrapper

● No longer possible to use "test" or "demo" endpoints – only "production" endpoint is now available. "Test" and "Production" modes are still available and the module requires "Production API Key" from now on

● Fixed a small bug where it wasn't possible to determine "production" and "test" mode values for internal use

● Configuration page now forces delivery method response to be parsed as JSON ● If a quote cannot be retrieved during transactional email processing, delivery point

address will be returned as an empty string

● Google Maps external script is now loaded via JavaScript instead of Layout XML files ● Removed overrides of Magento's Page HTML blocks

● Fixed an OSC test, which failed due to AJAX loader still being present on the page

Batch processing - 0.6.0 - 2015 05 28

Batch processing related improvements:

● Removed “Ship” button for Shipbeat orders (now it’s easier to print labels) ● Initial shipment order is now created at the same time the order is placed ● Order actions bar is now always displayed on the order information page ● “Track” link only visible when order tracking information exists

● Rearranged order actions buttons

● “Register delivery“ link visible if delivery has not been created

● “Register delivery” and “Print label” are added to the top actions bar

● Labels are now persisted in the database to eliminate latency between your Magento store and Shipbeat API

● Error labels are generated in case there are problems with real labels

● Cronjob has been added to persist missing labels for registered deliveries in the database

● Added mass actions

Other improvements and changes:

● Developers now have a “Demo” mode available for their stores that simulates Production environment’s speed with dummy database

(17)

● Renamed some configuration options and values

● Fixed a bunch of exceptions in the Shipment Configuration page ● A bunch of refactorings to improve code quality

● Updated old and added new tests

Delivery points - 0.5.0 - 2015 05 11

Delivery point related improvements:

● It is now possible to retrieve delivery points for multiple carriers under the same delivery point shipping method

● Added a template directive for displaying delivery point address in the emails

● Delivery points can now be selected when making new orders or re-ordering from the backend

● Magento Onepage Checkout now displays selected delivery point address in the sidebar after shipping method has been saved

● Delivery point address is now displayed in order overview in the backend

● A friendly button indicating the possibility to change delivery point after it has been selected is now displayed next to a delivery point shipping method

● Google map is reinitialized each time delivery point popup is shown. This helps prevent scaling issues in case the browser was resized in between popup display/hide events

● When encountering an error while saving delivery point, Save button no longer stays inactive

● Postal code is now cleared in between popup show/hide events

● Magento Onepage Checkout used to display delivery point address even though shipping method was not synced with Magento

● Optimization for API calls when looking up multiple delivery point quotes in the same session

Other improvements:

● Shipping method descriptions can now have line breaks in them

● Address is now created right before the delivery in the admin instead of during quote lookup

● Fallback to country area is now removed. This used to give incorrect quotes when customer enters incorrect postal code

Internal changes:

● Moved to Grunt build system away from Codekit ● New test cases for new features

(18)

● Fix an exception notification spam in logs ● Code refactoring in tests

● Code refactoring under the hood

● Better way to inject JavaScript into frontend ● PHP short open tags are no longer there

Return deliveries - 0.4.0 - 2015 04 23

● Return delivery is now a special kind of delivery method visible for the merchant ● Return delivery can be created from order overview

● Return label can be downloaded from order overview

OSC compatibility - 0.3.1 - 2015 04 21

OSC (onestepcheckout.com) related changes:

● Ensures that delivery method is always synced with DB ● Update the backend when deselecting delivery point ● Address is now created right before creating a delivery

● User action is no longer available when only one shipping method is available ● User gets a visual clue to select a delivery point when only delivery point method is

available

● Delivery point address is displayed even at initial page launch

● Error message is displayed if initially no delivery points could be found Other changes:

● Descriptions can be added to shipping methods ● Delivery Point popup mobile view improvements And more small fixes under the hood...

Initial release - 0.3.0 - 2015 04 13

● Display Shipbeat shipping methods to your customers ● Custom price for shipping methods

● Price override over X basket value ● Track & Trace of shipped packages ● Print labels

Shipbeat Magento Module. Installation and user guide