Intelligent Shipper

Shipping Integration API – Multipiece Shipment Bookings Appendices
API Version: 1.6
Document Version: 1.6.28

Document Owner	INTERSOFT Systems and Programming Limited

Document Owner	INTERSOFT Systems and Programming Limited
Version	1.6.28
Date	15/07/2022
Description	Appendices supporting the Intelligent Shipper Shipment Booking API specification
Author	Laura Price

Commercial and in Confidence
The information contained in this document is confidential. No part of this document may be reproduced, disclosed to any third party, or issued in any form or by any means without the express written permission of Intersoft Systems & Programming Ltd.

Contents

2. Appendix 1 – Royal Mail Shipments
2.1. Service Options
2.2. Service Format
2.3. Enhancement Codes
3. Appendix 2 – Error Codes List
3.1. createShipment Error Codes
3.2. cancelShipment Error Codes
3.3. confirmShipment Error Codes
3.4. printDocument Error Codes
3.5. printQRCode Error Codes
3.6. manifestHistory Error Codes
3.7. printManifest Error Codes
5. Appendix 3 – Customs Documentation Examples
5.1. CN23
5.2. Proforma Invoice
5.3. Commercial Invoice
6. Appendix 4 – Frequently Asked Questions (FAQ)s
7. Appendix 5 - ISO Code Links
8. Appendix 6 - Parcelforce Safe Places List
9. Appendix 7 - Carrier Package Types
9.1. FedEx Package Type Names
9.2. UPS Package Type Names
10. Appendix 8 – Hazmat Shipments
10.1. Hazardous Materials Classification
10.2. Example Hazmat Label
10.3. Example ID8000 Label
11. Document Controls

Appendix 1 – Royal Mail Shipments

The sections below provide further details on how to populate the createShipmentRequest for Royal Mail shipments.

Service Options

The following fields in the createShipmentRequest must be populated for Royal Mail shipments:

Posting Location – this should be populated with the posting location linked to your Royal Mail account.
Service Level – this should be populated with the service level linked to the Royal Mail contract you want to use.
Safe Place - available on Royal Mail Tracked, Tracked High Volume and 24/48 non-signature services. Cannot be used in conjunction with services which require a signature.

Service Format

The table below lists the Royal Mail service formats. The formats available will depend on the service being used.

Service Format code	Description

Service Format code	Description
L	Inland Letter
F	Inland Large Letter
P	Inland Parcel
P	International Letter
G	International Flat
E	International Parcel
N	Inland Format Not Applicable
N	International Format Not Applicable
H	International Printed Papers

Enhancement Codes

The table below lists the service enhancements available for use with Royal Mail shipments and enhancement code that must be provided in the createShipmentRequest to use each enhancement.
NOTE: Royal Mail allow a maximum of 4 enhancement codes to be used per shipment.
NOTE 2: A maximum of one enhancement from each Enhancement Group can be used per shipment.

Code	Description	Enhancement Group	Comments

Code	Description	Enhancement Group	Comments
6	Recorded	Recorded Signed for Mail	A maximum of 4 enhancements are allowed by RMG. With the exception of Tracking Notifications, there cannot be more than 1 enhancement from each Enhancement Group. 13 &14 are only available on RMG Tracked services. To use both email and SMS Notifications for a shipment, provide enhancement codes 13 and 14. Royal Mail can provide information on which notifications are available as both SMS and email.
13	SMS Notification	Tracking Notifications
14	E-Mail Notification	Tracking Notifications
22	Local Collect	Local Collect
24	Saturday Guaranteed	Saturday Guaranteed

Appendix 2 – Error Codes List

The sections below list the error codes that could potentially be returned in an unsuccessful response for each service.

createShipment Error Codes

Field	Blank?	Invalid?	Error Code	Error Description

Field	Blank?	Invalid?	Error Code	Error Description
transactionId	Y	N	E3333	Error deserializing XML message. Check your XML complies with the API documentation
transactionId	N	Y	E3333	Error deserializing XML message. Check your XML complies with the API documentation
applicationId	Y	N	E3333	Error deserializing XML message. Check your XML complies with the API documentation
applicationId	N	Y	E3333	Error deserializing XML message. Check your XML complies with the API documentation
userId	Y	N	E3333	Error deserializing XML message. Check your XML complies with the API documentation
userId	N	Y	E3333	Error deserializing XML message. Check your XML complies with the API documentation
password	Y	N	E3333	Error deserializing XML message. Check your XML complies with the API documentation
password	N	Y	E3333	Error deserializing XML message. Check your XML complies with the API documentation
shipperCompanyName	Y	N	E1111	The field shipperCompanyName is required
shipperCompanyName	N	Y	E1205	The field shipperCompanyName exceeds the maximum allowable length of 35
shipperAddressLine1	Y	N	E1111	The field shipperAddressLine1 is required
shipperAddressLine1	N	Y	E1205	The field shipperAddressLine1 exceeds the maximum allowable length of 35
shipperAddressLine2	N	Y	E1205	The field shipperAddressLine2 exceeds the maximum allowable length of 35
shipperAddressLine3	N	Y	E1205	The field shipperAddressLine3 exceeds the maximum allowable length of 35
shipperCity	Y	N	E1111	The field shipperCity is required
shipperCity	N	Y	E1205	The field shipperCity exceeds the maximum allowable length of 20
shipperCounty	N	Y	E1205	The field shipperCounty exceeds the maximum allowable length of 35
shipperCountryCode	Y	N	E1111	The field shipperCountryCode is required
shipperCountryCode	N	Y(Char)	E1205	he field shipperCountryCode exceeds the maximum allowable length of 2
shipperCountryCode	N	Y(Num)	E1437	The Shipper country code is invalid.
shipperPostCode	Y	N	E1111	The field shipperPostcode is required
shipperPostCode	N	Y	E1205	The field shipperPostcode exceeds the maximum allowable length of 10
shipperPostCode	N	Y(Num/Char)	E1437	The Postcode is not a valid UK Postcode
shipperContactName	N	Y	E1205	The field shipperContactName exceeds the maximum allowable length of 40
shipperPhoneNumber	N	Y	E1205	The field shipperPhoneNumber exceeds the maximum allowable length of 20
shipperPhoneNumber	N	Y(Char)	E1437	The contact phone number is invalid
shipperVatNumber	N	Y	E1205	The field shipperVatNumber exceeds the maximum allowable length of 15
shipperEmailAddress	N	Y	E1437	The contact email address is not a valid email address
shipperReference	Y	N	E1111	The field shipperReference is required
shipperReference	N	Y	E1205	The field shipperReference exceeds the maximum allowable length of 20
shipperReference2	N	Y	E1205	The field shipperReference2 exceeds the maximum allowable length of 20
shipperDeptCode	N	Y	E1205	The field shipperDeptCode exceeds the maximum allowable length of 17
destinationCompany Name	N	Y	E1205	The field destinationCompanyName exceeds the maximum allowable length of 35
destinationAddressLine1	Y	N	E1111	The field destinationAddressLine1 is required
destinationAddressLine1	N	Y	E1205	The field destinationAddressLine1 exceeds the maximum allowable length of 35