/api/p/v{version}/loads/search

The endpoint for searching loads requires specifying the API version in the URL path. Including the version number ensures that your application interacts with the correct version of the API, providing stability and compatibility as the API evolves. For more information on how versioning works and how to include it in your requests, please refer to the Versioning page.

Request Parameters

The following parameter is required in the URL path:

Request Body Parameters

The version is required in the path parameters. The query request parameters for this endpoint are listed below.

Example CURL request

Use the Current API version number and make sure to replace the Authorization header value with your actual Bearer token for the request:

curl --location 'https://integrations.alvys.com/api/p/v1/loads/search' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ...' \
--header 'Content-Type: application/json' \
--data '{
  "page": 0,
  "pageSize": 200,
  "dateRange": {
      "startDate": "2023-09-09T13:09:30.788Z",
      "endDate": "2024-09-09T13:09:30.788Z"
               },
  "status": ["In Transit"],
  "updatedBy" : "0d00f000-1b85-4ed8-000-6a000d1111db",
  "updatedAtRange": {
      "start": "2024-09-09T13:09:30.788Z",
      "end": "2024-10-19T13:09:30.788Z"
  },           
  "orderNumbers": [
         "123456789"
               ],
  "loadNumbers": [
         "123456789"
                 ],
  "poNumbers": [
          "123456789"
               ],
  "customerId": "0e2bb9d5eae342c9bb89f7ac24f01a84"
}

Response Parameters

The following table lists the parameters included in the response for load-related requests.

Example Response

On the right side, you can see examples of different error codes by clicking "Example" and selecting the response code.

Rate Limits

All endpoints are subject to rate limits to protect the API from traffic spikes. For detailed information on rate limits, please refer to the Rate Limits section.

This page is interactive, allowing you to try a request by completing the fields for the parameters below. As you fill out the parameters, the CURL command on the right side of the page will be automatically updated. Alternatively, you can fork our Public API Postman Collection directly. Make sure to authorize yourself before trying a request.