This service retrieves shipment level pricing based upon the merchant location address, destination, and details of the parcel product selected. For convenience, the service is compatible with the Create Shipment service and accepts the same field details, The calculated price is related to your available postage products and contract rates.

Pricing for all products

This service can retrieve shipment-level pricing for all products on a billing account by omitting the product_id field.

Example Request

Example Response

Example Error Response

References

Request Field Reference

Element Name	Description	Optional / Mandatory	Type	Length
shipments	Shipment information is to be supplied for each delivery of items to a physical address.	Mandatory	Array
shipment_reference	A unique reference for the shipment, generated by the merchant.	Optional	String	50
customer_reference_1	A merchant specified reference for the shipment. This value is not required to be unique.	Optional	String	50
customer_reference_2	A merchant specified reference for the shipment. This value is not required to be unique.	Optional	String	50
email_tracking_enabled	Whether the recipient of the shipment will receive tracking notification email. The email address of the receiver must be provided if the email_tracking_enabled field is set to true.	Optional - for some products this defaults to true	Boolean - true or false	N/A
from	The address where the items will be sent from.	Mandatory
name	The name of the sender.	Mandatory	String	40
business_name	The name of the sending business.	Optional	String	40
type	The type of address. If this field is supplied, its value must be "MERCHANT_LOCATION".	Optional	String (See Desc.)
lines	The address lines of the address. Minimum of one address line, up to a maximum of three. The second address line can accommodate up to 60 characters.	Mandatory	Array	40
suburb	The suburb for the address.	Mandatory	String	40
state	The state code for the address. Valid values are: ACT, NSW, NT, QLD, SA, TAS, VIC, WA.	Mandatory	String	3
postcode	The postcode for the address.	Mandatory	String	4
phone	The sender’s phone number.	Optional	String	20
email	The sender’s email address.	Optional	String	50
to	The address where the items will be delivered.	Mandatory
name	The name of the receiver.	Mandatory	String	35
apcn	The Australia Post customer number.	Optional	String	10
business_name	The name of the business for the address.	Optional	String	40
type	The type of address. Valid values are: PARCEL_LOCKER - an address with this type represents an Australia Post Parcel Locker. PARCEL_COLLECT - an address with this type represents an Australia Post Parcel Collection location. STANDARD_ADDRESS - an address with this type represents a normal delivery address.	Optional	String (See Desc.)
lines	The address lines of the address. Minimum of one address line, up to a maximum of three. The second address line can accommodate up to 60 characters.	Mandatory	Array	40
suburb	The suburb for the address.	Mandatory	String	35
state	The state code for the address. Valid values are: ACT, NSW, NT, QLD, SA, TAS, VIC, WA.	Mandatory	String	3
postcode	The postcode for the address.	Mandatory	String	4
phone	The receiver’s phone number.	Optional	String	20
email	The receiver’s email address.	Optional	String	50
delivery_instructions	Instructions to aid in prompt delivery of the item.	Optional	String	128
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
product_id	The Australia Post code representing the postage product for the item.	Mandatory	String	5
item_description	A description of the item, generated by the merchant.	Optional	String
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
contains_dangerous_goods	Whether the item contains dangerous goods, generated by the merchant.	Optional. Defaults to false.	Boolean - true or false
authority_to_leave	Whether the item can be left in a safe place on delivery without receiving a signature. This is optional for domestic shipments, but must not be specified for international shipments.	Optional (See Desc.) - Defaults to true for Australia Post, and false for StarTrack.	Boolean - true or false
allow_partial_delivery	Whether items can be delivered to their final destination as they become available or whether all items in the resulting consignment must be delivered together.	Optional. Defaults to true.	Boolean - true or false	N/A
features	Additional features for the item.	Optional
name	Name of the feature. Eg: TRANSIT_COVER.	Mandatory	String
attributes	Additional information about the feature. Please note that attributes depend on the feature.	Depends on feature.	String
cover_amount	Cover amount.		Decimal	4.2
tracking_details	The merchant can optionally define the specific consignment, article, and barcode identifiers for the item. If this information is not supplied, Australia Post will generate the identifiers. Important note: if you are generating your own identifiers you must adhere to the specifications provided by Australia Post. Please contact Lodgement and APIs support for details.	Optional
consignment_id	The consignment ID, generated by the merchant, to be assigned to the item.	Mandatory	String	30
article_id	The article ID, generated by the merchant, to be assigned to the item.	Mandatory	String	30
barcode_id	The barcode ID, generated by the merchant, to be assigned to the item.	Mandatory	String

Response Field Reference

Element Name	Description	Type	Length
shipments	Shipment information for each shipment and items created.	Array
shipment_id	The identifier for the shipment generated by Australia Post.	String	50
shipment_reference	The reference for the shipment, generated by the merchant and passed in the request.	String	50
shipment_creation_date	The date and time that the shipment was created.	Date and time	N/A
email_tracking_enabled	Whether the recipient of the shipment will receive tracking notification email.	Boolean - true or false	N/A
from	The address where the items will be sent from. This must always be the address of the listed against the charge account used.
type	The classification for the address. Value returned will be: MERCHANT_LOCATION - an address with this type represents the physical address for the merchant’s location.	String
lines	The address lines of the address. A minimum of one address line, up to a maximum of three. The second address line can accommodate up to 60 characters.	String	40
suburb	The suburb for the address.	String	40
postcode	The postcode for the address.	String	4
state	The state code for the address. Valid values are: ACT, NSW, NT, QLD, SA, TAS, VIC, WA.	String	3
name	The name of the sender.	String	40
email	The sender’s email address.	String	50
phone	The sender’s phone number.	String	20
to	The address where the items will be delivered.
type	The type of address. Valid values are: PARCEL_LOCKER - an address with this type represents an Australia Post Parcel Locker. PARCEL_COLLECT - an address with this type represents an Australia Post Parcel Collection location. STANDARD_ADDRESS - an address with this type represents a normal delivery address.	String (See Desc.)
lines	The address lines of the address. A minimum of one address line, up to a maximum of three. The second address line can accommodate up to 60 characters.	String	40
suburb	The suburb for the address.	String	35
postcode	The postcode for the address.	String	4
state	The state code for the address. Valid values are: ACT, NSW, NT, QLD, SA, TAS, VIC, WA.	String	3
name	The name of the receiver.	String	50
apcn	The Australia Post customer number.	String	10
business_name	The name of the business for the address.	String	40
email	The receiver’s email address.	String	50
phone	The receiver’s phone number.	String	20
delivery_instructions	Instructions to aid in prompt delivery of the item.	String	128
items	An item element is to be supplied for each parcel.	Array
height	The height of the parcel in centimetres.	Decimal	4.1
length	The length of the parcel in centimetres.	Decimal	4.1
width	The width of the parcel in centimetres.	Decimal	4.1
weight	The parcel’s weight in kilograms.	Decimal	N.3
shipment_summary	Summary pricing information for the shipment.
total_cost	The total price of the shipment, including goods and services tax (G.S.T).	Decimal	N.2
shipping_cost	The shipping cost for this shipment.	Decimal	N.2
total_gst	The goods and services tax amount included in the total cost.	Decimal	N.2
status	The status of the item.	String
number_of_items	The number of items within the shipment.	Integer
tracking_summary	The number of items in the shipment for each delivery status. The delivery status will be listed with the number of items in the shipment where the delivery status has been applied.	Array

Code	Name	Example Message
42012	PRODUCT_NOT_SUPPORTED_BY_CONTRACT_ERROR	The product CODE you have entered is not available on your contract ACCOUNT for the destination postcode POSTCODE. For further assistance, please contact your Account Manager or call Australia Post on 13 21 31.
43017	ALL_OR_NONE_SHIPMENT_NO_ERROR	The request contains shipments with items that are missing barcode ids. Please add barcode ids to the items where the ids are missing, and resubmit your request.
44002	ALL_OR_NONE_AUSPOST_ID_ERROR	The request contains shipments with items that are missing a tracking identifier field. Please ensure that each item contains values for the fields consignment_id, article_id, and barcode_id, and resubmit your request.
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.
42002	NO_PRICES_FOR_PRODUCT	The service CODE is not available based upon the information submitted.
43003	UNABLE_TO_CALCULATE_PRICE	The service CODE is not available based upon the submitted weight of WEIGHT kg.
43004	UNABLE_TO_CALCULATE_PRICE	The service CODE is not available based upon the calculated cubic weight of WEIGHT kg for the submitted dimensions and weight.
42006	MAX_WIDTH	AP and On Demand: Maximum width must not exceed 113 cm ST: Unlimited
42007	MAX_HEIGHT	AP and On Demand: Maximum height must not exceed 113 cm ST: Unlimited
42008	MAX_LENGTH	AP and On Demand: Maximum length must not exceed 113 cm ST: Unlimited
42009	MAX_VOLUME	AP and On Demand: Maximum volume must not exceed 0.25 m3 ST: Unlimited
42010	MAX_WEIGHT	AP and On Demand: Maximum weight must not exceed 32 kg ST: Unlimited
42011	TWO_DIMENSIONS_LESS_THAN_5CM	At least 2 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 submit the request again.
44003	DANGEROUS_GOODS_NOT_ SUPPORTED_BY_PRODUCT_ERROR	The product CODE specified in an item has indicated that dangerous goods will be included in the parcel, however, the product does not allow dangerous goods to be sent using the service. Please choose a product that allows dangerous goods to be included within the parcel to be sent.
43009	MAX_LENGTH_CUSTOMER_REFERENCE_TEXT	A value for customer reference 1 or 2 exceeds the maximum limit of 50 characters. Please reduce the length of the value and submit the request again.
43011	MAX_LENGTH_DELIVERY_INSTRUCTION	A value for delivery instructions exceeds the maximum limit of 128 characters. Please reduce the length of the value and submit the request again.
400	MAX_LENGTH_DESTINATION_BUSINESS_NAME	Business name longer than 40 characters: VALUE
40002	JSON_MANDATORY_FIELD_MISSING	The input request is missing the mandatory field with the name 'FIELD NAME'. Please resubmit the request including the required fields and values.
44043	ITEM_DIMENSION_WEIGHT_NOT_APPLICABLE_ERROR	The product PRODUCT is a flat-rate product and must not include weight or dimensions.
66004	NO_CONTRACT_PRICING_AVAILABLE_FOR_SHIPMENT	None of the products in your contract are available for the submitted request.
400	Bad Request	None of the products in your contract are available for the submitted request.
400	Bad Request	Price requests without product_id cannot include multiple shipments

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.
44062	PARTIAL_DIMENSIONS_IN_SHIPMENT_WARNING	Incomplete dimensions supplied - price will be calculated on weight.
44061	PARTIAL_DELIVERY_NOT_APPLICABLE_WARNING	Partial delivery is not applicable for this product.

Resource Information

Service Capabilities