Postback - via API
- rossc
- Zoe Perryman
- Dennis Navarro
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: Flip API Documentation
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
GET Scans
This method allows a party to retrieve scan events from OneFlo/efm App
The results will look like:
{
"noOfResults": 1,
"nextScanId": 550000001,
"scanEvents": [
{
"consignmentId": 12345678,
"connote": "connote",
"consignmentReference": "reference",
"occurredAtLocalTime": "2024-12-09T12:41:58",
"code": "code",
"description": "string",
"extraInfo": "string",
"barcode": "string",
"itemNumber": 1
}
]
}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 dates. Once you have received the first set of scan events, you use the nextScanId provided in the response to seed for the subsequence calls: e.g.
https://api.flipgroup.com.au/customers/XXXXXX/scans?nextScanId=xxxxxxxxx&maxResults=1000
The response from each call will return an updated nextScanId, which should be used in the next call. This should be repeated until noOfResults is returned as less then the supplied maxResults (eg 1000) which means there are no more results to retrieve at this time.