POST
/
api
/
v1
/
core
/
rates
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

​
Authorization
string
header
required

Body

application/json

This endpoint accepts a JSON request body that calculates shipping rates based on various parameters. The request includes details about the accounts involved, caller type, currency, label format, parcel specifications (such as dimensions and weight), shipping addresses, optional service attributes, and the shipment date.

The body is of type object.

Response

200 - application/json

All successful rate responses.

The response is of type object.