Origin Carrier
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.
A list of account information for the rate request.
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.
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).
The identifier of the fulfilment node processing the shipment.
curl --request POST \
--url https://api-stage.orchestro.ai/e1/api/v1/core/rates \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"callerType": "SHIPPER",
"accounts": [
{
"accountNumber": "AC0088",
"accountType": "SHIPPER"
},
{
"accountNumber": "AC0077",
"accountType": "WMS"
}
],
"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": [
{
"quoteId": "",
"parcelType": "P",
"pickupType": "Pickup",
"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",
"parcels": [
{
"quoteId": "f387f8e4-901d-4578-9095-8b3838d30b47",
"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,
"surcharges": [
{
"rate": 0.35,
"code": "FUEL",
"description": "Fuel Surcharge"
}
],
"serviceAttributes": [
{
"key": "AD_SIGN",
"available": true
}
],
"destinationSortHub": "KEARNY"
}
]
}
]
}
Authorizations
Body
A list of account information for the rate request.
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.
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).
The identifier of the fulfilment node processing the shipment.
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 '{
"callerType": "SHIPPER",
"accounts": [
{
"accountNumber": "AC0088",
"accountType": "SHIPPER"
},
{
"accountNumber": "AC0077",
"accountType": "WMS"
}
],
"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": [
{
"quoteId": "",
"parcelType": "P",
"pickupType": "Pickup",
"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",
"parcels": [
{
"quoteId": "f387f8e4-901d-4578-9095-8b3838d30b47",
"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,
"surcharges": [
{
"rate": 0.35,
"code": "FUEL",
"description": "Fuel Surcharge"
}
],
"serviceAttributes": [
{
"key": "AD_SIGN",
"available": true
}
],
"destinationSortHub": "KEARNY"
}
]
}
]
}