{{ activeApiMethod.description }}
This service initiates the generation of labels for the requested shipments that have been previously created using the Create Domestic Shipments service.
Labels for a subset of items in a shipment can be generated by providing a list of item IDs.
Please Note: The maximum number of items for Parcel Post and Express Post domestic despatch movements is 20 items.
There is a one-step and a two-step process to generate a label:
The one-step process can be switched on by including the 'wait_for_label_url' parameter.
Please note: If using ZPL labels, there is a strict limit of 50 parcels per request for both modes of label printing
HTTP Response Code: 200
HTTP Response Code: 400
| Element Name | Description | Optional / Mandatory | Type | Length |
|---|---|---|---|---|
| preferences | The required preferences to be applied. | Mandatory | Array | |
| type | For printing preferences the type is "PRINT". | Mandatory | String | |
| groups | The required page format for the labels. | Mandatory | ||
| group | The label group to apply the print preference. Valid types are:
| Mandatory | String | |
| layout | The layout specifies the number of labels per page and the size of the page. The layout must be valid for the product types of the items in the shipment. Valid Layouts are:
| Mandatory | String | |
| branded | Whether the Australia Post branding should be included on the labels. If you are using purchased stationery from Australia Post, then the generated labels should not include the branding. Note that for international shipments, this field is ignored. | Mandatory | Boolean - true or false | |
| left_offset | Use this field to adjust the left margin of the page. | Mandatory | Integer | |
| top_offset | Use this field to adjust the top margin of the page. | Mandatory | Integer | |
| shipments | List each shipment for which you want labels generated. The print preferences will be applied to all the items in the shipments. | Mandatory | Array | |
| shipment_id | The Australia Post generated unique identifier for the shipment. | Mandatory | String | 50 |
| Element name | Description | Type | Length |
|---|---|---|---|
| message | A message related to the generation progress. | String | |
| code | A code related to the generation progress. Currently, the only code returned is 'Request actioned'. | String | |
| 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 |
| Code | Name | Example Message | More information |
|---|---|---|---|
| 44013 | SHIPMENT_NOT_FOUND_ERROR | The shipment with shipment id SHIPMENT you requested can not be found. Please check the shipment id requested and submit the request again. | |
| 44033 | NO_SHIPMENT_IN_REQUEST_ERROR | The Request you have entered does not contain any shipments to process. |