API Reference

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.

get
https://api.shipium.com/api/v1/deliveryexperience/shipment/carrierSelection/labels
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
string
shipiumLabelIds
array of strings
shipiumLabelIds
carrierManifestIds
array of strings
carrierManifestIds
partnerManifestIds
array of strings
partnerManifestIds
shipiumManifestIds
array of strings
shipiumManifestIds
carrierServiceMethodIds
array of strings
carrierServiceMethodIds
statuses
array of strings
statuses
string
string
string
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.

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.

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.

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).

include
string
int32

The number results to include on each page of the response

boolean
Headers
string
Response

Updated 10 days ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 days ago