Rate
Label
Reprint
Cancel
Coverage
Filter
Rates
This endpoint allows you to submit rate requests for various parcels by providing detailed shipment, account, and service information. It returns rate data for the shipment based on the provided attributes.
curl --request POST \
--url https://api-stage.orchestro.ai/e1/api/v1/core/rates \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"accounts": [
{
"accountNumber": "AC0089",
"accountType": "SHIPPER"
}
],
"callerType": "SHIPPER",
"currency": "USD",
"labelFormat": "PNG",
"parcels": [
{
"dimensions": {
"height": 4,
"length": 4,
"unit": "inch",
"width": 4
},
"parcelType": "P",
"pickupType": "Pickup",
"reference1": "testRef1",
"reference2": "testRef2",
"referenceId": "testRefId",
"serviceAttributes": [
"AD_SIGN"
],
"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
}
}
],
"sendAllServiceAttributes": true,
"sendTNT": true,
"shipmentDate": "2024-12-22T06:34:00",
"sortOrder": "rate",
"transitTime": "2024-12-22T06:34:00",
"zplEncoded": false,
"labelLayout": "",
"fulfillmentNode": ""
}'{
"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": "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
}
],
"destinationSortHub": "KEARNY"
}
]
}
]
}Authorizations
Body
The identifier of the fulfilment node processing the shipment.
Defines the type of the caller submitting the rate request (e.g., WMS).
The currency for the rate request (e.g., USD).
The format for the generated shipping labels (e.g., PDF).
A list of parcels to be rated, with details about their dimensions, weight, and shipping attributes.
Type of parcel (e.g., P for parcel).
The type of pickup service requested (e.g., Pickup).
Reference number for the shipment.
Secondary reference number for the shipment.
Unique reference ID for the shipment.
Additional service attributes for the shipment (e.g., AD_SIGN for signature service).
Type of shipping service (e.g., DGRD for dangerous goods).
The date and time of shipment (ISO 8601 format).
Address from which the shipment is originating.
Primary address line.
Secondary address line.
Type of address (e.g., B for business).
City of the origin address.
Name of the company at the origin address.
Country code for the origin address (e.g., US for the United States).
Email address for the shipper.
Name of the shipper.
Phone number of the shipper.
State or region of the origin address.
ZIP or postal code of the origin address.
Address to which the parcel is being shipped.
Primary address line.
Secondary address line.
Type of address (e.g., B for business).
City of the destination address.
Name of the recipient company.
Country code for the destination address.
Email address of the recipient.
Name of the recipient.
Phone number of the recipient.
State or region of the destination address.
ZIP or postal code of the destination address.
Flag indicating whether all service attributes should be included in the response.
Flag indicating whether time and transit details (TNT) should be included in the response.
The date and time of the shipment (ISO 8601 format).
Sort order for the returned rates (e.g., 'rate' to sort by price).
Response
curl --request POST \
--url https://api-stage.orchestro.ai/e1/api/v1/core/rates \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"accounts": [
{
"accountNumber": "AC0089",
"accountType": "SHIPPER"
}
],
"callerType": "SHIPPER",
"currency": "USD",
"labelFormat": "PNG",
"parcels": [
{
"dimensions": {
"height": 4,
"length": 4,
"unit": "inch",
"width": 4
},
"parcelType": "P",
"pickupType": "Pickup",
"reference1": "testRef1",
"reference2": "testRef2",
"referenceId": "testRefId",
"serviceAttributes": [
"AD_SIGN"
],
"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
}
}
],
"sendAllServiceAttributes": true,
"sendTNT": true,
"shipmentDate": "2024-12-22T06:34:00",
"sortOrder": "rate",
"transitTime": "2024-12-22T06:34:00",
"zplEncoded": false,
"labelLayout": "",
"fulfillmentNode": ""
}'{
"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": "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
}
],
"destinationSortHub": "KEARNY"
}
]
}
]
}