Field	Type	Max Length	Required	Description
FirstName	String	50	Yes	First Name
LastName	String	50	Yes	Last Name
Email	String	50	Yes	Email Address
Phone	String	50	Yes	Phone Number
Address1	String	10	Yes	Address Line 1
Address2	String	50	No	Address Line 2
Address3	String	50	No	Address Line 3
City	String	50	Yes	City
State	String	2* (US)	Yes	State/Province
Zip	String	5* (US)	Yes	Postal Code
Country	String	2	Yes	Country Code

Request Parameters

Field	Type	Max Length	Required	Description
FromAddress	Address	-	Yes	Sender’s information
ToAddress	Address	50	Yes	Recipient's information
BoxInformation	Box Info	50	Yes	Box Information
ShippingInformation	Shipping Info	100	No	Shipping information
Items	Items[]	10	No	Array of order items

Address

Field	Type	Max Length	Required	Description
FirstName	String	50	Yes	First Name
LastName	String	50	Yes	Last Name
Email	String	50	Yes	Email Address
Phone	String	50	Yes	Phone Number
Address1	String	10	Yes	Address Line 1
Address2	String	50	No	Address Line 2
Address3	String	50	No	Address Line 3
City	String	50	Yes	City
State	String	2* (US)	Yes	State/Province
Zip	String	5* (US)	Yes	Postal Code
Country	String	2	Yes	Country Code

Box Information

Field	Type	Max Length	Required	Description
Weight	Decimal	50	Yes	Package Weight
Length	Decimal	50	Yes	Package Length
Height	Decimal	50	Yes	Package Height
Width	Decimal	50	Yes	Package Width
PackageType	String	10	Yes	Packaging Type (Box, Softpack)

Shipping Information

Field	Type	Max Length	Required	Description
SaturdayDelivery	bool	-	No	Saturday Delivery
SignatureRequired	bool	-	No	Signature Required for Delivery
Insurance	bool	-	No	Insure Value of Contents

Item

Field	Type	Max Length	Required	Description
ItemCode	String	50	Yes	Item Code
UPC	String	50	No	UPC Code
Price	Decimal	-	Yes	Item Price
Quantity	Int	-	Yes	Quantity
HTSCode	String	50	Yes * (Int’l)	Harmonized Tariff Schedule Code
Weight	Decimal	-	Yes * (Int’l)	Item Weight

Request Example

1{
2  "FromAddress": {
3    "FirstName": "string",
4    "LastName": "string",
5    "Email": "string",
6    "Phone": "string",
7    "Address1": "string",
8    "Address2": "string",
9    "Address3": "string",
10    "City": "string",
11    "State": "string",
12    "Zip": "string",        // *required
13    "Country": "string"     // *required
14  },
15  "ToAddress": {
16    "FirstName": "string",
17    "LastName": "string",
18    "Email": "string",
19    "Phone": "string",
20    "Address1": "string",
21    "Address2": "string",
22    "Address3": "string",
23    "City": "string",
24    "State": "string",
25    "Zip": "string",        // *required
26    "Country": "string"     // *required
27  },
28  "BoxInformation": {
29    "Weight": "decimal",    // *required
30    "Length": "decimal",    // *required
31    "Height": "decimal",    // *required
32    "Width": "decimal",     // *required
33    "PackageType": "string" // *required ["Box", "Softpack"]
34  },
35  "ShippingInformation": {
36    "SaturdayDelivery": "bool",
37    "SignatureRequired": "bool",
38    "Insurance": "bool"
39  },
40  "Items": [
41    {
42      "ItemCode": "string",
43      "UPC": "string",
44      "Price": "decimal",
45      "Quantity": "string",
46      "HTSCode": "string",
47      "Weight": "decimal"
48    }
49  ]
50}

Successful Response Example

1{
2  "results": {
3    "InsuranceCost": "decimal",
4    "InsuranceAmount": "decimal",
5    "Weight": "decimal",
6    "Width": "decimal",
7    "Height": "decimal",
8    "Length": "decimal",
9    "Prices": [
10      {
11        "Rate": "decimal",
12        "ServiceLevel": "string"
13      },
14      {
15        "Rate": "decimal",
16        "ServiceLevel": "string"
17      }
18    ]
19  }
20}
21Error Response Example
22{ "success": false, "error": "string" }
23

< Shipment

POST /public/quote >

On this page

Shipment Rating Request Parameters Address Box Information Shipping Information Item Request Example Successful Response Example