The Services API allows customer systems to discover which Freightways delivery or courier services are available for specific coordinates, as well as to verify whether a particular service standard (for example, “Overnight” or “Rural Delivery”) is supported for a given carrier and customer account.
Endpoints Overview
| Method | Endpoint | Purpose |
|---|---|---|
| GET | /v1/services |
Lists available services for a latitude / longitude pair (optionally filtered by carrier). |
| POST | /v1/carriers/{carrierName}/customers/{customerId}/service-availability |
Checks whether a given service is available for a carrier, customer and receiver address.Query Parameters |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
lat |
number (double) | ✅ | Latitude of the location. |
lon |
number (double) | ✅ | Longitude of the location. |
carrierName |
string | ✅ | Carrier ID to filter by. If omitted, all carriers are returned. |
Example Request
GET /v1/services?lat=-36.8485&lon=174.7633&carrierName=NZCouriers
Authorization: Bearer <token>
Accept: application/jsonExample Response 200
{
"carrierName": "NZCouriers",
"availableServices": [
{
"serviceStandard": "Overnight",
"description": "Next-business-day delivery",
"saturdayDelivery": false
}
]
}