This service retrieves valid postage products and pricing based upon the merchant location address, destination, and details of the parcel for eParcel Accounts. Use this web service when the user interface is required to present user product and pricing options for delivery.

An estimated price for valid products, for one or more items to be delivered to a single address is returned based on the request query. The calculated price is related to your available postage products and contract rates.

Please Note: The maximum number of items for Parcel Post and Express Post domestic despatch movements is 20 items.

Surcharges

This service provides information about services and base pricing excluding surcharge pricing.

If you require the full price breakdown which includes the surcharge amounts, please refer to Get Shipment Price. This will give you the full service price including any surcharges that apply (including fuel surcharge).

Example Request

Example Response

Example Error Response

References

Request Field Reference

Element name	Description	Optional / Mandatory	Type	Length
from	The address where the items will be sent from.	Mandatory
postcode	The postcode where the items will be sent from.	Mandatory	String	4
to	The address where the items will be delivered.	Mandatory
postcode	The postcode where the items will be delivered.	Mandatory	String	4
items	An item element is to be supplied for each parcel. Important Note: The maximum number of items for Parcel Post and Express Post domestic despatch movements is 20 items	Mandatory	Array
item_reference	A unique reference for the item, generated by the merchant.	Optional	String	50
length	The length of the parcel in centimetres. If volumetric pricing applies then this is mandatory.	Optional (See Desc.)	Decimal	4.1
width	The width of the parcel in centimetres. If volumetric pricing applies then this is mandatory.	Optional (See Desc.)	Decimal	4.1
height	The height of the parcel in centimetres. If volumetric pricing applies then this is mandatory.	Optional (See Desc.)	Decimal	4.1
weight	The parcel’s weight in kilograms.	Mandatory	Decimal	N.3
features	Additional features for the item.	Optional	List
type	Type of additional feature. Eg: TRANSIT_COVER.	Mandatory	String
attributes	Additional information about the product. Please note that feature attributes depends on the feature type.	Depends on feature type	String
cover_amount	The amount of cover required.		Decimal	4.2

Response Field Reference

Element name	Description	Type	Length
items	Items that were successfully priced are returned with the applicable product information.	Array
item_reference	A unique reference for the item, generated by the merchant.	String	50
length	The length of the parcel in centimetres.	Decimal	4.1
width	The width of the parcel in centimetres.	Decimal	4.1
height	The height of the parcel in centimetres.	Decimal	4.1
weight	The parcel’s weight in kilograms.	Decimal	N.3
prices	The product information and associated pricing for each of the products that can be validly applied to the item.	Array
product_id	The Australia Post identifier for the product.	String	5
product_type	The displayable name for the product.	String	30
options	Options available for the postage product.
authority_to_leave_option	Whether the option for "authority to leave" is available for the postage product.	Boolean - true or false
signature_on_delivery_option	Whether the option for "signature on delivery" is available for the postage product.	Boolean - true or false
calculated_price	The estimated total price, including goods and services tax (G.S.T) for sending the item using the product, when the item is not included as a subsequent item in a bundle.	Decimal	N.2
calculated_gst	The goods and services tax (G.S.T) that is included in the estimated total price.	Decimal	N.2
bundled_price	The estimated total price for sending the item using the product, when the item is included as a subsequent item in a bundle.	Decimal	N.2
bundled_gst	The goods and services tax (G.S.T) that is included in the estimated bundled price.	Decimal	N.2
features	Additional features available for the product and its corresponding prices. This is optional as some products may not have any additional features.
type	A unique string that identifies the type of feature. Currently, the only additional feature available is TRANSIT_COVER.
attributes	Additional attributes relevant to the feature.
rate	The percentage rate used to calculate fees. eg: If the rate is 1.5 and the user opts for a cover of $500, the transit cover fee is 500*1.5/100 = $7.50. This includes tax.	Decimal	2.2
cover_amount	The requested cover amount.	Decimal	N.2
included_cover	The amount of transit cover bundled with this product. It means that this transit cover amount is included in the selected product.	Integer
maximum_cover	The maximum cover possible for the product.	Integer
price	Price related information of the feature.
calculated_price	Price for the feature.	Decimal	N.2
calculated_gst	GST included in the price.	Decimal	N.2
errors	Any errors that occurred when processing the request.	Array
code	The code for the error.	String
name	The name or category for the error.	String
message	The description of the error.	String
context	A map of values that attempts to highlight important information that may have caused the error.This may or may not be populated depending on the type of error.	Map
warnings	Any warnings that occurred when processing the request.	Array
code	The code for the error.	String
name	The name or category for the error.	String
message	The description of the error.	String
context	A map of values that attempts to highlight important information that may have caused the warning.This may or may not be populated depending on the type of warning.	Map

Code	Name	Example Message
41001	CUSTOMER_NOT_FOUND	Customer information for the submitted customer identifier ACCOUNT could not be found. For further assistance please contact your Account Manager or call Australia Post on 13 21 31.
41002	ACCOUNT_NOT_FOUND	An account with the id of ACCOUNT cannot be found. Please check that the identifier is correct and submit the request again.
41003	CONTRACT_NOT_VALID_ERROR	The contract for the charge account with number ACCOUNT has expired or is not yet valid. For further assistance please contact your Account Manager or call Australia Post on 13 21 31.
41007	FROM_POSTCODE_DOES_NOT_ MATCH_CONTRACT_ORIGIN_POSTCODE	The postcode POSTCODE submitted for the sender "from" address does not match the lodgement postcode POSTCODE the contract. Please change the sender "from" postcode to match the lodgement postcode in the contract and attempt the request again.
42001	NO_PRODUCTS_FOUND	The submitted sender postcode POSTCODE and the destination postcode POSTCODE did not result in any postage services for the contract.
42006	MAX_WIDTH	The maximum width must not exceed 105 cm
42007	MAX_HEIGHT	The maximum height must not exceed 105 cm
42008	MAX_LENGTH	The maximum length must not exceed 105 cm
42009	MAX_VOLUME	The maximum volume must not exceed 0.25 m3
42010	MAX_WEIGHT	The maximum weight must not exceed 10000 kg
42011	TWO_DIMENSIONS_LESS_THAN_5CM	At least two dimensions must be 5 cm
44010	MAX_LENGTH_MERCHANT_REFERENCE_TEXT	A value for merchant reference exceeds the maximum limit of 50 characters. Please reduce the length of the value and resubmit the request.
66004	NO_CONTRACT_PRICING_AVAILABLE_FOR_SHIPMENT	Your account currently does not have a contracted rate for this product, "from" and "to" lane combination in shipment SHIPMENT ID - please contact your account manager for further information.

Resource information

Service capabilities