Rates

POST

api

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": "GRD",
          "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": 7002
        }
      ]
    }
  ]
}

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.

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.

parcels.dimensions

object

Dimensions of the parcel.

parcels.parcelType

string

Type of parcel (e.g., P for parcel).

Example:

"P"

parcels.pickupType

string

The type of pickup service requested (e.g., Pickup).

Example:

"Pickup"

parcels.reference1

string

Reference number for the shipment.

Example:

"123456"

parcels.reference2

string

Secondary reference number for the shipment.

Example:

"123456"

parcels.referenceId

string

Unique reference ID for the shipment.

Example:

"cf6fea899f1848b494d9568e8266e076"

parcels.serviceAttributes

string[]

Additional service attributes for the shipment (e.g., AD_SIGN for signature service).

parcels.serviceType

string

Type of shipping service (e.g., DGRD for dangerous goods).

Example:

"DGRD"

parcels.shipDate

string

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

Example:

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

parcels.shipFrom

object

Address from which the shipment is originating.

parcels.shipTo

object

Address to which the parcel is being shipped.

parcels.weight

object

Weight of the parcel.

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[]

parcels.dimensions

object

parcels.parcelType

string

Example:

"P"

parcels.pickupType

string

Example:

"Pickup"

parcels.quoteId

string

Example:

"301312f9-500a-4e6a-8976-aad12db55e8c"

parcels.rates

object[]

parcels.rates.baseRate

number

Example:

4.59

parcels.rates.destinationSortHub

string

Example:

"KEARNY"

parcels.rates.serviceAttributes

object[]

Example:

[{ "available": false, "key": "AD_SIGN" }]

parcels.rates.serviceType

string

Example:

"GRD"

parcels.rates.surcharges

object[]

Example:

[
  {
    "code": "FUEL",
    "description": "Carrier Fuel SurCharge",
    "rate": 0.23
  }
]

parcels.rates.tnt

string

Example:

"3 - 7 days"

parcels.rates.totalRate

number

Example:

4.82

parcels.rates.zone

number

Example:

1

Example:

[
  {
    "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
  }
]

parcels.referenceId

string

Example:

"testRefId"

parcels.serviceType

string

Example:

"GRD"

parcels.shipDate

string

Example:

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

parcels.shipFrom

object

parcels.shipTo

object

parcels.weight

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 }
  }
]

PostTheEvents Labels

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": "GRD",
          "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": 7002
        }
      ]
    }
  ]
}

API Documentation

GRD

Rate

Label

Reprint

Cancel

Coverage

Filter

Authorizations

Body

Response