API reference
A valid request URL is required to generate request examples{
"customAttributes": [
{
"childAttributes": "<array>",
"key": "<string>",
"value": "<string>"
}
],
"isSuccessful": true,
"messages": [
{
"code": "<string>",
"message": "<string>",
"source": "<string>"
}
],
"packageResponses": [
{
"customAttributes": [
{
"childAttributes": "<array>",
"key": "<string>",
"value": "<string>"
}
],
"id": "<string>",
"integratorId": "<string>",
"label": {
"imageData": "aSDinaTvuI8gbWludGxpZnk=",
"imageFormat": "<string>",
"labelUrl": "<string>"
},
"trackingNumber": "<string>"
}
],
"shippingTotal": {
"currencyCode": "<string>",
"value": 123
},
"trackingNumber": "<string>"
}Get Labels
Get Shipping Label for the Service Type Requested
A valid request URL is required to generate request examples{
"customAttributes": [
{
"childAttributes": "<array>",
"key": "<string>",
"value": "<string>"
}
],
"isSuccessful": true,
"messages": [
{
"code": "<string>",
"message": "<string>",
"source": "<string>"
}
],
"packageResponses": [
{
"customAttributes": [
{
"childAttributes": "<array>",
"key": "<string>",
"value": "<string>"
}
],
"id": "<string>",
"integratorId": "<string>",
"label": {
"imageData": "aSDinaTvuI8gbWludGxpZnk=",
"imageFormat": "<string>",
"labelUrl": "<string>"
},
"trackingNumber": "<string>"
}
],
"shippingTotal": {
"currencyCode": "<string>",
"value": 123
},
"trackingNumber": "<string>"
}Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
limits which fields are returned in the response body
Body
Consolidation references for Order Number, Shipment Number and Order Id
Show child attributes
Show child attributes
Carrier specific options
Ex: RequiresDeliveryConfirmation when using usps with non-express mail service type.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Fulfillment method for the shipment. STH / Delivery. Empty will be assumed as STH.
Returns the Label in the requested format. Specify either "LASER" or "THERMAL" format. Actual supported image formats vary by carrier.
The related Order ID for this shipment request. Informational only.
The related Order Number for this shipment request. Informational only.
The related Shipment Number for this shipment request. Informational only.
Show child attributes
Show child attributes
Selected Shipment Request Type.
Selected Shipping Service Type.
Specify an optional signature option for this shipment. All packages will inherit this option value automatically. Set this option on the package level to override this value.