Site Logo

🎉 ShipEngine is becoming ShipStation API 🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our New ShipStation API page.

DHL Express UK

DHL Express UK allows you to ship packages from Great Britain and the US to destinations all over the world.

This guide provides developers with the details needed to build DHL Express UK shipping capabilities into your ShipStation API workflows.

ShipStation API also has integrations for DHL Express, DHL Express Australia, and DHL Express Canada. Visit their carrier guides for details!

Requirements

PropertyTypeRequired?Description
nicknamestringrequiredThis is a nickname for you to identify the carrier account in ShipStation API.
account_numberstringrequiredYour DHL Express account number
site_idstringrequiredYour DHL Express account Site ID
passwordstringrequiredYour DHL Express account password
param3booleanOptionalUse DDP alternative

Before connecting, you must first register for your site_id and password on the DHL Express - MyDHL API portal.

Shipping Requirements

  • Both weight and dimensions are required to successfully create a label.
  • Company name is required for both Ship From and Ship To addresses. If not provided, the name property value will be reused in the Company field.

Connect Account

You can connect a DHL Express account using the POST method to the /v1/connections/carriers/ endpoint, or via the ShipStation API Dashboard.

For instructions on connecting DHL Express via the ShipStation API dashboard, go to our DHL Express help article.

Connect via Endpoint

carrier_name: dhl_express_uk

POST /v1/connections/carriers/:carrier_name

Sample request:

1
2
3
4
5
6
7
8
9
10
11
POST /v1/connections/carriers/dhl_express_uk HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
"nickname": "My DHL Express UK Account"
"account_number": "123456789",
"site_id": "your_site_id_here.",
"password": "your_password_here"
}

A successful connection will return a response with the carrier_id, which you'll use for any requests for this account going forward.

Rates

DHL Express supports rate shopping with ShipStation API.

Service Details

Available DHL Express UK services are provided below. Please note that carriers may update their available services at any time. To ensure you are always using valid services, you can use the list carrier services endpoint at any time.

Domestic Services

ServiceAPI CodeOrigin Countries
Domestic Expressdhl_uk_domestic_expressGB
Domestic Express 9:00dhl_uk_domestic_express_900GB
Domestic Express 12:00dhl_uk_domestic_express_1200GB

International Services

All services except document services have a max weight of 150 lb (70 kg) and max length of 118" (300 cm) for individual international shipments. The total maximum weight for a multi-piece shipment is 2,200 lb (1,000 kg). Document services have a max weight of 10 oz. Packages over those maximum values will not be accepted by DHL Express.

ServiceAPI CodeOrigin Countries
Economy Selectdhl_uk_economy_selectGB
Economy Select EUdhl_uk_economy_select_euGB
Express 9:00dhl_uk_express_worldwide_900GB
Express 9:00 Documentsdhl_uk_express_worldwide_900_documentsGB
Express 10:30dhl_uk_express_worldwide_1030GB
Express 10:30 Documentsdhl_uk_express_worldwide_1030_documentsGB
Express 12:00dhl_uk_express_worldwide_1200GB
Express 12:00 Documentsdhl_uk_express_worldwide_1200_documentsGB
Express Worldwidedhl_uk_express_worldwideGB, US
Express Worldwide Documentsdhl_uk_express_worldwide_documentsGB
Express Worldwide EUdhl_uk_express_worldwide_euGB

Optimizing Customs Data for International Shipments to Prevent Delays

To ensure smooth customs clearance and minimize the risk of shipment inspections or delays, it is critical to provide high-quality data for every international shipment. Poor data quality, specifically vague descriptions and missing HS codes, often triggers manual reviews by destination authorities.

Key Takeaways for Merchants

  • Be Literal: Describe the item as if you are explaining it to someone who cannot see it.
  • Include Part Numbers: If your product has a Part Number (PAN), include it in the reference field to help customs verify the item.
  • The "Rule of Three": A great description usually answers What it is, What it's made of, and What it's for.

Write Accurate Line Item Descriptions

Customs authorities need to know exactly what is being imported, what it is made of, and its intended use. Avoid using internal marketing descriptions or vague terms.

  • Avoid Stop Words: Words like "Sample," "Variety," or "Gift" are frequently flagged and may trigger an automatic inspection. This is a ​List of Common Stop Words.
  • Include Material Composition: For items like footwear or apparel, specify the materials (e.g., "Men’s jeans, 80% cotton, 20% polyester" instead of just "Jeans").
  • Detail the Product Type: Instead of "VINTAGE FOOTWEAR," use "Women’s shoes - leather upper and rubber sole."
  • Be Specific: Instead of "Wheel adjusted," use "Bicycle rear pivot part."

Utilizing Harmonized System (HS) Codes

Providing a correct HS code (or Commodity Code) is the most effective way to help customs officials categorize your goods.

  • US-Based Shippers: Use the US Census Bureau’s Schedule B Search Engine to find the correct code.
  • Global Shippers: Ensure you are using the most current codes required by the destination country to avoid incorrect duty/tax calculations.

Provide Part and Reference Numbers

When possible, include the specific part or item number in your commercial invoice data. Mapping these to the correct reference fields in your shipping tool (e.g., the "PAN" reference type) provides an extra layer of clarity for clearance agents and helps verify the item against the provided description.

Prohibited Stop Words & Description Comparison

Using vague language is the fastest way to get a shipment flagged for inspection. Below are examples of poor descriptions found in recent audit data versus the clear, detailed descriptions required by customs authorities.

Poor Description (Vague)Better Description (Detailed)Why it Matters
VINTAGE FOOTWEARWomen's shoes: leather upper, rubber soleDefines gender, material, and sole type.
JEANSMen’s jeans: 80% cotton, 20% polyesterSpecifies material composition for textiles.
SAMPLE / VARIETYStainless steel kitchen whisk (K792)Stop Words like "Sample" or "Variety" trigger automatic flags.
HAIR PRODUCTOrganic argan oil hair serum (100ml)Identifies the specific substance and volume.
The Mesa - MediumCanvas messenger bag with brass bucklesMoves past marketing names to actual physical traits.

Merchant Checklist: International Shipping Compliance

To ensure your international shipments clear customs without delay, use this checklist to review your data before printing your labels.

  • Is the description specific? (e.g., "Men's 100% cotton t-shirt" instead of "Apparel")
  • Did you avoid Stop Words? (Ensure "Sample," "Gift," and "Variety" are not used)
  • Is the material composition listed? (e.g., "Stainless steel," "Leather," "Plastic")
  • Is the HS code/Commodity code included? (Use a search tool if you aren't 100% sure)
  • Is the Part Number (PAN) mapped correctly? (Helps verify the item in the clearance system)
  • Is the unit value and currency accurate? (Ensure values match your commercial invoice)

Description Logic: The "Physical" Rule

When writing descriptions, ignore your marketing names. Customs authorities don't know what a Polaris IGX 144+ Linkage Kit is. Instead, describe the physical object: Steel mechanical linkage parts for vehicle suspension.

Technical Note: Mapping Compliance Data

When integrating with international carriers, how you map data fields in your API payload directly impacts customs clearance rates. While the UI may show a single "Description" field, the backend mapping should prioritize the following:

  1. Reference Field Mapping (PAN) To assist customs authorities in verifying shipments against digital records, ensure that product part numbers are mapped to the correct reference type.
  • Reference Type: PAN (Part Number)
  • Usage: Map your internal SKU or manufacturer part number here. This allows clearance systems to match the physical item to the digital declaration more efficiently.
  1. Data Integrity vs. UX Display It is important to note that what the customer sees in the ShipStation or Shopify UI may not always reflect the full data payload sent to the carrier.
  • Payload Enrichment: Even if a merchant uses a short marketing title in their store, the integration should attempt to send the most granular description available in the product database to the description field in the customs object.
  • Stop Word Scrubbing: Consider implementing a validation layer that flags or prevents the use of Stop Words (Sample, Gift, Variety) in the description field before the API call is finalized. This is a ​List of Common Stop Words.
  1. HS Code Automation Automating the harmonized_tariff_code field is the highest-value optimization you can provide. Ensuring this field is populated with a 6 to 10-digit code reduces the reliance on the text description alone, as the code provides a universal language for customs agents worldwide.

Shipping from Great Britain to Northern Ireland

DHL Express UK will support B2B, B2C, C2C, and C2B movement types for shipping from Great Britain to Northern Ireland, in accordance with the Windsor Framework.

Requirements

To comply with The Windsor Framework, DHL Express requires the following for Non-Document shipments:

  • For B2B shipments,
    • A UKIMS number, using registration type code ADQ
    • a UKIMS number, using registration type code IMS, is required when sending on the Green lane
    • a copy of the invoice should be provided using paperless trade (PLT). This is essential for Red lane shipments, and preferred for Green lane shipments.
  • Change the DHL product code from “DOM” or "N" to “3”
  • Provide Invoice line-item data
  • Provide a physical copy of the invoice, preferably using paperless trade (PLT) ​* The transport label should display DOM using white text on a black background to represent an adutiable shipment. (This will be handled automatically if using GLS when NETWORK_PRODUCT_CODE 3 is provided).
  • No changes are required for Document shipments.

Movement Indicators​

ParameterRequired by the CarrierDescription
Movement IndicatorRequired. There is no default value for the movement indicator.
Not At Risk FlagXOptional. Full data for B2B shipments on lanes GB to UK should always be provided for Non-Document shipments
Sender UKIMS NumberRequired. The carrier provides separate fields for sender and receiver UKIMS number in all EDI types.
Receiver UKIMS NumberAt least 1 is required for “green lane” shipping.

Data Requirements​

TIP: You may find it helpful to see the Products Object section of our International Shipping page.

Movement TypeProperty
B2B parcels ​with​​ UKIMS authorisation
  • A copy of the invoice should be provided using paperless trade (PLT). This is essential for Red lane shipments, and preferred for Green lane shipments.
  • A UKIMS number, using registration type code ADQ
  • A UKIMS number, using registration type code IMS, is required when sending on the Green lane.
  • Shipment.ProductCode = 003
  • Shipment.placeOfIncoterms
  • Shipment.ExportReason
  • Parcel.CustomsValueAmount
  • Product.Value
  • Product.ValueCurrency
  • Product.Quantity
  • Product.Description (must be an accurate description in plain English)
  • Product.CountryISO3
  • Product.Weight
B2B parcels ​without​​ UKIMS authorisation
  • A copy of the invoice should be provided using paperless trade (PLT). This is essential for Red lane shipments, and preferred for Green lane shipments.
  • A UKIMS number, using registration type code ADQ
  • A UKIMS number, using registration type code IMS, is required when sending on the Green lane.
  • Shipment.ProductCode = 003
  • Shipment.placeOfIncoterms
  • Shipment.ExportReason
  • Parcel.CustomsValueAmount
  • Product.Value
  • Product.ValueCurrency
  • Product.Quantity
  • Product.Description (must be an accurate description in plain English)
  • Product.CountryISO3
  • Product.Weight
B2C/C2C/C2B parcels
  • Shipment.ProductCode = 003
  • Shipment.placeOfIncoterms
  • Shipment.ExportReason
  • Parcel.CustomsValueAmount
  • Product.Value
  • Product.ValueCurrency
  • Product.Quantity
  • Product.Description (must be an accurate description in plain English)
  • Product.CountryISO3
  • Product.Weight

Return Services

Return services are not supported for this carrier

Packages

DHL Express UK does not have carrier-specific package types. You can use the generic package type or custom package types.

Adding Shipment Insurance

DHL Express UK supports adding carrier insurance to your shipments. Review the Parcel Insurance page for details on adding shipment insurance with ShipStation API.

Label Support

  • Label sizes: 4" x 6", 4" x 8"
  • Label formats: PDF

Label Reference Fields

DHL Express supports adding custom label messages.

Label messages will be printed on the Ref field on the label and the Reference field on the commercial invoice. If using multiple label message properties in your request, the messsages will be combined into a single message with a 35-character maximum. Any additional characters will be trimmed from the field.

Multi-Package Labels

DHL Express supports creating multi-package shipments with all available services. DHL has a 999-label maximum for multi-package shipments.

Label Branding

DHL Express does not support label branding.

Voiding Labels

ShipStation API supports voiding DHL labels, but the void request is not sent to DHL. However, DHL Express does not charge an account holder unless the waybill is physically picked up and scanned into the network by a courier. If DHL does not pick up the waybill within 10 business days of its creation, its automatically recycled.

Paperless Labels

DHL Express does not support paperless labels.

Customs Declarations

Customs declarations are submitted electronically, but the commercial invoice is available to download and print from the label response.

Delivery Confirmation

Confirmation TypeAPI CodeDescription
Electronic signaturesignatureSignature is required for the shipment to be delivered. This signature may be a neighbor, building manager, or the recipient can authorize the release of the package (without being present).

See our Delivery Confirmation page for more details about using the confirmation property.

Advanced Options

DHL Express supports certain advanced options, which you can add to the shipment object when creating a shipment or label.

OptionTypeDefault ValueDescription
bill_to_partyenumerated stringnullDetermines which party is paying for shipping costs. This field must be used in conjunction with the bill_to_country_code, bill_to_postal_code, and bill_to_account fields. Available values: recipient, third_party
delivery_duty_paidbooleanfalseIndicates the shipment is DDP (that is, the shipper is paying the duties/taxes for the shipment rather than the recipient).
non_machinablebooleanfalseIndicates that the package cannot be processed through sorting machines.
saturday_deliverybooleanfalseIndicates that the carrier should charge for delivery on Saturday for services that do not otherwise include Saturday delivery.

To ensure you always have the most up-to-date information about a carrier's advanced options, use the list carrier options call.

Manifests

DHL Express does not require manifesting your shipments. For accounts based in the US, manifests are submitted electronically at the time of label creation.

Scheduling Pickups

DHL Express supports scheduling pickups with ShipStation API.

See our Schedule a Carrier Pickup page for more details about scheduling pickups using ShipStation API.

Service Points (PUDO)

DHL Express does not support shipping to service points.

Tracking

ShipStation API's integration with DHL Express supports receiving tracking updates. Review our ​Track a Package guides​​ for details on tracking with the ShipStation API.

Disconnecting Your DHL Express Account

See the Disconnect section in our Delete a Carrier page for the process of deleting or disconnecting a carrier from ShipStation API.

NOTE:

If you disconnect a carrier account and reconnect it, the account will have a new carrier_id in ShipStation API.