Origin Carrier
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.
A list of accounts requesting the shipping labels.
The type of caller initiating the request, such as SHIPPER or WMS.
The currency in which the transaction is carried out.
The format of the generated label (e.g., PDF or ZPL).
A list of parcels being shipped, including dimensions, references, and other parcel-specific data.
Whether to send all service attributes related to the shipment.
Whether to include TNT information for the shipment.
The date and time when the shipment is planned to be made, in ISO 8601 format.
The order in which shipment options should be sorted.
The identifier of the fulfilment node processing the shipment.
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
},
"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
Body
A list of accounts requesting the shipping labels.
The type of caller initiating the request, such as SHIPPER or WMS.
The currency in which the transaction is carried out.
The format of the generated label (e.g., PDF or ZPL).
A list of parcels being shipped, including dimensions, references, and other parcel-specific data.
Whether to send all service attributes related to the shipment.
Whether to include TNT information for the shipment.
The date and time when the shipment is planned to be made, in ISO 8601 format.
The order in which shipment options should be sorted.
The identifier of the fulfilment node processing the shipment.
Response
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
},
"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"
}
}
]
}