Get Parcel Rates

Request

Parameter	Type	Description
accountId	IDCustomScalar	The ID of the Team Account associated with the delivery quote.
origin	AddressInput!	An object containing the address information for the delivery origin.
destination	AddressInput!	An object containing the address information for the delivery destination.
parcels	[ParcelInput!]!	An array of objects containing information about the items to be delivered.

Example Query

query ParcelRates {
  parcelRates(
    origin: {
      name: "John Doe"
      addressLine1: "1 World Way"
      city: "Los Angeles"
      state: "CA"
      postalCode: "90045"
    }
    destination: {
      name: "Jane Smith"
      addressLine1: "4100 Donald Douglas Dr"
      city: "Long Beach"
      state: "CA"
      postalCode: "90808"
    }
    parcels: [
      {
        description: "Sample Parcel"
        width: 61 # cm (integer)
        length: 61 # cm (integer)
        height: 61 # cm (integer)
        weight: 11.34 # kg (decimal)
      }
    ]
  ) {
    amount
    attributes
    estimatedDays
    provider {
      name
      logoSm
      logoLg
    }
    service {
      name
      terms
    }
  }
}

Response

Field	Type	Description
amount	Integer	The cost of the service (in cents) to deliver this parcel.
attributes	[String]	Attributes of this rate (CHEAPEST, FASTEST, or BESTVALUE) compared to other rates for this parcel.
estimatedDays	Integer	Estimated transit time in days.
provider.name	String	Name of the service provider.
provider.logoSm	String	URL to the service provider's logo (small).
provider.logoLg	String	URL to the service provider's logo (large).
service.name	String	Name of the service level.
service.terms	String	Additional details about the service level.

Example Response

{
  "data": {
    "parcelRates": [
      {
        "amount": 5396,
        "attributes": ["BESTVALUE"],
        "estimatedDays": 1,
        "provider": {
          "name": "UPS",
          "logoSm": "https://example.com/small/UPS.png",
          "logoLg": "https://example.com/large/UPS.png"
        },
        "service": {
          "name": "Ground",
          "terms": "Delivery times vary. Delivered usually in 1-5 business days."
        }
      },
      {
        "amount": 4571,
        "attributes": ["CHEAPEST"],
        "estimatedDays": 2,
        "provider": {
          "name": "UPS",
          "logoSm": "https://example.com/small/UPS.png",
          "logoLg": "https://example.com/large/UPS.png"
        },
        "service": { "name": "Ground Saver", "terms": "" }
      },
      {
        "amount": 13224,
        "attributes": ["FASTEST"],
        "estimatedDays": 1,
        "provider": {
          "name": "UPS",
          "logoSm": "https://example.com/small/UPS.png",
          "logoLg": "https://example.com/large/UPS.png"
        },
        "service": {
          "name": "Next Day Air® Early",
          "terms": "Next business day delivery by 8:30 a.m., 9:00 a.m., or 9:30 a.m. "
        }
      },
      {
        "amount": 5110,
        "attributes": [],
        "estimatedDays": 2,
        "provider": {
          "name": "FedEx",
          "logoSm": "https://example.com/small/FedEx.png",
          "logoLg": "https://example.com/large/FedEx.png"
        },
        "service": { "name": "Ground® Economy", "terms": "" }
      }
    ]
  }
}