Rates

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 '
{
  "fulfilmentNode": "NODE123",
  "accounts": [
    {
      "accountNumber": "AC0088",
      "accountType": "SHIPPER"
    },
    {
      "accountNumber": "AC0077",
      "accountType": "WMS"
    }
  ],
  "callerType": "WMS",
  "currency": "USD",
  "labelFormat": "PDF",
  "parcels": [
    {
      "dimensions": {
        "height": 12,
        "length": 12,
        "unit": "inch",
        "width": 12
      },
      "parcelType": "P",
      "pickupType": "Pickup",
      "reference1": "123456",
      "reference2": "123456",
      "referenceId": "cf6fea899f1848b494d9568e8266e076",
      "serviceAttributes": [
        "AD_SIGN"
      ],
      "serviceType": "DGRD",
      "shipDate": "2023-12-22T06:34:00",
      "shipFrom": {
        "address1": "280 S YORK RD",
        "address2": "",
        "addressType": "B",
        "city": "BENSENVILLE",
        "company": "SHIPPERZS ATTN NAME",
        "country": "US",
        "email": "",
        "name": "SHIPPERZS ATTN NAME",
        "phone": "",
        "state": "IL",
        "zip": "60106"
      },
      "shipTo": {
        "address1": "637 E WOODBRIDGE AVE",
        "address2": "",
        "addressType": "B",
        "city": "AVENEL",
        "company": "Test-Company-Name",
        "country": "US",
        "email": "",
        "name": "JOSH SMITH",
        "phone": "",
        "state": "NJ",
        "zip": "07001"
      },
      "weight": {
        "unit": "oz",
        "value": 1
      }
    }
  ],
  "sendAllServiceAttributes": true,
  "sendTNT": true,
  "shipmentDate": "2024-12-22T06:34:00",
  "sortOrder": "rate"
}
'

{
  "currency": "USD",
  "parcels": [
    {
      "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
      }
    }
  ]
}

POST

api

core

rates

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 '
{
  "fulfilmentNode": "NODE123",
  "accounts": [
    {
      "accountNumber": "AC0088",
      "accountType": "SHIPPER"
    },
    {
      "accountNumber": "AC0077",
      "accountType": "WMS"
    }
  ],
  "callerType": "WMS",
  "currency": "USD",
  "labelFormat": "PDF",
  "parcels": [
    {
      "dimensions": {
        "height": 12,
        "length": 12,
        "unit": "inch",
        "width": 12
      },
      "parcelType": "P",
      "pickupType": "Pickup",
      "reference1": "123456",
      "reference2": "123456",
      "referenceId": "cf6fea899f1848b494d9568e8266e076",
      "serviceAttributes": [
        "AD_SIGN"
      ],
      "serviceType": "DGRD",
      "shipDate": "2023-12-22T06:34:00",
      "shipFrom": {
        "address1": "280 S YORK RD",
        "address2": "",
        "addressType": "B",
        "city": "BENSENVILLE",
        "company": "SHIPPERZS ATTN NAME",
        "country": "US",
        "email": "",
        "name": "SHIPPERZS ATTN NAME",
        "phone": "",
        "state": "IL",
        "zip": "60106"
      },
      "shipTo": {
        "address1": "637 E WOODBRIDGE AVE",
        "address2": "",
        "addressType": "B",
        "city": "AVENEL",
        "company": "Test-Company-Name",
        "country": "US",
        "email": "",
        "name": "JOSH SMITH",
        "phone": "",
        "state": "NJ",
        "zip": "07001"
      },
      "weight": {
        "unit": "oz",
        "value": 1
      }
    }
  ],
  "sendAllServiceAttributes": true,
  "sendTNT": true,
  "shipmentDate": "2024-12-22T06:34:00",
  "sortOrder": "rate"
}
'

{
  "currency": "USD",
  "parcels": [
    {
      "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
      }
    }
  ]
}

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.

Show child attributes

accounts.accountNumber

string

Unique account number assigned to a shipper or logistics provider.

Example:

"AC0088"

accounts.accountType

string

Type of the account, such as SHIPPER or WMS.

Example:

"SHIPPER"

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.

Show child attributes

parcels.dimensions

object

Dimensions of the parcel.

Show child attributes

parcels.dimensions.height

number

Height of the parcel.

Example:

12

parcels.dimensions.length

number

Length of the parcel.

Example:

12

parcels.dimensions.unit

string

Unit of measurement (e.g., inch).

Example:

"inch"

parcels.dimensions.width

number

Width of the parcel.

Example:

12

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.

Show child attributes

parcels.shipFrom.address1

string

Primary address line.

Example:

"280 S YORK RD"

parcels.shipFrom.address2

string

Secondary address line.

Example:

""

parcels.shipFrom.addressType

string

Type of address (e.g., B for business).

Example:

"B"

parcels.shipFrom.city

string

City of the origin address.

Example:

"BENSENVILLE"

parcels.shipFrom.company

string

Name of the company at the origin address.

Example:

"SHIPPERZS ATTN NAME"

parcels.shipFrom.country

string

Country code for the origin address (e.g., US for the United States).

Example:

"US"

parcels.shipFrom.email

string

Email address for the shipper.

Example:

""

parcels.shipFrom.name

string

Name of the shipper.

Example:

"SHIPPERZS ATTN NAME"

parcels.shipFrom.phone

string

Phone number of the shipper.

Example:

""

parcels.shipFrom.state

string

State or region of the origin address.

Example:

"IL"

parcels.shipFrom.zip

string

ZIP or postal code of the origin address.

Example:

"60106"

parcels.shipTo

object

Address to which the parcel is being shipped.

Show child attributes

parcels.shipTo.address1

string

Primary address line.

Example:

"637 E WOODBRIDGE AVE"

parcels.shipTo.address2

string

Secondary address line.

Example:

""

parcels.shipTo.addressType

string

Type of address (e.g., B for business).

Example:

"B"

parcels.shipTo.city

string

City of the destination address.

Example:

"AVENEL"

parcels.shipTo.company

string

Name of the recipient company.

Example:

"Test-Company-Name"

parcels.shipTo.country

string

Country code for the destination address.

Example:

"US"

parcels.shipTo.email

string

Email address of the recipient.

Example:

""

parcels.shipTo.name

string

Name of the recipient.

Example:

"JOSH SMITH"

parcels.shipTo.phone

string

Phone number of the recipient.

Example:

""

parcels.shipTo.state

string

State or region of the destination address.

Example:

"NJ"

parcels.shipTo.zip

string

ZIP or postal code of the destination address.

Example:

"07001"

parcels.weight

object

Weight of the parcel.

Show child attributes

parcels.weight.unit

string

Unit of weight (e.g., oz for ounces).

Example:

"oz"

parcels.weight.value

number

Weight value of the parcel.

Example:

1

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

Show child attributes

parcels.dimensions

object

Show child attributes

parcels.dimensions.height

number

Example:

4

parcels.dimensions.length

number

Example:

4

parcels.dimensions.unit

string

Example:

"inch"

parcels.dimensions.width

number

Example:

4

parcels.parcelType

string

Example:

"P"

parcels.pickupType

string

Example:

"Pickup"

parcels.quoteId

string

Example:

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

parcels.rates

object[]

Show child attributes

parcels.rates.baseRate

number

Example:

4.59

parcels.rates.destinationSortHub

string

Example:

"KEARNY"

parcels.rates.serviceAttributes

object[]

Show child attributes

parcels.rates.serviceAttributes.available

boolean

Example:

false

parcels.rates.serviceAttributes.key

string

Example:

"AD_SIGN"

Example:

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

parcels.rates.serviceType

string

Example:

"GRD"

parcels.rates.surcharges

object[]

Show child attributes

parcels.rates.surcharges.code

string

Example:

"FUEL"

parcels.rates.surcharges.description

string

Example:

"Carrier Fuel SurCharge"

parcels.rates.surcharges.rate

number

Example:

0.23

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

Show child attributes

parcels.shipFrom.address1

string

Example:

"1500 Marilla Street"

parcels.shipFrom.address2

string

Example:

""

parcels.shipFrom.addressType

string

Example:

"B"

parcels.shipFrom.city

string

Example:

"Dallas"

parcels.shipFrom.company

string

Example:

"Dallas City Hall"

parcels.shipFrom.country

string

Example:

"US"

parcels.shipFrom.email

string

Example:

""

parcels.shipFrom.name

string

Example:

"The City Secretary's Office"

parcels.shipFrom.phone

string

Example:

""

parcels.shipFrom.state

string

Example:

"TX"

parcels.shipFrom.zip

string

Example:

"75201"

parcels.shipTo

object

Show child attributes

parcels.shipTo.address1

string

Example:

"210 Joralemon St"

parcels.shipTo.address2

string

Example:

""

parcels.shipTo.addressType

string

Example:

"B"

parcels.shipTo.city

string

Example:

"Brooklyn"

parcels.shipTo.company

string

Example:

"Municipal Building"

parcels.shipTo.country

string

Example:

"US"

parcels.shipTo.email

string

Example:

""

parcels.shipTo.name

string

Example:

"Brooklyn Municipal Building"

parcels.shipTo.phone

string

Example:

"212-669-8090"

parcels.shipTo.state

string

Example:

"NY"

parcels.shipTo.zip

string

Example:

"11201"

parcels.weight

object

Show child attributes

parcels.weight.unit

string

Example:

"lb"

parcels.weight.value

number

Example:

6

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

Coverage-API Labels

⌘I

Getting Started

Network Standards

Member

Connection

Specification

Invoice

Member Portal and Analytics

Resources

Changelog

WMS/RSE

Origin Carrier

Authorizations

Body

Response