ShipRate AU

Live shipping prices for a parcel sent WITHIN Australia, from two independent sources at once: Australia Post retail (PAC) and Easyship's pre-negotiated commercial courier panel. Returns every service with price, currency and transit time where available, cheapest first, plus a note on why the two sources are not directly comparable. Use when asked what it costs to send a parcel between Australian postcodes, or which courier is cheapest for a given weight and route.

{
  "type": "object",
  "properties": {
    "from_postcode": {
      "type": "string",
      "description": "Origin Australian postcode, e.g. '3000'."
    },
    "to_postcode": {
      "type": "string",
      "description": "Destination Australian postcode, e.g. '2000'."
    },
    "weight_kg": {
      "type": "number",
      "description": "Parcel weight in kilograms. AusPost caps domestic parcels at 22kg.",
      "minimum": 0.01,
      "maximum": 22
    },
    "length_cm": {
      "type": "number",
      "description": "Optional. Defaults to 30."
    },
    "width_cm": {
      "type": "number",
      "description": "Optional. Defaults to 22."
    },
    "height_cm": {
      "type": "number",
      "description": "Optional. Defaults to 10."
    },
    "category": {
      "type": "string",
      "description": "Optional goods category, needed by Easyship. One of: accessory_no_battery, accessory_with_battery, audio_video, bags_luggages, books_collectibles, cameras, computers_laptops, documents, dry_food_supplements, fashion, health_beauty, home_appliances, home_decor, jewelry, mobile_phones, pet_accessory, sport_leisure, tablets, toys, watches. Defaults to 'fashion'. Call list_goods_categories if unsure."
    },
    "value_aud": {
      "type": "number",
      "description": "Optional declared value in AUD. Defaults to 100. Does not affect domestic price, only insurance options."
    }
  },
  "required": [
    "from_postcode",
    "to_postcode",
    "weight_kg"
  ]
}

Live shipping prices for a parcel sent FROM Australia to another country, from Australia Post retail (PAC) and, where it can quote, Easyship's commercial panel. Returns each service with price and currency. Use when asked what it costs to post something overseas from Australia. Note that AusPost international prices are retail and exclude any destination duty or tax, which the recipient pays.

{
  "type": "object",
  "properties": {
    "country_code": {
      "type": "string",
      "description": "ISO-2 destination country code, e.g. 'US', 'GB', 'NZ', 'SG'."
    },
    "weight_kg": {
      "type": "number",
      "description": "Parcel weight in kilograms. AusPost caps international parcels at 20kg.",
      "minimum": 0.01,
      "maximum": 20
    },
    "from_postcode": {
      "type": "string",
      "description": "Optional origin Australian postcode, used for the Easyship leg. Defaults to '3000'."
    },
    "to_postcode": {
      "type": "string",
      "description": "Optional destination postal code. Improves commercial-panel accuracy; ignored by AusPost."
    },
    "to_city": {
      "type": "string",
      "description": "Optional destination city. Some couriers will not quote without it."
    },
    "to_state": {
      "type": "string",
      "description": "Optional destination state or province code."
    },
    "category": {
      "type": "string",
      "description": "Optional goods category for Easyship. One of: accessory_no_battery, accessory_with_battery, audio_video, bags_luggages, books_collectibles, cameras, computers_laptops, documents, dry_food_supplements, fashion, health_beauty, home_appliances, home_decor, jewelry, mobile_phones, pet_accessory, sport_leisure, tablets, toys, watches. Defaults to 'fashion'."
    },
    "hs_code": {
      "type": "string",
      "description": "Optional HS tariff code. More specific than category and matters for destination duty. Supplying this overrides category."
    },
    "value_aud": {
      "type": "number",
      "description": "Optional declared customs value in AUD. Defaults to 100."
    }
  },
  "required": [
    "country_code",
    "weight_kg"
  ]
}

Returns the exact goods categories the commercial rate source will accept. These are a fixed list, not free text: plausible-sounding values like 'general' or 'others' are rejected outright. Call this if a quote came back with a category error, or to pick the closest match before quoting.

{
  "type": "object",
  "properties": {},
  "required": []
}

Resolve an Australian postcode to its suburbs and state, or a suburb name to its postcode. Works in both directions. Use it to validate an address before quoting, or when a suburb name is ambiguous because the same name exists in several states.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "An Australian postcode such as 3000, or a suburb name such as Carlton."
    },
    "state": {
      "type": "string",
      "description": "Optional state filter: NSW, VIC, QLD, SA, WA, TAS, NT or ACT. Supply it when a suburb name exists in more than one state."
    }
  },
  "required": [
    "query"
  ]
}

Carriers charge on whichever is greater, actual weight or cubic (volumetric) weight, so a light bulky parcel costs far more than its scale weight suggests. Give the dimensions and actual weight and this returns the cubic weight under each common convention and which weight you would be charged on. Use it before quoting so the weight you pass to a quote tool is the one that will actually be billed.

{
  "type": "object",
  "properties": {
    "length_cm": {
      "type": "number",
      "description": "Longest side in centimetres."
    },
    "width_cm": {
      "type": "number",
      "description": "Width in centimetres."
    },
    "height_cm": {
      "type": "number",
      "description": "Height in centimetres."
    },
    "weight_kg": {
      "type": "number",
      "description": "Actual weight on the scales, in kilograms."
    }
  },
  "required": [
    "length_cm",
    "width_cm",
    "height_cm",
    "weight_kg"
  ]
}