Create Shipment

A unique identifier assigned to the shipment by the carrier. This ID is useful for tracking and managing the shipment throughout its transit journey and can be used in future queries or to reference the specific shipment. <br /> <br />Note: This field is only populated if a consignment service was used in the request.

A unique identifier assigned to the entire consignment shipment by the carrier. This number allows shippers and recipients to track the status and location of the entire shipment throughout its transit. It is useful for monitoring progress, ensuring timely delivery, and addressing any issues that may arise during transportation. <br /> <br />Note: This field is only populated if the service is a consignment service.

A URL link provided by the carrier that allows the shipper and recipients to access real-time tracking information about the consignment shipment. This link directs users to the carrier's website where they can view detailed status updates and current location of the shipment. <br /> <br />Note: This field is only populated if this feature is available and the service is a consignment service.

Returns the generated shipping labels for the shipment. This field is populated only if the requested action was "Process." The labels include the necessary barcodes and shipping information required for effective transit and delivery of the packages.<br/><br/>Note: This field has the following reservations: <br/><ul><li>This field returns the labels only if the ReturnLabelsAtPackageLevel field is set to false.</li><li>In addition to the shipping label, this field also returns the ID8000 label for Class 9 hazardous products—provided that the PrintId8000Label field in the request parameters is set to true.</li></ul><br/>

Specifies the format of the shipping label that will be returned in the createShipment response. <br />The following are the valid values: <br /><ul><li>PDF - returns a Base64-encoded PDF</li><li>PNG - returns a Base64-enconded PNG</li><li>ZPL203DPI - returns Base 64 encoded text for Zebra printer at 203 DPI</li><li>ZPL300DPI - returns Base 64 encoded text for Zebra printer at 300 DPI</li><li>DATASTREAM - returns the label elements such as tracking URL, barcode number, 2D barcode image etc. for the label to be created in your own system, rather than returning a label image</li><li>PDF4X3 - returns a Base64-encoded 4x3 format PDF</li><li>PNG4X3 - returns a Base64-enconded 4x3 format PNG</li></ul>

This object is only returned if the shipment is dutiable and the requested action was "Process." This object includes any requisite documentation necessary for customs clearance and compliance, ensuring that all regulatory requirements are met for international shipments.

Specifies the format in which the documents related to the shipment are provided. For example, a Base 64 encoded PDF, PNG or ZPL203DPI, and ZPL300DPI. <br /> <br />This format is crucial for ensuring that the documents can be easily accessed, printed, and utilised during shipping and customs processes.