Prepared shipments
Creates shipments and stored shipments from a prepared shipment.
GET |
Fetches a prepared shipment that was previously created.
URI parameters
prepareId | string | Identification of the prepared shipment. | Required |
For description of properties, please refer to the Property reference guide.
For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /prepared-shipments/{prepareId} GET.
DELETE |
Deletes a prepared shipment.
Note
When the prepared shipment is deleted no further operation will be possible on the prepared shipment ID.
URI parameters
prepareId | string | Identification of the partial shipment | Required |
No response body is returned when a prepared shipment is successfully deleted.
For description of properties, please refer to the Property reference guide.
For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /prepared-shipments/{prepareId} DELETE.
POST |
Creates a shipment from a prepared shipment.
Note
The shipment data in the request body must fulfill the specific requirements of the shipment's service.
Multiple shipments can be created if the stored shipment represent a combined normal and return shipment.
By default the documents are returned as a URL. As an option the documents can be inline in the print.data object in the result. The print.data object is encoded in base64.
Caution
The generated documents will only be available for one (1) hour.
URI parameters
prepareId | string | Identification of the prepared shipment. | Required |
Query parameters
returnFile | boolean | 'true' if the PDF/ZPL file should be returned inline. | Optional |
keepPreparedShipment | boolean | The prepare ID should be used again. For example, if an order contains shipments that should be sent from different locations, if an item in the order is backordered or for a return service. | Optional |
For description of properties, please refer to the Property reference guide.
For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /prepared-shipments/{prepareId}/shipments POST.
POST |
Creates a stored shipment from a prepared shipment.
Note
The shipment data in the request body must fulfill the specific requirements of the shipment's service.
URI parameters
prepareId | string | Identification of the prepared shipment. | Required |
Query parameters
keepPreparedShipment | boolean | The prepare ID should be used again. For example, if an order contains shipments that should be sent from different locations, if an item in the order is backordered or for a return service. | Optional |
For description of properties, please refer to the Property reference guide.
For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to //prepared-shipments/stored-shipments POST.