• Register

Rate Request Notification

This topic is part of the Service Provider's Published Rates flow. This conceptual diagram is part of the overall workflow.

A Service Provider receives a rate request notification in application/JSON format posted to their recipient URL when either of the following occurs:

  • either a listing or a rate request matches the saved search you selected to be notified.
  • a listing is edited or updated in such a way that a price change could occur on a previously placed rate such as when the destination changes.

If you require a change to your saved search criteria, please contact us at api-support@uship.com.

 

Rate Request Notification

 

 

Payload Data

Root

Field Type Description Sample Valid Values 
id
 String Unique identifier of the rate. "1234abcd0910hijk1420" 
checksum
 String Unique identifier that changes any time a user or the system updates relevant rate request data. Verifies the rate request has not changed since it was originally created. "098765ab" 
testMode
 Boolean
  • true - The rate request is in test mode and does not appear on production.
  • false - The rate request is not in test mode and the results appear on production.
 true 
totalWeightInGrams
 Container Wrapper for the data trio that describes the total weight of the shipment in grams.
  • value: "171910",
  • label: "379 lbs",
  • shortLabel: "379 lbs"
 
serviceTypes
 Container Contains an array of the data trio to list the types of service for the listing.
  • value: "EnclosedTransport",
  • label: "Enclosed Transport',
  • shortLabel: "Enclosed Transport"

Route

See Route Object description.

 

Lister

See Listers Objects description.

 

Items

See Listing Items Objects description.

 

 

 

Sample Payload

{
  "id": "1234abcd0910hijk1420",
  "checksum": "098765ab",
  "testMode": true,
  "route": {
    "distance": {
      "kilometers": 1123.3193,
      "label": "698 mi.",
      "shortLabel": "698 mi."
    },
    "items": [
      {
        "address": {
          "majorMunicipality": "Ames",
          "postalCode": "50012",
          "stateProvince": "IA",
          "stateProvinceLabel": "Iowa",
          "country": "US",
          "countryLabel": "United States",
          "latitude": 42.023294,
          "longitude": -93.647478,
          "label": "Ames, IA",
          "shortLabel": "Ames, IA"
        },
        "timeFrame": {
          "label": "On 7/17/2014",
          "shortLabel": "7/17",
          "earliestArrival": "2014-07-17T05:00:00Z",
          "latestArrival": "2014-07-17T05:00:00Z",
          "timeFrameType": {
            "value": "on",
            "label": "On",
            "shortLabel": "On"
          }
        }
      },
      {
        "address": {
          "majorMunicipality": "Brentwood",
          "postalCode": "37027",
          "stateProvince": "TN",
          "stateProvinceLabel": "Tennessee",
          "country": "US",
          "countryLabel": "United States",
          "latitude": 36.00245,
          "longitude": -86.791159,
          "label": "Brentwood, TN",
          "shortLabel": "Brentwood, TN"
        },
        "timeFrame": {
          "label": "On 7/17/2014",
          "shortLabel": "7/17",
          "earliestArrival": "2014-07-17T05:00:00Z",
          "latestArrival": "2014-07-17T05:00:00Z",
          "timeFrameType": {
            "value": "on",
            "label": "On",
            "shortLabel": "On"
          }
        }
      }
    ]
  },
  "lister": {
    "userId": 123456789,
    "displayName": "FirstName A.",
    "feedback": {
      "count": 5,
      "percentPositive": 95.5,
      "starRating": 5
    },
    "links": [
      {
        "rel": "Item",
        "verb": "GET",
        "href": "/v2/users/123456789/profile",
        "title": "profile"
      }
    ]
  },
  "items": [
    {
      "title": "2008 Suzuki GSX-R1000",
      "commodity": {
        "value": "MotorcyclesMopeds",
        "label": "Motorcycles & Mopeds",
        "shortLabel": "Motorcycles & Mopeds"
      },
      "attributes": {
        "groundClearanceInMeters": {
          "title": "Ground Clearance",
          "value": 0.127,
          "label": "5 in."
        },
        "wheelbaseInMeters": {
          "title": "Wheel Base",
          "value": 1.422,
          "label": "4 ft 8 in."
        },
        "lengthInMeters": {
          "title": "Length",
          "value": 2.057,
          "label": "6 ft 9 in."
        },
        "dryWeightInGrams": {
          "title": "Dry Weight",
          "value": 171910,
          "label": "379 lbs"
        },
        "hasSidecar": {
          "title": "Sidecar",
          "value": true,
          "label": "Yes"
        },
        "isPalletized": {
          "title": "Palletized",
          "value": false,
          "label": "No"
        },
        "isRunning": {
          "title": "Operational",
          "value": true,
          "label": "Yes"
        },
        "isTrike": {
          "title": "Trike",
          "value": false,
          "label": "No"
        },
        "makeName": {
          "title": "Make",
          "value": "Suzuki",
          "label": "Suzuki"
        },
        "modelName": {
          "title": "Model",
          "value": "GSX-R1000",
          "label": "GSX-R1000"
        },
        "year": {
          "title": "Year",
          "value": 2008,
          "label": "2008"
        }
      }
    }
  ],
  "serviceTypes": [
    {
      "value": "LtlTransportOnly",
      "label": "LTL Transport Only",
      "shortLabel": "LTL Transport Only"
    },
    {
      "value": "OpenTransport",
      "label": "Open Transport",
      "shortLabel": "Open Transport"
    },
    {
      "value": "EnclosedTransport",
      "label": "Enclosed Transport",
      "shortLabel": "Enclosed Transport"
    }
  ],
  "totalWeightInGrams": {
    "value": "171910",
    "label": "379 lbs",
    "shortLabel": "379 lbs"
  }
}

 

 

 

Ready to start providing bookable Published Rates?

Contact your uShip Account Manager or email us at api-support@uship.com to start your integration.

version 16 as of 3 years ago by Unknown