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 '{
"sortOrder": "rate",
"callerType": "WMS",
"currency": "USD",
"sendTNT": true,
"sendAllServiceAttributes": true,
"labelFormat": "PDF",
"accounts": [
{
"accountType": "SHIPPER",
"accountNumber": "AC0088"
},
{
"accountType": "WMS",
"accountNumber": "AC0077"
}
],
"shipmentDate": "2024-05-08T00:38:22Z",
"parcels": [
{
"quoteId": "",
"serviceType": "GRD",
"shipFrom": {
"company": "Orchestro.ai",
"name": "Tom Fiorita",
"address1": "7137 Southlake Pkwy",
"address2": "Suite B",
"city": "Morrow",
"state": "GA",
"zip": "30260",
"country": "US",
"phone": "",
"email": "",
"addressType": "R"
},
"parcelType": "P",
"weight": {
"unit": "lb",
"value": 0.09
},
"serviceAttributes": [],
"shipDate": "2024-05-13T00:38:22",
"pickupType": "Pickup",
"shipTo": {
"company": "",
"name": "Matt Murray",
"address1": "921 McLean ave, apt E7",
"address2": "",
"city": "Yonkers",
"state": "NY",
"zip": "10704",
"country": "US",
"phone": "",
"email": "",
"addressType": "R"
},
"dimensions": {
"unit": "inch",
"length": 4,
"width": 1,
"height": 1
}
}
]
}'
{
"currency": "USD",
"parcels": [
{
"quoteId": "9494733d-c000-4392-93c9-a06b9d733c60",
"shipDate": "2024-05-13T00:38:22",
"serviceType": "GRD",
"pickupType": "Pickup",
"parcelType": "P",
"shipFrom": {
"company": "Orchestro.ai",
"name": "Tom Fiorita",
"address1": "7137 Southlake Pkwy",
"address2": "Suite B",
"city": "Morrow",
"state": "GA",
"zip": "30260",
"country": "US",
"phone": "",
"email": "",
"addressType": "R"
},
"shipTo": {
"company": "",
"name": "Matt Murray",
"address1": "921 McLean ave, apt E7",
"address2": "",
"city": "Yonkers",
"state": "NY",
"zip": "10704",
"country": "US",
"phone": "",
"email": "",
"addressType": "R"
},
"weight": {
"unit": "lb",
"value": 0.09
},
"dimensions": {
"unit": "inch",
"length": 4,
"width": 1,
"height": 1
},
"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
}
]
}
],
"labels": {
"id": "PK5MZNF7",
"createdDate": "2024/09/17 22:37:57",
"labelUrl": "https://ocn-stage-e1-files.s3.amazonaws.com/PK5MZNF7.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240917T223757Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604799&X-Amz-Credential=AKIAXLQKESR5BTU3KJX3%2F20240917%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=3203bd09d0b11e16602131cedff412adc3c414f09d81541cade4ed2e3ae4f96c",
"labelDate": "2024/09/17 22:37:57",
"sortCode": "KEARNY",
"labelFormat": "PDF"
}
}
]
}

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.