List Quotes

POST

/quotes

Parameters

Header Parameters

Authentication

string

Example

APP_TOKEN

Request Body

object

destination_address

object

first_name

Recipient first name, populated from the Veeqo order.

string

last_name

Recipient last name.

string

company

Recipient company name.

string

line_1

First line of the recipient address.

string

line_2

Second line of the recipient address.

string

city

Recipient city.

string

country

Country code for the recipent address in ISO 3166-1 alpha-2 format.

string

state

Recipient state or county.

string

zip

Zip/Post Code of the recipient address.

string

phone

Populated from the shipping address or if empty, the billing address.

string

email

Populated from the shipping address or if empty, the billing address.

string

collection_address

The Veeqo location the shipment will be dispatched from.

object

name

The location name.

string

line_1

First line of the collection address.

string

line_2

Second line of the collection address.

string

city

The collection address city.

string

state

The collection address state or county.

string

country

The collection address country, in ISO 3166-1 alpha-2 format.

string

phone

string

zip

ZIP/Post code of the collection address.

string

contents

Array<object>

object

description

string

quantity

number

tariff_number

HS Code of the item, used when the item is shipped internationally.

string

origin_country

Country of origin of the product.

string

price_per_unit

Order value of the product.

number

total_sale_price

Value of the product, minus discounts.

number

weight_in_grams

Weight of one instance of the product.

number

parcels

Array<object>

object

dimensions

object

height

number

width

number

length

number

unit

string

Allowed values: cm inches

weight_in_grams

number

total_price

Total sales price of the shipment.

number

reference

Veeqo order number for the shipment.

string

currency_code

The 3 letter ISO 4217 currency code all shipment prices are in.

string

delivery_cost

Delivery cost paid by the end customer.

number

Example

{
  "destination_address": {
    "first_name": "Derek",
    "last_name": "Trotter",
    "company": "Trotters Independent Traders",
    "city": "Peckham",
    "country": "GB",
    "state": "",
    "zip": "SE15 2EB",
    "phone": "07758989787",
    "email": "<sales@trotters.com>",
    "line_1": "80 Nelson Mandella House",
    "line_2": "Nyrere Estate"
  },
  "collection_address": {
    "name": "Nags Head",
    "line_1": "Nags Head, Chapel Market",
    "line_2": "",
    "city": "Peckham",
    "country": "GB",
    "phone": "02893243309",
    "zip": "N1 ORW",
    "state": ""
  },
  "contents": [
    {
      "description": "Ifone 9s",
      "quantity": 1,
      "tariff_number": "505050",
      "origin_country": "GB",
      "price_per_unit": 250,
      "total_sale_price": 250,
      "weight_in_grams": 455
    }
  ],
  "parcels": [
    {
      "dimensions": {
        "height": 15,
        "width": 22,
        "length": 10,
        "unit": "cm"
      },
      "weight_in_grams": 50
    }
  ],
  "total_price": 253,
  "reference": "#P-217",
  "currency_code": "USD",
  "delivery_cost": 3
}

Responses

201

Successfully fetched rates.

Array<object>

object

code

Code to identify the given quote when shipping.

string

name

Service name for the quote, displayable in Veeqo.

string

price

Price that will be charged for the service.

number

currency

The 3 letter currency code in ISO 4217 format that the service price is in.

string

service

Specify if the service requires a collection or dropoff.

string

Allowed values: collection dropoff

delivery_estimate

The estimated delivery date time in ISO 8601 format.

string

service_carrier

Carrier name for the quote. This value will be passed onto external marketplaces if the service has been selected for shipment.

string

Example

[
  {
    "code": "next_day",
    "name": "Next Day",
    "price": 4.1,
    "currency": "USD",
    "service_type": "collection",
    "delivery_estimate": "2020-10-14T13:11:32.141Z"
  },
  {
    "code": "two_day",
    "name": "Two Day",
    "price": 2.48,
    "currency": "USD",
    "service_type": "collection",
    "delivery_estimate": "2020-10-15T13:11:32.142Z"
  },
  {
    "code": "one_day_dropoff",
    "name": "One Day",
    "price": 4.05,
    "currency": "USD",
    "service_type": "dropoff",
    "delivery_estimate": "2020-10-14T13:11:32.142Z"
  }
]

Headers

Authentication

string

Example

APP_TOKEN

400

Bad Request

object

errors

Array of strings detailing errors related to showing quotes.

array

Example

{
  "errors": [
    "Post code invalid",
    "Shipment weight cannot be 0"
  ]
}