| Excerpt |
|---|
Our API services are best used when your system is capable of integrating via web calls using REST. |
To expedite your despatch process by reducing double data entry and the risk of human error, your system can create consignments and generate the required shipping documents using our Restful API endpoints. Maintaining and deleting consignments will happen in OneFlo / efmApp. The Despatch Team will continue to use OneFlo / efmApp to create pickups, generate the manifest documents, transfer the consignment data to the carrier, and see tracking events. |
| Table of Contents | ||
|---|---|---|
|
Typical System Process for Create Consignment
...
Further Information
...
Typical Workflow
Receiver places an order
Order prioritised and marked ‘Ready to dispatch’ in the sender system
Order picked and packed
Order marked ‘Picked and packed’ in the sender system
Sender systems creates consignments and generates the required shipping documents using our APIs
Senders system updated with tracking no
Label and stage freight for pickup
Generate manifest document + transfer shipment data to the carrier in the OneFlo / efmApp
Restful API
Our Create Consignment process follows a RESTful API Architecture.
A RESTful API -- also referred to as a RESTful web service or REST API -- is based on representational state transfer (REST), which is an architectural style and approach to communications often used in web services development.
REST technology is generally preferred over other similar technologies. This tends to be the case because REST uses less bandwidth, making it more suitable for efficient internet usage. RESTful APIs can also be built with programming languages such as JavaScript or Python.
Further Information
| Child pages (Children Display) | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|