--- title: "Get My Vehicles" url: "https://stage-api-docs.centraldispatch.com/apis/stage-listing-api-2-0-0/versions/6459c118-c2b9-484e-816d-5657457559e4/operations/getMyVehicles" --- > Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-listing-api-2-0-0/versions/6459c118-c2b9-484e-816d-5657457559e4.md # Get My Vehicles `GET` `/listing-vehicles/mine` Operation ID: `getMyVehicles` Get the vehicles in listings that belong to the calling customer. #### 👥 Customer Type - Shipper #### 🔍 Allowed Search Criteria `externalVehicleId`: A vehicle identifier managed by the user. Shippers can use this field to map a vehicle record in their local TMS to a Central Dispatch record. `listingId`: The ID of the listing. #### 📝 Important Notes Be sure to URL encode any parameters that contain spaces or special characters. Results will be paginated. Navigate through the results using the `next` value. #### Example ```bash curl -X GET https://api.centraldispatch.com/listing-vehicles/mine?limit(1,10)%listingId=400000000 ``` ## Query parameters - `externalVehicleId` (string, optional) - A vehicle identifier managed by the user. Shippers can use this field to map a vehicle record in their local TMS to a Central Dispatch record. - `listingId` (string, optional) - The ID of the listing. ## Header parameters - `Accept` (string, required) - The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 2.x.x of an API, the Accept header should be set to `application/vnd.coxauto.v2+json`. ## Responses - `200` - OK. Successful request. - `400` - Bad Request. Check the request payload. **Scenarios:** - Missing or malformed customer ID in token. - Invalid limit values (must be positive, within max range). - Invalid parameter or validation failure. - `401` - Unauthorized. Authentication failed or missing. - `403` - Forbidden. The attempted action is not permitted. - `404` - Not Found. - `406` - Not Acceptable **Scenarios:** - `Accept` version header is missing or invalid - v2 API requires: `Accept: application/vnd.coxauto.v2+json`. - `422` - Unprocessable Entity. Errors found in the request. - `429` - Too Many Requests. Rate limit exceeded. - `500` - Error. - `503` - Service Unavailable. Temporary service interruption. ## OpenAPI definition ````yaml openapi: 3.0.1 info: title: Listing API version: 2.0.0 servers: - url: https://marketplace-api.centraldispatch.com description: Production server paths: /listing-vehicles/mine: get: tags: - Listing-Vehicles summary: Get My Vehicles description: | Get the vehicles in listings that belong to the calling customer. #### 👥 Customer Type - Shipper #### 🔍 Allowed Search Criteria `externalVehicleId`: A vehicle identifier managed by the user. Shippers can use this field to map a vehicle record in their local TMS to a Central Dispatch record. `listingId`: The ID of the listing. #### 📝 Important Notes Be sure to URL encode any parameters that contain spaces or special characters. Results will be paginated. Navigate through the results using the `next` value. #### Example ```bash curl -X GET https://api.centraldispatch.com/listing-vehicles/mine?limit(1,10)%listingId=400000000 ``` operationId: getMyVehicles parameters: - name: externalVehicleId in: query description: A vehicle identifier managed by the user. Shippers can use this field to map a vehicle record in their local TMS to a Central Dispatch record. schema: type: string example: EXT123456 - name: listingId in: query description: The ID of the listing. schema: type: string example: "42220470" - name: Accept in: header description: The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 2.x.x of an API, the Accept header should be set to `application/vnd.coxauto.v2+json`. required: true schema: type: string example: application/vnd.coxauto.v2+json responses: "200": description: OK. Successful request. headers: Etag: description: Contains the current version of the resource and should be used for the `If-Match` header on updates. schema: type: string example: "8675300" X-CoxAuto-Media-Type: description: Contains the major version and format information. schema: type: string example: coxauto.v2; format=json content: application/json: schema: $ref: "#/components/schemas/VehicleCollection" "400": description: |- Bad Request. Check the request payload. **Scenarios:** - Missing or malformed customer ID in token. - Invalid limit values (must be positive, within max range). - Invalid parameter or validation failure. content: application/json: schema: $ref: "#/components/schemas/Errors" "401": description: Unauthorized. Authentication failed or missing. "403": description: Forbidden. The attempted action is not permitted. "404": description: Not Found. content: application/json: schema: $ref: "#/components/schemas/Errors" "406": description: >- Not Acceptable **Scenarios:** - `Accept` version header is missing or invalid - v2 API requires: `Accept: application/vnd.coxauto.v2+json`. content: application/json: schema: $ref: "#/components/schemas/Errors" "422": description: Unprocessable Entity. Errors found in the request. content: application/json: schema: $ref: "#/components/schemas/Errors" "429": description: Too Many Requests. Rate limit exceeded. "500": description: Error. content: application/json: schema: $ref: "#/components/schemas/Errors" "503": description: Service Unavailable. Temporary service interruption. security: - Bearer: [] security: - Bearer: [] components: schemas: VehicleCollection: type: object properties: href: type: string description: The URL used to query the current collection of the resource. example: https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(5,1) items: type: array items: $ref: "#/components/schemas/VehicleResponse" description: A collection of records. limit: type: integer description: The maximum number of items to be returned in the response. format: int32 example: 1 next: type: string description: The URL to the next page of the collection, if available. nullable: true example: https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(5,1) previous: type: string description: The URL to the previous page of the collection, if available. nullable: true example: https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(6,1) first: type: string description: The URL to the first page of the collection. nullable: true example: https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(1,1) count: type: integer description: The total count of resources in the collection. format: int32 example: 23 description: A paginated collection of vehicles. Errors: type: object properties: errors: type: array items: $ref: "#/components/schemas/Error" description: A collection of errors. nullable: true description: An error occurred, and the request could not be completed. VehicleResponse: type: object properties: vehicleId: type: string description: The ID of the vehicle. format: uuid example: b331c130-e89b-12d3-a456-426614174000 listing: type: string description: The fully qualified URL of the listing. nullable: true example: https://marketplace-api.centraldispatch.com/listings/id/42220470 externalVehicleId: type: string description: A vehicle identifier managed by the user. Shippers can use this field to map a vehicle record in their local TMS to a Central Dispatch record. nullable: true example: EXT123456 pickupStopNumber: type: integer description: The stop number where the vehicle will be picked up. format: int32 example: 1 dropOffStopNumber: type: integer description: The sequential stop number where the vehicle will be delivered. format: int32 example: 2 vin: type: string description: The vehicle identification number (VIN). nullable: true example: KL8CH6SA6NC001234 year: type: integer description: The 4 digit year of the vehicle. format: int32 example: 2022 make: type: string description: The manufacturer's make of the vehicle. nullable: true example: Chevrolet model: type: string description: The manufacturer's model of the vehicle. nullable: true example: Spark trim: type: string description: The manufacturer's trim of the vehicle. nullable: true example: LS vehicleType: enum: - ATV - BOAT - CAR - HEAVY_EQUIPMENT - LARGE_YACHT - MOTORCYCLE - OTHER - PICKUP - RV - SUV - TRAVEL_TRAILER - VAN type: string description: The type of vehicle e.g. CAR, PICKUP, SUV. This list is not exhaustive and additional values may be added at any time. vehicleTypeOther: type: string description: The description of the vehicle type. nullable: true example: CAR color: type: string description: The color of the vehicle. nullable: true example: Red licensePlate: type: string description: The license plate of the vehicle. nullable: true example: B314PIE licensePlateState: type: string description: The two-letter state abbreviation of the vehicle's license plate. nullable: true example: CA lotNumber: type: string description: The lot number of the vehicle. nullable: true example: LOT789 isInoperable: type: boolean description: Indicates whether the vehicle is inoperable. example: false tariff: type: number description: The tariff on the vehicle. format: double example: 1030.5 tariffCurrency: $ref: "#/components/schemas/Currency" additionalInfo: type: string description: Additional information. nullable: true example: The vehicle is in the back of the lot behind the big tree. oversized: type: boolean description: Indicates whether the load is oversized. example: false shippingSpecs: $ref: "#/components/schemas/ShippingSpecsResponse" vehicleAttributes: type: array items: $ref: "#/components/schemas/VehicleAttributeResponse" description: A collection of vehicle attributes. nullable: true noKeys: type: boolean description: Indicates whether the vehicle has no keys. example: true noTires: type: boolean description: Indicates whether the vehicle has no tires. example: false flatTire: type: boolean description: Indicates whether the vehicle has a flat tire. example: true frameDamage: type: boolean description: Indicates whether the vehicle has frame damage. example: false doesNotRun: type: boolean description: Indicates whether the vehicle does not run. example: true doesNotSteer: type: boolean description: Indicates whether the vehicle does not steer. example: false doesNotRoll: type: boolean description: Indicates whether the vehicle does not roll. example: false inOpNotes: type: string description: Notes about the inoperable condition of the vehicle. nullable: true example: Vehicle does not start. description: Details of a vehicle. Error: type: object properties: code: type: string description: The code used for the issue. nullable: true example: resource.issue_type message: type: string description: A detailed message. nullable: true example: The issue happened because something is wrong. property: type: string description: The property to which the issue is associated. nullable: true example: person properties: type: object additionalProperties: type: string description: Additional properties related to the issue. nullable: true example: firstName: D0nn@ lastName: Sm!th description: Details of an error or issue. Currency: enum: - USD type: string description: The currency of the monetary field. This list is not exhaustive and additional values may be added at any time. default: USD example: USD ShippingSpecsResponse: type: object properties: height: type: integer description: The height of the vehicle. format: int32 nullable: true example: 58 width: type: integer description: The width of the vehicle. format: int32 nullable: true example: 62 length: type: integer description: The length of the vehicle. format: int32 nullable: true example: 143 weight: type: integer description: The weight of the vehicle. format: int32 nullable: true example: 2246 description: Details of the shipping specifications of a vehicle. VehicleAttributeResponse: type: object properties: vehicleAttributeType: enum: - DAMAGE - FEATURE type: string description: The value of the vehicle attribute. This list is not exhaustive and additional values may be added at any time. nullable: true example: DAMAGE vehicleAttributeName: enum: - CAB_AND_CHASSIS - CONVERTIBLE - CREW_CAB - DOES_NOT_ROLL - DOES_NOT_RUN - DOES_NOT_STEER - DUAL_REAR_WHEEL - EXTENDED_CAB - EXTENDED_LENGTH - FLAT_BED - FLAT_TIRE - FRAME_DAMAGE - IS_4X2 - IS_4X4 - LADDER_RACK - LEFT_KIT - LONG_BED - NO_KEYS - NO_TIRES - OTHER_INOP - OTHER_INOP_NOTES - OVERSIZE_TIRES - OVERSIZED_UNIT - RAISED_ROOF - REGULAR_CAB - SHORT_BED - SINGLE_REAR_WHEEL - STANDARD_LENGTH - TOOLBOX - UTILITY_BODY type: string description: The name of the vehicle attribute. This list is not exhaustive and additional values may be added at any time. nullable: true example: FLAT_BED value: type: string description: The value of the vehicle attribute. nullable: true example: "true" description: Details of a vehicle attribute. securitySchemes: Bearer: type: http scheme: Bearer ````