Based on the carrier service selected for the shipment, a label in the formats provided by the end user will be generated and stored for alter retrieval from the carrier.
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
Schema Details
shipiumShipmentId
- Type: string
- Required: true
carrierSelectionId
- Type: string
- Required: true
labelFormats
- Type: array of strings
- Description: List of formats to generate the package label in. Supported formats are pdf, png, zpl, and printerless.
printerlessParameters
- Type: object
- Description: If one of the labelFormats is "printerless", these parameters are required.
includeLabelImagesInResponse
- Type: boolean
- Description: When "true" the response will include the raw image data of the labels that were requested to be generated by the carrier.
customLabelEntries
- Type: object
- Description: List of formats to generate the package label in.
testMode
- Type: boolean
- Description: When true, calls to generate the labels will be made to the carrier sandbox servers. No actual labels are created, only a representation of the label. No money is charged to the underlying account either.
eligibleForManifest
- Type: boolean
- Description: When true, or null, this label will be included in end-of-day and scheduled manifests. False indicates that the label should not be included in any manifests.
contentDescription
- Type: string
- Description: A short description (under 35 characters) of the package contents being returned that is passed on to the carrier. Required for returns shipments only.
holdAtLocation
- Type: object
- Description: Use HoldAtLocation to indicate the package should be held at a carrier location for pickup.
API Response Codes
- `` 200 Label generated for the shipment.
- `` 400 Invalid inputs were provided.
Example CURL Request
curl --request POST \
--url https://api.shipium.com/api/v1/deliveryexperience/shipment/shipiumShipmentId/carrierSelection/carrierSelectionId/label \
--header 'accept: application/json' \
--header 'content-type: application/json'