| Excerpt |
|---|
Find out what endpoints are available in our Restful API Customer.API schema |
The following services are available for use within the OneFlo API.
Service | Function | Definition | Method | Expected Input (mandatory in bold) | Output | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Locations | Allows client to check if the location is a valid OneFlo location. |
|
| 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 |
| 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. |
|
| 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. |
| Full consignment information | Returns a consigment ID, a OneFlo generated Tracking number, and the consignment information. | ||||||
Consignments | . | Allows the client to query OneFlo for a (list of) consignment(s) based on the parameters of a search. |
|
| Consignment Object(s) | ||||||
Consignments | (ConsignmentID) | Allows the client to retrieve a specific consignment |
| Consignment ID (retrieved from the consignment call) | Consignment Object | ||||||
Consignments | Label | Allows the client to retrieve all labels associated to the Consignment |
| Consignment ID (retrieved from the consignment call) | A label (or set of) in PDF format. | ||||||
Consignments | Connote | Allows the client to retrieve a connote paperwork associated to the Consignment. There’s also an option to retrieve DG paperwork if necessary. |
| Consignment ID (retrieved from the consignment call) IncludeDG (flag - default:false) | A Connote in PDF format. May include DG paperwork in PDF if requested. | ||||||
Consignments | Proofofdeliveries | Allows the client to retrieve a (set of) proof of deliveries - or image that prove that a consignment has been delivered. |
| Consignment ID (retrieved from the consignment call) | An image as received from the carrier. Returns with the content type but it’s typically an image (PNG file) | ||||||
Services | Allows the client to get a list of contracted services for the account. |
| AccountId | Returns a list of services and their properties. |