Retrieve a single page of generated shipment labels that match the supplied parameters. This call is the metadata about the labels, the images of the labels must be asked for in the call, or directly using the `getLabelImageV1` call.

URL Expired

The URL for this request expired after 30 days.

Parameters

• carrierId: string
• carrierAccountId: string
• shipiumLabelIds: array of strings
  • ADD string
• carrierManifestIds: array of strings
  • ADD string
• partnerManifestIds: array of strings
  • ADD string
• shipiumManifestIds: array of strings
  • ADD string
• carrierServiceMethodIds: array of strings
  • ADD string
• statuses: array of strings
  • Show 11 enum values
  • ADD string
• originCountryCode: string
• originPostalCode: string
• shipiumTenantId: string
• fromShipDateTime: date-time The earliest that the label can have been created. This is when the label was created within Shipium, and is not affected by schedules or client input.
• toShipDateTime: date-time The latest that the label can have been created. This is when the label was created within Shipium, and is not affected by schedules or client input.
• fromManifestDateTime: date-time The earliest that the client indicated that label was manifested by an end-of-day process. This is a client-supplied time, which is not related scheduled manifesting.
• toManifestDateTime: date-time The latest that the client indicated that label was manifested by an end-of-day process. This is a client-supplied time, which is not related scheduled manifesting.
• include: array of strings All fields that should be included in the response. If this is not provided, all fields will be returned (other parameters may still filter fields).
  • ADD string
• anchor: string
• count: int32 The number results to include on each page of the response
• includeLabelImagesInResponse: boolean
• X-DELEGATED-PARTNER-ID: string

Example Request

curl --request GET \
     --url https://api.shipium.com/api/v1/deliveryexperience/shipment/carrierSelection/labels \
     --header 'accept: application/json'

Example Response

{
  "status": 200,
  "message": "Labels that match the parameters, with pagination."
}