When a Shipment is created and lodged, a Label model will be created.


Properties are protected and can be accessed with their getPropertyName() getter method or set via setPropertyName(value) setter method.

carrierCarrierInterfaceThe carrier associated with the label.
rateRateThe Rate model associated with the label.
trackingNumber?stringThe tracking number the label is for.
labelId?stringThe carrier label ID.
labelData?stringThe raw data for the label. This is typically a base64encoded string representing a PDF, GIF or PNG for the actual label image.
labelMime?stringThe mime-type for the label data, which denotes the type of file the data is encoded for.
responsearrayThe raw response from the carrier for the consignment.