Shipper Integration | Royal Mail V4

Shipper Integration | Royal Mail V4

Royal Mail V4 Integration Help

Kornit X has created a shipper integration to allow fulfillers to generate Royal Mail shipping labels using Royal Mail V4. Once all items in an order have been scanned at the dispatch scan point, a final scan of any item in the order will create a shipment in Royal Mail and return a Royal Mail shipping label.

This integration is provided by a subsidiary of Royal Mail named Intersoft.  Create an Online Business Account (OBA) with Royal Mail and provide The KornitX team with the OBA Email, Account ID, a "ship from" address including telephone number, and Posting Location Number. 

We will set up an account with Intersoft for you. This will trigger an electronic approval request with Royal Mail, who (subject to the information provided being valid and correct) will approve the account within 2-5 working days.  We will then provide you with a shipping account ID and a shipping location ID, to be used in the shipping integration settings.
To sign in or register for an OBA account please follow this link - Click Here

Features of this integration 
You can also set multiple options that you can enable once you have connected with Royal Mail and these are the following include the following. Please note that not all of the below features need to be enabled or filled in, these options are available to give users the best service. The features are listed in the way they are within the Platform. 
  1. "Enabled" toggle - When the shipper integration has been turned on this toggle will be set to on. To disable the integration simply slide this to off. 
  2. "Secondary Orders" toggle- This option should be enabled if your orders have both a primary and secondary company set on them.  In most cases, this option will need to be enabled unless you are advised otherwise by Kornit X staff. 
  3. "Start Timestamp" textbox - The start date/time of the integration.  Only orders created after this date/time will have a shipment created against them when the Ahead of Time option is enabled.
  4. "Dropship Delegation" toggle- Dropship delegates allow an integration to be set up once on a single dropship company and the integration settings apply to all dropships that are linked to that fulfiller.  A dropship delegate can be set on any fulfiller company.  If this is a feature you want to use, enable this option on the RM integration settings of the dropship delegate that's set on the fulfiller company.
  5. "Ahead of time" enabled toggle - With this toggle enabled, the system will attempt to create a shipment against the order, making the call to the carrier, shortly after order creation. Once enabled there will be an option to add a start time stamp (UTC) which will mean that the integration will only try to ship orders that were created after this time.
  6. "Wait Until Required Dispatch Date" toggle - Set by default only, when ahead of time is enabled orders that have required dispatch date will not have a shipment created until dispatch date reached
  7. "Shipment Strategy" dropdown - A shipment strategy can also be selected from the Shipment Strategy drop down. If nothing is selected, the default Combined Strategy is used. Please note if not using standard there are 4 different options including "Manual Override". "Individual Parcels", "Combined Parcels" and "Bundled Parcels". 
  8. "Dimensions Strategy" textbox - The dimensions strategy field can be left blank to use the default dimensions, here are the examples. Client\RoyalMailV4\RoyalMailV4NoDimensionsStrategy - Package dimensions information is not sent in the shipment request, Client\RoyalMailV4\RoyalMailV4MaxWidthDepthDimensionsStrategy - The package dimensions are calculated using the largest item width, the largest item depth and the total height of each item in the order. Client\RoyalMailV4\RoyalMailV4SortedStackingDimensionsStrategy - Each order item is rotated to find the shortest edge.  The sum of each items shortest edge is sent as the package height.  The width and depth package dimensions are calculated using the largest item width and the largest item depth.
  9. "SKU Character Limit" textbox - With this textbox here you can set a number to limit the length of each SKU. This is useful if for the shipping labels you need to limit the length to 10 characters. Not setting this will just use the full SKU of say 20 characters that some products may use. 
  10. "Client ID" and "Client Secret" textboxes - The Client ID and Secret fields should be left blank unless you are advised otherwise by a member of the Kornit X team.
  11. "Shipping Account ID" and "Shipping Location ID" textboxes - We will provide these fields for you as Intersoft will generate these for Royal Mail to be provided to you. 
  12. "Shipping Service Strategy" Dropdown/Textbox - This is not required and is only used when the Standard options below do not fulfil the client needs, where this is the case a custom strategy can be made at an additional development cost. Users with one will not see dropdown only the path 
  13. "Pre Registration Type" dropdown - This dropdown offers the options for Import One Stop Shop (IOSS) and Economic Operators Registration and Identification number (EORI) which need to be selected depending on whether or not the customer isn't paying for tax on their orders. If this is not set the end user would have to pay for the tax. 
  14. "Pre Registration Number" textbox - The IOSS or EORI number associated with the selection made in the Pre Registration Type drop down.
      
Label Settings 
There are settings that need to be enabled for labels and these have been documented below.
  1. "Include Contact Telephone" toggle - With this toggle enabled the contact telephone number will include being printed on the shipping label, meaning for every customer who leaves a telephone number when ordering will receive this on their package. 
  2. "Include Contact Email" toggle - Same as the telephone, with this enabled the email that the customer used when placing their order will be included on the shipping label of all orders. 
  3. "Enable Forced Tracking" toggle - Enabled by default this will ensure that for any untracked orders you will return a number that can be used to track within the status callback. 
  4. "Company Name" textbox - Filling in this textbox will include your company name on the shipping labels. 
  5. "Contact Name" textbox - This textbox can include a contact name from your company that will be included on all shipping labels, this could for example be a generic customer service contact.
  6. "Address" textboxes - Finally, the shipping label can include the return address of your company including Address Line 1-3, Town, County, Country Code and Postcode. Please note including this will ensure every shipping label generated will include the return address.  
These are all set within the integration setup window but these are required to ensure all printed labels include the correct data you require. 
We recommend reading the following article which goes into more detail on how to use the Royal Mail V4 integration - Click here

Still Need Help?
You can access our extensive knowledge base or raise a ticket with our technical support teams using the buttons below

View all help articles

Raise a support ticket

    • Related Articles

    • Shipper Integration | Royal Mail Shipping API v2

      Royal Mail Shipping API v2 Integration Help We advise confirming whether or not the shipping API V2 or V3 needs to be used here before enabling either of these shipper integrations.  For customers who do not already have a Royal Mail Shipping API v2 ...

    • Shipper Integration: Royal Mail Rest V3

      Royal Mail Rest V3 Integration Help Our Platform integrates seamlessly with your Royal Mail to allow the booking in of shipments, the printing of labels and the passing of tracking references. You must select the client in the Shipping Service ...

    • Shipper Integration: Mail International

      Mail International Integration Help If you do not already have a Mail International account you can contact them here - https://www.mailint.com/client-area/ Our Platform integrates seamlessly with Mail International to allow the booking in of ...

    • Shipper Integration | WIzmo

      Wizmo Integration Help If you do not already have a Wizmo account you can contact them here - Wizmo Account Setup Our Platform integrates seamlessly with your Shipper account to allow the booking in of shipments, the printing of labels and the ...

    • Shipper Integration | Express Bird

      Express Bird Integration Help If you do not already have an Express Bird account you can contact them here - Express Bird Account Setup Our Platform integrates seamlessly with your Shipper account to allow the booking in of shipments, the printing of ...