Skip to main content
GET
Get trip

Request Parameters

The following parameters are available in the URL path and query string:

Example CURL request

Example using Trip ID:
Example using Trip Number:
Replace {version} with the API version number, {tripId} with the actual trip ID, {tripNumber} with the actual trip number, and YOUR_ACCESS_TOKEN with your actual Bearer token: Using Trip ID:
Using Trip Number:

Response Parameters

The following table lists the parameters included in the response for a single trip request:

⚠️ Important Note on Rates and RatesV2 Fields

Both the legacy Rates[] and the new RatesV2[] fields are currently returned in the Trips API response under driver1, driver2, and ownerOperator.
  • The legacy Rates[] field remains available for backward compatibility but is no longer populated for new trips created after migration to Driver Settlement.
  • For trips that existed prior to migration, Rates[] may still contain historical data; however, it can be out of sync with RatesV2[] if additional rate changes were made after migration.
  • Integrations that continue to read data from Rates[] may receive empty or outdated arrays.
  • To ensure accurate and complete pay information, integrations should rely on RatesV2[] going forward.
Each rate type (e.g., tripValuePercentageRate, perTripRate, minimumPayRate) within RatesV2[] is returned as a structured object with optional lineItems[] breakdowns.

Versioning

The version parameter in the URL path specifies which version of the API you are using. 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.

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 specifying the API version in the URL path and providing the necessary request body. As you fill out the parameters, the Curl command on the right side of the page will be automatically updated.

Authorizations

Authorization
string
header
required

OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as Authorization: Bearer <token>.

Path Parameters

version
string
default:1.0
required

API version (e.g., 1.0)

Example:

"1.0"

Query Parameters

id
string
tripNumber
string
includeDeleted
boolean
default:false

Response

OK

Id
string
required
TripNumber
string
required
Status
string
required
LoadNumber
string
required
Stops
object[]
required
TotalMileage
object
required
EmptyMileage
object
required
LoadedMileage
object
required
TripValue
object
required
CarrierPayOnHold
boolean
required
Truck
object | null
Trailer
object | null
OrderNumber
string | null
TenderAs
string | null
TenderAsSubsidiaryType
string | null
RequiredEquipment
string[] | null
Temperature
object | null
PickupDate
string<date-time> | null
DeliveryDate
string<date-time> | null
PickedUpAt
string<date-time> | null
DeliveredAt
string<date-time> | null
CarrierAssignedAt
string<date-time> | null
ReleasedAt
string<date-time> | null
CarrierPaidAt
string<date-time> | null
DueDate
string<date-time> | null
Driver1
object | null
Driver2
object | null
OwnerOperator
object | null
ReleasedBy
string | null
DispatchedBy
string | null
DispatcherId
string | null
CarrierSalesAgentId
string | null
Carrier
object | null
UpdatedAt
string<date-time> | null
UpdatedBy
string | null
IsDeleted
boolean | null
References
object[] | null