Get shipping quotes

curl --request POST \
  --url https://api.teleship.com/api/rates/quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shipTo": {
    "name": "John",
    "address": {
      "line1": "2513 S Jackson St",
      "city": "Seattle",
      "postcode": "98144",
      "state": "WA",
      "country": "US"
    }
  },
  "shipFrom": {
    "name": "Jane",
    "address": {
      "line1": "3 Belvedere Pl",
      "city": "London",
      "postcode": "SE1 0AD",
      "country": "GB"
    }
  },
  "weight": {
    "value": "1.2",
    "unit": "kg"
  },
  "dimensions": {
    "length": "40",
    "width": "30",
    "height": "16",
    "unit": "cm"
  },
  "packageType": "parcel"
}
'

{
  "messages": [
    {
      "code": 123,
      "level": "error",
      "timestamp": "2024-01-01T00:00:00.00Z",
      "message": "An error occurred",
      "details": [
        "Missing required field"
      ]
    }
  ],
  "rates": [
    {
      "price": "10.59",
      "currency": "GBP",
      "transit": 5,
      "estimatedDelivery": "2024-01-01T00:00:00.00Z",
      "service": {
        "name": "<string>",
        "code": "<string>",
        "transit": 123,
        "checkoutName": "<string>",
        "description": "<string>",
        "dispatchDays": 1,
        "includeFirstMile": false,
        "isActive": true,
        "config": {
          "isPostal": true
        },
        "id": "<string>"
      },
      "charges": [
        {
          "name": "base",
          "amount": 22.77,
          "currency": "GBP"
        },
        {
          "name": "Duty",
          "amount": 1.2,
          "currency": "GBP"
        },
        {
          "name": "VAT",
          "amount": 0.5,
          "currency": "GBP"
        }
      ]
    }
  ],
  "commodities": [
    {
      "itemNumber": 123,
      "title": "<string>",
      "hsCode": "<string>",
      "charges": [
        {
          "name": "Duty",
          "amount": 1.2,
          "currency": "GBP",
          "rate": 0.1
        }
      ],
      "restrictions": [
        {
          "importRegion": "<string>",
          "flag": "<string>",
          "importRisk": "<string>",
          "id": "<string>",
          "countryOfOrigin": "AF",
          "hts": "<string>",
          "chapter": "<string>",
          "message": "<string>",
          "info": "<string>",
          "capture": "<string>",
          "metadata": {},
          "serviceCode": "TELESHIP-EXPEDITED-PICKUP",
          "shippingMethod": "RM-RETURN-T24",
          "restrictionLevel": "FALSE",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "scaleWeight": {
    "value": "1.0",
    "unit": "kg"
  },
  "dimWeight": {
    "value": "1.0",
    "unit": "kg"
  },
  "billWeight": {
    "value": "1.0",
    "unit": "kg"
  }
}

{
  "messages": [
    {
      "code": 123,
      "level": "error",
      "timestamp": "2024-01-01T00:00:00.00Z",
      "message": "An error occurred",
      "details": [
        "Missing required field"
      ]
    }
  ]
}

{
  "messages": [
    {
      "code": 123,
      "level": "error",
      "timestamp": "2024-01-01T00:00:00.00Z",
      "message": "An error occurred",
      "details": [
        "Missing required field"
      ]
    }
  ]
}

{
  "messages": [
    {
      "code": 123,
      "level": "error",
      "timestamp": "2024-01-01T00:00:00.00Z",
      "message": "An error occurred",
      "details": [
        "Missing required field"
      ]
    }
  ]
}

POST

api

rates

quotes

curl --request POST \
  --url https://api.teleship.com/api/rates/quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shipTo": {
    "name": "John",
    "address": {
      "line1": "2513 S Jackson St",
      "city": "Seattle",
      "postcode": "98144",
      "state": "WA",
      "country": "US"
    }
  },
  "shipFrom": {
    "name": "Jane",
    "address": {
      "line1": "3 Belvedere Pl",
      "city": "London",
      "postcode": "SE1 0AD",
      "country": "GB"
    }
  },
  "weight": {
    "value": "1.2",
    "unit": "kg"
  },
  "dimensions": {
    "length": "40",
    "width": "30",
    "height": "16",
    "unit": "cm"
  },
  "packageType": "parcel"
}
'

{
  "messages": [
    {
      "code": 123,
      "level": "error",
      "timestamp": "2024-01-01T00:00:00.00Z",
      "message": "An error occurred",
      "details": [
        "Missing required field"
      ]
    }
  ],
  "rates": [
    {
      "price": "10.59",
      "currency": "GBP",
      "transit": 5,
      "estimatedDelivery": "2024-01-01T00:00:00.00Z",
      "service": {
        "name": "<string>",
        "code": "<string>",
        "transit": 123,
        "checkoutName": "<string>",
        "description": "<string>",
        "dispatchDays": 1,
        "includeFirstMile": false,
        "isActive": true,
        "config": {
          "isPostal": true
        },
        "id": "<string>"
      },
      "charges": [
        {
          "name": "base",
          "amount": 22.77,
          "currency": "GBP"
        },
        {
          "name": "Duty",
          "amount": 1.2,
          "currency": "GBP"
        },
        {
          "name": "VAT",
          "amount": 0.5,
          "currency": "GBP"
        }
      ]
    }
  ],
  "commodities": [
    {
      "itemNumber": 123,
      "title": "<string>",
      "hsCode": "<string>",
      "charges": [
        {
          "name": "Duty",
          "amount": 1.2,
          "currency": "GBP",
          "rate": 0.1
        }
      ],
      "restrictions": [
        {
          "importRegion": "<string>",
          "flag": "<string>",
          "importRisk": "<string>",
          "id": "<string>",
          "countryOfOrigin": "AF",
          "hts": "<string>",
          "chapter": "<string>",
          "message": "<string>",
          "info": "<string>",
          "capture": "<string>",
          "metadata": {},
          "serviceCode": "TELESHIP-EXPEDITED-PICKUP",
          "shippingMethod": "RM-RETURN-T24",
          "restrictionLevel": "FALSE",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "scaleWeight": {
    "value": "1.0",
    "unit": "kg"
  },
  "dimWeight": {
    "value": "1.0",
    "unit": "kg"
  },
  "billWeight": {
    "value": "1.0",
    "unit": "kg"
  }
}

{
  "messages": [
    {
      "code": 123,
      "level": "error",
      "timestamp": "2024-01-01T00:00:00.00Z",
      "message": "An error occurred",
      "details": [
        "Missing required field"
      ]
    }
  ]
}

{
  "messages": [
    {
      "code": 123,
      "level": "error",
      "timestamp": "2024-01-01T00:00:00.00Z",
      "message": "An error occurred",
      "details": [
        "Missing required field"
      ]
    }
  ]
}

{
  "messages": [
    {
      "code": 123,
      "level": "error",
      "timestamp": "2024-01-01T00:00:00.00Z",
      "message": "An error occurred",
      "details": [
        "Missing required field"
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-request-id

string

x-account-id

string

Body

application/json

shipTo

object

required

Show child attributes

shipFrom

object

required

Show child attributes

weight

object

required

Show child attributes

dimensions

object

required

Show child attributes

returnTo

object

Show child attributes

billTo

object

Show child attributes

shipDate

string<date-time>

The expected pickup/dropoff date. If provided this must be at least one non-holiday, business day in the future

Example:

"2024-01-01T00:00:00.00Z"

description

string

Gives the recipient information about the parcel in tracking emails.

Maximum string length: 100

packageType

enum<string>

default:parcel

The type of package for the shipment

Available options:

envelope,

tube,

parcel

commodities

object[]

List of the parcel's contents for customs purposes. One entry for each item in the parcel.

Show child attributes

customs

object

Customs declaration details for the shipment

Show child attributes

additionalServices

object

Additional services for the shipment

Show child attributes

orderTrackingReference

string

The request reference for the shipment

customerReference

string

Customer information that will appear on the label. This can be used for pick and pack purposes, to help with parcel identification, or anything else the shipper needs.

commercialInvoiceReference

string

Commercial invoice reference

metadata

object

freightCharge

object

The freight/shipping charge provided by the merchant at checkout. Used for accurate VAT-on-freight calculations.

Show child attributes

Response

messages

object[]

required

Show child attributes

rates

object[]

The available rates for the shipment

Show child attributes

commodities

object[]

Classified and dutiable commodities info

Show child attributes

scaleWeight

object

The scale weight of the shipment

Show child attributes

dimWeight

object

The dimensional weight of the shipment

Show child attributes

billWeight

object

The bill weight of the shipment

Show child attributes

Overview

Authentication

Shipping services

Trade engine

Taxes collections

Authorizations

Headers

Body

Response