POST
/
api
/
v1
/
core
/
labels
curl --request POST \
--url https://api-stage.orchestro.ai/e1/api/v1/core/labels \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"callerType": "SHIPPER",
"labelFormat": "PDF",
"accounts": [
{
"accountNumber": "AC0089",
"accountType": "SHIPPER"
}
],
"shipmentDate": "2024-12-22T06:34:00",
"sendTNT": true,
"sortOrder": "rate",
"currency": "USD",
"fulfillmentNode": "",
"sendAllServiceAttributes": true,
"parcels": [
{
"referenceId": "cf6fea899f1848b494d9568e8266e076",
"reference1": 123456,
"reference2": 123456,
"shipDate": "2023-12-22T06:34:00",
"serviceType": "DGRD",
"pickupType": "Pickup",
"parcelType": "P",
"shipFrom": {
"company": "ACME INC.",
"name": "ACME INC.",
"address1": "280 S YORK RD",
"address2": "",
"city": "BENSENVILLE",
"state": "IL",
"zip": "60106",
"country": "US",
"phone": "",
"email": "",
"addressType": "B"
},
"shipTo": {
"company": "Test-Company-Name",
"name": "JOSH SMITH",
"address1": "637 E WOODBRIDGE AVE",
"address2": "",
"city": "AVENEL",
"state": "NJ",
"zip": "07001",
"country": "US",
"phone": "",
"email": "",
"addressType": "B"
},
"serviceAttributes": [
"AD_SIGN"
],
"weight": {
"value": 1,
"unit": "lb"
},
"dimensions": {
"unit": "inch",
"length": 12,
"width": 12,
"height": 12
}
}
]
}'
{
"currency": "USD",
"parcels": [
{
"quoteId": "301312f9-500a-4e6a-8976-aad12db55e8c",
"referenceId": "testRefId",
"shipDate": "2024-08-22T06:34:00",
"serviceType": "GRD",
"pickupType": "Pickup",
"parcelType": "P",
"shipFrom": {
"company": "Dallas City Hall",
"name": "The City Secretary's Office",
"address1": "1500 Marilla Street",
"address2": "",
"city": "Dallas",
"state": "TX",
"zip": "75201",
"country": "US",
"phone": "",
"email": "",
"addressType": "B"
},
"shipTo": {
"company": "Municipal Building",
"name": "Brooklyn Municipal Building",
"address1": "210 Joralemon St",
"address2": "",
"city": "Brooklyn",
"state": "NY",
"zip": "11201",
"country": "US",
"phone": "212-669-8090",
"email": "",
"addressType": "B"
},
"weight": {
"unit": "lb",
"value": 6
},
"dimensions": {
"unit": "inch",
"length": 4,
"width": 4,
"height": 4
},
"rates": [
{
"zone": 6,
"serviceType": "GRD",
"tnt": "3 - 7 days",
"baseRate": 7.06,
"totalRate": 7.41,
"totalDiscount": 1.2,
"baseRateDiscount": 0,
"surcharges": [
{
"rate": 3,
"discount": 0,
"code": "Pick",
"description": "Pick Up Charges"
},
{
"rate": 0.75,
"discount": 0,
"code": "PEAK",
"description": "Carrier Peak Surcharge"
},
{
"rate": 2,
"discount": 0,
"code": "DDAS",
"description": "Delivery Area Surcharge"
},
{
"rate": 0.29,
"discount": 0,
"code": "FUEL",
"description": "Fuel Surcharge"
}
],
"serviceAttributes": [
{
"key": "POD_RQD",
"rate": 5,
"discount": 0.1,
"available": true
}
],
"destinationSortHub": "KEARNY"
}
]
}
]
}

Authorizations

Authorization
string
header
required

Body

application/json

This endpoint accepts a JSON request body that contains account details, caller type, currency, label format, and parcel information.

The body is of type object.

Response

200 - application/json

All successful Label responses

The response is of type object.