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

NameTypeDescription
Tracking NumberStringThe consignment or tracking reference number.
CarrierStringThe carrier name (e.g., EVRI).
GFS API KeyCredentialsYour GFS Connect API key used to authenticate the request.

Outputs

NameTypeDescription
Found?Booleantrue if a matching consignment was found.
GFS IDStringThe internal identifier used in GFS Connect to reference the consignment.
Despatch DateStringThe shipment’s despatch date (YYYY-MM-DD format).
Full Finder DataObjectThe raw response object returned by the GFS Finder API

References

πŸ“˜ GFS Finder API Reference