On this page

Consignments brexit data guide

Navigate post-Brexit shipping with our Consignments platform. Ensure your consignments meet all customs and carrier data requirements for seamless international delivery.

warning

Please note: This article is soon to be deprecated following the roll out of the Windsor Framework coming into effect on 1st May 2025.

For more information, we have published separate windsor framework articles for our Consignments platform and our Shipments platform with supporting carrier mapping information.

The UK’s departure from the EU has resulted in some changes to the data required for international shipments in Consignments. This page details the consignment data needed to generate customs documentation in Consignments and allocate international shipments to DPD, Evri, Parcelforce, Yodel, Royal Mail, DHL, or P2P.

Customs Documentation Required Data

The following consignment properties are required in order for Consignments to generate CN22, CN23, and commercial invoice documents.

info

Consignments enables you to create consignments either by making a Create Consignment API request, or by using the manual consignment creation page in the UI. Note that validation requirements are slightly different for these two methods.

Description	Consignments Data Element	Consignments API	Consignments User Interface
Delivery Town	Addresses> Destination Address>Town		n/a
Exporter Address	Addresses >Exporter		n/a
Category Type	CustomsDocumentation > CategoryType >	Yes	Yes
Declaration Date	CustomsDocumentation > DeclarationDate	Yes	Mandatory
Declaration Name	CustomsDocumentation > Designated PersonResponsible	Yes	Mandatory
Invoice Date	CustomsDocumentation > InvoiceDate	Yes	Mandatory
Consignment Carriage Value	CustomsDocumentation > ReceiversShippingCost	No	n/a
Shipper’s VAT Number	CustomsDocumentation > ShippersVatNumber	Yes	Optional
Shipping Terms	CustomsDocumentation > ShippingTerms >	Yes	Mandatory
Receiver’s EORI	Order > Metadata Consignment > Metadata Key Value: ReceiversEORI	No	n/a
Shipper’s EORI	Order > Metadata Consignment > Metadata Key Value: ShippersEORI	Yes	n/a
Carriage Value Currency	Order > Metadata Consignment > Metadata Key Value: CarriageCurrency	No	n/a
Package Description	`Package` > Description	Yes	Mandatory
Height	`Package` > Dimensions > Height		Mandatory
Length	`Package` > Dimensions > Length		Mandatory
Package Unit of Dimension	`Package` > Dimensions > Unit		Mandatory
Package Width	`Package` > Dimensions > Width		Mandatory
Maximum number of items	`Package` > Item >	Unbounded	Unbounded
Minimum number of items	`Package` > Item >	1	0
Country of Origin	`Package` > Item > CountryOfOrigin	Yes
Item Description	`Package` > Item > Description	Yes
Harmonisation Code	`Package` > Item > HarmonisationCode	Yes
Quantity	`Package` > Item > Quantity
Item Value	Package > Item > Value > Money > Amount	Yes	Conditional: Required if an item is provided
Currency	Package > Item > Value > Money > Currency > IsoCode	Yes	Conditional: Required if an item is provided
Item Weight	`Package` > Item > Weight > Value		Conditional: Required if an item is provided
Item unit of Weight	`Package` > Item > Weight > Weight Unit		Conditional: Required if an item is provided
Duty Paid Value	Package > Metadata Key Value: DutyPaidValue		n/a
Package VAT Value	Package > Metadata Key Value: VatValue		Not Available
Package Value	`Package` > Value > Money > Amount	Yes	Mandatory
Package Currency	`Package` > Value > Money > Currency > IsoCode	Yes	Mandatory
Package Unit of Weight	`Package` > Weight > Unit		Mandatory
Package Weight	`Package` > Weight > Value		Mandatory

Carrier Data Requirements

This section shows the consignment data required to ship internationally with specific carriers, and the shipping routes that these restrictions apply to for each carrier. When allocating a consignment that will use one of these routes, Consignments only considers that consignment for allocation to a particular carrier if the consignment meets the carrier’s data requirements.

Affected Routes

DPD - Customs document not required. Non-GB Destinations for the following routes:
- DPD INTERNATIONAL: GB to EU & Non-EU
- DPD UK DOMESTIC: GB to IE, JE & GG
- DPD LOCAL: GB to IE, JE & GG
Evri - Commercial Invoice document required. The following routes are affected:
- GB to Non-GB Destinations
- Non-GB Origin to GB
- GB to Northern Ireland
PARCELFORCE INTL - Customs document required. Affects GB to all non-GB destinations
info
Parcelforce’s Euro Priority Business and Euro Priority Home services have been renamed to Euro Priority and Euro Economy Home respectively. This name change does not affect the services in any way.
YODEL - Customs document not required. Affects all GB to Northern Ireland & Channel Islands routes.
info
Northern Ireland Addresses will have a Country of GB & the postcode prefix (Postcode Area) will always be ‘BT’.
ROYAL MAIL INTL - CN22 and CN23 customs documents required. Affects GB to all non-GB destinations.
DHL - Commercial invoice or PLT required. Affects GB to all non GB destinations.
P2P - Customs document required. Affects GB to all non-GB destinations.
UPS - Customs document required (UK to NI paperless). Affects GB to all non-GB destinations, including Northern Ireland.

Data

View below for the Brexit shipping data table.

Description	PRO Data Element	DPD INTERNATIONAL	HERMES INTL & NI	PARCELFORCE INTL	YODEL	ROYAL MAIL	DHL EXPRESS	P2P	FEDEX	UPS
Exporter Address	Addresses >Exporter	Conditional: Must be provided if different from the Origin Address If required please provide either: ShippingLocationReference or A minmum of AddressLine1, Region, Postcde, Country, Email and One or more of Telephone, Mobile and Landline Sorted will default to Origin Address if an Exporter Address has not been provided.
Category Type	CustomsDocumentation > CategoryType >	Mandatory Permitted values: Gift ReturnedGoods SaleOfGoods Documents Other None Note: Any other value will fail to return DPD services in any Quote, Allocation or Delivery Option result.		Mandatory Permitted values: Gift CommercialSample Documents Other	Mandatory Permitted values: Gift Sales CommercialSample Personal Note: Any other provided value will fail to return YODEL services in any Quote, Allocation or Delivery Option result.	Conditional: mandatory if electronic Customs clearance required Permitted values: Gift CommercialSample SaleOfGoods Documents ReturnedGoods Other				Required for paperless
Declaration Date	CustomsDocumentation > DeclarationDate
Declaration Name	CustomsDocumentation > DesignatedPersonResponsible					Mandatory
Invoice Date	CustomsDocumentation > InvoiceDate			Mandatory for Euro Priority service		Mandatory if submitting a Commercial Invoice
Invoice Number	CustomsDocumentation > ReferencesOfAttachedInvoices					Mandatory if submitting a Commercial Invoice
Consignment Carriage Value	CustomsDocumentation > ReceiversShippingCost				Mandatory - total consignment carriage value	Conditional: mandatory if electronic Customs clearance required				Delivery cost charged to the consignee. If a discounted delivery charge (or no value) is provided, UPS will use the freight cost charged to the shipper
Carriage Value Currency	Order > Metadata Consignment > Metadata Key Value: CarriageCurrency				The currency of the Carriage Value provided	The currency of Carriage Value provided
Shipper’s VAT Number	CustomsDocumentation > ShippersVatNumber	Mandatory: EU and Rest of World Pass “GBUNREG” if not VAT registered	Mandatory: EU and Rest of World	Mandatory for EU and ROW	Conditional: Mandatory if DDP Shipping Term is selected	Mandatory if sender is VAT registered				Mandatory
IOSS VAT ID Number	Order > Metadata Consignment > Metadata Key Value: IossVatIdentificationNumber	Required if shipping under IOSS scheme	Required if shipping under IOSS scheme NOTE: If shipping terms sent as DDU / DAP, IOSS number will be ignored.	Required if shipping under IOSS scheme		Required if shipping under IOSS scheme	Required if shipping under IOSS scheme	Required if shipping under IOSS scheme	Required if shipping under IOSS scheme	Required if shipping under IOSS scheme
Shipping Terms	CustomsDocumentation > ShippingTerms >	Mandatory: Only DAP or DDP Accepted Any other provided value will fail to return DPD services in any Quote, Allocation or Delivery Option result.	Mandatory: Home Delivery: DDU or DDP or DAP Parcelshop: DDP ONLY Any other provided value will fail to return Evri services in any Quote, Allocation or Delivery Option result.	Mandatory. Shipping terms are determined by shipper’s account number / department number.	Mandatory: DDU ONLY	Mandatory if DDP	Mandatory	Mandatory
Receiver’s EORI	Order > Metadata Consignment > Metadata Key Value: ReceiversEORI	Conditional: Receiver’s EORI number mandatory if the destination address is a business.		Optional: Required if the receiver is a business
Shipper’s EORI	Order > Metadata Consignment > Metadata Key Value: ShippersEORI	Mandatory: EU and Rest of World Pass “GBUNREG” if not VAT registered	Mandatory: for Commercial Invoice	Mandatory: for EU and Rest of World	Mandatory	Mandatory	Recommended for EU	Recommended for EU	Recommended for EU	Mandatory
Commercial Invoice Declaration	Order > Metadata Consignment > Metadata Key Value: CommercialInvoiceDeclarationStatement						Origin of Goods statement for preferential VAT rate			May be used for Origin of Goods statement for preferential VAT rate
Commercial Invoice Comments	Order > Metadata Consignment > Metadata Key Value: CommercialInvoiceComments									Additional comments for Commercial Invoice / paperless Max 150 characters
Package Description	Package > Description	Mandatory		Mandatory
Height	Package > Dimensions > Height
Length	Package > Dimensions > Length
Package Unit of Dimension	Package > Dimensions > Unit
Package Width	Package > Dimensions > Width
Maximum number of items	Package > Item >	Unbounded	Unbounded	Unbounded	10
Minimum number of items	Package > Item >	1	1	1	1
Country of Origin	Package > Item > CountryOfOrigin	Mandatory	Mandatory	Mandatory	Mandatory	Mandatory		Mandatory	Required for paperless trade	Required for paperless
Item Description	Package > Item > Description	Mandatory	Mandatory	Mandatory	Mandatory	Recommended if electronic Customs clearance required	Mandatory	Mandatory	Required for paperless trade
Item - additional reference	Package > Item > ItemReferenceProvidedByCustomer									Max 15 characters
Harmonisation Code	Package > Item > HarmonisationCode	Mandatory	Mandatory	Mandatory	Manadatory	Conditional: mandatory if electronic Customs clearance required	Mandatory if dutiable	Mandatory
Tariff Description	Package > Item > HarmonisationKeyWords			Mandatory if not shipping ‘Documents Only’ The Tariff Description should be taken from reputable source of information. For example, the trade tariff pages on gov.uk
Quantity	Package > Item > Quantity	Mandatory	Mandatory	Mandatory	Mandatory	Mandatory	Mandatory	Mandatory	Required for paperless trade	Required for paperless
Unit	Package > Item > Unit								Required for paperless trade	Required for paperless
Item Value	Package > Item > Value > Money > Amount	Mandatory	Mandatory	Mandatory	Mandatory	Mandatory	Mandatory	Mandatory	Required for paperless trade	Required for paperless
Currency	Package > Item > Value > Money > Currency > IsoCode	Mandatory	Mandatory	Mandatory	Mandatory	Mandatory	Mandatory	Mandatory	Required for paperless trade
Item Weight	Package > Item > Weight > Value	Mandatory	Mandatory	Mandatory		Mandatory			Required for paperless trade
Item unit of Weight	Package > Item > Weight > Weight Unit	Mandatory		Mandatory					Required for paperless trade
Duty Paid Value	Package > Metadata Key Value: DutyPaidValue		Conditional: Must be provided if the ShippingTerms = “DDP”			Conditional: mandatory if electronic Customs clearance required
Package VAT Value	Package > Metadata Key Value: VatValue		Conditional: Must be provided if the ShippingTerms = “DDP”
Package Value	Package > Value > Money > Amount	Mandatory		Mandatory
Package Currency	Package > Value > Money > Currency > IsoCode	Mandatory		Mandatory						Required for paperless
Package Unit of Weight	Package > Weight > Unit
Package Weight	Package > Weight > Value

Adding Metadata Properties

Some required fields for international shipments do not have a dedicated property in the PRO consignments data contract. You will need to record information for each of these fields using a Metadata property with a specific KeyValue.

The table below lists the fields that should be recorded as metadata, and their accompanying KeyValues.

Property	KeyValue
Shipper’s EORI	`ShippersEORI`
Receiver’s EORI	`ReceiversEORI`
Carriage Value Currency	`CarriageCurrency`
Duty Paid Value	`DutyPaidValue`
Package VAT Value	`VatValue`
IOSS Number	`IossVatIdentificationNumber`
Receiver Personal ID Number	`ReceiverPersonalID`

The example below shows a ShippersEORI value recorded using the Metadata property. The KeyValue denotes to PRO that this is a Shipper’s EORI, and the StringValue contains the EORI itself.

EORI Number Example

  {
    "ConsignmentReferenceProvidedByCustomer": "YOUR-REF",
    "Addresses": [
        // addresses
    ],
    "Packages": [
        // package properties
    ],
    "Metadata": [
        {
            "KeyValue": "ShippersEORI",
            "StringValue": "GB987654312000"
        }
    ]
    // other consignment properties
}

info

For more information on commercial invoices and other customs documents in the Consignments API package, see the Getting Customs Docs and Invoices page.

Consignments brexit data guide

Customs Documentation Required Data link

Carrier Data Requirements link

Affected Routes link

Data link

Adding Metadata Properties link

EORI Number Example link