--- updatedAt: 2026-07-08T23:35:32.000Z agentTools: projectIndex: https://developer.truckstop.com/llms.txt --- # Search within your posted loads # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Load Management", "version": "1.0.0" }, "servers": [ { "url": "https://api-int.truckstop.com" }, { "url": "https://api.truckstop.com" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } }, "schemas": { "Pagination": { "type": "object", "properties": { "totalPages": { "type": "number", "example": 1, "readOnly": true }, "pageNumber": { "type": "number", "example": 1 }, "pageSize": { "type": "number", "example": 100 }, "totalItemCount": { "type": "number", "example": 1, "readOnly": true }, "resultsTruncated": { "type": "boolean", "example": false, "readOnly": true } } }, "Dimensional": { "type": "object", "properties": { "length": { "type": "number", "example": 53 }, "width": { "type": "number", "example": 8 }, "height": { "type": "number", "example": 10 }, "weight": { "type": "number", "example": 40000 }, "palletCount": { "type": "number", "example": 5 }, "pieceCount": { "type": "number", "example": 500 }, "cube": { "type": "number", "example": 4240 } } }, "Rate": { "type": "object", "properties": { "amount": { "type": "number", "example": 123.45 }, "currencyCode": { "type": "string", "example": "USD", "minLength": 3, "maxLength": 3 } } }, "RateAttributes": { "description": "Posted All In Rate is for standard loads\nTender All In Rate is for BIN loads", "type": "object", "properties": { "postedAllInRate": { "$ref": "#/components/schemas/Rate" }, "tenderAllInRate": { "$ref": "#/components/schemas/Rate" } } }, "PostAsUser": { "type": "object", "properties": { "id": { "type": "string", "example": "df7dbc1a-a21d-e911-a9ec-a3b8a698ca96" }, "firstName": { "type": "string", "example": "Tom" }, "lastName": { "type": "string", "example": "Jerry" }, "email": { "type": "string", "example": "tomjerry@truckstop.com" }, "phone": { "type": "string", "example": "(123) 456-7890" }, "userName": { "type": "string", "example": "TOMJERRY" } } }, "LoadState": { "type": "object", "properties": { "loadStateDescription": { "type": "string", "example": "Posted" }, "loadStateId": { "type": "number", "example": 1 } } }, "LoadStateReason": { "type": "object", "properties": { "loadStateReasonDescription": { "type": "string", "example": "Not Specified" }, "loadStateReasonId": { "type": "number", "example": 0 } } }, "LoadActivity": { "type": "object", "properties": { "id": { "type": "string", "example": "cc6f6efc-f111-4eaf-7a7d-08dcd8c75967" }, "createdDate": { "type": "string", "example": "2024-09-23T15:34:33" }, "loadState": { "$ref": "#/components/schemas/LoadState" }, "loadStateReason": { "$ref": "#/components/schemas/LoadStateReason" }, "comment": { "type": "string", "example": "null" } } }, "EquipmentAttributes": { "type": "object", "properties": { "equipmentTypeId": { "type": "number", "example": 17, "description": "(Required) Integer Identifer of the equipment type required for this load." }, "equipmentOptions": { "type": "array", "items": { "type": "number", "example": 2, "description": "(Required - Can be empty) Array of integers for equipment options (Tarp, Hazmat, etc)" } }, "transportationModeId": { "type": "number", "example": 2, "description": "(Required) Integer identifer of the transportation mode (Full, partial, etc)" }, "otherEquipmentNeeds": { "type": "string", "example": "Pallet Return", "description": "(Optional) Text field (128 char) of any other equipment needs." } } }, "LoadStop": { "type": "object", "properties": { "id": { "type": "string", "example": "8ee4e385-e266-436a-a176-08dcd8c7603b", "readOnly": true }, "type": { "type": "number", "example": 1 }, "sequence": { "type": "number", "example": 1, "readOnly": true }, "earlyDateTime": { "type": "string", "example": "2024-09-24T11:34:32" }, "lateDateTime": { "type": "string", "example": "2024-09-24T11:34:32" }, "location": { "$ref": "#/components/schemas/Location" }, "contactName": { "type": "string", "example": "Joseph Smith" }, "contactPhone": { "type": "string", "example": 1234567890, "minLength": 10, "maxLength": 10 }, "stopNotes": { "type": "string", "example": "This is the pickup" }, "referenceNumbers": { "type": "array", "items": { "type": "string" } } } }, "Location": { "type": "object", "properties": { "id": { "type": "string", "example": "null", "readOnly": true }, "locationName": { "type": "string", "example": "Shipper Name" }, "city": { "type": "string", "example": "Chicago" }, "state": { "type": "string", "example": "IL", "minLength": 2, "maxLength": 2 }, "streetAddress1": { "type": "string", "example": "123 Main St." }, "streetAddress2": { "type": "string", "example": "null" }, "countryCode": { "type": "string", "example": "USA", "minLength": 3, "maxLength": 3 }, "postalCode": { "type": "string", "example": 60007 }, "latitude": { "type": "number", "example": 41.8781, "readOnly": true }, "longitude": { "type": "number", "example": -87.6298, "readOnly": true } } }, "Load": { "type": "object", "properties": { "loadId": { "type": "string", "example": "a020197d-511c-4370-aa8d-2b6172fecc4c", "readOnly": true }, "legacyLoadId": { "type": "string", "example": "null", "readOnly": true }, "postasuserID": { "type": "string", "example": "df7dbc1a-a21d-e911-a9ec-a3b8a698ca96", "description": "(Optional — not recommended)\nUnique GUID of the user you wish to post the load as, if different from the authenticated user.\n\nFor security reasons, we recommend that each user authenticate individually rather than posting on another user's behalf.\n\nPlease note:\n• Loads posted using PostAs cannot be filtered by PostAs within Truckstop.com.\n• Your integration should always be treated as the source of truth for your loads.\n\nLeave blank to omit this field." }, "postAsUser": { "allOf": [ { "$ref": "#/components/schemas/PostAsUser" }, { "readOnly": true } ] }, "createdBy": { "type": "string", "example": "df7dbc1a-a21d-e911-a9ec-a3b8a698ca96", "readOnly": true }, "updatedBy": { "type": "string", "example": "null", "readOnly": true }, "createdDateTime": { "type": "string", "example": "2024-09-23T15:34:33", "readOnly": true }, "updatedDateTime": { "type": "string", "example": "2024-09-23T15:34:33", "readOnly": true }, "loadState": { "allOf": [ { "$ref": "#/components/schemas/LoadState" }, { "readOnly": true } ] }, "loadStateReason": { "allOf": [ { "$ref": "#/components/schemas/LoadStateReason" }, { "readOnly": true } ] }, "tenderId": { "type": "number", "readOnly": true }, "carrierName": { "type": "string", "example": "null", "readOnly": true }, "loadActivity": { "allOf": [ { "$ref": "#/components/schemas/LoadActivity" }, { "readOnly": true } ] }, "equipmentAttributes": { "$ref": "#/components/schemas/EquipmentAttributes" }, "commodityId": { "type": "number", "example": 1, "description": "(Optional) Integer ID of the commodity for this load \n\nCommodities List" }, "loadStops": { "type": "array", "description": "(Required -- Min 2, max 20) Array of LoadStop objects", "items": { "$ref": "#/components/schemas/LoadStop" }, "minItems": 2, "example": [ { "type": 1, "sequence": 1, "earlyDateTime": "2024-09-24T11:00:00", "lateDateTime": "2024-09-24T11:00:00", "location": { "locationName": "Shipper", "city": "Chicago", "state": "IL", "streetAddress1": "123 Main St", "streetAddress2": null, "countryCode": "USA", "postalCode": 60007, "latitude": 41.8781, "longitude": -87.6298 }, "contactName": "Joseph Smith", "contactPhone": 1234567890, "stopNotes": "Pickup" }, { "type": 2, "sequence": 2, "earlyDateTime": "2024-09-24T11:00:00", "lateDateTime": "2024-09-24T11:00:00", "location": { "locationName": "Receiver", "city": "Chicago", "state": "IL", "streetAddress1": "321 Main St", "streetAddress2": null, "countryCode": "USA", "postalCode": 60007, "latitude": 41.8781, "longitude": -87.6298 }, "contactName": "Joseph Smith", "contactPhone": 1234567890, "stopNotes": "Drop Off" } ] }, "note": { "type": "string", "example": "Important Load Info", "description": "Any publically visible loads notes (0-4000 characters)" }, "freightClassId": { "type": "number", "example": 1 }, "loadNumber": { "type": "string", "example": "Load123-456", "description": "Broker specific load identifer" }, "loadTrackingRequired": { "type": "boolean", "example": false, "description": "Only used for BIN loads, should be false for standard loads" }, "integratorLoadUrl": { "type": "string", "description": "Integrator load URL", "nullable": true, "maxLength": 500 }, "rateAttributes": { "$ref": "#/components/schemas/RateAttributes" }, "customData": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "My_Custom_Field" }, "value": { "type": "string", "example": "My_Custom_Value" } } } }, "distance": { "type": "number", "example": 123, "readOnly": true }, "Dimensional": { "$ref": "#/components/schemas/Dimensional" }, "LoadActionAttributes": { "type": "object", "description": "4 - PostOnly is for standard loads\n1 - PostOnlineTender is for BIN loads", "properties": { "loadActionId": { "type": "string", "example": 4 }, "loadActionOption": { "type": "string", "example": "PostOnly" } } }, "LoadLabel": { "type": "string", "example": "Boxes of screws" }, "tenderNotes": { "type": "string", "example": "Notes shown after booking", "description": "These notes are not displayed until the load is booked" }, "loadReferenceNumbers": { "type": "array", "items": { "type": "string" } }, "termsAndConditions": { "type": "object", "properties": { "id": { "type": "string", "example": "1234-56789-0123456" }, "name": { "type": "string", "example": "My T&C", "readOnly": true } } }, "carrierTenderGroupIds": { "type": "array", "items": { "type": "number" }, "readOnly": true }, "isPrivate": { "type": "boolean", "example": false, "description": "Indicates whether the load is private. When true, the load is visible only to your private carrier network. Optionally, provide leadTimeHours to control how many hours before the earliest pickup time a private load transitions to public." }, "leadTimeHours": { "type": "number", "nullable": true, "description": "Number of hours before early pickup that private load transitions to public." }, "waterfallID": { "type": "string", "format": "uuid", "nullable": true, "description": "(Optional) Allows brokers to post a private load associated with a waterfall.\n\nWhat is a waterfall?\n[More info here](https://developer.truckstop.com/update/reference/waterfallid#/versions).\n\nProviding a waterfallID will automatically set isPrivate to true. If omitted, the load behaves normally." }, "carrierListIds": { "type": "array", "nullable": true, "description": "List of carrier list IDs (each must be a UUID).", "items": { "type": "string", "format": "uuid" } }, "boostedFrom": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "example": "2026-03-03T15:13:03.319Z", "description": "UTC timestamp when the current or most recent load boost started." }, "boostedTo": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "example": "2026-03-03T15:13:03.319Z", "description": "UTC timestamp when the current or most recent load boost ends or ended." } } } } }, "paths": { "/loadmanagement/v2/load/search": { "post": { "tags": [ "Manage your loads" ], "summary": "Search within your posted loads", "security": [ { "bearerAuth": [] } ], "requestBody": { "description": "JSON payload containing the search terms", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "pageNumber": { "type": "integer", "example": 1 }, "pageSize": { "type": "integer", "example": 100 } } }, "searchCriteria": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "LoadActionId" }, "operator": { "type": "string", "example": "eq" }, "value": { "type": "string", "example": 4 } } } }, "sortCriteria": { "type": "array", "items": { "type": "object", "properties": { "direction": { "type": "string", "example": "descending" }, "name": { "type": "string", "example": "OriginCity" } } } } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Load" } } } } } } } } } } } } ```