You are currently viewing documentation for Linnworks Desktop, if you are looking for Linnworks.net documentation, click here.






Royal Mail Integration

 

If you need to change the integration details such as the account number, you need to create a Linnworks Support ticket with the following information: OBA Account Number, OBA Email Address and Company Name so we can request the web services details to be updated otherwise you will receive errors when printing labels and filing the manifest.

Your Royal Mail account must be a credit account and not a pre-paid account. If it is a pre-paid account please talk to Royal Mail about changing your account otherwise you will not be able to use the integration.

You must provide your current email address setup in your Royal Mail OBA account profile and your OBA account number. Your account number must start with a 0 and be 10 digits long. If it does not please add the 0 to the front of the number.

Royal Mail International Changes April 1st 2014

As from 1st April 2014, Royal Mail has made changes to their international shipping services. Please see the International Country List to find out which services have been updated and which countries they can ship to.

Overview

The Linnworks direct Royal Mail integration works for standard, recorded and tracked services. There is no need for Despatch Express or Despatch Manager Online. The direct integration bypasses DMO completely and submits data directly to Royal Mail via Pre-advice manifest for Tracked services and OBA for all the other.  Note: As from April 2014. The Royal Mail integration is now automated setup process, all you need to do is follow the Setting up the integration section below.

1. Required Information for the Royal Mail Integration

Before you can start setting up the integration you need to make sure that you have the following:

Your Royal Mail OBA Account must be a Credit Account otherwise you will not be able to integrate it, If your account is pre-paid, you can change your account type by contacting Royal Mail directly.


You will need the following information:

  • Royal Mail Account Number (Your account number must be 10 digits long, if its not please add a 0 on the front.)

  • Contact Name

  • Business Name

  • Business Address

  • OBA Email Address (This must be the registered email address on your OBA Account)

  • Contact Telephone Number

  • Linnworks Email Address

You must also have a label printer and label stock. The printer can be either thermal printer that is capable of printing labels on Royal Mail provided labels with peel off section, alternatively Linnworks is also capable of printing Royal Mail labels on integrated label invoice paper with peel off bullets (see bottom of this document for links where such paper can be bought from). Integrated invoice labels can be printed on a standard ink-jet or laser printer (Laser printer highly recommended over the ink-jet for the purpose of barcode and overall label quality).

All your items must have weights in the system and labels can be printed only for orders with all items linked to inventory. Alternatively you have to use default weights for all shipping labels or enter the weight manually for each label when you process the order. Documentation can be found here that explains how to use the import tool so you can import the weights on to your inventory items.

The Royal Mail integration process has now been automated as from 1st April 2014.
Royal Mail has made also changes to its international services. Please see the Royal Mail Country List to find out which services can ship to which countries.
To setup Royal Mail Integration you must use the online request form unless you have the additional details for your account. PPI Licence, Access Code, Posting Location, Web Services Username and Password (The web services username and password are not the same as your OBA login details).

2. Royal Mail Online Integration Request Form

You will need to fill in the online request form twice, once for the OBA integration and again when setting up the Tracked integration. Follow the steps below for each OBA and Tracked.

Please follow the steps below:

  • Open Linnworks

  • Click on Settings > Shipping Management Fig 2.1

  • Click on the configuration button next to Royal Mail OBA or Royal Mail Tracked (Also shown in Fig 2.1

  • Enter your Linnworks account password if requested Fig 2.2

  • Click on the link to the online request form Fig 2.3

  • Enter the required information into the form and click Submit Fig 2.4

The online request form sends the information you have provided to Royal Mail, They will setup your account so it will integrate Linnworks. Royal Mail will process the request, setup your account and provide the additional authentication details required for the integration to work.

Royal Mail will add the additional details to your Linnworks Account:
(PPI Licence, Access Code, Posting Location, Web Services Username and Password).



Fig 2.1  Shipping Management

Fig 2.2  Linnworks Account Password Request

Fig 2.3  Online Request Form Link

Fig 2.4  Online Request Form
STOP - You must now wait for the email stating that your OBA account has been setup, if you continue to try and setup the services and other details you will encounter errors and will have to contact the Linnworks Support Team.
Once you have received the email from Royal Mail you will need to add the services available on your OBA account. Continue with section 3 of the Royal Mail documentation.

3. Setup and Configure OBA Integration and Add OBA Services

Make sure you have gone through step 2 to setup the initial settings for OBA before you continue, If you have received the details you will now need to enter your despatch address, printer settings and add the services.

  • Open Linnworks

  • Click on Settings > Shipping Management Fig 3.1

  • Click on the configuration button next to Royal Mail OBA Fig 3.1

  • Enter your Linnworks account password if requested Fig 3.2

  • Enter your despatch address information, you must enter Business Name, contact name, address information, email and contact telephone number. Contact telephone number must be 12 characters long.Fig 3.3

  • Chose the printer used for printing labels and select the paper size (For most thermal printers it will be [user defined] option). Chose the label type. Standard Royal Mail label stock is defined as standard 101mm by 87mm label. For integrated invoice labels, select the appropriate type of paper. Fig 3.3

  • If your label stock already has delivered by Royal Mail pre-printed on the label, turn off Print Delivered by Logo. (Shown in Fig 3.3 under despatch details).

You now need to add the Royal Mail services available to your account and add them to the Linnworks system.


  • Click Services button. Fig 3.3

Linnworks will validate your account and obtain all the services available to your account.

  • Tick all the services you want to use and click Add Selected. (Also shown in Fig 3.3)

  • The selected services will be added to the list of assigned services.

  • If a service requires tracking number generation, you will see Red Exclamation mark against the service range column. (Barcodes for OBA services are automatically assigned).

  • Click Save and the integration window will close, reopen it.

  • Print the test label for each service by clicking Print Test label on each of the services.

  • If you are using any services that require tracking number, it is most likely you will need to realign barcode position and tracking number text. You can do this by changing barcode position values and Track no. position values. All values are in inches. The barcode and the tracking number text must be positioned within the peel off sections of the label. Fig 3.4

Once you have configured all the necessary services and if needed barcode position, click Save button to save the configuration. Linnworks will validate all the selected services and all the configuration settings to ensure everything is in order.




Fig 3.1  Shipping Management

Fig 3.2  Linnworks Account Password Request

Fig 3.3  Online Request Form

Fig 3.4  Online Request Form
Linnworks will automatically allocate the tracking ranges to OBA services instantly when you save the integration. These ranges are refreshed as you print more labels.

4. Setup and Configure Tracked Integration and Add Tracked Services

Make sure you have gone through step 2 to setup the initial settings for OBA before you continue, If you have received the details you will now need to enter your despatch address, printer settings and add the services.

  • Open Linnworks

  • Click on Settings > Shipping Management Fig 4.1

  • Click on the configuration button next to Royal Mail Tracked Fig 4.1

  • Enter your Linnworks account password if requested Fig 4.2

  • Enter your despatch address information, you must enter Business Name, contact name, address information, email and contact telephone number. Contact telephone number must be 12 characters long.Fig 4.3

  • Chose the printer used for printing labels and select the paper size (For most thermal printers it will be [user defined] option). Chose the label type. Standard Royal Mail label stock is defined as standard 101mm by 87mm label. For integrated invoice labels, select the appropriate type of paper.Fig 4.3

  • If your label stock already has delivered by Royal Mail pre-printed on the label, turn off Print Delivered by Logo. Fig 4.3

You now need to add the Royal Mail services available to your account and add them to the Linnworks system.


  • Click Services button. Fig 4.3

Linnworks will validate your account and obtain all the services available to your account.

  • Tick all the services you want to use and click Add Selected. (Also shown in Fig 4.3)

  • The selected services will be added to the list of assigned services.

  • All tracked services requires tracking number generation, you will see Red Exclamation mark against the service range column.

  • Important: The tracked services require a barcode range.

    A request will automatically be sent directly to Royal Mail for each service that you have added. Royal Mail will process this like the initial integration request but for the barcodes and you will receive an email once it has been completed.
  • Click Save and the integration window will close, reopen it.

  • You will not be able to print a text label until the barcodes have been assigned by Royal Mail.

  • If you are using any services that require tracking number, it is most likely you will need to realign barcode position and tracking number text. You can do this by changing barcode position values and Track no. position values. All values are in inches.Fig 4.4

  • The barcode and the tracking number text must be positioned within the peel off sections of the label as shown in Fig 4.4

Once you have configured all the necessary services and if needed barcode position, click Save button to save the configuration. Linnworks will validate all the selected services and all the configuration settings to ensure everything is in order.




Fig 4.1  Shipping Management

Fig 4.2  Linnworks Account Password Request

Fig 4.3  Online Request Form

Fig 4.4  Online Request Form
You will not be able to print Tracked labels until the barcodes have been added onto your account by Royal Mail.
Please be aware that the barcode request process time will depend on when Royal Mail process your request, if you have any issues or do not receive the confirmation email within a week please contact Royal Mail directly or contact the Linnworks support team by creating a support ticket.

5. Printing Labels

    When shipping to Germany, Linnworks will take by default the Postcode and the Town, if the Town is blank Linnworks will use the Region field. See Royal Mail Addressing Your Items
  • Once you have configured the integration you can start printing labels from Open Orders.

  • Go to Orders > Open Orders.

  • Assign an order to Royal Mail service, by right clicking on the order > Bulk Change > Change Shipping Method > ROYAL MAIL > and select the service you want to send this order with.

  • To print the label right click on the order > Print > Print shipping label.

  • The label will be generated and sent to the printer specified in the configuration.

  • If the service selected for the order requires a tracking number, it will be recorded on the order and once processed will be propagated to the channel where the order came from. It can also be emailed to the customer in the email despatch notifications if you have set this up.

  • Linnworks validates the service against the consignment. The checks include destination is valid for the service and the weight of the order is valid for the service. If there was an error printing the label you will see it in flags section of the order grid. You can get an error message by moving the mouse over it.

You can automate the assignment of orders to services by scripting, or in the channel configuration by assigning channel shipping method to Royal Mail service. For example eBay orders with standard shipping can automatically be allocated to Royal Mail 1st Class Mail. For more advanced allocation you need to use scripting. For example if you want to allocate an order that is over a certain value to Tracked service, a script can evaluate the value of the order, its content and destination and allocate an appropriate service.

All order items must have weights. Linnworks calculates the consignment weight at the point of printing the label and records this on the consignment information. You can specify default weight for the service in Royal Mail OBA configuration settings by clicking Settings spanner. In this case all consignments for orders that have a weight of 0 (zero) generated using this service will be generated with the default weight. All consignments with 0 weight and no default will generate an error.

If label has been printed with item weight and the item weight changed prior to manifest being filed, the first weight will be applied. The consignment weight is recorded at the point of printing the label. If weight has changed (re-entered), cancel the label and reprint it.

If labels coming out upside down, this can be reconfigured in your printer settings, by going to Control Panel > Printers > right click on the thermal printer > Printing Preferences > Paper settings and select 180 degree rotation.

Some thermal printers add dithering by default. If the barcode comes out with dithering you will need to turn it off by going to Control Panel > Printers > right click on the thermal printer > Printing Preferences > Dithering > turn off dithering.

6. Printing Pick List Labels

  • Open Linnworks

  • Click on Settings

  • Click on Shipping Management

  • Click on Royal Mail OBA

  • The label will be generated and sent to the printer specified in the configuration.

  • Click on the drop down box Label Type and Choose Pick List - 139mm x 99.1mm

  • Click on Save

  • If you have bin rack location on your inventory items it will sort it in bin rack order. You can now print labels with the pick list next to the label you need a label that is 139mm x 99.1mm. This also works with integrated invoices.

7. Cancelling Labels

To cancel the label you need to do the following:

  • Go to Settings > Shipping Management > Royal Mail OBA

  • Click Manifest

  • This screen will display all the consignments that have not yet been manifests (todays prints).

  • Find the consignment you want to cancel and click Cancel button

Note 1: If the consignment has been manifested it cannot be cancelled.

Please be aware that the barcode request process time will depend on when Royal Mail process your request, if you have any issues or do not receive the confirmation email within a week please contact Royal Mail directly or contact the Linnworks support team by creating a support ticket.

8. Royal Mail Manifest and Sales Orders

Before the collection of your consignments or a drop off, you must produce Collection Manifest and Sales Order Summary. All of this has to be done from Linnworks before the collection:

  • Go to Settings > Shipping Management > Select Royal Mail OBA or Royal Mail Tracked > Click on Manifest button.

  • Print Manifest. This will produce Collection Manifest. The collection manifest lists only consignments that have tracking numbers.

  • All consignment without barcode will not be included in the collection manifest but will be sent to Royal Mail when you file the manifest.

  • Once collection manifest printed, click File Manifest. At this point Linnworks will connect to Royal Mail OBA and submit all the consignments to generate a sales order. This process may take couple of minutes.

  • Once Manifest is filed, you will be prompted to print Sales Order Summary, which must be handed over to the Royal Mail collection officer.

In some circumstances the Manifest may fail to file. If it fails you must login to your OBA Account, find the OPEN sales order and fix any errors. If the problem persists please inform Linnworks technical support who will be able to implement further validation for a specific service. Once the sales order has been fixed on OBA website, print the sales order summary from OBA website and acknowledge it in Linnworks.
Collection manifest and Sales Order Summary must be handed over to the collection officer and it is highly recommended to print and file the manifest at least 20 minutes before the collection. Manifest and Sales Order Summary can be reprinted at any time, by going to: Shipping Management > Royal Mail OBA > Manifest > Filed Manifests. or Shipping Management > Royal Mail Tracked > Manifest > Filed Manifests.

9. Integrated Invoice Labels

Linnworks can embed Royal Mail shipping labels onto the invoice and despatch paperwork. The shipping label will be generated and placed onto the invoice at the time of printing. The invoice/despatch note can be used as a packing slip, this method reduces errors and streamlines the process.

To embed shipping labels onto the invoice you will add shipping label element to the invoice template being used for printing.

  • Go to Settings > Template Designer

  • Make a copy of the Default invoice

  • Click Edit, rename the template to RM Template

  • Drag and drop Shipping Label element onto the invoice

  • Double click the Shipping Label element and untick Landscape

  • Position the top of the label in the area where the label peel off section is.

  • Save the template

  • Go to Open Orders

  • Allocate a test order to Royal Mail service, ensure weight is defined for the order

  • Select the order, Right click > Print > Specific Invoice > RM Template

  • If the order becomes red on the open orders, it means there is an error generating the label for it. You can see the exact error by moving the mouse onto the Flags section. The generic error for printing invoice will always state that the There was an error printing the label or module doesn’t support it.

You can also configure the invoice template to be used only when the shipping service is Royal Mail. This will allow you to print mixed invoices in one action, (with Royal Mail shipping label and others). To specify under which conditions the invoice is printed, do the following

  • Go to Settings > Template Designer

  • Edit RM Template invoice

  • Printing Condition and enter

The invoice printing conditions needs to be as follows: ShippingVendor='Royal Mail'
  • Save template. This will make your invoice template conditional (i.e. Linnworks will choose it when you print invoice if the Shipping Vendor for the order is Royal Mail)

  • Go to Open Orders

  • Allocate a test order to Royal Mail service, ensure weight is defined for the order

  • Select the order, Right click > Print > Print Invoice
 linnworks_stationery.jpg

Buy Integrated Labels

 

Enter discount code ‘LINNWORKS’ on the site for a 10% discount

page_header_2014.png
Buy Integrated Labels

 

Enter discount code ‘LINNWORKS’ on the site for a 10% discount