...
This method allows a party to retrieve scan events from OneFlo/efm App
...
The results will look like:
| Code Block |
|---|
{
"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 datedates. Once you have received the first set of scan events, you grab use the max(nextScanId) nextScanId provided in the response to seed for the recurring callsubsequence 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.