Skip to content

Parcelforce

Parcelforce is a leader among parcel delivery services in the UK. Through ShipStation API’s integration with Parcelforce, you can ship with both domestic and international services. Register for a Royal Mail Online Business Account - OBA to get started!

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

The following properties are required to connect a Parcelforce account:

PropertyTypeRequired?Description
nicknamestringrequiredA nickname for the account in ShipStation API (especially useful if connecting multiple accounts).
contact_namestringrequiredContact name for the account.
company_namestringrequiredCompany name for the account.
account_numberstringrequiredRoyal Mail OBA (Online Business Account) number. Format is 10 characters; if you have a 9-character account number, include a preceding zero.
oba_emailstringrequiredThe Royal Mail Online Business Account (OBA) email address used to manage Royal Mail payments and invoices online at Royal Mail Online Business Account. Format: local-part@domain (e.g., jsmith@example.com).
oba_postal_codestringrequiredPostal code where the oba_email address is registered. Can sometimes be the customer's PLN postal code.
phonestringrequiredContact phone number.
posting_location_numberstringrequiredPLN (Posting Location Number). Format is a 10-digit number starting with 9000.
street_line1stringrequiredPrimary street address line.
street_line2stringoptionalSecondary street address line.
street_line3stringoptionalThird street address line.
citystringrequiredCity name.
postal_codestringrequiredPostal code for the address.
passwordstringrequiredAccount password.
sftp_usernamestringoptionalSFTP username (if applicable).
sftp_passwordstringoptionalSFTP password (if applicable).
contract_numberstringrequiredContract number provided by Royal Mail.
collection_contract_numberstringoptionalCollection contract number (if applicable).
department_idintegeroptionalDepartment ID (if applicable).
collection_department_idintegeroptionalCollection department ID (if applicable).
test_accountbooleanoptionalSet to true for test credentials, false for production.

Connection Requirements

NOTE:

Royal Mail OBA Account Prerequisites

Before connecting your Parcelforce account to ShipStation API, ensure you have an active Royal Mail Online Business Account (OBA) profile. Key requirements:

  1. OBA Profile Required: Shippers must have an active OBA profile created by Royal Mail before submitting a connection request via ShipStation API. If an OBA profile has not been created, the connection request will be rejected.

  2. Account Status: Royal Mail will deactivate OBA accounts that remain inactive for over 90 days. Ensure your OBA account is active before submitting your integration request.

  3. Check OBA Status: You can check your OBA account status at the Royal Mail OBA Account Status Check page.

  4. Need Help? If you're unsure which email address is associated with your OBA account, contact the Royal Mail OBA Helpdesk:

    • Phone: 08457 950 950
    • Email: oba.helpdesk@royalmail.com

NOTE:

Intersoft Integration

Parcelforce's integration with ShipStation API is managed by Intersoft, a company owned by Royal Mail. The data flow is: ShipStation API > Intersoft > Royal Mail/Parcelforce > Intersoft > ShipStation API.

When you submit a connection request, it is automatically sent to the Royal Mail OBA team for approval. The OBA team responds immediately and either approves or rejects the request based on whether the Royal Mail account details are accurate. If approved, your account status updates from "Disabled" to "Enabled." If rejected, you'll need to re-enter the correct details and resubmit.

  • 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 addresses.
  • 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).
  • Manifests required: All shipments must be manifested daily. See the Manifests section below for critical daily manifesting requirements and penalty information.

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 via the ShipStation API dashboard, see our Parcelforce help article.

Connect via Endpoint

carrier_name: parcelforce_royal_mail

POST /v1/connections/carriers/:carrier_name

Sample request:

POST /v1/connections/carriers/parcelforce_royal_mail HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "My Parcelforce account",
  "account_number": "1234567890",
  "oba_email": "john.doe@example.com",
  "oba_postal_code": "KW1 6LZ",
  "company_name": "Example Corp",
  "contact_name": "John Doe",
  "street_line1": "77 Netherpark Crescent",
  "city": "STIRKOKE HOUSE",
  "postal_code": "KW1 6LZ",
  "phone": "215-555-5555",
  "posting_location_number": "9000123456",
  "password": "pa55word",
  "contract_number": "12345"
}

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

The available services with Parcelforce Worldwide 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

NameCodeAPI Code
EXPRESS10TE1royal_mail_express_10
EXPRESS10 AGETA1royal_mail_exp10_age
EXPRESS10 AGE COMP 1TA2royal_mail_exp10_age_comp1
EXPRESS10 AGE COMP 2TA3royal_mail_exp10_age_comp2
EXPRESS10 AGE COMP 3TA4royal_mail_exp10_age_comp3
EXPRESS10 COMP 1TE2royal_mail_exp10_comp1
EXPRESS10 COMP 2TE3royal_mail_exp10_comp2
EXPRESS10 COMP 3TE4royal_mail_exp10_comp3
EXPRESS24NDAroyal_mail_express_24
EXPRESS24 AGENDHroyal_mail_exp24_age
EXPRESS24 AGE COMP 1NDIroyal_mail_exp24_age_comp1
EXPRESS24 AGE COMP 2NDJroyal_mail_exp24_age_comp2
EXPRESS24 AGE COMP 3NDKroyal_mail_exp24_age_comp3
EXPRESS24 COMP 1NDBroyal_mail_exp24_comp1
EXPRESS24 COMP 2NDCroyal_mail_exp24_comp2
EXPRESS24 COMP 3NDEroyal_mail_exp24_comp3
EXPRESS24 RETURNSRT0royal_mail_exp24_ret
EXPRESS24 RETURNS COMP 1RT1royal_mail_exp24_ret_comp1
EXPRESS24 RETURNS COMP 2RT2royal_mail_exp24_ret_comp2
EXPRESS24 RETURNS COMP 3RT3royal_mail_exp24_ret_comp3
EXPRESS24 WEEKENDFEKroyal_mail_exp24_weekend
EXPRESS24 WEEKEND AGENDOroyal_mail_exp24_weekend_age
EXPRESS24 WEEKEND COMP 1FEQroyal_mail_exp24_weekend_comp1
EXPRESS24 WEEKEND COMP 1 AGENDSroyal_mail_exp24_weekend_comp1_age
EXPRESS24 WEEKEND COMP 2FERroyal_mail_exp24_weekend_comp2
EXPRESS24 WEEKEND COMP 2 AGENDTroyal_mail_exp24_weekend_comp2_age
EXPRESS24 WEEKEND COMP 3FEUroyal_mail_exp24_weekend_comp3
EXPRESS24 WEEKEND COMP 3 AGENDVroyal_mail_exp24_weekend_comp3_age
EXPRESS24 WITH PINTEAroyal_mail_exp24_pin
EXPRESS24 WITH PIN COMP 1TEBroyal_mail_exp24_pin_comp1
EXPRESS24 WITH PIN COMP 2TECroyal_mail_exp24_pin_comp2
EXPRESS24 WITH PIN COMP 3TEDroyal_mail_exp24_pin_comp3
EXPRESS24 WITH PIN WEEKENDRT4royal_mail_exp24_pin_weekend
EXPRESS24 WITH PIN WEEKEND COMP 1RT5royal_mail_exp24_pin_weekend_comp1
EXPRESS24 WITH PIN WEEKEND COMP 2RTEroyal_mail_exp24_pin_weekend_comp2
EXPRESS24 WITH PIN WEEKEND COMP 3RTFroyal_mail_exp24_pin_weekend_comp3
EXPRESS48FE0royal_mail_exp48
EXPRESS48 AGEFEAroyal_mail_exp48_age
EXPRESS48 AGE COMP 1FEBroyal_mail_exp48_age_comp1
EXPRESS48 AGE COMP 2FECroyal_mail_exp48_age_comp2
EXPRESS48 AGE COMP 3FEDroyal_mail_exp48_age_comp3
EXPRESS48 COMP 1FE1royal_mail_exp48_comp1
EXPRESS48 COMP 2FE2royal_mail_exp48_comp2
EXPRESS48 COMP 3FE3royal_mail_exp48_comp3
EXPRESS48 LARGEFEMroyal_mail_exp48_large
EXPRESS48 LARGE COMP 1FENroyal_mail_exp48_large_comp1
EXPRESS48 LARGE COMP 2FEOroyal_mail_exp48_large_comp2
EXPRESS48 LARGE COMP 3FEProyal_mail_exp48_large_comp3
EXPRESS48 RETURNS COMP 1RTBroyal_mail_exp48_return_comp1
EXPRESS48 RETURNS COMP 2RTCroyal_mail_exp48_return_comp2
EXPRESS48 RETURNS COMP 3RTDroyal_mail_exp48_return_comp3
EXPRESSAMFEEroyal_mail_exp_am
EXPRESSAM AGEMA1royal_mail_exp_am_age
EXPRESSAM AGE COMP 1MA2royal_mail_exp_am_age_comp1
EXPRESSAM AGE COMP 2MA3royal_mail_exp_am_age_comp2
EXPRESSAM AGE COMP 3MA4royal_mail_exp_am_age_comp3
EXPRESSAM COMP 1FEFroyal_mail_exp_am_comp1
EXPRESSAM COMP 2FEGroyal_mail_exp_am_comp2
EXPRESSAM COMP 3FELroyal_mail_exp_am_comp3
EXPRESSAM WEEKENDTEHroyal_mail_exp_am_weekend
EXPRESSAM WEEKEND AGEM07royal_mail_exp_am_weekend_age
EXPRESSAM WEEKEND AGE COMP 1M08royal_mail_exp_am_weekend_age_comp1
EXPRESSAM WEEKEND AGE COMP 2M09royal_mail_exp_am_weekend_age_comp2
EXPRESSAM WEEKEND AGE COMP 3M10royal_mail_exp_am_weekend_age_comp3
EXPRESSAM WEEKEND COMP 1TEIroyal_mail_exp_am_weekend_comp1
EXPRESSAM WEEKEND COMP 2TEJroyal_mail_exp_am_weekend_comp2
EXPRESSAM WEEKEND COMP 3TEKroyal_mail_exp_am_weekend_comp3

International Services

NameCodeAPI Code
CHINA ECONOMY - 3PCCERroyal_mail_china_economy_3_pc
CHINA ECONOMY - DEPOT DROPCEQroyal_mail_china_economy_depot_drop
CHINA ECONOMY - DIRECT HUB DROPCESroyal_mail_china_economy_direct_hub_drop
CHINA ECONOMY - PERSONAL EFFECTSCEOroyal_mail_china_economy_personal_effects
CHINA ECONOMY - POL DROPCEProyal_mail_china_economy_pol_drop
EUROPRIORITY DTP IOSSERAroyal_mail_europriority_dtp_ioss
EUROPRIORITY DTP IOSS-EXTRACOMP1ER1royal_mail_europriority_dtp_ioss_extra_comp1
EUROPRIORITY DTP IOSS-EXTRACOMP2ER2royal_mail_europriority_dtp_ioss_extra_comp2
EUROPRIORITY DTP IOSS-EXTRACOMP3ER3royal_mail_europriority_dtp_ioss_extra_comp3
GLOBALEXPRESSGXRroyal_mail_global_express
GLOBALEXPRESS-EXTRACOMP1GX1royal_mail_global_express_extra_comp1
GLOBALEXPRESS-EXTRACOMP2GX2royal_mail_global_express_extra_comp2
GLOBALEXPRESS-EXTRACOMP3GX3royal_mail_global_express_extra_comp3
GLOBALPRIORITY EUROPEECAroyal_mail_globalpriority_europe
GLOBALPRIORITY EUROPE-EXTRACOMP1EC1royal_mail_globalpriority_europe_extra_comp1
GLOBALPRIORITY EUROPE-EXTRACOMP2EC2royal_mail_globalpriority_europe_extra_comp2
GLOBALPRIORITY EUROPE-EXTRACOMP3EC3royal_mail_globalpriority_europe_extra_comp3
GLOBALPRIORITY ROWGPAroyal_mail_globalpriority_row
GLOBALPRIORITY ROW-EXTRACOMP1GP1royal_mail_globalpriority_row_extra_comp1
GLOBALPRIORITY ROW-EXTRACOMP2GP2royal_mail_globalpriority_row_extra_comp2
GLOBALPRIORITY ROW-EXTRACOMP3GP3royal_mail_globalpriority_row_extra_comp3
IRELAND EXPRESSIXAroyal_mail_ireland_express
IRELAND EXPRESS-EXTRACOMP1IX1royal_mail_ireland_express_extra_comp1
IRELAND EXPRESS-EXTRACOMP2IX2royal_mail_ireland_express_extra_comp2
IRELAND EXPRESS-EXTRACOMP3IX3royal_mail_ireland_express_extra_comp3

Shipping to the Channel Islands

  • Guernsey and Jersey: Royal Mail requires customs declarations for Channel Islands shipments to Guernsey and Jersey. Please use the country code GE and JE, respectively. Royal Mail will not produce these forms if the country code is GB.
  • Isle of Man: Change the country code to IM and then the proper forms will be included with the label. Isle of Man (IOM) shipments do not require customs and there is no option to select IOM as a country code.

Shipping to Northern Ireland

Starting 1st May 2025, changes to Royal Mail products and services will take effect in accordance with the Windsor Framework. Under the Windsor Framework, shipments will fall into 1 of 2 categories:

  • Green Lane: For trusted traders sending goods staying in Northern Ireland — minimal checks, simplified processes.

  • Red Lane: For goods at risk of moving into the EU via the Republic of Ireland — full customs procedures apply.

Royal Mail 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).

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

Business Accounts - Different Types of Goods Movements

Movement TypeDefinitionAdditional data to be provided by the customer
Business to Consumer (B2C)Parcels sent by a business in Great Britain to a private individual residing in Northern Ireland for personal use.* Product Description (must be accurate and in plain English)
* Product Weight
* Product Value
* Product Country of Origin
* HS Harmonized Tariff code (optional),
Consumer to Business (C2B)Parcels sent by a private individual in Great Britain to a business in Northern Ireland (for example, a customer returning an item to a shop).* Product Description (must be accurate and in plain English)
* Product Weight
* Product Value
* Product Country of Origin
* Returned Goods Indicator
* HS Harmonized Tariff code (optional),
Business to Business (B2B - value of goods above £135 )Parcels sent by a business in Great Britain to a business in Northern Ireland.* Exporter / Sender details (inc. EORI)
* Importer / Receiver details (inc. EORI)
* Total Value (not by item)
* Gross Mass
* UKIMS Number
* Product Description (must be accurate and in plain English)
* Product Country of Origin
* HS Harmonized Tariff code (optional),
Business to Business (B2B - value of goods £135 or less )Parcels sent by a business in Great Britain to a business in Northern Ireland where total goods value up to and including £135.* Exporter / Sender details (inc. EORI)
* Importer / Receiver details (inc. EORI)
* Total Value (not by item)
* Gross Mass
* UKIMS Number
* Product Description (must be accurate and in plain English)
* Product Country of Origin
* HS Harmonized Tariff code (optional),

NOTE: For B2B movements, where UKIMS registration is not presented with the parcel data, the sending customer may be liable to delays, customs charges or the parcel returned to the sender.

Consumers - Different Types of Goods Movements

Movement TypeDefinitionAdditional data to be provided by the customer
Consumer to Consumer (C2C)Parcels sent by a private individual in Great Britain to a private individual residing in Northern Ireland for personal use.* Product Description (must be accurate and in plain English)
* Product Weight
* Product Value
* HS Harmonized Tariff code (optional),
Consumer to Business (C2B)Parcels sent by a private individual in Great Britain to a business in Northern Ireland (for example, a customer returning an item to a shop).* Product Description (must be accurate and in plain English)
* Product Weight
* Product Value
* Product Country of Origin
* Returned Goods Indicator
* HS Harmonized Tariff code (optional),

Does Royal Mail offer a Next Day service from Great Britain to Northern Ireland?

Next Day services will be available for C2C, C2B, B2C, and B2B. For B2B shipments Royal Mail will only process goods classified as 'not at risk'. For goods classified as 'at risk' Royal Mail may be able to carry these goods on a Parcelforce Worldwide service. For account enquiries, contact 03448 429102.

Reason for Export Defaulting Behavior

Parcelforce automatically handles the reason_for_export field based on your shipment configuration, reducing the data you need to provide for GB to NI shipments.

Automatic Defaulting Behavior

When shipment.customs.contents is set to "merchandise", the carrier will automatically default the reason_for_export field based on the movement.indicator value:

movement.indicatorshipment.customs.contentsDefaulted reason_for_export
B2Cmerchandisee_commerce_goods
B2Bmerchandisecommercial_sale_of_goods_b2b

No additional fields are required from the merchant in these cases.

Explicit Override Behavior

Merchants can bypass the automatic defaulting by setting shipment.customs.contents to "other" and providing a value in shipment.customs.contents_explanation:

movement.indicatorshipment.customs.contentsshipment.customs.contents_explanation
B2Cothere_commerce_goods
B2Bothercommercial_sale_of_goods_b2b

Return Services

To create return labels, Royal Mail must approve you for at least one of the following services:

NameCodeAPI Code
EXPRESS24 RETURNSRT0royal_mail_exp24_ret
EXPRESS24 RETURNS COMP 1RT1royal_mail_exp24_ret_comp1
EXPRESS24 RETURNS COMP 2RT2royal_mail_exp24_ret_comp2
EXPRESS24 RETURNS COMP 3RT3royal_mail_exp24_ret_comp3
EXPRESS48 RETURNS COMP 1RTBroyal_mail_exp48_return_comp1
EXPRESS48 RETURNS COMP 2RTCroyal_mail_exp48_return_comp2
EXPRESS48 RETURNS COMP 3RTDroyal_mail_exp48_return_comp3

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

Packages

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

NameCodeClassDomesticInternational
Large LetterLLLetter
Medium ParcelMPBox
ParcelPBox
Printed PapersHBox
Small ParcelSPBox

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

  • Supports label reference field 1, limited to 20 characters
  • Address line has a 35-character limit.

Multi-Package Labels

Parcelforce Worldwide supports multi-package shipments for most services.

Label Branding

Parcelforce Worldwide does not support label branding.

Voiding Labels

Royal Mail supports voiding labels with ShipStation API. Labels cannot be voided once the shipments have been manifested. If you need to void a shipment on a sales order summary, you must contact Royal Mail directly.

See our Void a Label page for details about voiding labels with ShipStation API.

Paperless Labels

Parcelforce Worldwide does not support paperless labels.

Customs Declarations

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

NOTE:

Channel Islands (Guernsey and Jersey)

Shipments to Guernsey and Jersey require customs declarations. Use country code GE for Guernsey and JE for Jersey. Customs documentation will not work with GB as the country code.

NOTE:

Isle of Man

The Royal Mail website indicates that Isle of Man shipments do not require customs declarations. Since there is no Isle of Man country code option, use GB as the country code when shipping to the Isle of Man. This ensures customs validation is not triggered by ShipStation API.

NOTE: Action Required: New Zealand Border Levy Changes

Effective April 1, 2026, a new NZD $2.21 (+ GST) levy applies to low-value air freight consignments entering New Zealand. This levy is charged per consignment, not per item.

See the Shipping to New Zealand: Low Value Goods (LVG) Levy section in International Shipments for full details.

Delivery Confirmation

Royal Mail shipments do not set a default confirmation type.

Royal Mail has enhancement codes that correspond to delivery confirmation types in ShipStation API. For example, the Royal Mail enhancement code for the Signed For service maps to the confirmation type direct_signature.

Only certain services allow certain enhancements. If you choose an option that is not supported with a selected service, you'll get a generic error like Error code E0004 - Failed Schema Validation.

Please consult with Royal Mail for the latest version of Key FAQs for Royal Mail API Shipping, their page RMG Shipping API Technical User Guide, or similar documentation to learn more about enhancement codes.

Advanced Options

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

OptionTypeDefault ValueDescription
ServiceLevelnumber01Royal Mail supports ServiceLevel advanced options. When this field and value are included in a label request, Royal Mail will correctly associate the contract billing for the shipment.

For example, ”ServiceLevel”: “02”, where the default is always 01 unless specified. The range is from 01 to 99.
NotificationsEmailstringnullThe carrier will send email tracking notifications if an email address is present.

Available for: Express AM, Express 10, Express 24, China Economy, Euro Priority, Global Express, and Ireland Express services.
NotificationsPhonestringnullThe carrier will send SMS tracking notifications if a phone number is present.

Available for: Express AM, Express 10, Express 24, and Express 48 services.
LocalCollectbooleannullLocal Collect
SafeplacestringnullText instructing the delivery driver where to place the package if no one is available to receive it (e.g., “Place on backdoor”).

Available for: Express 10, Express 24, Express 48, Express AM services (including COMP 1/2/3 variants and Large variants).

Restrictions: Cannot be used with services that require a signature. Maximum 30 characters—text will be truncated before sending to the carrier.

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.

Royal Mail requires you to create and print a Sales Order Summary, which you must then hand to the driver who picks up the parcels.

You can generate your Sales Order Summary through the manifest process. When you make your request to the /v1/manifests endpoint, the response will include a link to download the Sales Order Summary PDF.

Please note: You cannot close shipments with dispatch dates in the future, only past or current-date shipments.

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.

NOTE:

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