Book a shipment label
ADD ENDPOINT DESCRIPTION HERE
Request body
A unique identifier for the request. <br>Used for tracing and to prevent duplicate shipment bookings. <br>This value is optional, if not included, a random requestUUID is generated.
A human readable reference for the request. <br>This will be included in the mail that is sent once the operation completes.<br>This value is optional, if not included, a random reference will be generated.
shipping service group from which to load the shipping services to use.
Optional length <em>(in meters)</em> of the shipment.
Optional width <em>(in meters)</em> of the shipment.
Optional height <em>(in meters)</em> of the shipment.
The total weight <em>(kilograms)</em> of the shipment including packaging.
The seller who is booking this shipment (required). <br>The booked shipment will show up in the history of this seller.
The invoice number to be used for customs declaration.
The invoice date to be used for customs declaration.
Optional amount which should get insured when booking the shipment. <br>Note that most shipping services already have a basic insurance included. To use the already included insurance, you must not set this field to any value other than <code>null</code>.<br>Setting this field to a non <code>null</code> value will book an additional insurance.
Optional value setting whether a return labels should be included in addition to the main label or not.
Optional value setting whether to turn on/off tracking functionality for shipment. Additional charges will apply when set to true.
Optional future or today's date when the shipment will be handed over to the carrier. If not specified, default's to today.
Optional terms of trade. If not specified, default's <code>DAP</code>.
The userId of a third party app who booked the shipment.
Optional value. Identifies the order in the customer's shop.
Optional description of the shipment contents.
Optional system reference, can be used to trace the shipment
Optional COD total amount parameter. If the amount is greater than 0, it will be processed as a COD shipment
The currency in which COD amount is specified.
Response
successful operation
Indicates whether the operation was successful or not.
Optional additional information about the operation's result. <br>When the operation failed, this field includes more information about the error.
ID of booked shipment
The tracking number of the booked shipment.
The tracking link of the booked shipment. Note that some carriers do not immediately recognize shipments after they have been created
List of URLs where the labels can be downloaded.
List of URLs where additional documents, such as export documents, can be downloaded.