Shipper
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.
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",
"accounts": [
{
"accountNumber": "AC0089",
"accountType": "SHIPPER"
}
],
"sendAllServiceAttributes": true,
"sendTNT": true,
"shipmentDate": "2024-12-22T06:34:00",
"sortOrder": "rate",
"transitTime": "2024-12-22T06:34:00",
"zplEncoded": false,
"currency": "USD",
"labelFormat": "PNG",
"labelLayout": "",
"fulfillmentNode": "",
"parcels": [
{
"parcelType": "P",
"pickupType": "Pickup",
"quoteId": "301312f9-500a-4e6a-8976-aad12db55e8c",
"reference1": "testRef1",
"reference2": "testRef2",
"referenceId": "testRefId",
"serviceAttributes": [
"AD_SIGN"
],
"serviceType": "GRD",
"shipDate": "2024-08-22T06:34:00",
"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",
"height": 4,
"length": 4,
"width": 4
}
}
]
}'
{
"currency": "USD",
"zplEncoded": "false",
"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": "DGRD",
"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": "P761NBH3",
"createdDate": "2024/09/25 09:42:32",
"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",
"labelDate": "2024/09/25 09:42:32",
"sortCode": "KEARNY",
"labelFormat": "PNG"
},
"reference1": "testRef1",
"reference2": "testRef2"
}
]
}
Authorizations
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
.
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",
"accounts": [
{
"accountNumber": "AC0089",
"accountType": "SHIPPER"
}
],
"sendAllServiceAttributes": true,
"sendTNT": true,
"shipmentDate": "2024-12-22T06:34:00",
"sortOrder": "rate",
"transitTime": "2024-12-22T06:34:00",
"zplEncoded": false,
"currency": "USD",
"labelFormat": "PNG",
"labelLayout": "",
"fulfillmentNode": "",
"parcels": [
{
"parcelType": "P",
"pickupType": "Pickup",
"quoteId": "301312f9-500a-4e6a-8976-aad12db55e8c",
"reference1": "testRef1",
"reference2": "testRef2",
"referenceId": "testRefId",
"serviceAttributes": [
"AD_SIGN"
],
"serviceType": "GRD",
"shipDate": "2024-08-22T06:34:00",
"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",
"height": 4,
"length": 4,
"width": 4
}
}
]
}'
{
"currency": "USD",
"zplEncoded": "false",
"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": "DGRD",
"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": "P761NBH3",
"createdDate": "2024/09/25 09:42:32",
"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",
"labelDate": "2024/09/25 09:42:32",
"sortCode": "KEARNY",
"labelFormat": "PNG"
},
"reference1": "testRef1",
"reference2": "testRef2"
}
]
}