null

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 4 Current »

Using RESTful Customer.API option, your system can pull data directly from OneFlo/efm App.

Implementation


Speak to your Account Manager who will help you work out if the API method is right for your system.

If it is, you will be provided with an API authentication token.

Your development team can then call our Customer.API Get Consignments with appropriate parameters.

Swagger: https://uat-apidocs.flipgroup.com.au/

GET Consignments

This method pulls unmanifested as well as manifested consignments with their full data set. The data here for each consignment includes:

  • connote number

  • any references

  • sender

  • recipient

  • service used

  • shipping units and their barcodes (including any dangerous goods or pallet information)

  • scan events if there are any

image-20240307-053817.png

GET Scans

This method allows a party to retrieve scan events from OneFlo/efm App

image-20241211-221349.png

Usage Recommendations

The endpoint can be used to retrieve a delta (just the changes) since the last time the scans were retrieved. This is recommended in lieu of providing a range of dates to retrieve data. To facilitate this, use the nextScanId to retrieve subsequent updates (e.g. every 15-60 minutes).

To do this, you’ll need to seed the nextScanId by grabbing a set of scan events from a range of date. Once you have received the first set of scan events, you grab the max(nextScanId) to seed for the recurring call: e.g.

https://api.flipgroup.com.au/customers/XXXXXX/scans?nextScanId=xxxxxxxxx

Technical Requirements

Postback - Technical Requirements

  • No labels