The Consignments API is a RESTful web service that provides powerful import and update functionality for consignments, delivery documents, and manifests. It offers flexibility for customers who want to build their own flow to fit in with their business processes. The API is built using HTTP and JSON. By integrating with this service, you can streamline your operations and manage your delivery processes directly from your own systems.
This API provides crucial functionality, including:
- Importing consignments: Easily import your consignments, either one by one or in batches.
- Updating consignments: Modify existing details for a specific consignment after it has been imported.
- Cancelling consignments: Invalidate and cancel a previously created consignment.
- Retrieving consignment details: Access comprehensive information and the current status for a specific consignment.
- Accessing necessary documents: Once a carrier and service is allocated (either specified in the API or based on your configured rules), a delivery label and any necessary customs documentation are generated instantly.
- Manifesting consignments: Finalise your consignments for carrier collection by generating manifest documentation.