Create Shipment

Create a Royal Mail shipment. This will return an image of the shipping label in PDF, PNG or ZPL format.

Body Params

Shipment Details

ShipmentInformation
object
required

Used to provide shipment-level information such as service code, content type, general goods description, total shipment weight and value etc.

Shipper
object
required

Used to provide shipper details such as address, contact details, VAT and EORI number etc.

Destination
object
required

An object providing details on the shipment destination, such as receiver and contact details.

CarrierSpecifics
object

Royal Mail-specific features that can be used when creating a Royal Mail shipment.

Packages
array of objects
required

Used to provide information on the packages that are being sent in this shipment.


Note: You must add at least one package to the shipment.You can add a maximum of 50 packages in a single shipment.If the number of packages exceeds 50, an error will be returned, and the shipment will not be created.

Packages*
Items
array of objects | null

Used to provide information on the individual goods/products being shipped within the package. This includes vital details, such as SKU code for inventory tracking, quantity of each item, description for clarity, and shipping specifics like weight, customs classifications (HS Code), and country of origin.

Note: The item information is only required for dutiable shipments.Non-Dutiable and Documents Only (DOX) shipments do not require item information. Please be advised that the item verification on a shipment is done via Hurricane services; therefore, it should be enabled.The maximum number of distinct items that will be verified in a single shipment is 15.

Items
Customs
object

Used to provide information for customs clearance related to the shipment. This includes, reasons for export, applicable incoterms, any pre-registration numbers and type required, shipping and other charges, as well as details about the invoice and whether an export license is needed. It ensures compliance with international shipping regulations.

ReturnToSender
object

Used to provide the address details to be used when returning the shipment back to the sender.

Responses

401

Unauthorized

403

Forbidden

404

The carrier was not found.

500

Internal Server Error

Language
Credentials
OAuth2
Response
Choose an example:
application/json