How to configure Royal Mail Intersoft (ROYALMAILINTERSOFT) in techSHIP [Guide]

This connection uses Intelligent Shipper API v1.7.

The Royal Mail Intersoft integration supports:

• Shipment labels and shipment cancellation.

• Shipment confirmation and manifest documents, when returned by the carrier.

• Signature and Saturday-delivery requests.

• International customs data and item-level product identifiers.

Information to be Provided

Specifications and Constraints

Operational Details

The connection requires API v1.7. International shipments require item data, including SKU, country of origin, harmonized code, and a nonzero unit price, together with the required sender customs information.

Package type is a Client Account setting. Select a format compatible with the service. Domestic and international services may require different formats; configure separate Client Accounts when their required formats differ.

Shipment confirmation processes shipments created on the current day in the location's time zone. Already-confirmed shipments can cause confirmation to fail.

Product Identifiers

Identifiers remain associated with their own items, and leading zeros are preserved. Over-limit values are rejected rather than truncated. Missing manufacturer identifiers are not replaced with SKU.

Configuring a Baseline Account

A Baseline Account serves as the fundamental connection point between techSHIP and the carrier's system. It acts as a template that holds the credentials and fundamental properties required to process shipments.

The techSHIP AI Assistant is available from the Carrier page for supported Carrier configuration tasks. For detailed conceptual information and advanced configuration, refer to 📄 techSHIP AI Assistant: Overview & Availability [Information].

Adding a Carrier

Before adding an account, you must ensure the Carrier entity is available for your location.

1. Click My Carriers from the left menu under the Carriers category.

2. Click Add Carrier.

   

3. Select the desired Carrier.

You may encounter additional messages depending on the carrier status or your plan:

• Subscription Required (⭐): If the carrier has a star icon, you will see a message stating "To use this carrier, a subscription upgrade is required." Press Contact to Upgrade to proceed.

  

• Carrier Suspended: If the carrier has not been used for an extended period, you will see a message stating “This carrier is currently on hold...” Click Request Assistance to reactivate it.

  

• Setup Fee Waived: If a carrier from the same carrier group is already installed in your location, you can add this carrier without incurring additional fees.

  

4. If needed, update the carrier Name.

5. Click Add Carrier.

   

If the purchase confirmation appears, complete the following steps:

• Review the purchase notice and any applicable charge information.

• Optionally enter a PO Number.

• Select I am authorized to complete this purchase on behalf of my organization.

• Click Purchase to confirm the Carrier addition.

Once the Carrier is added, you will be automatically redirected to the Carrier page to continue setting it up.

6. Enter the Code of the Carrier as it appears in your host system.

The Code of the Carrier must match exactly the value defined in the host system. Any discrepancy (including casing or extra spaces) may prevent the carrier from working correctly.

7. Click Save.

   

If your facility utilizes the centralized Pickup Schedule, we highly recommend adding this new carrier to your calendar now. While not required to process labels, this ensures accurate induction metrics for your Insights dashboards. To learn more, see 📄 Understanding the Centralized Pickup Schedule & Expected Induction Logic [Information].

Adding a Baseline Account

From the Carrier page, click Add Account to create a new Baseline Account.

You will be redirected to the Baseline Account page to complete the setup.

Entering incorrect values will prevent the system from generating shipping labels.

General Tab

In the General tab, define the administrative properties:

• Name: Enter a descriptive name for the account.

Enter a descriptive name based on unique properties. E.g.:

• Carrier Name - Account Number (CarrierX - 123456789)

• Carrier Name - Consolidator Name (CarrierY - MyConsolidator)

• Carrier Name

• Usage: Select the most suitable option:

  • Test: Used for sandbox or onboarding purposes.

  • Production: Used for live shipping.

Keep the Status field set to its default Active value. An account must be Active to remain fully editable. For detailed conceptual information on account statuses, refer to 📄 How to Inactivate and Activate a Carrier Baseline Account [Step-by-Step Guide].

Carrier Tab

Enter Username, Password, and Application ID on the Baseline Account. Complete the sender address, Phone, and Email.

Leave Service URL empty to use the default test or production v1.7 endpoint. If an override is required, use the authorized HTTPS v1.7 shipments endpoint.

Labels Tab

Single-package shipments support PDF, PNG, and ZPL at 203 dpi. Multiple-package shipments require PDF; the combined document is associated with the first package.

Finalizing the Setup

Once you have entered the required information, click Save.

After you save the Baseline Account, check whether the Registration tab or a registration status badge is available.

If neither is available, the Carrier does not use this Registration workflow in techSHIP. If registration is still pending, open the Registration tab and press Registration, then complete 📄 How to Register a Carrier Baseline Account [Step-by-Step Guide] before creating shipments.

From the Carrier page, you can now see the Baseline Account listed with the administrative status Active. The Active status is separate from the account's registration status.

The Baseline Account configuration is now saved. You can continue with Configuring a Client Account below to assign the Baseline Account to a specific Client.

Configuring a Client Account

Adding an Account

Before adding a Client Account, ensure that the Client has been created. For instructions creating a Client, see: 📄 10 - How to create a Client profile [Step-by-Step guide].

1. Click Clients from the left menu under the Clients section.

2. Click the Edit icon for the desired Client.

   

3. Click Add Accounts.

   

4. Optionally, use the Search box to search by Baseline Account Name or Carrier.

5. Select the Baseline Accounts that will serve as the foundation for your new Client Accounts.

6. Click Add Accounts.

   

   A toast notification will confirm the accounts were successfully assigned. Click the Refresh icon if recently added accounts are not displayed.

   

7. Click Edit on each newly created account.

   

8. Configure the available options in each tab (except Carrier).

   

For complete instructions on configuring this settings, see 📄 How to configure the Billing Account General Options tab [Step-by-Step guide].

Carrier Tab

Configure:

• Service code and Package type: Select the carrier-approved combination.

• Override WMS Service Code: Enable to replace the service received from the Integrated system.

• Posting location: Enter the authorized posting location.

• Default commodity description, Reason for export, Currency, and Product: Set the normal shipment defaults. Use the appropriate document or non-document product.

• Default shipper type and Default receiver type: Set the actual parties for international classification.

• Incoterms, Sender VAT number, Sender EORI number, and Sender IOSS number: Complete as applicable.

• Contact phone and Contact email: Supply valid contact details.

• Substitute missing ship-to phone and Ship-to phone substitution: Configure only when an approved substitute is appropriate.

• Calculate declared value from lines: Enable when the declared value should be derived from item values if no value is already supplied.

Order party types take precedence over client defaults. When both are unset, the carrier's B2C default is preserved. When only one is set, the missing sender defaults to business or the missing receiver to direct consumer. Supported classifications are B2B, B2C, and C2C.

Specifying Rate Shopping Service Codes

Rate Shopping is not supported. Select a specific Service code.

Label References

Configure Reference 1 in the Client Account's General tab, under Labels. It supplies the shipment's shipper reference.

For guidance, see Using order References in your labels [Step-by-Step guide].

Finalizing the Setup

Once you have entered the required information, click Save.

With the account configured and requirements verified, you can now proceed to process orders as described below.

Configuring an Order

The steps described in this section are not required for carrier setup, and they are offered as an optional review if further order-level configuration is required.

Follow the UI Navigation steps in 📄 05 - How to edit an order’s information - [Step-by-Step guide], using the carrier-specific values provided in this guide.

In the order's carrier-specific settings, review Service code, Ship date, Commodity description, Currency, and Declared value.

Use Shipper type, Receiver type, the shipper and consignee tax-identifier fields, and Commercial invoice shipping charge as applicable. Order-level shipper identifiers override their corresponding client defaults.

Set Signature required, Saturday guaranteed, and Safe place only for applicable services.

Click Save to apply the order changes, then continue with the standard shipping workflow.

Troubleshooting

• Unsupported API endpoint: Clear an obsolete Service URL or replace it with the authorized v1.7 endpoint.

• Invalid service format: Check Package type against Service code. Do not use one format for services requiring different formats.

• Product identifier rejected: Correct the named item and preserve its actual identifier within the applicable length limit.

• Missing international data: Check item SKU, origin, price, harmonized code, Sender EORI number, contact details, and Posting location.

• Multiple-package label failure: Select PDF.

• Timeout or server error during creation: Check whether the carrier created the shipment before retrying.

• Manifest confirmation fails: Check the shipment date and whether any shipment has already been confirmed.