Support Portal

Welcome
Login

New API-Parameters for Northern Ireland Deliveries - POST Labels

Windsor Framework - Northern Ireland

As of September 30, 2024, new arrangements under the Windsor Framework will be implemented for deliveries to Northern Ireland. As a result, Seven Senders will require additional parameters during the label creation process. This information will be communicated to the carriers to ensure compliance for deliveries from the GB mainland to Northern Ireland.

Additional Parameter in POST Labels Request

Almost all of the additional parameters are information provided in the POST Customs Shipment Request when Seven Senders is used as the customs broker. The new Northern Ireland requirements mandate that this information also be included in the POST Labels Request, as the data must be transmitted to the carriers in GB.

Parameter Introduction for NI Deliveries

Below are the additional parameters with descriptions and examples. Note that these are the additional parameters and you must also provide the existing POST Labels request parameter.

ParameterTypeDescriptionExample
parcelJSONobject (max one object per label request) 
parcel.descriptionstring
(32 chr.)
description of the parcel contentsmobile phone case and charger
parcel.skusJSONobject (multiple objects per label request possible)
parcel.skus.
article_id
string
(30 chr.)
internal reference for an article/SKUEP2017002392
parcel.skus.
arrival_country_description
string
(248 chr.)
description of the SKU in Englishliquid silicone case for mobile phone
parcel.skus.
arrival_country_tariff_number
string
(10 chr.)
commodity code of the article according to the legislation in the arrival country6109100000 
parcel.skus.
sales_value_total
floatsales value (VAT included)19.99
parcel.skus.
currency
string
(3 ltr. ISO)
ISO currency code of the arrival country of the shipmentGBP
parcel.skus.qtyintegerItem quantity for the specific SKU3
parcel.skus.
total_net_weight
floatweight for one item of the specific SKU0.2
parcel.skus.
country_of_origin
string
(2 ltr. ISO)
ISO-2 country code for the country of origin of the article (where it was produced).CN
parcel.skus.
return_reason
stringReturn reason for return label creation (why the item is being returned)mobile phone case was broken

Example Request Body for NI Deliveries (additional parameter)

Below is an example request body with the additional parameters for NI Shipments/Labels:

Additional Parameter for NI Labels - POST Labels
"parcel": {    
            "description""mobile phone case",    
            "skus": [        
                      {            
                       "article_id""EP2017002392",              
                       "arrival_country_description""liquid silicone case for mobile phone",                           "arrival_country_tariff_number""6109100000",                       
                       "sales_value_total"19.99,           
                       "currency""GBP",          
                       "qty"3,          
                       "total_net_weight"0.2,           
                       "country_of_origin""CN",          
                       }
                     ]
        }

Carrier-specific mandatory fields and optional fields 

The carrier-specific mandatory and optional fields are shown below:

ParameterEvriRoyal MailYodelDHL GB
parcel
parcel.descriptionmandatoryoptional
optionaloptional
parcel.skus
parcel.skus.article_idoptionalmandatory
optionaloptional
parcel.skus.arrival_country_descriptionmandatorymandatorymandatorymandatory
parcel.skus.arrival_country_tariff_numberoptionalmandatoryoptionalmandatory for B2B
parcel.skus.sales_value_totalmandatorymandatorymandatorymandatory
parcel.skus.currencyGBPGBPGBP
GBP
parcel.skus.qtymandatory
mandatorymandatory
mandatory
parcel.skus.total_net_weightoptionalmandatorymandatorymandatory
parcel.skus.country_of_originoptional
mandatoryoptionalmandatory
parcel.skus.return_reasonnot needednot needednot needednot needed

Case - Return Label Creation

No NI specific parameters are required to create the return labels. There is NO additional data required for returns from NI to UK mainland. Therefore we will keep the integration as it is for returns (from BT to mainland) as no additional data is required. For return labels creation from UK mainland to NI, we are awaiting further information from HMRC. However, this scenario should not be a valid use case for Seven Senders Labels and Shipments.


Special case Yodel - NI Outbound Label Creation

If you are shipping to Northern Ireland with Yodel, the dimension parameters are mandatory. Therefore, please also submit the following object in the POST Labels API:

    "dimension": {        
                   "height"0,        
                   "length"0,        
                    "width"0    
                 }

If you are unable to pass the "dimensions" object to the Seven Senders API, please contact your Seven Senders representative.


Did you find it helpful? Yes No