Royal Mail swagger documentation updates

Miscellaneous enhancements

The following enhancements have been made to the PROSHIPPING ROYAL MAIL API endpoints.

• Create Shipment: The following two new categories have been added to the Customs > ReasonForExport field in addition to the existing categories:
  • ECommerce Sale of Goods - for B2C or D2C shipments, such as goods sold directly to consumers via online retail.
  • Commercial Sale of Goods - for B2B shipments, covering business to business commercial sales.

This is done so that the shipments are correctly classified as e-commerce or commercial sales, ensuring compliance with Royal Mail's latest specification.

📘

Note

Please note that if the existing Sale of Goods value is selected as the reason for export, the system automatically determines whether the shipment is Ecommerce (B2C or D2C) or Commercial (B2B) based on the value provided in the BusinessTransactionType field in the create shipment request.

For more information, refer to the Royal Mail Create Shipment endpoint.

• Get Carrier Services. A new Services > Get Carrier Services endpoint has been added to the PROSHIPPING ROYAL MAIL API block, allowing users to retrieve the service levels associated with each requested service code.

Field description updates

The query and response field descriptions for the following PROSHIPPING ROYAL MAIL API endpoints have been updated to improve clarity and support correct usage of the API: