API > Quote > Get a quote

Quote

Get a parcel delivery quote

Obtain a parcel delivery quote from a collection address to a delivery address, optionally filtered by carrier, service or type.

Endpoint

POST

https://api.interparcel.com/quote

Request Headers

Name	Type	Required	Example	Description
Accept	String	true	application/json	Request the content in the correct format
Content-Type	String	true	application/json	Ensure the content sent is in the correct format
X-Interparcel-Auth	String	true	YOUR_API_KEY	Your API Key provided by Interparcel
X-Interparcel-API-Version	String	true	3	The latest API version

Request Body

collection
- city
- state
- postcode
- country
delivery
- city
- state
- postcode
- country
filter
- serviceLevel
  - Service Level
- carriers
  - Carrier
- services
  - Service
- pickupType
  - Pickup Type
parcels
- weight
- length
- width
- height

Example Request - Minimum

This is the minimum data required to get a quote

{
	"collection": {
		"city": "Crawley",
		"postcode": "RH10 9RD",
		"country": "UK"
	},
	"delivery": {
		"city": "Cergy",
		"postcode": "75001",
		"country": "France"
	},
	"parcels": [
		{
			"weight": 2,
			"length": 5,
			"width": 10,
			"height": 12
		}
	]
}

Example Request - All Filters

All filters have been populated. You wouldn't normally use them all at the same time.

{
	"collection": {
		"city": "Crawley",
		"state": "West Sussex",
		"postcode": "RH10 9RD",
		"country": "UK"
	},
	"delivery": {
		"city": "Brighton",
		"state": "Sussex",
		"postcode": "RH10 9RD",
		"country": "UK"
	},
	"filter": {
		"serviceLevel": [
			"express",
			"timed"
		],
		"carriers": [
			"DX",
			"Parcelforce"
		],
		"services": [
			"DX Express",
			"Parcelforce"
		],
		"pickupType": [
			"collection",
			"dropoff"
		]		
	},
	"parcels": [
		{
			"weight": 2,
			"length": 5,
			"width": 10,
			"height": 12
		},
		{
			"weight": 3,
			"length": 4,
			"width": 16,
			"height": 7
		}
	]
}

Example Responses

Success

▼

{
    "status": 0,
    "services": [
        {
            "id": "DXEXP",
            "carrier": "DX",
            "name": "Express",
            "service": "DX Express",
            "serviceLevel": "express",
            "price": 17.99,
            "currency": "GBP",
            "taxable": true,
            "includedCover": 20,
            "maxCover": 1000,
            "printerNeeded": false,
            "restrictions": {
                "maximumWeight": 20,
                "maximumLength": 95
            },
            "pickupType": "collection",
            "delivery": {
                "daysFrom": 0,
                "daysTo": 0
            }
        }
    ]
}

Success - No services found

▼

{
    "status": 0,
    "services": []
}

Error - Invalid Collection Country

▼

{
    "status": 1,
    "errorMessage": "Invalid collection country",
    "errorCode": "100001"
}

Definitions

Body

Name	Type	Required	Description
collection	Address Object	true	Collection address
delivery	Address Object	true	Delivery address
filter	Filter Object	false	Filter the quote results
parcels	Parcels Array of Objects	true	Parcel details

Address

Name	Type	Required	Description
city	String	true	Town / City
state	String	conditional	State
postcode	String	true	Postcode
country	String	true	Country

Filter

Name	Type	Required	Description
serviceLevel	Array	false	One or more Service Levels
carriers	Array	false	One or more carriers
services	Array	false	One ore more service codes
pickupType	Array	false	One or more Pickup Types

Parcels

Name	Type	Required	Description
weight	Decimal	true	Parcel weight in kg
length	Integer	true	Parcel length in cm
width	Integer	true	Parcel width in cm
height	Integer	true	Parcel height in cm

Service Levels

standard, express, timed, sameday, pallet

Pickup Types

collection, dropoff