Get a posted load by id

πŸ“˜

GET /loadmanagement/v2/load/{id} Get load details by load id

Authorization bearer token
Accept application/json
URL Params {id} - The LoadID (GUID) returned when the load was posted
Body Params None

GET https://api-int.truckstop.com/loadmanagement/v2/load/<id> HTTP/1.1
Authorization: bearer <access_token>
accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
CorrelationId: 901b6bd9-cd5a-4fca-9955-fc94db7eeacd

{
  "loadId": "a020197d-511c-4370-aa8d-2b6172fecc4c",
  "postAsUserId": "df7dbc1a-a21d-e911-a9ec-a3b8a698ca96",
  "postAsUser": {
    "id": "df7dbc1a-a21d-e911-a9ec-a3b8a698ca96",
    "firstName": "Tom",
    "lastName": "Jerry",
    "email": "[email protected]",
    "phone": "(123)-456-7890",
    "userName": "TOMJERRY"
  },
  "createdBy": "df7dbc1a-a21d-e911-a9ec-a3b8a698ca96",
  "updatedBy": "df7dbc1a-a21d-e911-a9ec-a3b8a698ca96",
  "createdDateTime": "2019-01-10T22:6:47",
  "updatedDateTime": "2019-03-14T09:16:55",
  "loadState": {
    "loadStateDescription": "Posted",
    "loadStateId": 1
  },
  "loadStateReason": null,
  "tenderId": 0,
  "carrierName": "",
  "loadActivity": [
    {
      "id": "493c98cc-a8c5-e911-aa10-c79a7aacaffe",
      "createdDate": "2019-08-24T13:19:46Z",
      "loadState": { 
        "loadStateDescription": "Posted", 
        "loadStateId": 1 
      },
      "loadStateReason": { 
        "loadStateReasonDescription": "Not Specified", 
        "loadStateReasonId": 0 
      },
      "comment": "Test data"
    }
  ],
  "source": "Integration",
  "equipmentAttributes": {
    "equipmentTypeId": 17,
    "equipmentOptions": [
      2,
      3
    ],
    "transportationModeId": 2,
    "otherEquipmentNeeds": "Pallet return"
  },
  "commodityId": 1,
  "loadStops": [
    {
      "id": "5465e391-6ada-e911-aa11-ac4ba6accd3e",
      "type": 1,
      "sequence": 1,
      "earlyDateTime": "2019-09-18T17:09:04Z",
      "lateDateTime": "2019-09-18T17:10:04Z",
      "location": {
        "id": "bc72bac5-da02-4c08-9eda-f42b0f1c2cb3",
        "locationName": "ABC Warehouse",
        "city": "New York",
        "state": "NY",
        "streetAddress1": "261 madison ave",
        "streetAddress2": "101",
        "countryCode": "USA",
        "postalCode": "10016",
        "latitude": 40.7505,
        "longitude": -73.9806
      },
      "contactName": "Joseph Adams",
      "contactPhone": "5553125555",
      "stopNotes": "Be polite",
      "referenceNumbers": [
        "123"
      ]
    },
    {
      "id": "5665e391-6ada-e911-aa11-ac4ba6accd3e",
      "type": 2,
      "sequence": 2,
      "earlyDateTime": "2019-09-21T17:11:04Z",
      "lateDateTime": "2019-09-21T17:12:04Z",
      "location": {
        "id": "1a7667b0-1699-48ca-b8ef-75e4e5cf0b6a",
        "locationName": "XYZ Warehouse",
        "city": "Houston",
        "state": "TX",
        "streetAddress1": "1902 westheimer rd",
        "streetAddress2": "101",
        "countryCode": "USA",
        "postalCode": "77098",
        "latitude": 29.743,
        "longitude": -95.4075
      },
      "contactName": "Marty",
      "contactPhone": "5553325555",
      "stopNotes": "",
      "referenceNumbers": [
        "6789",
        "234hhd3"
      ]
    }
  ],
  "note": "For more details around this load please call 555-432-1026 and reference load number 39363.",
  "loadNumber": "LN_39363",
  "loadTrackingRequired": true,
  "rateAttributes": {
    "postedAllInRate": {
      "amount": 1000.53,
      "currencyCode": "USD"
    },
    "tenderAllInRate": {
      "amount": 1000.53,
      "currencyCode": "USD"
    }
  },
  "customData": [
    {
      "key": "LoadNumber",
      "value": "1234"
    },
    {
      "key": "MySpecialKey",
      "value": "MySpecialValue"
    }
  ], 
  "dimensional": {
    "length": 10.00,
    "width": 10.00,
    "weight": 3000.00,
    "height": 8.00,
    "palletCount": 0,
    "pieceCount": 1,
    "cube": 800.00
  },
  "loadActionAttributes": {
    "loadActionId": "1",
    "loadActionOption": "PostOnlineTender"
  },
  "loadLabel": "Copper Cauldron",
  "tenderNotes": "Lannister always pays his debts",
  "loadReferenceNumbers": [
    "123",
    "heth4573"
  ],
  "termsAndConditions": {
    "id": "b64f76d0-5ee1-e911-aa11-ac4ba6accd3e",
    "name": "TC 9651"
  }
}

Response Fields:

  • The response is a Load Object.
  • Error responses contain an HTTP Code and an Error object.