GFS Finder
The Finder API is used to perform a search, or lookup, to locate an individual consignment within the wider GFS Connect API. If found, the response contains the unique identifier for the consignment within the Connect API, and links to additional API endpoints that can be used to interact with the consignment.
Inputs
| Name | Type | Description |
|---|---|---|
| Tracking Number | String | The consignment or tracking reference number. |
| Carrier | String | The carrier name (e.g., EVRI). |
| GFS API Key | Credentials | Your GFS Connect API key used to authenticate the request. |
Outputs
| Name | Type | Description |
|---|---|---|
| Found? | Boolean | true if a matching consignment was found. |
| GFS ID | String | The internal identifier used in GFS Connect to reference the consignment. |
| Despatch Date | String | The shipment’s despatch date (YYYY-MM-DD format). |
| Full Finder Data | Object | The raw response object returned by the GFS Finder API |
References
Updated about 7 hours ago