Generate Label Metadata

The generate_label_metadata flag is an optional flag that can be included by merchants who print their own labels, and require additional label metadata to incorporate into their labels. It can be included at the shipment level in the following requests: Create Shipment, Update Shipment, Create Order Including Shipments. It is available for domestic shipments only.

Element name	Description	Optional / Mandatory	Type	Length
generate_label_metadata	If set to True, the metadata for the label will be returned with the shipment, for the merchant to incorporate into their own label.	Optional	Boolean - true or false	N/A

There are a number of rules applicable when using the generate_label_metadata flag, detailed in the sections below.

Tracking Details allocation

Merchants can opt from the following two options, namely:

To manage the allocation of tracking_details. In which case only the consignment_id and article_id must be provided at the item level in the request.
Or
Not to include tracking_details in the request. In which case tracking details will be generated by the Shipping & Tracking APIs (note this option is not available for merchants using SSCC* numbers)

In both cases Australia Post will include the consignment_id, article_id, and barcode_id as part of the label metadata for each item in the response.

* SSCC: Serial Shipment Container Code: number plate used by merchant members of GS1.

Multiple Shipments or Items in a request

If there are multiple items in a create shipment request, the combination of tracking_details of each item must match.
If there are multiple shipments in a request, the combination of the generate_label_metadata flag and the item tracking_details must match for each of the shipments.
The maximum number of items that are allowed to be included in the request is 250.
When sending an Update Item request, the combination of tracking_details for any new or updated items must match that of the item/s provided in the original Create Shipment request.

Create / Get Label

A Create Label request will be rejected for the shipment. The label must be created by the merchant.
A Get Label request will therefore not be possible, as no request_id will be returned by a Create Label request.

Consolidation - Startrack

If the Consolidation flag is set to True, the value of the generate_label_metadata flag must match for two shipments to be eligible for consolidation.
When an item is updated, or a shipment is consolidated, the response will only include the label metadata of the new item / shipment.

Get Shipment

For a Get Shipment request, the label metadata will not be returned in the response. It will only be returned as part of the Create Shipment response.

Update Shipment – Labels required

If the generate_label_metadata flag was set to true when a shipment was originally created, label metadata is defaulted to true for any subsequent Update Shipment API call for that shipment even if the flag is not included in the payload.
To obtain the actual labels for the shipment from our APIs, the Update Shipment request needs to include "generate_label_metadata": false.

Product ID

The generate label metadata feature is available for most domestic product_ids.

Response Block Attributes:

label_metadata element	Description	Example	On shipping label
barcode_id	This article barcode string contains the following data pieces: For StarTrack: the article_id For Australia Post: It is a string that contains a GS1 compliant string with the following elements separated by GS1 Application identifiers: GTIN article_id destination postcode date and time of label being generated. The Australia Post 2D Datamatrix is the main barcode that supports automated parcel sorting and it is used for tracking and delivery of parcels.	StarTrack: LKIZ50000387EXP00001 Australia Post: 0199312650999998912JD020603601000931508\| 4203000\|9277215833	StarTrack: On article barcode AustraliaPost: In full On 2D Datamatrix symbol (replace pipe characters with Function1 symbol characters) In the linear barcode (only the GTIN section followed by the article id E.g.: 0199312650999998912JD020603601000931508)
routing_barcode	In the format “SSS9999DDD” where... SSS: is an alphanumeric value that represents a valid StarTrack Label Code. 9999: the four-digit Australian receiver postcode. DDD: is an alphanumeric value that represents a valid StarTrack nearest depot (for EXP and equivalent products) or a Primary Port Code (for PRM and equivalent products).	StarTrack: EXP3000MEL Australia Post: n/a	On StarTrack routing barcode
qr_2d_barcode	String that contains key values and it is used as a back-up of electronic manifest data.	StarTrack: MELBOURNE 3000LKIZ50000387LKIZ50000387EXP00001EXP 100092931 1 20210513Derrick Cummings BAGMEL 840 Osinski Radial NN Australia Post: n/a	On StarTrack QR barcode
consignment_id	A 7 or 8 digit number that together with the despatch id or Merchant location id (MLID) provides a unique id to the consignment.	StarTrack: LKIZ50000387 Australia Post: 2JD0206036	Displayed in human-readable format preceded by MLID or Despatch ID
article_id	Unique identifier of articles within a consignment.	StarTrack: LKIZ50000387EXP00001 Australia Post: 2JD020603601000931508	Displayed in human-readable format above/below the article barcode
nearest_depot	Alphanumeric code that indicates the Star Track depot nearest to the town/suburb. Used by the Express Network for correct parcel streaming.	StarTrack: MEL Australia Post: n/a	Displayed in human-readable format on ST Road (EXP) labels
primary_port	Alphabetic code used in the Premium network for correct parcel streaming.	StarTrack: MEL Australia Post: n/a	Displayed in human-readable format on ST Premium labels
secondary_port	Alphabetic code used in the Premium network for correct parcel streaming.	StarTrack: MEL Australia Post: n/a	Displayed in human-readable format on ST Premium labels

Generate Label Metadata

Tracking Details allocation

Multiple Shipments or Items in a request

Create / Get Label

Consolidation - Startrack

Get Shipment

Update Shipment – Labels required

Product ID

Response Block Attributes:

Request Payload example including the flag as true:

AP Create Shipment Request

ST Create Shipment Request

Response payloads for the label_metadata:

Response block example for an AP product:

Response block example for a ST product (EXP):

Response block example for a ST product (PRM):

Was this helpful?