PartnerHub

<back to all web services

VehicleGet

To override the Content-type in your clients HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/VehicleGet HTTP/1.1 
Host: partnerhub.pbsdealers.com 
Content-Type: text/jsv
Content-Length: length

{
	SerialNumber: String,
	VehicleId: 00000000000000000000000000000000,
	Year: String,
	Make: String,
	Model: String,
	Trim: String,
	ModelNumber: String,
	StockNumber: String,
	VIN: String,
	LicenseNumber: String,
	Lot: String,
	Status: String,
	StatusList: 
	[
		String
	],
	OwnerRef: 00000000000000000000000000000000,
	ModifiedSince: 0001-01-01,
	ModifiedUntil: 0001-01-01,
	LastSaleSince: 0001-01-01,
	VehicleIDList: 
	[
		00000000000000000000000000000000
	],
	IncludeInactive: False,
	IncludeBuildVehicles: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Vehicles: 
	[
		{
			Id: string/00000000-0000-0000-0000-000000000000,
			VehicleId: 00000000000000000000000000000000,
			SerialNumber: String,
			StockNumber: String,
			VIN: String,
			LicenseNumber: String,
			FleetNumber: String,
			Status: String,
			OwnerRef: 00000000000000000000000000000000,
			ModelNumber: String,
			Make: String,
			Model: String,
			Trim: String,
			VehicleType: String,
			Year: String,
			Odometer: 0,
			ExteriorColor: 
			{
				Code: String,
				Description: String
			},
			InteriorColor: 
			{
				Code: String,
				Description: String
			},
			Engine: String,
			Cylinders: String,
			Transmission: String,
			DriveWheel: String,
			Fuel: String,
			Weight: 0,
			InServiceDate: 0001-01-01,
			LastServiceDate: 0001-01-01,
			LastServiceMileage: 0,
			Lot: String,
			Options: 
			[
				{
					Code: String,
					Description: String,
					Price: 0,
					Cost: 0
				}
			],
			Refurbishments: 
			[
				{
					ReferenceNumber: String,
					Description: String,
					Price: 0,
					Cost: 0,
					Date: 0001-01-01,
					ApplicationModel: String
				}
			],
			Order: 
			{
				InvoiceNumber: String,
				Price: 0,
				Status: String,
				Eta: String,
				EstimatedCost: 0,
				OrderDate: String,
				StatusDate: String,
				IgnitionKeyCode: String,
				DoorKeyCode: String,
				Description: String,
				LocationStatus: String,
				LocationStatusDate: 0001-01-01
			},
			MSR: 0,
			BaseMSR: 0,
			Retail: 0,
			DateReceived: 0001-01-01,
			InternetPrice: 0,
			Lotpack: 0,
			Holdback: 0,
			InternetNotes: String,
			Notes: String,
			CriticalMemo: String,
			IsCertified: False,
			LastSaleDate: 0001-01-01,
			LastUpdate: 0001-01-01,
			AppraisedValue: 0,
			Warranties: 
			[
				{
					Type: String,
					CompanyName: String,
					CoveragePlan: String,
					Description: String,
					Price: 0,
					Cost: 0,
					Term: String,
					Deductible: 0,
					PolicyNumber: String,
					StartDate: String,
					StartMileage: 0,
					ExpirationDate: String,
					ExpirationMileage: 0
				}
			],
			Freight: 0,
			Air: 0,
			Inventory: 0,
			IsInactive: False,
			CustomFields: 
			[
				{
					Key: String,
					Value: String,
					Type: String
				}
			]
		}
	]
}