{{ activeApiMethod.description }}

Resource information

Rate Limited?: No
Requests per rate limit window: -
Authentication: Secure API Key
Response Formats: pdf

HTTP Methods: GET
Resource family: Orders
Response object: -
API Version: v1.0

Service capabilities

This service returns the PDF order summary that contains a charges breakdown of the articles in the order.

Example Request

GET: https://digitalapi.auspost.com.au/shipping/v1/accounts/0000123456/orders/AP0000002422/summary

Example Response

HTTP Response Code: 200

Response content type is application/pdf

Example Error Response

HTTP Response Code: 400

References

Error Response Field Reference

Element Name	Description	Type	Length
errors	The error codes and descriptions related to the action attempted.	Array
code	The code associated with the error.	String
name	The name category for the error.	String
message	The human readable error message.	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

Error Code Reference

Code	Name	Example Message
44026	ORDER_NOT_FOUND	An order with order id ORDER cannot be found. Please check that the identifier is correct and submit the request again.