Fixed Price


This endpoint provides fixed price information for the cost of a carrier shipping household goods in the US and Canada only.

Resource URI

GET  https://api.uship.com/v2/fixedprice

Authorization

 

OAuth 2.0 bearer token with client credentials grant type https://developer.uship.com/docs/read/Client_Credentials.

 

Request Headers

 
Header Value Description
Content-Type
application/json
Acceptable Content-Types for the response.
Authorization
Bearer {access token}
Required for every call after initial authorization. The "Bearer" label is case sensitive. There must be a space between this authorization label and the access token string.

 

Query Parameters

 
Parameter Type Description
originZip
String
Required. Origin zip code.
destinationZip
String
Required. Destination zip code.
length
String
Required. length in inches.
height
String
Required. height in inches.
width
String
Required. width in inches.

 

Example Request

 
GET https://api.uship.com/v2/fixedprice?originzip=12345&destinationzip=43210&length=20&width=30&height=40
 

Example Response

 

Status-Code: 200 OK

 {
   "price": 150.05,
   "nypAmount": 120.05
}

 

Response Model

 
Field Type Description
price
Decimal
Total price including uShip service charges.
nypAmount
Decimal
Name your price which is total price excluding uShip service charges.

 

HTTP Error Codes

 
Code Message Description
400 Invalid or missing parameter. originZip or destinationZip is null/empty.
400 Invalid or missing parameter. length, width, or height are empty or less than or equal to 0.
400 Problem finding the route: {originZip} to {destinationZip}. unable to route between the origin and destination zip.
400 Volume must be less than 100000000. Volume exceeds maximum allowed value of 100,000,000. (This is approximately 38` x 38` x 38`)