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.

post

https://api.shipium.com/api/v1/deliveryexperience/shipment/{shipiumShipmentId}/carrierSelection/{carrierSelectionId}/label

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

shipiumShipmentId

string

required

carrierSelectionId

string

required

Body Params

Information on the types of labels to be generated by the carrier, as will as if a manifest for the shipment is generated. This field is ignored if the "generateLabel" field is set to "false".

currencyCode

string

Currency in which all the rates for shipping carrier selection costs will be calculated in.

labelFormats

array of strings

List of formats to generate the package label in. Supported formats are pdf, png, zpl, and printerless.

labelFormats

printerlessParameters

object

If one of the labelFormats is "printerless", these parameters are required.

includeLabelImagesInResponse

boolean

When "true" the response will include the raw image data of the labels that were requested to be generated by the carrier.

customLabelEntries

object

List of formats to generate the package label in.

testMode

boolean

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. If this value is null, it will inherit from the Shipment. A non-testMode label cannot be combined with a testMode Shipment.

eligibleForManifest

boolean

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

string

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

object

Use HoldAtLocation to indicate the package should be held at a carrier location for pickup.

Responses

200Label generated for the shipment.

400Invalid inputs were provided.