Auspost Shipping Pricing

Auspost Shipping Pricing · GPT Actions

Australia Post Domestic Parcel Postage Calculator

API for calculating domestic parcel postage rates in Australia.

  • GET /postage/parcel/domestic/calculate.jsonCalculate Domestic Parcel Postage
Original API schema
{
  "openapi": "3.0.0",
  "info": {
    "title": "Australia Post Domestic Parcel Postage Calculator",
    "version": "1.0.0",
    "description": "API for calculating domestic parcel postage rates in Australia."
  },
  "servers": [
    {
      "url": "https://digitalapi.auspost.com.au"
    }
  ],
  "paths": {
    "/postage/parcel/domestic/calculate.json": {
      "get": {
        "summary": "Calculate Domestic Parcel Postage",
        "operationId": "calculateDomesticParcelPostage",
        "tags": [
          "Parcel Postage"
        ],
        "parameters": [
          {
            "name": "from_postcode",
            "in": "query",
            "required": true,
            "description": "The postcode to send the parcel from",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to_postcode",
            "in": "query",
            "required": true,
            "description": "The destination postcode",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "length",
            "in": "query",
            "required": true,
            "description": "Length of the parcel in centimeters",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "width",
            "in": "query",
            "required": true,
            "description": "Width of the parcel in centimeters",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "height",
            "in": "query",
            "required": true,
            "description": "Height of the parcel in centimeters",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "weight",
            "in": "query",
            "required": true,
            "description": "Weight of the parcel in kilograms",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "service_code",
            "in": "query",
            "required": false,
            "description": "Code of the postage service (default: AUS_PARCEL_REGULAR)",
            "schema": {
              "type": "string",
              "default": "AUS_PARCEL_REGULAR"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "postage_result": {
                      "type": "object",
                      "properties": {
                        "service": {
                          "type": "string",
                          "description": "Name of the postage service"
                        },
                        "delivery_time": {
                          "type": "string",
                          "description": "Estimated delivery time"
                        },
                        "total_cost": {
                          "type": "string",
                          "description": "Total cost of the postage"
                        },
                        "costs": {
                          "type": "object",
                          "properties": {
                            "cost": {
                              "type": "object",
                              "properties": {
                                "item": {
                                  "type": "string",
                                  "description": "Name of the cost item"
                                },
                                "cost": {
                                  "type": "string",
                                  "description": "Cost of the item"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "ApiKeyAuth": []
          }
        ]
      }
    }
  }
}