Estimate Fulfillment Shipping Rate

This API describes how to get the fulfillment shipping rate estimation.

Method: POST

Request Body

json

{
  "shipping_method": "STAND",
  "warehouse_code": "LAX01W",
  "currency": "USD",
  "to_address": {
    "address_1": "1 MAIN ST",
    "address_2": "",
    "city": "Anytown",
    "state": "CA",
    "zip": "90210",
    "country": "US"
  },
  "package": {
    "weight": 20.35,
    "width": 12.55,
    "length": 15.2,
    "height": 4.7
  }
}

Request Body Explanation

Attribute Name	Type	Description
shipping_method	String	shipping method name, you can get this value from the `Get Warehouse List` API
warehouse_code	String	code of the warehouse shipping from, you can get this value from the `Get Warehouse List` API
currency	String	Currency code, only support USD for now
to_address	Object	consignee's address
address_1	String	address line 1
address_2	String	address line 2
city	String	city name
state	String	state or province
zip	String	zip code
country	String	country name
package	Object	package information
weight	Float	package weight, unit LB
width	Float	package width, unit inch
length	Float	package length, unit inch
height	Float	package height, unit inch

Response Body

json

{
  "code": 200,
  "data": {
    "currency": "USD",
    "shipping_method": "STAND",
    "warehouse_code": "LAX01W",
    "estimated_cost": 17.6
  }
}

Response Body Explanation

Attribute Name	Type	Description
code	Integer	Response code: 200 successful, 400/500 failed
data	Object	return value list of cost for different shipping methods
currency	String	Currency code
shipping_method	String	Shipping method name
warehouse_code	String	warehouse code
estimated_cost	Float	estimated shipping cost. This is ONLY ESTIMATE and final quotation is determined once tracking number gets checked-in in the system.

Response Example (when zip code not in service area)

json

{
  "code": 400,
  "message": "zip code is not in service area."
}