Create Consignment - Restful API

Owned by Dennis Navarro
Last updated: Sept 19, 2024 by rossc
2 min read

 

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.

 

Typical System Process for Create Consignment

image-20240919-001351.png

Typical Workflow

  1. Receiver places an order

  2. Order prioritised and marked ‘Ready to dispatch’ in the sender system

  3. Order picked and packed

  4. Order marked ‘Picked and packed’ in the sender system

  5. Sender systems creates consignments and generates the required shipping documents using our APIs

  6. Senders system updated with tracking no

  7. Label and stage freight for pickup

  8. 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

 

 

Â