Skip to content

Frequent rates examples

Example 1: Quote with everyday pricing (default)

Section titled “Example 1: Quote with everyday pricing (default)”

When your account is set to display everyday pricing, the standard quote response includes tier options as additional choices.

Terminal window
curl -X POST \
-H "Api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"declared_value": "1000.00",
"referrer": "API",
"requesting_site": "http://www.example.com",
"tailgate_pickup": true,
"tailgate_delivery": true,
"items": [
{
"weight": "5",
"height": "25",
"width": "35",
"length": "40",
"quantity": 1,
"description": "carton"
}
],
"sender": {
"postcode": "2000",
"suburb": "SYDNEY",
"type": "business",
"country": "AU"
},
"receiver": {
"postcode": "3000",
"suburb": "MELBOURNE",
"type": "business",
"country": "AU"
}
}' \
https://www.transdirect.com.au/api/bookings/v4

The couriers_please quote shows the everyday price at the top level, with tier options in the tiers array:

{
"couriers_please": {
"total": 11.03,
"price_insurance_ex": 11.03,
"fee": 0,
"applied_gst": 1.11,
"insured_amount": 0,
"service": "road",
"transit_time": "0-1 Business Days",
"pickup_dates": ["2025-06-06", "2025-06-07"],
"pickup_time": {
"from": "09:00",
"to": "17:00"
},
"tiers": [
{
"identifier": 1,
"description": "Multipickup 10",
"total": 6.96,
"price_insurance_ex": 6.96,
"fee": 0,
"applied_gst": 0.64,
"insured_amount": 0
},
{
"identifier": 2,
"description": "Multipickup 21",
"total": 5.75,
"price_insurance_ex": 5.75,
"fee": 0,
"applied_gst": 0.53,
"insured_amount": 0
}
]
}
}

In this example:

  • Everyday price: $11.03
  • Multipickup 10 (Tier 1): $6.96 — 37% saving
  • Multipickup 21 (Tier 2): $5.75 — 48% saving

Example 2: Quote with frequent rates enabled

Section titled “Example 2: Quote with frequent rates enabled”

When your account is set to always display frequent rates, the top-level price reflects the Frequent User rate and the tiers array is not included:

{
"couriers_please": {
"total": 5.75,
"price_insurance_ex": 5.75,
"fee": 0,
"applied_gst": 0.53,
"insured_amount": 0,
"service": "road",
"transit_time": "0-1 Business Days",
"pickup_dates": ["2025-06-06", "2025-06-07"],
"pickup_time": {
"from": "09:00",
"to": "17:00"
}
}
}

Example 3: Confirming with a frequent rate tier

Section titled “Example 3: Confirming with a frequent rate tier”

To confirm a booking at a specific tier, include the tier parameter in the confirmation request:

Terminal window
curl -X POST \
-H "Api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"courier": "couriers_please",
"pickup_date": "2025-09-17",
"tier": 2
}' \
https://www.transdirect.com.au/api/bookings/v4/725625/confirm

A successful confirmation returns a 204 No Content response.

Example 4: Confirming with Aramex frequent rates

Section titled “Example 4: Confirming with Aramex frequent rates”

The same tier system applies to Aramex:

Terminal window
curl -X POST \
-H "Api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"courier": "aramex",
"pickup_date": "2025-09-17",
"tier": 2
}' \
https://www.transdirect.com.au/api/bookings/v4/725625/confirm