RESTful API - System Component Map

The diagram shows the 4 main endpoints used in the process of creating a consignment using the Restful API method

1. Validate Address - This is to ensure your locality, postcode and state combination will not be rejected by our system

2. Retrieve Quote - This is to ensure that you select the appropriate service based on the parameters of your shipment. From this quote, the cost of the shipment can be retrieved and saved in your system. Most importantly, you can select the carrier service to use in your consignment. Select the first in the list if you are using Least Cost Routing (ie the cheapest service). Otherwise display the list to your user so they can select what is most appropriate given price and ETAs

3. Save Consignment - Based on 1 and 2 above, save the consignment and retrieve the consignment id and connote number to save in your system

4. Retrieve Labels - This will return a PDF which you can send to the appropriate print queue on your network to print

Open