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.

DX Guide

DX offers domestic and international shipping solutions for shipments originating in the UK.

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

Requirements

PropertyTypeRequired?Description
nicknamestringrequiredHow your carrier account will be identified in ShipStation API.
accountCodestringrequiredYour DX account number.
usernamestringrequiredYour DX account username.
passwordstringrequiredYour DX account password.

Shipping Requirements

  • International shipping is available between Great Britain and Ireland only.
  • All international shipments require the shipper's EORI number and harmonization codes for all items in the shipment.

Connect Account

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

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

Connect via Endpoint

carrier_name: dx

POST /v1/connections/carriers/:carrier_name

1
2
3
4
5
6
7
8
9
10
11
POST /v1/connections/carriers/dx HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
"nickname": "my DX account nickname",
"accountCode": "123456789",
"username": "your_username.",
"password": "pa55word",
}

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

Rates

DX does not send estimated rates to ShipStation API. Your DX account contact can provide you with the details about your contracted rates.

Service Details

Available DX 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 Code
Secure Flex Next daysecure_flex_next_day
Secure Flex Premium 1secure_flex_premium_1
Secure Flex Premium 9secure_flex_premium_9
Secure Flex Premium 1030secure_flex_premium_1030
Secure Flex AIRsecure_flex_air
Secure Flex AIR Premium 1secure_flex_air_premium_1
Secure Business Premium 1secure_business_premium_1
Secure Business Premium 1030secure_business_premium_1030
Secure Business Premium 12secure_business_premium_12
Secure Business Premium 9secure_business_premium_9
Secure Business AIRsecure_business_air
Secure Business AIR Premium 1secure_business_air_premium_1
Secure Business AIR Premium 12secure_business_air_premium_12
Secure Business Mandatory Signature AIR SATdx_secure_business_sig_air_sat
Secure Business Mandatory Signature SATdx_secure_business_sig_sat
Secure Business Mandatory Signature SAT Pre 1dx_secure_business_sig_sat_pre_1
Secure Business Mandatory Signature SAT Pre 9dx_secure_business_sig_sat_pre_9
Secure Business Mandatory Signature SAT Pre 12dx_secure_business_sig_sat_pre_12
Secure Business Mandatory Signature SAT Pre 1030dx_secure_business_sig_sat_pre_1030
Secure Flex Leave Safe (Length)dx_secure_flex_leave_safe
Secure Flex Leave Safe AIRdx_secure_flex_leave_safe_air
Secure Flex Leave Safe AIR Pre 1dx_secure_flex_leave_safe_air_pre_1
Secure Flex Leave Safe AIR SATdx_secure_flex_leave_safe_air_sat
Secure Flex Leave Safe Length (Fixed Date)dx_secure_flex_leave_safe_length_fix_date
Secure Flex Leave Safe Pre 1dx_secure_flex_leave_safe_pre_1
Secure Flex Leave Safe Pre 9dx_secure_flex_leave_safe_pre_9
Secure Flex Leave Safe Pre 1030dx_secure_flex_leave_safe_pre_1030
Secure Flex Leave Safe SATdx_secure_flex_leave_safe_sat
Secure Flex Leave Safe SAT Pre 1dx_secure_flex_leave_safe_sat_pre_1
Secure Flex Leave Safe SAT Pre 9dx_secure_flex_leave_safe_sat_pre_9
Secure Flex Leave Safe SAT Pre 1030dx_secure_flex_leave_safe_sat_pre_1030
Secure Flex Mandatory Signaturedx_secure_flex_mandatory_signature
Secure Flex Mandatory Signature AIRdx_secure_flex_mandatory_signature_air
Secure Flex Mandatory Signature AIR Pre 1dx_secure_flex_mandatory_signature_air_pre_1
Secure Flex Mandatory Signature AIR SATdx_secure_flex_mandatory_signature_air_sat
Secure Flex Mandatory Signature (Fixed Address)dx_secure_flex_mandatory_signature_fixed_address
Secure Flex Mandatory Signature (Fixed Date)dx_secure_flex_mandatory_signature_fixed_date
Secure Flex Mandatory Signature Pre 1030dx_secure_flex_mandatory_signature_pre
Secure Business Next daysecure_business_next_day_dom

International Services

DX International shipping services are only available for shipments between Great Britain and Ireland.

ServiceAPI Code
Secure Flex Next daysecure_flex_next_day_ie_intl
Secure Flex Premium 1secure_flex_premium_1_ie_intl
Secure Flex Premium 9secure_flex_premium_9_ie_intl
Secure Flex Premium 1030secure_flex_premium_1030_ie_intl
Secure Flex AIRsecure_flex_air_ie_intl
Secure Flex AIR Premium 1secure_flex_air_premium_1_ie_intl
Secure Business Next daysecure_business
Secure Business Premium 1secure_business_premium_1_ie_intl
Secure Business Premium 1030secure_business_premium_1030_ie_intl
Secure Business Premium 12secure_business_premium_12_ie_intl
Secure Business Premium 9secure_business_premium_9_ie_intl
Secure Business AIRsecure_business_air_ie_intl
Secure Business AIR Premium 1secure_business_air_premium_1_ie_intl
Secure Business AIR Premium 12secure_business_air_premium_12_ie_intl
Secure Business Mandatory Signature AIR SAT Internationaldx_secure_business_sig_air_sat_ie_intl
Secure Business Mandatory Signature SAT Internationaldx_secure_business_sig_sat_ie_intl

Shipping to Northern Ireland

DX will support the B2B and B2C movement types, in accordance with the Windsor Framework.

DX will not support shipments of prohibited, or restricted goods. This means there will be no invoices needed and no duties payable.

DX Customer Requirements​

  • All DX B2B Customers will need to agree to the updated DX Brexit Terms.
  • B2B shippers or receivers must have UKIMS authorisation​​, and ​TSS (Trader Support Service) registration​​.
  • B2B shippers and receivers must authorise DX as a UKIMS agent.
    • This is how DX will share B2B data with HMRC.
  • Be sure you have the latest DX API Guide.
  • Know the rules for your products and if they are restricted, prohibited, or controlled.
  • GB-NI bookings will require line-level data for GB-NI shipments:
    • Is the shipment B2B or B2C? (A weight limit applies for B2C shipments. Any items over this limit will be sent as B2B)*
    • DX Customers will create GB-NI labels manually or via API, and provide product line details for the B2B or B2C movement type.
    • EORI / UKIMS number of sender or receiver
    • Provide a plain English product description for all products and their 6-digit commodity code
    • Product Weight
    • Product Value
    • Product Quantity
    • Product Country of Origin

B2C​:

  • Customers sending only B2C (below weight limits*) will not need UKIMs/TSS. These will be required for all Customers sending B2B or overweight B2C shipments GB-NI.
  • DX will move all B2C goods and share data with HMRC within 24 hrs of moving to the DX Belfast depot.
    • Weight limit for B2C: 31.5kg per package if multiple items are packed within, or 100kg per package if only 1 single item is packed within.

B2B​​: (Green-Lane only)

  • DX will pre-clear any B2B shipments prior to moving to the DX Belfast depot.

Return Services

DX does not support creating return labels with ShipStation API.

Packages

The following carrier package types are available for DX services:

NameAPI CodePackage Attributes
Boxdx_boxDomestic, International
Lengthdx_lengthDomestic, International
Pouchdx_pouchDomestic, International

Adding Shipment Insurance

DX 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"
  • Label formats: PDF

Label Reference Fields

DX supports adding custom label messages. If adding Safe Place instructions, use custom label messages to add them to the label reference fields.

Multi-Package Labels

DX supports creating multi-package shipments with all available services.

Label Branding

DX supports label branding.

Voiding Labels

DX supports voiding labels with ShipStation API. You can only void DX labels up to 23:59 on the date the label was created. Attempts after that will receive an Unable to Void Label message.

Paperless Labels

DX does not currently support paperless labels.

Delivery Confirmation

Confirmation TypeAPI CodeDescription
NoneNo ConfirmationDefault for Secure Flex Leave Safe services.
SignatureNeighbour SignatureAvailable for the Secure Flex Signature services.
Direct signatureMandatory SignatureRequired for any "Mandatory Signature" services.

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

Advanced Options

DX does not currently support any advanced options.

Manifests

DX does not require manifesting your shipments.

Scheduling Pickups

DX does not support scheduling a pickup with ShipStation API.

Service Points (PUDO)

DX does not support shipping to service points.

Tracking

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

Troubleshooting Tips

IssueResolution
The Secure Flex Next Day is not available in this Account. The available Services: Secure Flex Next Day (Generic).This error can show up even when you have Secure Flex Next Day service on your account. Because DX users only have certain confirmation types available in their DX agreement, the label will be blocked if you try to use a confirmation type not in your DX contract.
What to do: Change the confirmation type to another option available and you should be able to create a label. If you try to ship using Neighbourhood Signature and Mandatory Signature and get an error, check with your DX contact to confirm that these options are enabled on your contract.

Disconnecting Your DX Account

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