Labels
This endpoint allows users to create shipping labels by sending account information, parcel details, and shipment specifics. It returns the generated label or an error if the request fails.
Authorizations
Body
A list of accounts requesting the shipping labels.
[
{
"accountNumber": "AC0088",
"accountType": "SHIPPER"
},
{
"accountNumber": "AC0077",
"accountType": "WMS"
}
]
The type of caller initiating the request, such as SHIPPER or WMS.
"WMS"
The currency in which the transaction is carried out.
"USD"
The format of the generated label (e.g., PDF or ZPL).
"PDF"
A list of parcels being shipped, including dimensions, references, and other parcel-specific data.
Whether to send all service attributes related to the shipment.
true
Whether to include TNT information for the shipment.
true
The date and time when the shipment is planned to be made, in ISO 8601 format.
"2024-12-22T06:34:00"
The order in which shipment options should be sorted.
"rate"
Response
"USD"
[
{
"dimensions": {
"height": 4,
"length": 4,
"unit": "inch",
"width": 4
},
"labels": {
"createdDate": "2024/09/25 09:42:32",
"id": "P761NBH3",
"labelDate": "2024/09/25 09:42:32",
"labelFormat": "PNG",
"labelUrl": "https://ocn-stage-e1-files.s3.amazonaws.com/P761NBH3.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240925T094232Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAXLQKESR5BTU3KJX3%2F20240925%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=7ff0d7c855edb5436d282468c40e82f075da4926b01608158e6937d475018b1f",
"sortCode": "KEARNY"
},
"parcelType": "P",
"pickupType": "Pickup",
"quoteId": "301312f9-500a-4e6a-8976-aad12db55e8c",
"reference1": "testRef1",
"reference2": "testRef2",
"referenceId": "testRefId",
"serviceType": "GRD",
"shipDate": "2024-08-22T06:34:00",
"shipFrom": {
"address1": "1500 Marilla Street",
"address2": "",
"addressType": "B",
"city": "Dallas",
"company": "Dallas City Hall",
"country": "US",
"email": "",
"name": "The City Secretary's Office",
"phone": "",
"state": "TX",
"zip": "75201"
},
"shipTo": {
"address1": "210 Joralemon St",
"address2": "",
"addressType": "B",
"city": "Brooklyn",
"company": "Municipal Building",
"country": "US",
"email": "",
"name": "Brooklyn Municipal Building",
"phone": "212-669-8090",
"state": "NY",
"zip": "11201"
},
"weight": { "unit": "lb", "value": 6 }
}
]
"false"