Getting Quotes

  • v1
  • quotes
  • pro
  • api
  • consignments

This page explains how got get delivery quotes based on consignment details.

Overview

PRO has two endpoints that take the details of an as-yet uncreated consignment and return quotes for it:

  • Get Quotes returns a simple list of delivery quotes for the potential consignment.
  • Get Service Group Quotes returns a list of current service groups, along with quotes from the eligible services in each group.
Note

Both the Get Quotes and Get Service Group Quotes endpoints take a consignment object in the body of the request. However, they do not create consignments in and of themselves. In order to allocate to one of the quotes returned by these endpoints, you would need to first create the consignment.

For more information on creating consignments, see the Creating Consignments page.

Sending a Get Quotes Request

To call Get Quotes, send a POST request to https://api.electioapp.com/quotes/. The body of the request should contain a consignment object.

As a minimum, the Get Quotes endpoint requires you to send package weights and dimensions, origin address, and destination address data. You can either specify package weights and dimension via the Weight and Dimensions properties, or by supplying a PackageSizeReference.

There are lots of optional properties you can send when getting quotes for a consignment, including:

  • Your own consignment reference.
  • Details of the specific items inside the consignment's packages.
  • The consignment's source.
  • Shipping and delivery dates.
  • Customs documentation.
  • The consignment's direction of travel.
  • Metadata. PRO metadata enables you to us custom fields to record additional data about a consignment. For more information on using metadata in PRO, see the Metadata page.
  • Tags. Allocation tags enable you to filter the list of carrier services that a particular consignment could be allocated to. For more information on allocation tags, see the Tags page.

Adding optional properties can help to improve the relevance and accuracy of the quote results that you get back from PRO.

The Get Quotes Response

Once it has received the request, PRO returns a quote result. The quote result object includes two lists: one containing Quotes and one containing UnqualifiedServices (that is, eligible services for which it was not possible to obtain a delivery quote).

Each Quote object contains the following information:

  • A unique reference for the quote. This property is important, as it is used when allocating consignments to the quote via the Allocate With Quote endpoint.
  • Creation and expiry dates.
  • The name and reference of the relevant carrier and carrier service.
  • Origin and destination addresses.
  • Collection date, and a delivery date range.
  • Pricing information.
  • Details on each leg of the journey (where applicable).
  • The service direction.

At this point, you would be able to display the relevant quote information to your customer service operative.

Note

For full reference information on the Get Quotes endpoint, see the API Reference.

Example Get Quotes Call

The example below shows a Get Quotes call for a fairly simple consignment. PRO has responded with one quote and two unavailable services.

POST https://api.electioapp.com/quotes/

{
  "Packages": [
    {
      "Weight": {
        "Value": 0.5,
        "Unit": "Kg"
      },
      "Dimensions": {
        "Unit": "Cm",
        "Width": 10.0,
        "Length": 10.0,
        "Height": 10.0
      },
      "Description": "Socks",
      "Value": {
        "Amount": 5.99,
        "Currency": {
          "IsoCode": "GBP"
        }
      }
    }  
  ],
  "Addresses": [
    {
      "AddressType": "Origin",
      "ShippingLocationReference": "Sorted1",
      "IsCached": false
    },
    {
      "AddressType": "Destination",
      "Contact": {
        "Title": "Mr",
        "FirstName": "Peter",
        "LastName": "McPetersson",
        "Telephone": "07702123456",
        "Mobile": "07702123456",
        "LandLine": "0161544123",
        "Email": "peter.mcpetersson@test.com"
      },
      "AddressLine1": "13 Porter Street",
      "Region": "Greater Manchester",
      "Postcode": "M1 5WG",
      "Country": {
        "Name": "Great Britain",
        "IsoCode": {
          "TwoLetterCode": "GB"
        }
      },
      "IsCached": false
    }
  ]
}

Next Steps