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.

​
fulfilmentNode
string
required

The identifier of the fulfilment node processing the shipment.

Example:

"NODE123"

​
accounts
object[]

A list of account information for the rate request.

Example:
[
  {
    "accountNumber": "AC0088",
    "accountType": "SHIPPER"
  },
  {
    "accountNumber": "AC0077",
    "accountType": "WMS"
  }
]
​
callerType
string

Defines the type of the caller submitting the rate request (e.g., WMS).

Example:

"WMS"

​
currency
string

The currency for the rate request (e.g., USD).

Example:

"USD"

​
labelFormat
string

The format for the generated shipping labels (e.g., PDF).

Example:

"PDF"

​
parcels
object[]

A list of parcels to be rated, with details about their dimensions, weight, and shipping attributes.

​
sendAllServiceAttributes
boolean

Flag indicating whether all service attributes should be included in the response.

Example:

true

​
sendTNT
boolean

Flag indicating whether time and transit details (TNT) should be included in the response.

Example:

true

​
shipmentDate
string

The date and time of the shipment (ISO 8601 format).

Example:

"2024-12-22T06:34:00"

​
sortOrder
string

Sort order for the returned rates (e.g., 'rate' to sort by price).

Example:

"rate"

Response

200 - application/json

All successful rate responses.

​
currency
string
Example:

"USD"

​
parcels
object[]
Example:
[
  {
    "dimensions": {
      "height": 4,
      "length": 4,
      "unit": "inch",
      "width": 4
    },
    "parcelType": "P",
    "pickupType": "Pickup",
    "quoteId": "301312f9-500a-4e6a-8976-aad12db55e8c",
    "rates": [
      {
        "baseRate": 4.59,
        "destinationSortHub": "KEARNY",
        "serviceAttributes": [{ "available": false, "key": "AD_SIGN" }],
        "serviceType": "GRD",
        "surcharges": [
          {
            "code": "FUEL",
            "description": "Carrier Fuel SurCharge",
            "rate": 0.23
          }
        ],
        "tnt": "3 - 7 days",
        "totalRate": 4.82,
        "zone": 1
      }
    ],
    "referenceId": "testRefId",
    "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 }
  }
]