GSS Freight API

Freight API provides programmatic access to GSS functionality and content.

The API is REST API and uses single token key authentication. Currently, return format for all endpoints is JSON.

---

Checklist

• You need a GSS access token
• Familiarize yourself with API functionality
• Hack away

---

Things you should know

• Ensure you calls to the api are capable of handling errors and downtime
• Fields may be added to the endpoints are any time, ensure you conversions are capable of handling this
• Fields names are not case sensitive

SDK

• C# Sample

Endpoints

Publish Orders

• GET v2/pendingorders
• GET v2/order
• POST v2/neworder
• POST v2/neworders

Rates Query

• POST ratesquery/availablerates

Create and Print Shipments

• POST ratesquery/printcheapestcourier
• POST ratesquery/createandprint
• POST v2/publishmanifest
• POST ratesquery/reprint
• POST v2/deleteconnote
• GET labels/download

Tracking

• POST v2/shipmentstatus

FAQ

How do I connect to the API?

The API is only available to authenticated clients. Clients should authenticate users using [access_key]. Once authenticated, you need to request a resource from one of the endpoints using HTTP. Generally, reading any data is done through a request with GET method.

What return formats do you support?

Freight API currently returns data in JSON format. Some methods may return [XML] data, however we don't actively test for XML compatibility.

What kind of authentication is required?

Applications must identify themselves to access any resource. You need to contact your account manager to obtain a test access key.

Is there a request rate limit?

Presently there is no rate limiting on the api. We however reserve the right to enforce limits or block calls at our discretion.

Shoud I crack on?

Sure, fire away, however, we do suggest you talk to us, prior to starting so we can understand your requirements and explain how best to use this api.