Sandbox - Development API Requirements

Intersoft API is a fully RESTful service implemented using JSON messaging. You, as the customer are responsible for sending JSON messages and for maintaining the capability of receiving JSON messages in the format described in this documentation.

The API requires the user to provide a Bearer token. What a Bearer token is and how to generate one are explained in the Authentication section.

• Create Shipment - used to generate the delivery label(s) for your packages.
• Update Status to Cancel - used to cancel/ void a current shipping label. This can only be used before a shipment has been confirmed by being manifested.
• Manifest Shipments used to closeout shipments, which produces the collection manifest to be handed over to the driver and triggers electronic pre-advice and billing data to be sent to the carrier. This must be done before your shipments enter Royal Mail network. Not doing it may result in multiple issues such as delays, missing tracking, lack of notifications for your end consumers, surcharges etc.

📘

If your servers are based in China, we developed a dedicated API endpoint to connect to .cn domain.

To access this domain please change .net to .cn in the relevant endpoints that you will be using.
Example - for Create Shipment instead of https://api.intersoftsapient.net/v4/shipments/rm the URL should be changed into https://api.intersoftsapient.cn/v4/shipments/rm

Please note: as a backup - please develop .net as well.