Rating

This API endpoint allows a merchant to request shipping and handling quotes based on a set of order items and a destination zip code.

Methods

rate.quote
rate.services

Entity Properties

Destination
Method Information Properties
Rate Properties

`rate.quote`

rate.quote (object $destination, object $items, object $methodInfo) Request shipping and handling quotes based on a set of order items and a destination zip code.

Parameters

destination

object

Destination (see Destination Properties)

items

object

Order Items. Format:

[ { "sku": "product1", "qty": 1 }, { "sku": "product2", "qty": 3 } ]

methodInfo

object

Method Information (see Method Information Properties)

Return Value

An object with rates and handling cost.

Example Request

Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "rate.quote",
        [
            {
                "country" : "US",
                "region" : "NY",
                "city" : "New York",
                "street" : "11 Times Square",
                "postcode" : "10036",
                "company" : "Microsoft",
                "classification" : "com"
                
            },
            [
                { 
                    "sku" : "product1", 
                    "qty": 1 
                }, 
                { 
                    "sku" : "product2", 
                    "qty" : 3 
                } 
            ],
            {
                "methods" : "ups_03",
                "signature_required" : "adult",
                "saturday_delivery" : false,
                "overbox" : false
            }
        ]
    ]
}

Example Response

Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : {
        "rates" : [
            {
                "code" : "ups_03",
                "description" : "UPS Ground",
                "zone" : "002",
                "days_in_transit" : "2",
                "package_count" : 1,
                "shipping_cost" : "17.23",
                "shipping_cost_currency" : "USD",
                "if_ordered_by" : "15:00:00",
                "min_delivery_date" : "2017-02-05",
                "max_delivery_date" : "2017-02-05",
                "signature_fee" : "1.15",
                "signature_fee_currency" : "USD",
                "multiple_warehouses" : false,
                "allocation" : [
                    { "product1" : [{ "warehouse_id": 1, "qty": "1.000" }] },
                    { "product2" : [{ "warehouse_id": 1, "qty": "3.000" }] }
                ]
            }
        ],
        "handling_cost" : "2.4",
        "handling_cost_currency" : "USD"
    }
}

`rate.services`

rate.services (int|null $warehouseId) Get a list of the enabled shipping methods.

Parameters

warehouseId

integer | null

Warehouse. If not specified, the first allowed warehouse will be used.

Return Value

An array of enabled shipping methods.

Example Request

Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "c4d62bb4c368d8158b1221cd5f27a659",
        "rate.services",
        1
    ]
}

Example Response

Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "result" : {
        "external_ltl" : {
            "title" : "LTL",
            "carrier_code" : "external",
            "service" : "ltl",
            "rates_available" : false
        },
        "external_ltl_thirdparty" : {
            "title" : "LTL - Third Party",
            "carrier_code" : "external",
            "service" : "ltl_thirdparty",
            "rates_available" : false
        },
        "fedex_EUROPE_FIRST_INTERNATIONAL_PRIORITY" : {
            "title" : "FedEx Europe First International Priority",
            "carrier_code" : "fedex",
            "service" : "EUROPE_FIRST_INTERNATIONAL_PRIORITY",
            "rates_available" : true
        },
        "fedex_FEDEX_1_DAY_FREIGHT" : {
            "title" : "FedEx 1 Day Freight",
            "carrier_code" : "fedex",
            "service" : "FEDEX_1_DAY_FREIGHT",
            "rates_available" : true
        },
        "fedex_FEDEX_2_DAY" : {
            "title" : "FedEx 2 Day",
            "carrier_code" : "fedex",
            "service" : "FEDEX_2_DAY",
            "rates_available" : true
        },
        "ups_02" : {
            "title" : "UPS 2nd Day Air",
            "carrier_code" : "ups",
            "service" : "02",
            "rates_available" : true
        },
        "ups_03" : {
            "title" : "UPS Ground",
            "carrier_code" : "ups",
            "service" : "03",
            "rates_available" : true
        },
        "ups_07" : {
            "title" : "UPS Worldwide Express",
            "carrier_code" : "ups",
            "service" : "07",
            "rates_available" : true
        }
    }
}

Entity Properties

Destination Properties

Show Destination Properties

country

string

The “Country” property. ISO-2 format.

region

string

The “Region” property. 2 characters.

city

string

The “City” property.

street

string

The street address. Multi-line street addresses will be separated by a newline (“\n”) character.

postcode

string

The “Postal Code” property. Pass as a string to prevent leading 0s from being dropped.

company

string

The “Company” property.

classification

string

The “Classification” property. Allowed: “res” - residential, “com” - commercial, “po” - post office, “mil” - military, “unk” - unknown.

Method Information Properties

Show Method Information Properties

methods

string

One or more shipping methods. See the Shipping Methods document for a reference.

signature_required

string

If “adult” then the package(s) will be shipped with the Adult Signature Required option (21 years or older). If “any” then the package(s) will be shipped with the “Direct” signature required (recipient of any age). If “indirect” then the package(s) will be shipped with the “Indirect” signature required (if “Indirect” is not supported by the carrier, this option will fall back to ‘any’). If not specified will default to “none”.

saturday_delivery

boolean

Saturday delivery option. If not specified will default to ‘false’.

overbox

boolean

Request overbox option. If not specified will default to ‘false’.

Rate Properties

Show Rate Properties

code

string

Shipping methods. See the Shipping Methods document for a reference.

description

string

See the Shipping Methods document for a reference.

zone

string

Carrier zone.

days_in_transit

integer

Days in transit.

package_count

integer

The number of packages.

shipping_cost

string

Shipping cost.

shipping_cost_currency

string

Shipping cost currency. An ISO 4217 alphabetic code.

if_ordered_by

string

Same day shipping if you place your order by this time. 24 hour clock time. Eastern Time.

min_delivery_date

string

Minimum delivery date.

max_delivery_date

string

Maximum delivery date.

signature_fee

string

Signature fee.

signature_fee_currency

string

Signature fee currency. An ISO 4217 alphabetic code.

multiple_warehouses

boolean

Multiple warehouses flag indicates if the items were split between multiple warehouses.

allocation

array

Inventory allocated to warehouses.

base_rate

string

Base rate, before surcharges are applied.

base_rate_currency

string

Base rate currency. An ISO 4217 alphabetic code.

residential_surcharge

string

Residential surcharge.

residential_surcharge_currency

string

Residential surcharge currency. An ISO 4217 alphabetic code.

area_surcharge

string

Area surcharge.

area_surcharge_currency

string

Area surcharge currency. An ISO 4217 alphabetic code.

fuel_surcharge

string

Fuel surcharge.

fuel_surcharge_currency

string

Fuel surcharge currency. An ISO 4217 alphabetic code.

weight_surcharge

string

Weight surcharge.

weight_surcharge_currency

string

Weight surcharge currency. An ISO 4217 alphabetic code.

packaging_surcharge

string

Packaging surcharge.

packaging_surcharge_currency

string

Packaging surcharge currency. An ISO 4217 alphabetic code.

dimension_surcharge

string

Dimension surcharge.

dimension_surcharge_currency

string

Dimension surcharge currency. An ISO 4217 alphabetic code.

oversize_surcharge

string

Oversize surcharge.

oversize_surcharge_currency

string

Oversize surcharge currency. An ISO 4217 alphabetic code.

demand_surcharge

string

Demand surcharge.

demand_surcharge_currency

string

Demand surcharge currency. An ISO 4217 alphabetic code.

additional_surcharge

string

Additional surcharge.

additional_surcharge_currency

string

Additional surcharge currency. An ISO 4217 alphabetic code.

Get Started

Common Features

Shipping

Receiving

Inventory

System

Methods

Entity Properties

`rate.quote`

Parameters

Return Value

Example Request

Example Response

`rate.services`

Parameters

Return Value

Example Request

Example Response

Entity Properties

Destination Properties

Method Information Properties

Rate Properties

Get Started

Common Features

Shipping

Receiving

Inventory

System

​Methods

​Entity Properties

​rate.quote

​Parameters

​Return Value

​Example Request

​Example Response

​rate.services

​Parameters

​Return Value

​Example Request

​Example Response

​Entity Properties

​Destination Properties

​Method Information Properties

​Rate Properties

Methods

Entity Properties

`rate.quote`

Parameters

Return Value

Example Request

Example Response

`rate.services`

Parameters

Return Value

Example Request

Example Response

Entity Properties

Destination Properties

Method Information Properties

Rate Properties