QuuoteMe Developer Portal

Introduction

Welcome to QuuoteMe Developer Portal a comprehensive reference guide to the most complete Shipping and Logistic API suite.Here you can access to many API methods to cover all your business cases improving efficiency, reducing operations time/costs and delighting your customer with a next level shipping service.

You can find other information in the API section QuuoteMe Help Center.

Overview

QuuoteMe API is the easiest way to integrate your system with hundreds of carriers worldwide to ship your packages.

Managing Shipments
Creating Shipping Labels
Get Shipping Rates
Get Tracking
Schedule Pickup
Download orders etc.

Getting Started

How to get your credentials and make the first API call.

GetRates API

You can get rates using API.

GetRates Base URL

You can get rates to the following base URL:

https://shipping.quuote.me/v1/rates

GetRates authorization header

You can build the Authorization header as follows:

Body

The body of this request has the following attributes:

Name	Data Type	Required	Empty	Description	Max length
`from_address`	Array	true	false	Sender address information
`name`	string	true	false	Sender name
`street1`	string	true	false	Sender street1
`street2`	string	true	true	Sender street2
`city`	string	true	false	Sender city
`state`	string	false	true	Sender state
`zip`	string	true	false	Sender zip code	Depends on the country
`country`	alpha	true	false	Sender country(Exp. UK)	2 Char
`phone`	string	true	false	Sender phone	Depends on the country
`email`	string	true	false	Sender email
`to_address`	Array	true	false	Recipient address information
`name`	string	true	false	Recipient name
`street1`	string	true	false	Recipient street1	Depends on the specific carrier
`street2`	string	true	true	Recipient street2	Depends on the specific carrier
`city`	string	true	false	Recipient city
`state`	string	false	true	Recipient state
`zip`	string	true	false	Recipient zip code	Depends on the country
`country`	alpha	true	false	Recipient country(Exp. UK)	2 Char
`phone`	string	true	false	Recipient Phone	Country specific phone length
`email`	string	true	false	Recipient Email
`boxes`	Array	true	false	Boxes information (Minimum 1)
`qty`	string	true	false	Boxes Quantity
`length`	int	true	false	Boxes unit lenght
`width`	int	true	false	Boxes unit width
`height`	int	true	false	Boxes unit height
`weight`	float	true	false	Boxes unit weight	2 decimals
`box`	string	true	false	if not available type (N/A)
`box-slug`	string	true	false	Boxex box-slug (If input mode is equal to "Truck", give unit package type).See here
`item`	Array	true	false	Items information (Minimum 1)
`category`	string	true	false	Items category name
`description`	string	true	false	Items description
`currency`	alpha	true	false	Items currency (default: "USD")	3 char
`price`	float	true	false	Items price	2 decimals
`qty`	string	true	false	Items qty
`value`	float	true	false	Items value	2 decimals
`weight`	float	true	false	Item weight	2 decimals
`sku`	string	true	false	Items sku if not available type(N/A)
`total`	float	true	false	Items total price	2 decimals
`hs_code`	string	true	false	Items hs_code if not available type(N/A)
`price`	float	true	true	Total items price	2 decimals
`tax_included`	bool	true	false	type "false" or "true"
`isFTAEligible`	bool	false	false	type "false" or "true"
`currency`	alpha	true	false	currency (default: "USD")	3 char
`insurance`	bool	true	false	type "false" or "true"
`weight_unit`	alpha	true	false	Weight unit of measurement for weight: "kg" (default), "lb", "oz", "g"
`dimension_unit`	alpha	true	false	Dimension unit of measurement for lenght, width, height: "cm" (default), "in"
`input_mode`	string	true	false	The input mode must be either "Courier Service" or "Truck".
`movement_type`	string	true	false	The movement type must be "Door to Door".

⚠️ Warning: Please do not enter a wrong data in fields, as it may cause errors or data processing problems.

unitPackageType

If you select input mode is equal to "Truck", select unit package type one of these.

Box	Box-slug
Bag	`PA`
Box	`KT`
Carton	`KT`
Collico	`CC`
Drum	`PA`
Envelope	`PA`
Euro box pallet	`GB`
Euro pallet	`FP`
One-way pallet	`EP`
Package	`PA`
Roll	`PA`
Tube	`PA`
Wooden crate	`KI`

⚠️ Warning: Please unitPackageType select only when your input_mode is equal to "Truck".

GetRates JSON

QuuoteMe exposes a REST API, you need to send a well-formed JSON POST request containing Method and Params parameters.

{
    "from_address": {
        "name": "John Doe",
        "street1": "1234 Example St",
        "street2": "Example 101",
        "country": "US",
        "zip": "12345",
        "state": "CA",
        "city": "Example City",
        "phone": "+1 123-456-7890",
        "email": "john.doe@example.com"
    },
    "to_address": {
        "name": "John Doe",
        "street1": "1234 Example St",
        "street2": "Example 101",
        "country": "US",
        "zip": "12345",
        "state": "CA",
        "city": "Example City",
        "phone": "+1 123-456-7890",
        "email": "john.doe@example.com"
    },
    "boxes": [
        {
            "qty": "1",
            "length": "20",
            "width": "15",
            "height": "10",
            "weight": "0.5",
            "box": "custom box",
            "box_slug": "custom-box",
            "item": [
                {
                    "category": "example",
                    "description": "Example description",
                    "currency": "USD",
                    "price": "10.00",
                    "qty": "1",
                    "value": "10.00",
                    "weight": "0.5",
                    "sku": "example-001",
                    "total": "10.00",
                    "hs_code": "00000"
                }
            ],
            "price": "10.00"
        }
    ],
    "tax_included": false,
    "isFTAEligible": false,
    "currency": "USD",
    "insurance": false,
    "weight_unit": "kg",
    "dimension_unit": "cm",
    "input_mode": "Courier Service",
    "movement_type": "Door to Door"
}

GetRates cURL

Here is the cURL code example.

curl --location 'https://shipping.quuote.me/v1/rates' \
--header 'x-api-key: aaaaaaaaaaaaa' \
--header 'x-api-sec: aaaaaaaaaaaaa' \
--header 'Content-Type: application/json' \
--data-raw '

{
    "from_address": {
        "name": "John Doe",
        "street1": "1234 Example St",
        "street2": "Example 101",
        "country": "US",
        "zip": "12345",
        "state": "CA",
        "city": "Example City",
        "phone": "+1 123-456-7890",
        "email": "john.doe@example.com"
    },
    "to_address": {
        "name": "John Doe",
        "street1": "1234 Example St",
        "street2": "Example 101",
        "country": "US",
        "zip": "12345",
        "state": "CA",
        "city": "Example City",
        "phone": "+1 123-456-7890",
        "email": "john.doe@example.com"
    },
    "boxes": [
        {
            "qty": "1",
            "length": "20",
            "width": "15",
            "height": "10",
            "weight": "0.5",
            "box": "custom box",
            "box_slug": "custom-box",
            "item": [
                {
                    "category": "example",
                    "description": "Example description",
                    "currency": "USD",
                    "price": "10.00",
                    "qty": "1",
                    "value": "10.00",
                    "weight": "0.5",
                    "sku": "example-001",
                    "total": "10.00",
                    "hs_code": "00000"
                }
            ],
            "price": "10.00"
        }
    ],
    "tax_included": false,
    "isFTAEligible": false,
    "currency": "USD",
    "insurance": false,
    "weight_unit": "kg",
    "dimension_unit": "cm",
    "input_mode": "Courier Service",
    "movement_type": "Door to Door"
}

Booking API

You can create booking using API.

Booking Base URL

You can create booking to the following base URL:

https://shipping.quuote.me/v1/book

Booking authorization header

You can build the Authorization header as follows:

Body

The body of this request has the following attributes:

Name	Data Type	Required	Empty	Description	Max length
`quoterequest`	Array	true	false	Recipient boxes information
`boxes`	Array	true	false	Boxes information (Minimum 1)
`qty`	string	true	false	Boxes Quantity
`length`	int	true	false	Boxes unit lenght
`width`	int	true	false	Boxes unit width
`height`	int	true	false	Boxes unit height
`weight`	float	true	false	Boxes unit weight	2 decimals
`box`	string	true	false	Boxex box (custom-box)
`box-slug`	string	true	false	Boxex box-slug (If input mode is equal to "Truck", give unit package type).See here
`item`	Array	true	false	Items information (Minimum 1)
`category`	string	true	false	Items category name
`description`	string	true	false	Items description
`currency`	alpha	true	false	Items currency (default: "USD")	3 char
`price`	float	true	false	Items price	2 decimals
`qty`	string	true	false	Items qty
`value`	float	true	false	Items value	2 decimals
`weight`	float	true	false	Item weight	2 decimals
`sku`	string	true	false	Items sku if not available type(N/A)
`total`	float	true	false	Items total price	2 decimals
`hs_code`	string	true	false	Items hs_code if not available type(N/A)
`price`	float	true	true	Total items price	2 decimals
`tax_included`	bool	true	false	type "false" or "true"
`isFTAEligible`	bool	false	false	type "false" or "true"
`currency`	alpha	true	false	currency (default: "USD")	3 char
`weight_unit`	alpha	true	false	Weight unit of measurement for weight: "kg" (default), "lb", "oz", "g" (case-insensitive)
`dimension_unit`	alpha	true	false	Dimension unit of measurement for lenght, width, height: "cm" (default), "in"
`insurance`	bool	true	false	type "false" or "true"
`input_mode`	string	true	false	The input mode must be either "Courier Service" or "Truck".
`movement_type`	string	true	false	The movement type must be "Door to Door".
`shipper`	Array	true	false	Shipper address
`cname`	string	true	false	Shipper cname (company name)
`name`	string	true	false	Shipper name
`phone`	string	true	false	Shipper Phone	Country specific phone length
`email`	string	true	false	Shipper email
`address`	string	true	false	Shipper address	Depends on the specific carrier
`address2`	string	true	true	Shipper address2	Depends on the specific carrier
`country`	alpha	true	false	Shipper country(Exp. UK)	2 Char
`cntrname`	string	true	false	Shipper cntrname(country complete name)
`state`	string	false	true	Shipper state
`city`	string	true	false	Shipper city
`zip`	string	true	false	Shipper zip code	Depends on the country
`Consignee`	Array	true	false	Consignee address
`cname`	string	true	false	Consignee cname (company name)
`name`	string	true	false	Consignee name
`phone`	string	true	false	Consignee Phone	Country specific phone length
`email`	string	true	false	Consignee email
`address`	string	true	false	Consignee address	Depends on the specific carrier
`address2`	string	true	true	Consignee address2	Depends on the specific carrier
`country`	alpha	true	false	Consignee country(Exp. UK)	2 Char
`cntrname`	string	true	false	Consignee cntrname(country complete name)
`state`	string	false	true	Consignee state
`city`	string	true	false	Consignee city
`zip`	string	true	false	Consignee zip code	Depends on the country
`notify`	Array	false	true	Notify address
`cname`	string	false	true	Notify cname (company name)
`name`	string	false	true	Notify name
`phone`	string	false	true	Notify Phone	Country specific phone length
`email`	string	false	true	Notify email
`address`	string	false	true	Notify address	Depends on the specific carrier
`address2`	string	false	true	Notify address2	Depends on the specific carrier
`country`	alpha	false	true	Notify country(Exp. UK)	2 Char
`cntrname`	string	false	true	Notify cntrname(country complete name)
`state`	string	false	true	Notify state
`city`	string	false	true	Notify city
`zip`	string	false	true	Notify zip code	Depends on the country
`rate_id`	string	true	false	you can get "rate_id" from selected rates
`service_option`	string	true	false	you can get "service_option" from selected rates serviceOptions(name)
`pickup_price`	float	true	false	you can get "pickup_price" from selected rates serviceOptions(price)
`pickup`	Array	true	true	Pickup information(if service_option selected 'Drop-off' send pickup details empty)
`pickup_date`	date	true	true	Pickup date(after or equal to today) date format(Y-m-d)
`morning_min_time`	string	true	true	Pickup morning minimum time, time format(H:i), after or equal(00:00), (before:pickup.morning_max_time)
`morning_max_time`	string	true	true	Pickup morning maximum time, time format(H:i), (after:pickup.morning_min_time), (before:12:00)
`afternoon_min_time`	string	true	true	Pickup afternoon minimum time, time format(H:i), after or equal to (12:00), (before:pickup.afternoon_max_time)
`afternoon_max_time`	string	true	true	Pickup afternoon maximum time, time format(H:i), (after:pickup.afternoon_min_time), before or equal to (23:59)
`insurance`	bool	true	false	Insurance must be type "0" or "1"
`payment`	string	true	false	The payment field must be "e-wallet"
`cr_order_number`	string	true	false	If cr_order_number is empty type (N/A)

⚠️ Warning: Please do not enter a wrong data in fields, as it may cause errors or data processing problems.

unitPackageType

If you select input mode is equal to "Truck", select unit package type one of these.

Box	Box-slug
Bag	`PA`
Box	`KT`
Carton	`KT`
Collico	`CC`
Drum	`PA`
Envelope	`PA`
Euro box pallet	`GB`
Euro pallet	`FP`
One-way pallet	`EP`
Package	`PA`
Roll	`PA`
Tube	`PA`
Wooden crate	`KI`

⚠️ Warning: Please unitPackageType select only when your input_mode is equal to "Truck".

Booking JSON

QuuoteMe exposes a REST API, you need to send a well-formed JSON POST request containing Method and Params parameters.

{
    "quoterequest": {
        "boxes": [
            {
                "qty": "1",
                "length": "20",
                "width": "15",
                "height": "10",
                "weight": "0.5",
                "box": "custom box",
                "box_slug": "custom-box",
                "item": [
                    {
                        "category": "example",
                        "description": "Example description",
                        "currency": "USD",
                        "price": "10.00",
                        "qty": "1",
                        "value": "10.00",
                        "weight": "0.5",
                        "sku": "example-001",
                        "total": "10.00",
                        "hs_code": "00000"
                    }
                ],
                "price": "10.00"
            }
        ],
        "tax_included": false,
        "isFTAEligible": false,
        "currency": "USD",
        "insurance": false,
        "weight_unit": "kg",
        "dimension_unit": "cm",
        "input_mode": "Courier Service",
        "movement_type": "Door to Door"
    },
    "shipper": {
        "cname": "Example Company",
        "name": "John Doe",
        "phone": "+1 123-456-7890",
        "email": "john.doe@example.com",
        "address": "1234 Example St",
        "address2": "Example 101",
        "country": "US",
        "cntrname": "United State",
        "state": "CA",
        "city": "Example City",
        "zip": "12345"
    },
    "consignee": {
        "cname": "Example Company",
        "name": "John Doe",
        "phone": "+1 123-456-7890",
        "email": "john.doe@example.com",
        "address": "1234 Example St",
        "address2": "Example 101",
        "country": "US",
        "cntrname": "United State",
        "state": "CA",
        "city": "Example City",
        "zip": "12345"
    },
    "notify": {
        "cname": "Example Company",
        "name": "John Doe",
        "phone": "+1 123-456-7890",
        "email": "john.doe@example.com",
        "address": "1234 Example St",
        "address2": "Example 101",
        "country": "US",
        "cntrname": "United State",
        "state": "CA",
        "city": "Example City",
        "zip": "12345"
    },
    "rate_id": "00000",
    "service_option": "Free pickup",
    "pickup_price": 0,
    "pickup": {
        "pickup_date": "2024-05-20",
        "morning_min_time": "09:00",
        "morning_max_time": "11:00",
        "afternoon_min_time": "12:00",
        "afternoon_max_time": "17:00"
    },
    "insurance": 0,
    "payment": "e-wallet",
    "cr_order_number": "Example"
}

Booking cURL

Here is the cURL code example.

curl --location 'https://shipping.quuote.me/v1/book' \
--header 'x-api-key: aaaaaaaaaaaaa' \
--header 'x-api-sec: aaaaaaaaaaaaa' \
--header 'Content-Type: application/json' \
--data-raw '

{
    "quoterequest": {
        "boxes": [
            {
                "qty": "1",
                "length": "20",
                "width": "15",
                "height": "10",
                "weight": "0.5",
                "box": "custom box",
                "box_slug": "custom-box",
                "item": [
                    {
                        "category": "example",
                        "description": "Example description",
                        "currency": "USD",
                        "price": "10.00",
                        "qty": "1",
                        "value": "10.00",
                        "weight": "0.5",
                        "sku": "example-001",
                        "total": "10.00",
                        "hs_code": "00000"
                    }
                ],
                "price": "10.00"
            }
        ],
        "tax_included": false,
        "isFTAEligible": false,
        "currency": "USD",
        "insurance": false,
        "weight_unit": "kg",
        "dimension_unit": "cm",
        "input_mode": "Courier Service",
        "movement_type": "Door to Door"
    },
    "shipper": {
        "cname": "Example Company",
        "name": "John Doe",
        "phone": "+1 123-456-7890",
        "email": "john.doe@example.com",
        "address": "1234 Example St",
        "address2": "Example 101",
        "country": "US",
        "cntrname": "United State",
        "state": "CA",
        "city": "Example City",
        "zip": "12345"
    },
    "consignee": {
        "cname": "Example Company",
        "name": "John Doe",
        "phone": "+1 123-456-7890",
        "email": "john.doe@example.com",
        "address": "1234 Example St",
        "address2": "Example 101",
        "country": "US",
        "cntrname": "United State",
        "state": "CA",
        "city": "Example City",
        "zip": "12345"
    },
    "notify": {
        "cname": "Example Company",
        "name": "John Doe",
        "phone": "+1 123-456-7890",
        "email": "john.doe@example.com",
        "address": "1234 Example St",
        "address2": "Example 101",
        "country": "US",
        "cntrname": "United State",
        "state": "CA",
        "city": "Example City",
        "zip": "12345"
    },
    "rate_id": "00000",
    "service_option": "Free pickup",
    "pickup_price": 0,
    "pickup": {
        "pickup_date": "2024-05-20",
        "morning_min_time": "09:00",
        "morning_max_time": "11:00",
        "afternoon_min_time": "12:00",
        "afternoon_max_time": "17:00"
    },
    "insurance": 0,
    "payment": "e-wallet",
    "cr_order_number": "Example"
}

GetTracking API

You can track shipments using API.

Tracking Base URL

You can get tracking info to the following base URL:

https://shipping.quuote.me/v1/track

Tracking authorization header

You can build the Authorization header as follows:

Body

The body of this request has the following attributes:

Name	Data Type	Required	Empty	Description	Max length
`orderId`	string	true	false	Booking orderId

⚠️ Warning: Please do not enter a wrong data in fields, as it may cause errors or data processing problems.

Tracking JSON

QuuoteMe exposes a REST API, you need to send a well-formed JSON POST request containing Method and Params parameters.

{

"orderId": "ORDER-0000000000"

}

Tracking cURL

Here is the cURL code example.

curl --location 'https://shipping.quuote.me/v1/track' \
--header 'x-api-key: aaaaaaaaaaaaa' \
--header 'x-api-sec: aaaaaaaaaaaaa' \
--header 'Content-Type: application/json' \
--data '{

"orderId": "ORDER-0000000000"

GetDocuments API

You can create documents using API.

Document Base URL

You can create documents to the following base URL:

https://shipping.quuote.me/v1/getShipping

Document authorization header

You can build the Authorization header as follows:

Body

The body of this request has the following attributes:

Name	Data Type	Required	Empty	Description	Max length
`orderId`	string	true	false	Booking orderId

⚠️ Warning: Please do not enter a wrong data in fields, as it may cause errors or data processing problems.

Document JSON

QuuoteMe exposes a REST API, you need to send a well-formed JSON POST request containing Method and Params parameters.

{

"orderId": "ORDER-0000000000"

}

Document cURL

Here is the cURL code example.

curl --location 'https://shipping.quuote.me/v1/getShipping' \
--header 'x-api-key: aaaaaaaaaaaaa' \
--header 'x-api-sec: aaaaaaaaaaaaa' \
--header 'Content-Type: application/json' \
--data '{

"orderId": "ORDER-0000000000"