The following services are available for use within the OneFlo API.
Service | Definition | Method | Expected Input | Output |
|---|---|---|---|---|
Locations | Allows client to check if the location is a valid OneFlo location. | GET |
| 200 (success) - returns a location object 400 (invalid) |
OrderLookup | Allows client to create an Order dataset within OneFlo for use in Order Lookup - RESTful (API) Method | POST | Order Data | 200 (success) - indicates that the Order is available for retrieval within the OneFlo Portal |
Quotes | Allows the client to retrieve indicative pricing information based on the rate card assigned in OneFlo. | POST |
| Returns a list of service offerings by OneFlo that will be able to service the lane. |
Consignments | Allows the client to create a consignment in the OneFlo system. | POST | Full consignment information | Returns a consigment ID, a OneFlo generated Tracking number, and the consignment information. |
Consignments / Label | Allows the client to retrieve all labels associated to the Consignment | GET | Consignment ID (retrieved from the consignment call) | A label (or set of) in PDF format. |
Services | Allows the client to get a list of contracted services for the account. | GET | Returns a list of services and their properties. |