Get Rates

POST /api/{apikey}/getRates

{
  "origin": {
    "suburb_origin": "BARANGAROO",
    "post_code_origin": 2000,
    "building_type": "business"
  },
  "destination": {
    "suburb_destination": "MELBOURNE",
    "post_code_destination": 3000,
    "building_type": "residential"
  },
  "items": [
    {
      "type": "Carton",
      "weight": 1,
      "length": 1,
      "width": 1,
      "height": 1,
      "quantity": 1
    }
  ]
}

Shipment Price

POST /api/{apikey}/shipments/price

{
    "origin": {
    "suburb_origin": "BARANGAROO",
    "post_code_origin": 2000,
    "building_type": "business"
    },
    "destination": {
    "suburb_destination": "MELBOURNE",
    "post_code_destination": 3000,
    "building_type": "residential"
    },
    "items": [
    {
        "type": "Carton",
        "weight": 1,
        "length": 1,
        "width": 1,
        "height": 1,
        "quantity": 1
    }
    ]
}

Validation

POST /api/{apikey}/shipments/validation

                           {
  "goods_description": "Itaque officia in qui nisi tempor quo",

  "shipper_name": "Duncan Lee",
  "shipper_last_name": "Glass",
  "shipper_phone": "+1 (642) 636-5335",
  "shipper_email": "samonixis@mailinator.com",
  "shipper_company": "Gross Everett Trading",
  "shipper_street": "Laboriosam veniam velit in dicta animi qui libero nisi omnis optio necessit",

  "receiver_name": "Hamilton Odonnell",
  "receiver_last_name": "Hoover",
  "receiver_phone": "+1 (846) 375-7302",
  "receiver_email": "gosakel@mailinator.com",
  "receiver_company": "Cabrera and Ashley Trading",
  "receiver_street": "Maiores elit facere rerum ab quam et ma",

  "sender_city_name": "NSW, 2000, Australia",
  "receiver_city_name": "VIC, 3000, Australia",

  "courier_id": "courier_please",
  "rate_id": "TE1",
  "selected_account": "band_5",
  "selected_courier": "courier_please",
  "rate_courier": "Courier Please",

  "origin": "BARANGAROO",
  "country_code_origin": "AU",
  "post_code_origin": "2000",
  "selected_origin": "Australia",
  "state_origin": "NSW",
  "origin_input": "2000 - BARANGAROO, NSW",
  "quote_origin": "20208",
  "bussines_type_origin": "business",

  "destination": "MELBOURNE",
  "country_code_destination": "AU",
  "post_code_destination": "3000",
  "selected_destination": "Australia",
  "state_destination": "VIC",
  "destination_input": "3000 - MELBOURNE, VIC",
  "quote_destination": "4746",
  "bussines_type_destination": "business",

  "dangerous": 1,
  "cp_signature_changes": 1,
  "agree2": 1,
  "agree3": 1,

  "packages": [
    {
      "description": "Carton",
      "weight": 1,
      "length": 1,
      "width": 1,
      "height": 1,
      "quantity": 1
    }
  ],

  "cost": 9.18
}

Create Shipment

POST /api/{apikey}/shipments/create

{
  "goods_description": "Itaque officia in qui nisi tempor quo",

  "shipper_name": "Duncan Lee",
  "shipper_last_name": "Glass",
  "shipper_phone": "+1 (642) 636-5335",
  "shipper_email": "samonixis@mailinator.com",
  "shipper_company": "Gross Everett Trading",
  "shipper_street": "Laboriosam veniam velit in dicta animi qui libero nisi omnis optio necessit",

  "receiver_name": "Hamilton Odonnell",
  "receiver_last_name": "Hoover",
  "receiver_phone": "+1 (846) 375-7302",
  "receiver_email": "gosakel@mailinator.com",
  "receiver_company": "Cabrera and Ashley Trading",
  "receiver_street": "Maiores elit facere rerum ab quam et ma",

  "sender_city_name": "NSW, 2000, Australia",
  "receiver_city_name": "VIC, 3000, Australia",

  "courier_id": "courier_please",
  "rate_id": "TE1",
  "selected_account": "band_5",
  "selected_courier": "courier_please",
  "rate_courier": "Courier Please",

  "origin": "BARANGAROO",
  "country_code_origin": "AU",
  "post_code_origin": "2000",
  "selected_origin": "Australia",
  "state_origin": "NSW",
  "origin_input": "2000 - BARANGAROO, NSW",
  "quote_origin": "20208",
  "bussines_type_origin": "business",

  "destination": "MELBOURNE",
  "country_code_destination": "AU",
  "post_code_destination": "3000",
  "selected_destination": "Australia",
  "state_destination": "VIC",
  "destination_input": "3000 - MELBOURNE, VIC",
  "quote_destination": "4746",
  "bussines_type_destination": "business",

  "dangerous": 1,
  "cp_signature_changes": 1,
  "agree2": 1,
  "agree3": 1,

  "packages": [
    {
      "description": "Carton",
      "weight": 1,
      "length": 1,
      "width": 1,
      "height": 1,
      "quantity": 1
    }
  ],

  "cost": 9.18
}

Generate Label

GET /api/{apikey}/shipments/label?consignmentNumber=XXXX

{
  "success": true,
  "data": {
    "label_url": "https://example.com/label.pdf"
  }
}

Error Codes