Sign in

Ship Help Center

Sending UKIMS information to carriers

Avatar
Malene Tidemann
Updated

Following the implementation of the Windsor Framework (see Windsor framework - information for UK based shippers) a UKIMS (UK Internal Market Scheme) number must be provided for B2B shipments from Great Britain to Northern Ireland. nShift has enabled a field for the UKIMS number in Ship on all address types. 

Note: Even though you populate the UKIMS number field in Ship, the carrier may ignore it until their system is prepared to receive it. 

 

Go to your solution:

 

Ship Cloud and API

Enable the field on new bookings:

 

  1. Go to Ship > New.
     
  2. Click the field selector button.

    field-selector.png
     
  3. Check the box next to UKIMS number under the relevant address type and click Save.

    ukims.png
     
  4. The field can now be filled in when making a new shipment.  


Example showing the UKIMS field in an API request:

 "Addresses": [
   {
      "Kind": 1,
      "Name1": "Jane Doe",
      "Street1": "Test road 10",
      "PostCode": "8000",
      "City": "Aarhus C",
      "Mobile": "12345678",
      "ContactCSID": 10816512,
      "CountryCode": "DK",
      "UKIMSNumber": "UKIMStest"
   }
]

 

 

To add the field to a static address:

  1. Go to Ship > Configuration > Actors and Carriers.
     
  2. Click on the Actor and navigate to the address section, e.g., Sender address, or add an address by clicking New Configuration. 
     
  3. Click on the address and click Show more to display all address fields. 

    address-show-more.png
     
  4. Scroll down and fill in the UKIMS number field and click save.

    ukims-number.png

 

 

 

Ship On-premises

Follow these steps to enable the field in the Production view:

  1. Update your Ship On-premises installation to the newest version.
     
  2. In Main > Production, right-click the address you want to enable the field for and choose Field Selector...

    address-field-selector.png

     
  3. Select UKIMS Number and click OK.

    ukims-field.png
     
  4. Choose where to apply the changes and click OK.
     
  5. The field will now be added to the address and can be filled in.

 

The UKIMS field is also available on the different address setup items under Setup. Fill in the information here if the UKIMS number should be included as default on static address information. Example showing the field on Sender address:

ukims-field-COP.png

 

 

Supported carriers

(information updated on April 24, 2025)

Below is a list of the carriers who have reacted to our enquiries regarding updating their integration to support the Windsor framework:

  • DPD UK (331)
  • DHL Parcel UK (388)
  • Parcelforce UK (376)
  • Amazon INTL (915)
  • Whistl UK (485)
  • DX API GB (937)
  • FedEx INTL (139) (not completed)

Related articles