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.

Parcelforce Worldwide

Parcelforce Worldwide is a leader among parcel delivery services in the UK. Through ShipStation API’s integration with Parcelforce Worldwide, you can ship with both domestic and international services. Contact Parcelforce Worldwide today to register for an account!

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

If you are using or plan to use the Parcelforce services included with ShipStation API, rather than connecting your own Parcelforce Worldwide account, see our Parcelforce from ShipStation guide.

Requirements

PropertyTypeRequired?
nicknamestringrequired
account_numberstringrequired
passwordstringrequired
sftp_usernamestringOptional
sftp_passwordstringOptional
contract_numberstringrequired
collection_contract_numberstringOptional
department_idintegerOptional
collection_department_idintegerOptional
test_accountbooleanOptional

Connection Requirements

  • Test labels: Parcelforce requires test labels before you can create real labels! You must generate sample labels with test credentials and submit those sample labels to Parcelforce for approval. Once approved, you can enter your production credentials to start creating real labels.

Shipping Requirements

  • All shipments must include a first and last name for both the Ship To and Ship From address.
  • Ship To address requires a phone number.
  • All shipments require a signature upon delivery unless the No Signature Required (NSR) option has been applied to the shipment.
  • International shipments require dimensions (though we recommend adding dimensions for all shipments).
  • Parcelforce requires all shipments to be manifested and the manifests to be printed. You can create your forms using the Manifests endpoint.

Connect Account

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

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

Connect via Endpoint

carrier_name: parcelforce

POST /v1/connections/carriers/:carrier_name

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
POST /v1/connections/carriers/parcelforce HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
"nickname": "My Parcelforce Account",
"account_number": "1234",
"password": "pa55word",
"sftp_username": "sftp_user",
"sftp_password": "pa55word",
"contract_number": "12345",
"department_id": "12",
"test_account": false
}

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

Rates

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

Service Details

Available Parcelforce Worldwide 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.

Parcel Weight limit for all services (domestic and international): ≤30KG

Max parcel dimensions:

  • All services except Express 48 Large: 1.5m length and length + girth = ≤3m
  • Express 48 Large: 2.5m length and length + girth = ≤5m

Domestic Services

ServiceCarrier CodeAPI Code
Euro EconomyEPHEuropHome
Euro PriorityEPBEuropBus
GlobalBulk DirectGBDGlobBulkDir
GlobalpriorityGPRGlobPri
Globalpriority H M ForcesGPRGlobPriHMFor
Globalpriority ReturnsEPRGlobPriRet
GlobalvalueGVAGlobVal
Ireland ExpressI24IrelExpr
Euro Priority PackEPKEuropPack

International Services

Shipping ServiceCarrier CodeAPI Code
Euro EconomyEPHEuropHome
Express 9S09Exp9
Express 9 Courier PackSC9Exp9CP
Express 10S10Exp10
Express 10 Courier PackSC0Exp10CP
Express AMS12ExpAM
Express AM LargeSAMLExpAML
Express AM Courier PackSC2ExpAMCP
Express PMSPMExpPM
Express 24SNDExp24
Express 24 LargeS24LExp24L
Express 24 Courier PackSCDExp24CP
Express 24 SundaySCDPExp24S
Express 48SUPExp48
Express 48 LargeSIDExp48L
Globalpriority H M ForcesGPRGlobPriHMFor
Parcel RiderSPRParcRide

Shipping to Northern Ireland

Starting 1st May 2025, changes to Parcelforce products and services will take effect in accordance with the Windsor Framework. Parcelforce intends to support all movement types for shipping from Great Britain to Northern Ireland.

The data requirements for each movement type may vary. We will provide more details in this section as soon as they are available. Parcelforce customers sending parcels from Great Britain to Northern Ireland (GB-NI ) will need to provide additional data. The parcel movement's type will determine what data is required: Business-to-Consumer (B2C), Consumer-to-Consumer (C2C), Consumer-to-Business (C2B), or Business-to-Business (B2B).

Movement Indicators​

ParameterRequired by the CarrierDescription
Movement IndicatorRequired.
  • B2B, B2C, C2B, or C2C
  • If no Movement Indicator is provided, the default is B2C.
Not At Risk FlagXOptional.
  • Full data for B2B shipments on lanes GB to UK should always be provided for Non-Document shipments
  • Parcelforce will declare the shipment to be At Risk or Not At Risk. The carrier will choose Red or Green lane based on the provided values.
  • Shipment Movement Indicator
  • UKIMS number has been declared when appropriate
  • The specific description and value of the contents declared and whether other required information is provided.
  • Broadly speaking any B2B shipments without UKIMS that are valued at more than £135 would constitute Red lane.
  • HMRC CDS will notify Parcelforce if customs charges are to be charged back to the sender due to Red lane.
Sender UKIMS NumberRequired only for B2B. It can be the UKIMS number of either the Sender or Recipient.
Receiver UKIMS NumberRequired only for B2B. It can be the UKIMS number of either the Sender or Recipient.

While not required to create a label successfully, you can declare the movement_indicator in the windsor_framework_details object. If you know the shipper and recipient UKIMS numbers, you should declare them in the tax_identifiers object in both the ship_to and ship_from objects.

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

Data Requirements​

Movement TypeProperty
B2B parcels with UKIMS authorization
  • Movement Indicator (value: B2B)
  • UKIMS Number for Sender or Receiver
  • Recipient EORI Number (one of these must be associated with the UKIMS)
  • Sender EORI Number (one of these must be associated with the UKIMS)
  • Parcel: Weight, Value, Currency
  • Product: Description, Value, Country, Weight, Quantity, Harmonised Code
  • Content - Possible values: business papers, mixed, merchandise
  • Optional: Licence No/Certificate No
  • Optional: Content Type - Possible values: Gift, Sample.
B2B parcels without UKIMS authorization
  • Movement Indicator (value: B2B)
  • UKIMS Number for Sender or Receiver
  • Recipient EORI Number (one of these must be associated with the UKIMS)
  • Sender EORI Number (one of these must be associated with the UKIMS)
  • Parcel: Weight, Value, Currency
  • Product: Description, Value, Country, Weight, Quantity, Harmonised Code
  • Content Type - Possible values: Gift, Sample.
  • Optional: Licence No/Certificate No
B2C/C2C/C2B parcels
  • Movement Indicator value: B2C, C2C. or C2B
  • Parcel: Weight, Value, Currency
  • Product: Description, Value, Country, Weight, Quantity, Harmonised Code
  • Content - Possible values: business papers, or merchandise.
  • Optional: Licence No/Certificate No

NOTE: If Content is not provided, then the default value merchandise is passed in EDI. DM users can set business papers by MPM Business Logic.

Additional Windsor Frameworks Information for Parcelforce Worldwide

Parcel Contents Record: One or more Parcel Contents Records must be present for each Generic Parcel Information Record for International shipments to ALL destinations for Customs clearance, and for GB to NI shipments for Windsor Framework declarations. One record should be present for each type of content within each parcel (International shipments) or consignment (GB – NI Windsor Framework shipments). This record type is not applicable to GB Domestic, NI-to-GB, or NI-to-NI shipments.

Return Services

Parcelforce Worldwide supports creating return labels with domestic services. Please note that return labels will not include an Address Line 2. We send Address Lines 1 and 2 to Parcelforce, and this information is recorded in their system but does not print on the label. The return label will only include Address Line 1, city, postal code, and country code.

Review the Return Shipping Labels page for details on creating return labels with ShipStation API.

Packages

The following carrier package types are available for Parcelforce Worldwide services:

NameAPI CodeDetails
PackagepackageDomestic, International

Adding Shipment Insurance

Parcelforce Worldwide 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, PNG, ZPL

Label Reference Fields

Parcelforce Worldwide does not support adding custom label messages.

Multi-Package Labels

Parcelforce Worldwide supports multi-package shipments for most services.

Label Branding

Parcelforce Worldwide does not support label branding.

Voiding Labels

Parcelforce Worldwide supports voiding labels with ShipStation API.

Paperless Labels

Parcelforce Worldwide does not support paperless labels.

Customs Declarations

Parcelforce Worldwide returns a CN23 form to ShipStation API based on the shipment's customs information.

ShipStation API will provide a commercial invoice from Parcelforce when required. Print three of these and include them with the shipment.

Delivery Confirmation

All shipments require a signature upon delivery unless the No Signature Required (NSR) option has been applied to the shipment.

Confirmation TypeAPI CodeDescription
No signature requirednoneNo confirmation requested. When this option is selected, a “safe place” must also be selected so the carrier knows where it is safe to leave the package if no one is available to claim it upon delivery.
Adult signature requiredadult_signatureSignature is required for the shipment to be delivered.

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

Advanced Options

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

OptionTypeDefault ValueDescription
additional_handlingbooleannullIndicates the package requires special handling.
NotificationsPhonestringnullThe carrier will send SMS tracking notifications if a phone number is present.
NotificationsEmailstringnullThe carrier will send email tracking notifications if an email address is present.
saturday_deliverybooleanfalseIndicates that the carrier should charge for delivery on Saturday for services that do not otherwise include Saturday delivery. Only valid for certain services.

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

Manifests

Parcelforce requires all shipments to be manifested and the manifests to be printed.

See our Manifests page for more details about creating manifests with ShipStation API.

Scheduling Pickups

Parcelforce Worldwide does not support scheduling pickups with ShipStation API. Instead, you can arrange a pickup through Parcelforce Worldwide directly or drop packages off at a local post office or a Parcelforce Worldwide depot.

Service Points (PUDO)

Parcelforce Worldwide does not currently support shipping to service points.

Tracking

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

Disconnecting Your Parcelforce Worldwide Account

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