Create Shipment

Create a new shipment.

To create a shipment, the values in the shipment data of the request body must fulfill the specific requirements of the shipment's service. If this isn't the case no shipment will be created and a list of validation errors will be returned instead. To actually create a shipment the values supplied in the request body must not include an option object with id CONSOLIDATE. Otherwise a consolidated shipment will be created instead of a normal shipment. To check that a normal shipment was created look at the consolidated value in the result of a successful call.

Documents will be created according to the provided print configuration. Please note that the generated documents will only be available for 1 hour. By default the documents have to be requested from the URL contained in the href value of prints objects in the result. As an option the PDF or ZPL documents can be inline in the data object in the result print array. The print.data object is encoded in base64. To activate this option include a query parameter named returnFile with the value set to true.

This service requires a license for the APIConnect function that can be ordered separately. To view functions available to you, go to Help -> Session menu in your account and look in the License keys section. This function is represented by the REST API Print license key.