Fuel
Search fuel transactions
Search fuel transactions with paginated POST filters — card, driver, unit, date range, fuel type, and merchant, returning gallons, price, and totals.
POST
Search fuel transactions
The endpoint for searching fuel transactions requires specifying the API version in the URL path. This 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.
Parameter Type Required Description
Page Integer No The page number to retrieve. PageSize Integer Yes The number of results per page.
PageSize must be greater than 0. FuelCardNumber String Conditionally The fuel card number used for the transactions. This field is required if the other conditionally required fields are left empty. TruckNumber String Conditionally The truck number associated with the transactions.This field is required if the other conditionally required fields are left empty. TransactionRange Object Conditionally The date range for the transactions.
This field is required if the other conditionally required fields are left empty. TransactionRange.Start String (Date-Time) Conditionally The start date of the transaction range. This field is required if the other conditionally required fields are left empty. TransactionRange.End String (Date-Time) Conditionally The end date of the transaction range. This field is required if the other conditionally required fields are left empty.
Request Parameters
The following parameter is required in the URL path:Request Body
The following fields are required in the request body to filter the search results:<Table align={["left","left","left","left"]}>
</Table>
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:Response Parameters
The following table lists the parameters included in the response for fuel transaction search 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 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. Alternatively, you can directly edit the Curl command. Make sure to authorize yourself before trying a request.Authorizations
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
API version (e.g., 1.0)
Example:
"1.0"