API development requirements for Sandbox
The development of some basic API calls is a process of creating and testing essential API functions that are fundamental to the operation of a software application. These initial API calls are typically recommended to handle core functionalities that the software can rely on once it is fully operational.
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 section.
ImportantPrior to going live on SAPIENT, provide a bearer token. See Authentication for details.
As a minimum, have the following API calls developed:
Generate the delivery labels for your packages.
Cancel/void a current shipping label. Can only be used before a shipment has been confirmed by being manifested.
Closeout shipments to produce the collection manifest (Royal Mail Sales Order Summary) and trigger electronic pre-advice and billing data to be sent to the carrier.
ImportantManifest your shipments before they enter the Royal Mail network. Not doing so may result in delays, missing tracking, lack of notifications for your end consumers, surcharges, and other issues.
International Arrivals Containers (A-Scan) — Freight 2 Post customers only
These API calls are mandatory for Freight 2 Post customers. Freight 2 Post customers must manifest their shipments by container.
Create and name (with an ID or alias) a new International Arrivals Container for manifesting a specific group of shipments.
Get a list of all International Arrivals Containers set up on the system.
Update details of an International Arrivals Container.
Allocate shipments to a container or remove them before manifesting.
Delete a specific container.
Get details for a specific container.
NoteAt INTERSOFT, we have developed a dedicated API endpoint for servers based in China. To access this, kindly change your domain from .net to .cn for all the relevant endpoints you will be using.
For example, when creating a new shipment replace thehttps://api.intersoftsapient.net/v4/shipments/rm URL with https://api.intersoftsapient.cn/v4/shipments/rm.
As a back-up, please develop .net as well.
See also
Updated 12 days ago