> ## Documentation Index > Fetch the complete documentation index at: https://docs.alvys.com/llms.txt > Use this file to discover all available pages before exploring further. # Get trip > Retrieve trip records from Alvys by trip ID, including the assigned driver and truck, sequenced stops, current status, and associated load numbers. ### Request Parameters The following parameters are available in the URL path and query string: | Parameter | Type | Required | Description | | -------------- | ------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | version | String | Yes | The API version to use. | | tripNumber | String | Conditionally | The trip number to filter results. This field is required if the other conditionally required fields are left empty. | | id | String | Conditionally | The trip id to filter results. This field is required if the other conditionally required fields are left empty. | | includeDeleted | Boolean | No | When `true`, also returns trips that are deleted or invisible (for example, an original trip superseded by a load split). Defaults to `false`. | #### Example CURL request Example using Trip ID: ```bash theme={null} curl --location 'https://integrations.alvys.com/api/p/v{version}/trips?id={tripId}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' ``` Example using Trip Number: ```bash theme={null} curl --location 'https://integrations.alvys.com/api/p/v{version}/trips?tripNumber={tripNumber}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' ``` 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: ```bash theme={null} curl --location 'https://integrations.alvys.com/api/p/v1/trips?id=000c3a9bf0000000bf000d000e000a0b' \ --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ...' ``` Using Trip Number: ```bash theme={null} curl --location 'https://integrations.alvys.com/api/p/v1/trips?tripNumber=123456789' \ --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ....' ``` ### Response Parameters The following table lists the parameters included in the response for a single trip request: | Parameter | Type | Required | Description | | :------------------------------------------------------ | :---------------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- | | Id | string | Yes | Unique identifier of the trip. | | TripNumber | string | Yes | Number associated with the trip. | | Status | string | No | Current status of the trip. | | LoadNumber | string | No | Load number associated with the trip. | | TenderAs | string | No | Role under which the trip was tendered. | | TenderAsSubsidiaryType | string | No | Subsidiary type under which the trip was tendered (e.g., `"Carrier"`). | | Stops\[] | array | No | List of stops for the trip. | | Stops\[].Id | string | No | Unique identifier of the stop. | | Stops\[].Address.Street | string | No | Street address of the stop. | | Stops\[].Address.City | string | No | City of the stop. | | Stops\[].Address.State | string | No | State of the stop. | | Stops\[].Address.ZipCode | string | No | ZIP code of the stop. | | Stops\[].Coordinates.Latitude | string | No | Latitude of the stop. | | Stops\[].Coordinates.Longitude | string | No | Longitude of the stop. | | Stops\[].Status | string | No | Status of the stop. | | Stops\[].StopType | string | No | Type of stop (e.g., Pickup, Delivery). | | Stops\[].AppointmentDate | string (datetime) | No | Appointment date/time for the stop. | | TotalMileage.Distance.Value | number | No | Total mileage value. | | TotalMileage.Distance.UnitOfMeasure | string | No | Unit of measure for total mileage. | | TotalMileage.Source | string | No | Source of mileage data. | | TotalMileage.ProfileName | string | No | Name of the mileage profile used. | | EmptyMileage.Distance.Value | number | No | Empty mileage value. | | LoadedMileage.Distance.Value | number | No | Loaded mileage value. | | PickupDate | string (datetime) | No | Scheduled pickup date. | | DeliveryDate | string (datetime) | No | Scheduled delivery date. | | PickedUpAt | string (datetime) | No | Actual pickup timestamp. | | DeliveredAt | string (datetime) | No | Actual delivery timestamp. | | CarrierAssignedAt | string (datetime) | No | Carrier assignment timestamp. | | TripValue.Amount | number | No | Total trip value. | | TripValue.Currency | string | No | Currency for trip value. | | Truck.Id | string | No | Truck ID. | | Truck.Fleet.Id | string | No | Fleet ID of the truck. | | Truck.Fleet.Name | string | No | Fleet name of the truck. | | Trailer.Id | string | No | Trailer ID. | | Trailer.EquipmentType | string | No | Equipment type of trailer. | | Temperature | object | No | Temperature requirements for temperature-controlled trips. Returned only when configured; otherwise omitted from the response. | | Temperature.SetpointTemperature | number | No | Required target temperature. | | Temperature.SetpointTemperatureMax | number | No | Optional maximum temperature when a temperature range is defined. | | Temperature.ControlMode | string | No | Operational mode of the trailer (`Continuous`, `Start/Stop`). | | RequiredEquipment\[] | array of strings | No | List of equipment types required for the trip (e.g., `Reefer`, `Van`, `Flatbed`). Returned only when configured; omitted when no requirement exists. | | Driver1.Id | string | No | Unique ID of Driver 1. | | Driver1.ContractorType | string | No | Contractor type of Driver 1. | | Driver1.Rates\[] | array | No | **Legacy field.** Old driver rate objects. Returned for backward compatibility and may be empty or outdated. | | Driver1.RatesV2\[] | array | No | New structured rate objects for Driver 1 showing applied pay rules and calculated line items. | | Driver1.RatesV2\[].PolicyId | string | No | Unique identifier of the applied rate policy. | | Driver1.RatesV2\[].PolicyName | string | No | Display name of the rate policy. | | Driver1.RatesV2\[].PerTripRate.Rate | number | No | Flat per-trip pay rate applied to the trip. | | Driver1.RatesV2\[].PerTripRate.RateId | string | No | Identifier of the per-trip rate type. | | Driver1.RatesV2\[].PerTripRate.RateName | string | No | Name of the per-trip rate type. | | Driver1.RatesV2\[].PerTripRate.LineItems\[] | array | No | Detailed line-item breakdown for per-trip rate. | | Driver1.RatesV2\[].TripValuePercentageRate.Percentage | number | No | Percentage of trip value used to calculate pay. | | Driver1.RatesV2\[].TripValuePercentageRate.RateId | string | No | Identifier of the percentage-based rate type. | | Driver1.RatesV2\[].TripValuePercentageRate.RateName | string | No | Name of the percentage-based rate. | | Driver1.RatesV2\[].TripValuePercentageRate.LineItems\[] | array | No | Line-item breakdown for percentage-based rate (description, amount, currency). | | Driver2.Id | string | No | Unique ID of Driver 2. | | Driver2.ContractorType | string | No | Contractor type of Driver 2. | | Driver2.Rates\[] | array | No | Legacy rate list for Driver 2 — may be empty or outdated. | | Driver2.RatesV2\[] | array | No | Structured rate objects for Driver 2. | | OwnerOperator.Id | string | No | Unique ID of the owner-operator. | | OwnerOperator.Rates\[] | array | No | Legacy rate list for Owner Operator — may be empty or outdated. | | OwnerOperator.RatesV2\[] | array | No | Structured rate objects for Owner Operator. | | Carrier.Id | string | No | Carrier ID. | | Carrier.Rate.Amount | number | No | Carrier rate amount. | | Carrier.Rate.Currency | string | No | Carrier rate currency. | | Carrier.Linehaul.Amount | number | No | Carrier linehaul amount. | | Carrier.Linehaul.Currency | string | No | Currency of linehaul. | | Carrier.TotalPayable.Amount | number | No | Total payable amount to the carrier. | | Carrier.TotalPayable.Currency | string | No | Currency for total payable amount. | | DispatchedBy | string | No | User who dispatched the trip. | | DispatcherId | string | No | ID of the dispatcher. | | UpdatedAt | string (datetime) | No | Timestamp when the trip was last updated. | | UpdatedBy | string | No | User who last updated the trip. | #### ⚠️ 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. ## OpenAPI ````yaml GET /api/p/v{version}/trips openapi: 3.0.1 info: title: Alvys description: >- Alvys provides a robust set of REST APIs to allow you to integrate Alvys into virtually any platform. These APIs cover most of Alvys' major product areas with additional endpoints being added regularly based on customer requests. contact: name: Alvys Support url: https://www.alvys.com/resources/contact/ version: v1 servers: - url: https://integrations.alvys.com description: Public API Server - url: https://api.alvys.com/ description: Public API Server security: - Public: [] tags: - name: Authentication description: Obtain an OAuth 2.0 access token for the Alvys Public API. - name: Carrier Settlement Statements description: >- Search carrier settlement statements and retrieve a single statement by number. - name: Carriers description: Read carrier records, search carriers, and manage carrier documents. - name: Customers description: Create, read, update, delete, and search customer records. - name: Deductions description: >- Create one-time deductions and search or delete existing deduction records. - name: DispatchPreferences description: Dispatch preferences endpoints for reading dispatch rules and preferences. - name: Driver Settlement Statements description: >- Search driver settlement statements and retrieve a single statement by number. - name: Drivers description: >- Read driver records, search drivers and driver events, and manage driver documents. - name: Fuel description: Read and search fuel transactions. - name: Invoices description: >- Read invoices, create carrier invoices, and record carrier and customer payments. - name: Loads description: Read, update, search loads, and manage load documents and notes. - name: Locations description: Read and search company location details. - name: Maintenance description: Read and search maintenance records. - name: Tenders description: Create, accept, reject, cancel, update, and search inbound EDI tenders. - name: Tolls description: Read and search toll transactions. - name: Trailers description: Read trailers, search trailer events, and manage trailer documents. - name: Trips description: >- Read, search trips, manage trip documents, and record stop appointments, arrivals, and departures. - name: Trucks description: Read trucks, search truck events, and manage truck documents. - name: Users description: List and search users. - name: Visibility description: >- Read inbound and outbound visibility history and search outbound visibility errors. - name: Webhooks description: >- Create, read, update, delete, enable, disable, verify, test, and rotate secrets for webhook subscriptions; read event types, delivery logs, and health metrics. paths: /api/p/v{version}/trips: get: tags: - Trips summary: Get trip parameters: - name: id in: query schema: type: string - name: tripNumber in: query schema: type: string - name: includeDeleted in: query schema: type: boolean default: false - name: version in: path description: API version (e.g., 1.0) required: true schema: type: string default: '1.0' example: '1.0' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Alvys.Models.Trips.TripDetailsResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '401': description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '429': description: Too Many Requests content: application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' security: - Public: [] components: schemas: Alvys.Models.Trips.TripDetailsResponse: required: - CarrierPayOnHold - EmptyMileage - Id - LoadedMileage - LoadNumber - Status - Stops - TotalMileage - TripNumber - TripValue type: object properties: Truck: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trips.TripResponseTruckDetailsResponse nullable: true Trailer: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trips.TripResponseTrailerDetailsResponse nullable: true Id: type: string TripNumber: type: string Status: type: string LoadNumber: type: string OrderNumber: type: string nullable: true Stops: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.StopResponse' TenderAs: type: string nullable: true TenderAsSubsidiaryType: type: string nullable: true RequiredEquipment: type: array items: type: string nullable: true Temperature: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trips.TripResponseTemperatureRequirements nullable: true TotalMileage: allOf: - $ref: '#/components/schemas/Alvys.Models.Loads.LoadResponseMileage' EmptyMileage: allOf: - $ref: '#/components/schemas/Alvys.Models.Loads.LoadResponseMileage' LoadedMileage: allOf: - $ref: '#/components/schemas/Alvys.Models.Loads.LoadResponseMileage' PickupDate: type: string format: date-time nullable: true DeliveryDate: type: string format: date-time nullable: true PickedUpAt: type: string format: date-time nullable: true DeliveredAt: type: string format: date-time nullable: true CarrierAssignedAt: type: string format: date-time nullable: true ReleasedAt: type: string format: date-time nullable: true CarrierPaidAt: type: string format: date-time nullable: true DueDate: type: string format: date-time nullable: true TripValue: allOf: - $ref: '#/components/schemas/Alvys.Money' Driver1: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trips.TripResponseDriverResponse nullable: true Driver2: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trips.TripResponseDriverResponse nullable: true OwnerOperator: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trips.TripResponseOwnerOperatorResponse nullable: true ReleasedBy: type: string nullable: true DispatchedBy: type: string nullable: true DispatcherId: type: string nullable: true CarrierSalesAgentId: type: string nullable: true CarrierPayOnHold: type: boolean Carrier: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trips.TripResponseCarrierResponse nullable: true UpdatedAt: type: string format: date-time nullable: true UpdatedBy: type: string nullable: true IsDeleted: type: boolean nullable: true References: type: array items: $ref: '#/components/schemas/Alvys.Models.References.ReferenceResponse' nullable: true additionalProperties: false Microsoft.AspNetCore.Mvc.ProblemDetails: type: object properties: Type: type: string nullable: true Title: type: string nullable: true Status: type: integer format: int32 nullable: true Detail: type: string nullable: true Instance: type: string nullable: true additionalProperties: {} Alvys.Models.Trips.TripResponseTruckDetailsResponse: type: object properties: Telemetry: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trips.TripResponseTruckTelemetry nullable: true Id: type: string nullable: true Fleet: allOf: - $ref: '#/components/schemas/FleetResponse' nullable: true additionalProperties: false Alvys.Models.Trips.TripResponseTrailerDetailsResponse: required: - EquipmentType type: object properties: Telemetry: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trips.TripResponseTrailerTelemetry nullable: true Id: type: string nullable: true EquipmentType: type: string EquipmentLength: allOf: - $ref: '#/components/schemas/Alvys.Length' nullable: true Fleet: allOf: - $ref: '#/components/schemas/FleetResponse' nullable: true additionalProperties: false Alvys.Models.Trips.StopResponse: required: - $type type: object oneOf: - $ref: '#/components/schemas/Alvys.Models.Trips.AppointmentStopResponse' - $ref: '#/components/schemas/Alvys.Models.Trips.DeliveryWindowStopResponse' - $ref: '#/components/schemas/Alvys.Models.Trips.WaypointStopResponse' properties: $type: type: string description: Type discriminator for polymorphic serialization additionalProperties: false discriminator: propertyName: $type mapping: appointment: $ref: '#/components/schemas/Alvys.Models.Trips.AppointmentStopResponse' delivery_window: $ref: '#/components/schemas/Alvys.Models.Trips.DeliveryWindowStopResponse' waypoint: $ref: '#/components/schemas/Alvys.Models.Trips.WaypointStopResponse' Alvys.Models.Trips.TripResponseTemperatureRequirements: type: object properties: SetpointTemperature: type: number format: double nullable: true SetpointTemperatureMax: type: number format: double nullable: true ControlMode: type: string nullable: true additionalProperties: false Alvys.Models.Loads.LoadResponseMileage: required: - Distance type: object properties: Distance: allOf: - $ref: '#/components/schemas/Alvys.Distance' Source: type: string nullable: true ProfileId: type: string nullable: true ProfileName: type: string nullable: true additionalProperties: false Alvys.Money: required: - Amount type: object properties: Amount: type: number format: double Currency: type: integer format: int32 nullable: true additionalProperties: false Alvys.Models.Trips.TripResponseDriverResponse: required: - Rates type: object properties: Id: type: string nullable: true ContractorType: type: string nullable: true Rates: type: array items: $ref: '#/components/schemas/Alvys.Models.DriverRate' deprecated: true Fleet: allOf: - $ref: '#/components/schemas/FleetResponse' nullable: true AccessorialsDetails: type: array items: $ref: >- #/components/schemas/Alvys.Models.Accessorials.DriverAccessorialResponse nullable: true EChecks: type: array items: $ref: '#/components/schemas/Alvys.Models.Accessorials.ECheckResponse' nullable: true RatesV2: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.DriverRatePolicyResponse' nullable: true additionalProperties: false Alvys.Models.Trips.TripResponseOwnerOperatorResponse: required: - Id type: object properties: Id: type: string AccessorialsDetails: type: array items: $ref: >- #/components/schemas/Alvys.Models.Accessorials.OwnerOperatorAccessorialResponse nullable: true EChecks: type: array items: $ref: '#/components/schemas/Alvys.Models.Accessorials.ECheckResponse' nullable: true RatesV2: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.DriverRatePolicyResponse' nullable: true additionalProperties: false Alvys.Models.Trips.TripResponseCarrierResponse: required: - Accessorials - Id - Linehaul - Rate - TotalPayable type: object properties: Id: type: string CarrierInvoiceNumber: type: string nullable: true Rate: allOf: - $ref: '#/components/schemas/Alvys.Money' deprecated: true Linehaul: allOf: - $ref: '#/components/schemas/Alvys.Money' AccessorialsDetails: type: array items: $ref: >- #/components/schemas/Alvys.Models.Accessorials.CarrierAccessorialResponse nullable: true EChecks: type: array items: $ref: '#/components/schemas/Alvys.Models.Accessorials.ECheckResponse' nullable: true Accessorials: allOf: - $ref: '#/components/schemas/Alvys.Money' readOnly: true TotalPayable: allOf: - $ref: '#/components/schemas/Alvys.Money' readOnly: true additionalProperties: false Alvys.Models.References.ReferenceResponse: required: - Name - Value type: object properties: Id: type: string nullable: true ReferenceId: type: string nullable: true Name: type: string Value: type: string Type: type: string nullable: true Access: type: string nullable: true Origin: type: string nullable: true additionalProperties: false Alvys.Models.Trips.TripResponseTruckTelemetry: type: object properties: Coordinates: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.TripResponseCoordinates' nullable: true Timestamp: type: string format: date-time nullable: true additionalProperties: false FleetResponse: type: object properties: Id: type: string nullable: true Name: type: string nullable: true InvoiceNumberPrefix: type: string nullable: true additionalProperties: false Alvys.Models.Trips.TripResponseTrailerTelemetry: type: object properties: Coordinates: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.TripResponseCoordinates' nullable: true Timestamp: type: string format: date-time nullable: true SetpointTemperature: type: number format: double nullable: true ReturnAirTemperature: type: number format: double nullable: true SupplyAirTemperature: type: number format: double nullable: true ProbeTemperature: type: number format: double nullable: true ControlMode: type: string nullable: true Power: type: string nullable: true FuelPercent: type: number format: double nullable: true additionalProperties: false Alvys.Length: required: - UnitOfMeasure - Value type: object properties: Value: type: number format: double UnitOfMeasure: allOf: - $ref: '#/components/schemas/Alvys.LengthUnits' additionalProperties: false Alvys.Models.Trips.AppointmentStopResponse: required: - AppointmentConfirmed - AppointmentRequested - Id - References - ScheduleType - StopType type: object properties: AppointmentRequested: type: boolean AppointmentConfirmed: type: boolean AppointmentDate: type: string format: date-time nullable: true ScheduleType: type: string LoadingType: type: string nullable: true Id: type: string Address: allOf: - $ref: '#/components/schemas/Alvys.Features.Locations.ShortAddress' nullable: true Coordinates: allOf: - $ref: '#/components/schemas/Alvys.Models.Coordinates' nullable: true Status: type: string nullable: true StopType: type: string ArrivedAt: type: string format: date-time nullable: true DepartedAt: type: string format: date-time nullable: true References: type: array items: $ref: '#/components/schemas/Alvys.Models.References.ReferenceResponse' CompanyId: type: string nullable: true CompanyNumber: type: string nullable: true CompanyName: type: string nullable: true additionalProperties: false Alvys.Models.Trips.DeliveryWindowStopResponse: required: - Id - References - ScheduleType - StopType type: object properties: StopWindow: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.DateTimeWindowDto' nullable: true ScheduleType: type: string LoadingType: type: string nullable: true Id: type: string Address: allOf: - $ref: '#/components/schemas/Alvys.Features.Locations.ShortAddress' nullable: true Coordinates: allOf: - $ref: '#/components/schemas/Alvys.Models.Coordinates' nullable: true Status: type: string nullable: true StopType: type: string ArrivedAt: type: string format: date-time nullable: true DepartedAt: type: string format: date-time nullable: true References: type: array items: $ref: '#/components/schemas/Alvys.Models.References.ReferenceResponse' CompanyId: type: string nullable: true CompanyNumber: type: string nullable: true CompanyName: type: string nullable: true additionalProperties: false Alvys.Models.Trips.WaypointStopResponse: required: - $type - Id - References - StopType type: object properties: StopWindow: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.DateTimeWindowDto' nullable: true Id: type: string Address: allOf: - $ref: '#/components/schemas/Alvys.Features.Locations.ShortAddress' nullable: true Coordinates: allOf: - $ref: '#/components/schemas/Alvys.Models.Coordinates' nullable: true Status: type: string nullable: true StopType: type: string ArrivedAt: type: string format: date-time nullable: true DepartedAt: type: string format: date-time nullable: true References: type: array items: $ref: '#/components/schemas/Alvys.Models.References.ReferenceResponse' CompanyId: type: string nullable: true CompanyNumber: type: string nullable: true CompanyName: type: string nullable: true $type: enum: - waypoint type: string description: Type discriminator for polymorphic serialization additionalProperties: false Alvys.Distance: required: - UnitOfMeasure - Value type: object properties: Value: type: number format: double UnitOfMeasure: allOf: - $ref: '#/components/schemas/Alvys.DistanceDistanceUnits' additionalProperties: false Alvys.Models.DriverRate: required: - FreeUnit - Rate - RateType type: object properties: Rate: type: number format: double ExtraStops: type: number format: double nullable: true RateType: type: string PerDiemRateType: type: string nullable: true FreeUnit: type: number format: double Source: type: string nullable: true additionalProperties: false Alvys.Models.Accessorials.DriverAccessorialResponse: required: - Id - Quantity - Rate - RateType - Total - Type - Uom type: object properties: Id: type: string Type: type: string Total: allOf: - $ref: '#/components/schemas/Alvys.Money' Rate: allOf: - $ref: '#/components/schemas/Alvys.Money' RateType: type: string Uom: type: string Quantity: type: number format: double IsPaid: type: boolean nullable: true CreatedAt: type: string format: date-time nullable: true CreatedBy: type: string nullable: true UpdatedAt: type: string format: date-time nullable: true UpdatedBy: type: string nullable: true ECheckNumber: type: string nullable: true StopId: type: string nullable: true additionalProperties: false Alvys.Models.Accessorials.ECheckResponse: required: - Amount - CheckNumber - Fee - Id - Type type: object properties: Id: type: string CheckNumber: type: string Amount: allOf: - $ref: '#/components/schemas/Alvys.Money' Fee: allOf: - $ref: '#/components/schemas/Alvys.Money' Type: type: string IsPaid: type: boolean nullable: true CreatedAt: type: string format: date-time nullable: true additionalProperties: false Alvys.Models.Trips.DriverRatePolicyResponse: required: - PolicyId - PolicyName type: object properties: PolicyId: type: string PolicyName: type: string TripValuePercentageRate: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trips.TripValuePercentageRateDto nullable: true TripValuePercentageDeductionRate: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trips.TripValuePercentageRateDto nullable: true FuelSurchargePercentageRate: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trips.FuelSurchargePercentageRateDto nullable: true CustomerLineHaulPercentageRate: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trips.CustomerLineHaulPercentageRateDto nullable: true CustomerLineHaulDeductionRate: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trips.CustomerLineHaulPercentageRateDto nullable: true PerTripRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.PerTripRateDto' nullable: true ServiceFeeRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.ServiceFeeRateDto' nullable: true StatementMinimumPayRate: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trips.StatementMinimumPayRateDto nullable: true StatementBonusRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.StatementBonusRateDto' nullable: true StatementPerDiemRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.StatementPerDiemRateDto' nullable: true TotalMilesRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.MileageRateDto' nullable: true LoadedMilesRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.MileageRateDto' nullable: true EmptyMilesRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.MileageRateDto' nullable: true PerStopRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.PerStopRateDto' nullable: true PerLoadRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.PerLoadRateDto' nullable: true PerCustomerStopRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.PerStopRateDto' nullable: true PerHourRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.PerHourRateDto' nullable: true PerDayRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.PerDayRateDto' nullable: true DailyPerDiemRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.DailyPerDiemRateDto' nullable: true MileagePerDiemRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.MileagePerDiemRateDto' nullable: true PerMileRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.PerMileRateDto' nullable: true PerMileDeductionRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.PerMileRateDto' nullable: true DailyMinimumPayRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.DailyMinimumPayRateDto' nullable: true PerHourWithOvertimeRate: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trips.PerHourWithOvertimeRateDto nullable: true PerWeightRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.PerWeightRateDto' nullable: true RestBreaksRate: allOf: - $ref: '#/components/schemas/Alvys.Models.Trips.RestBreaksRateDto' nullable: true additionalProperties: false Alvys.Models.Accessorials.OwnerOperatorAccessorialResponse: required: - Id - Quantity - Rate - RateType - Total - Type - Uom type: object properties: Id: type: string Type: type: string Total: allOf: - $ref: '#/components/schemas/Alvys.Money' Rate: allOf: - $ref: '#/components/schemas/Alvys.Money' RateType: type: string Uom: type: string Quantity: type: number format: double IsPaid: type: boolean nullable: true CreatedAt: type: string format: date-time nullable: true CreatedBy: type: string nullable: true UpdatedAt: type: string format: date-time nullable: true UpdatedBy: type: string nullable: true ECheckNumber: type: string nullable: true StopId: type: string nullable: true additionalProperties: false Alvys.Models.Accessorials.CarrierAccessorialResponse: required: - Id - Quantity - Rate - RateType - Total - Type - Uom type: object properties: Id: type: string Type: type: string Total: allOf: - $ref: '#/components/schemas/Alvys.Money' Rate: allOf: - $ref: '#/components/schemas/Alvys.Money' RateType: type: string Uom: type: string Quantity: type: number format: double IsPaid: type: boolean nullable: true CreatedAt: type: string format: date-time nullable: true CreatedBy: type: string nullable: true UpdatedAt: type: string format: date-time nullable: true UpdatedBy: type: string nullable: true StopId: type: string nullable: true additionalProperties: false Alvys.Models.Trips.TripResponseCoordinates: required: - Latitude - Longitude type: object properties: Latitude: type: number format: double Longitude: type: number format: double additionalProperties: false Alvys.LengthUnits: enum: - Feet - Inches - Yards - Meters type: string Alvys.Features.Locations.ShortAddress: required: - City - State - Street - ZipCode type: object properties: Street: type: string City: type: string State: type: string ZipCode: type: string additionalProperties: false Alvys.Models.Coordinates: required: - Latitude - Longitude type: object properties: Latitude: type: string Longitude: type: string additionalProperties: false Alvys.Models.Trips.DateTimeWindowDto: required: - Begin - End type: object properties: Begin: type: string format: date-time End: type: string format: date-time additionalProperties: false Alvys.DistanceDistanceUnits: enum: - Miles - Kilometers - Meters - Feet type: string Alvys.Models.Trips.TripValuePercentageRateDto: required: - LineItems - Percentage - RateId - RateName type: object properties: Percentage: type: number format: double RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.FuelSurchargePercentageRateDto: required: - LineItems - Percentage - RateId - RateName type: object properties: Percentage: type: number format: double RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.CustomerLineHaulPercentageRateDto: required: - LineItems - Percentage - RateId - RateName - HideCalculationDetails type: object properties: Percentage: type: number format: double RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' HideCalculationDetails: type: boolean additionalProperties: false Alvys.Models.Trips.PerTripRateDto: required: - LineItems - Rate - RateId - RateName type: object properties: Rate: type: number format: double deprecated: true Tiers: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.MileageRateTierDto' nullable: true MileageType: type: string nullable: true RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.ServiceFeeRateDto: required: - FlatFee - LineItems - Percentage - RateId - RateName type: object properties: Percentage: type: number format: double FlatFee: type: number format: double RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.StatementMinimumPayRateDto: required: - LineItems - MinimumAmount - RateId - RateName type: object properties: MinimumAmount: type: number format: double RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.StatementBonusRateDto: required: - Amount - LineItems - RateId - RateName type: object properties: Amount: type: number format: double RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.StatementPerDiemRateDto: required: - LineItems - MileageType - RateId - RateName - Tiers type: object properties: Tiers: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.MileageRateTierDto' MileageType: type: string RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.MileageRateDto: required: - LineItems - RateId - RateName - Tiers - UseHighestTier type: object properties: Tiers: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.MileageRateTierDto' UseHighestTier: type: boolean RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.PerStopRateDto: required: - LineItems - RateId - RateName - Tiers type: object properties: Tiers: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.PerStopRateTierDto' RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.PerLoadRateDto: required: - LineItems - Rate - RateId - RateName type: object properties: Rate: type: number format: double RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.PerHourRateDto: required: - LineItems - Rate - RateId - RateName type: object properties: Rate: type: number format: double RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.PerDayRateDto: required: - LineItems - Rate - RateId - RateName type: object properties: Rate: type: number format: double RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.DailyPerDiemRateDto: required: - LineItems - Rate - RateId - RateName type: object properties: Rate: type: number format: double RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.MileagePerDiemRateDto: required: - LineItems - MileageType - RateId - RateName - Tiers - UseHighestTier type: object properties: Tiers: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.MileageRateTierDto' UseHighestTier: type: boolean MileageType: type: string RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.PerMileRateDto: required: - LineItems - MileageType - RateId - RateName - Tiers - UseHighestTier type: object properties: Tiers: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.MileageRateTierDto' UseHighestTier: type: boolean MileageType: type: string RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.DailyMinimumPayRateDto: required: - DailyRate - EndGraceHours - IncludeWaypoints - LineItems - RateId - RateName - StartGraceHours type: object properties: DailyRate: type: number format: double StartGraceHours: type: number format: double EndGraceHours: type: number format: double IncludeWaypoints: type: boolean RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.PerHourWithOvertimeRateDto: required: - BaseRate - LineItems - OtMultiplier - RateId - RateName - WeeklyOtThreshold type: object properties: BaseRate: type: number format: double OtMultiplier: type: number format: double WeeklyOtThreshold: type: number format: double RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.PerWeightRateDto: required: - LineItems - Rate - RateId - RateName type: object properties: Rate: type: number format: double RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.RestBreaksRateDto: required: - EveryNthHour - LineItems - PerBreakRate - RateId - RateName type: object properties: PerBreakRate: type: number format: double EveryNthHour: type: integer format: int32 RateId: type: string RateName: type: string LineItems: type: array items: $ref: '#/components/schemas/Alvys.Models.Trips.LineItemDto' additionalProperties: false Alvys.Models.Trips.LineItemDto: required: - Amount - Description type: object properties: Description: type: string Amount: allOf: - $ref: '#/components/schemas/Alvys.Money' additionalProperties: false Alvys.Models.Trips.MileageRateTierDto: required: - Miles - Rate type: object properties: Miles: type: integer format: int32 Rate: type: number format: double additionalProperties: false Alvys.Models.Trips.PerStopRateTierDto: required: - FlatBonus - Rate - Stops type: object properties: Stops: type: integer format: int32 Rate: type: number format: double FlatBonus: type: number format: double additionalProperties: false securitySchemes: Public: type: http scheme: bearer bearerFormat: JWT description: >- 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 `. ````