Retrieve Rates


This method is part of the Shipping Customer's Published Rates flow.

Get Rates from Rate Request

GET https://api.uship.com/v2/raterequests/{rateRequestId}/rates

Retrieve rates by specifying the rate request ID.

Sample JSON Responses


Examples are truncated for brevity.

Example 1

{
    "totalCount": 4,
    "items": [
        {
            "totalPrice": {
                "value": 93.02,
                "label": "$93.02",
                "shortLabel": "$93.02"
            },
            "created": "2014-06-24T21:08:22Z",
            "expires": "2014-07-01T20:08:46Z",
            "serviceType": {
                "value": "LtlTransportOnly",
                "label": "LTL Transport Only",
                "shortLabel": "LTL Transport Only"
            },
            "additionalInformation": "Optional accessorial field.",
            "transportMode": {
                "value": "Trucking",
                "label": "Trucking",
                "shortLabel": "Trucking"
            },
            "vehicleType": {
                "value": "Undefined",
                "label": "N/A",
                "shortLabel": "N/A"
            },
            "pickupTimeframe": {
                "delay": 1,
                "timeFrameType": {
                    "value": "Relative",
                    "label": "Relative",
                    "shortLabel": "Relative"
                }
            },
            "deliveryTimeframe": {
                "delay": 1,
                "timeFrameType": {
                    "value": "Relative",
                    "label": "Relative",
                    "shortLabel": "Relative"
                }
            },
            "id": "12345678910abcdefghijklm",
            "bidder": {
                "userId": 123456789,
                "displayName": "SOUTHEASTERN FREIGHT LINES",
                "imageUrl": "http://api.uship.com/resize.php?path=%2fstatic%2fusers%2fd912e881-8227-42db-9.jpg",
                "feedback": {
                    "count": 2,
                    "percentPositive": 100,
                    "starRating": 5
                },
                "links": [
                    {
                        "rel": "Item",
                        "verb": "GET",
                        "href": "/v2/users/123456789/profile",
                        "title": "profile"
                    }
                ]
            }
        }
    ]
}

Example 2

{
    "totalCount": 21,
    "items": [
        {
            "totalPrice": {
                "value": 111.95,
                "label": "$111.95",
                "shortLabel": "$111.95"
            },
            "created": "2014-05-21T15:05:02.295Z",
            "expires": "2014-05-28T15:05:02.218Z",
            "serviceType": {
                "value": "WhiteGlove",
                "label": "White Glove",
                "shortLabel": "White Glove"
            },
            "additionalInformation": "Optional",
            "transportMode": {
                "value": "Trucking",
                "label": "Trucking",
                "shortLabel": "Trucking"
            },
            "vehicleType": {
                "value": "Auto_Carrier",
                "label": "Auto Carrier",
                "shortLabel": "Auto Carrier"
            },
            "pickupTimeframe": {
                "delay": 5,
                "timeFrameType": {
                    "value": "Relative",
                    "label": "Relative",
                    "shortLabel": "Relative"
                }
            },
            "deliveryTimeframe": {
                "delay": 5,
                "timeFrameType": {
                    "value": "Relative",
                    "label": "Relative",
                    "shortLabel": "Relative"
                }
            },
            "id": "537cc09e11598810b8b092ef",
            "bidder": {
                "userId": 123456789,
                "displayName": "AUTO MOVERS INC",
                "imageUrl": "http://link/resize.php?path=%fstatic%2fusers%24a1b7fd3-c84b-4d82-b.jpg",
                "feedback": {
                    "count": 5,
                    "percentPositive": 100,
                    "starRating": 5
                },
                "links": [
                    {
                        "rel": "Item",
                        "verb": "GET",
                        "href": "/v2/users/123456789/profile",
                        "title": "profile"
                    }
                ]
            }
        }
    ]
}

 

API Reference


The localized sample values are ordered but not limited to the following:

Request Header Value
Accept-Language EN, FR, or ES

 

Rate Objects

Field Type Description Valid Sample Values
id
String 24-character alphanumeric identifier for the rate. "12345678910abcdefghijklm"
created
String Time and date stamp when the rate was created. "2014-06-24T21:08:22Z"
expires
String Time and date stamp when the rate expires. "2014-07-01T20:08:46Z"
additionalInformation
String Optional information from the Service Provider. -
Total Price
Field Type Description Valid Sample Values
value
Decimal The total shipping price calculated based on the rate request parameters provided. The amount must be positive. 100.50
label
String The localized price. "$100.50" | "93,02 $"
shortLabel
String The localized price formatted for a touch, tablet, or mobile device. "$100.50" | "93,02 $"
Service Type
Field Type Description Valid Sample Value Trio Valid Sample Value Trio
value
String

"LtlTransportOnly" "FlatbedTransport"
label
String "LTL Transport Only" | "Uniquement fret à chargement partiel" | "Solo transporte de carga parcial(LTL)"  "Flatbed Transport" | "Transport camion plateau" | "Transporte de plataforma"
shortLabel
String "LTL Transport Only" | "Uniquement fret à chargement partiel" | "Solo transporte de carga parcial(LTL)"  "Flatbed Transport" | "Transport camion plateau" | "Transporte de plataforma"
Transport Mode
Field Type Description Valid Sample Value Trio Valid Sample Value Trio
value
String
See transport mode. "Trucking" "Rail"
label
String The localized transport mode value. "Trucking" | "Camionnage" | "Camionaje" "Rail" | "Ferrovière" | "Ferrocarril"
shortLabel
String The localized transport mode value formatted for a touch, tablet, or mobile device. "Trucking" | "Camionnage" | "Camionaje" "Rail" | "Ferrovière" | "Ferrocarril"
Vehicle Type
Field Type Description Valid Sample Value Trio Valid Sample Value Trio
value
String
See vehicle types. "Undefined" "Van"
label
String The localized vehicle type value. "Undefined" | "Inconnu" | "Desconocido" "Van" | "Fourgon" | "Furgoneta"
shortLabel
String The localized vehicle type value formatted for a touch, tablet, or mobile device. "Undefined" | "Inconnu" | "Desconocido" "Van" | "Fourgon" | "Furgoneta"
Pickup or Delivery Timeframe
Field Type Description Valid Sample Values
delay
Integer

The number of days either before or after a booking or shipment pick up date only with the “Relative” time frame type. This value can be null if the "between" or "on" time frame types are being used.

3
timeFrameType
Container

Wrapper for the pick up or delivery time frame type.

-
value
String

The pick up and delivery time frame types. Valid values are as follows:

  • Arrange - Shipping Customer and Service Provider will arrange the pick up or delivery time frame after booking.
  • Before - The pick up or delivery will be made before a specified time frame.
  • Between - The pick up or delivery will be made between specified time frames.
  • OnDate - The pick up or delivery will be made on a specified date.
  • Relative - The pick up or delivery will be a specified number of days before or after a specified time frame.
"Relative"
label
String The localized time frame type. "Relative" | "Relatif" | "Relativo"
shortLabel
String The localized time frame type formatted for touch, tablet, or mobile devices. "Relative" | "Relatif" | "Relativo"

Bidder Object

Field Type Description Sample Valid Value
userId
Integer Identifier of the user who bid on the listing or effectively the LTL Freight Service Provider responding with rates. 123456789
displayName
String The name that displays in the marketplace for the active user. "Pacific Freight Lines"
imageUrl
String The web address or server path where the Service Provider's profile image is stored. "http://link.jpg"
Bidder Feedback

Wrapper for the feedback fields that determine a user's marketplace ratings through uShip.

Field Type Description Sample Valid Value
count
Integer The total number of feedback entries available for this user. 5
percentPositive
Decimal The percentage of positive ratings for this user out of 100%. 100
starRating
Decimal The average number of stars out of the total stars received for this user. One star being the lowest and five stars being the highest rating. 5

 

What Can I Do Next?


See Hypermedia Links for an explanation of how they work as part of the uShip API.

  • Retrieve a user's profile by specifying the user ID returned in this request: 
    GET https://api.uship.com/v2/users/123456789/profile
     
  • Retrieve rates by specifying the rate request ID:
    GET https://api.uship.com/v2/rateRequests/53a9fc7a1159880e90083bf6/rates
     

Docs Navigation