This document is supplied to provide some additional information to the online documentation that exists when accessing the API in the browser.
Submitting an inventory item requires posting a JSON (or XML) payload conforming to the inventory model to a web endpoint.
The inventory model supports any type of inventory (e.g. car, bike, truck etc.), however depending on the inventory type different validation may be applied at the API level.
When validation fails, an error response will be returned with an explanation.
| Http Method | POST |
|---|---|
| Resources |
v1/batch/pentana (no authentication) v2/batch/pentana (no authentication) api/auth/Inventory/postItem/{vertical}/{tenantId} (basic authentication) |
| Authentication | Required |
| Request Format | JSON or XML |
|---|---|
| Request Object | Inventory Model |
| Response Format | JSON or XML |
| Response Object |
Success - 200 ok.
Error - error code.
Error message body in JSON format in the case of malformated data.
|
Production URL:
https://inventory-api.carsalesnetwork.com.au/v1/batch/pentana
Please note that the Mandatory status for the items in the Model below is referring to saving to Autogate. Additional information might be required for the item to be published.
{
"DealerIdentifier": "631077c7-e8da-4020-b7aa-80768976eea1",
"Type": "Car",
"ListingType": "Used",
"Status": "For Sale",
"StockNumber": "test1234",
"Publishing": [
{ "Name": "Carsales" },
{
"Name": "Livetrade",
"Properties": {
"Report": "http://sample.com/report/123456",
"InitialBid": "1000",
"Reserve": "5000",
"BuyNowPrice": "5990",
"ListingEndDate": "2015-07-31T17:00:00"
}
}
],
"Make": "Holden",
"Model": "Commodore",
"BuildYear": "2014",
"BuildMonth": "9",
"ComplianceYear": "2014",
"ComplianceMonth": "10",
"Series": "VF",
"Badge": "SV6",
"IgcPrice": "39990",
"EgcPrice": "37500",
"Comments": "Inventory API check",
"RegistrationNumber": "REGO1234",
"RegistrationExpiry": "2015-10-26",
"VIN": "6G1FB5E##FL000000",
"Kilometres": "22234",
"Hours": "0",
"Bodystyle": "Sedan",
"Doors": "4",
"Seats": "5",
"Cylinders": "6",
"Gears": "6",
"GearType": "Manual",
"DriveType": "Rear Wheel Drive",
"EngineCapacity": "3564",
"EngineType": "Aspirated Piston",
"Fuel": "Petrol - Unleaded ULP",
"RedbookCode": "AUVHOLD2014AEBI",
"Colour": "Black",
"InteriorColour": "Grey",
"Gcm": 2,
"Gvm": 3,
"Features": [
"Cruise Control",
"Towbar"
],
"Photos": [
"http://liveimages.carsales.com.au/carsales/car/dealer/201900704.jpg?height=700&aspect=FitWithinNoPad&width=1050",
"http://liveimages.carsales.com.au/carsales/car/dealer/201900697.jpg?height=700&aspect=FitWithinNoPad&width=1050"
],
"Currency": "AUD"
}
631077c7-e8da-4020-b7aa-80768976eea1 Car Used For Sale test1234 Carsales Livetrade http://sample.com/report/123456 1000 5000 5990 2015-07-31T17:00:00 Holden Commodore 2014 9 2014 10 VF SV6 39990 37500 Inventory API check REGO1234 2015-10-26 6G1FB5E##FL000000 22234 0 Sedan 4 5 6 6 Manual Rear Wheel Drive 3564 Aspirated Piston Petrol - Unleaded ULP AUVHOLD2014AEBI Black Grey 2 3 Cruise Control Towbar http://liveimages.carsales.com.au/carsales/car/dealer/201900704.jpg http://liveimages.carsales.com.au/carsales/car/dealer/201900697.jpg AUD
Please note that the Mandatory status for the items in the Model below is referring to saving to Autogate. Additional information might be required for the item to be published.
| Property | Type | Allowable Values | Mandatory | Description |
|---|---|---|---|---|
| DealerIdentification | GUID | Yes | ||
| Type | String | Car, Bike, Truck, Boat, Caravan, Industry | Yes | |
| ListingType | String | New, Demo, Used | Yes | |
| Status | String | For Sale, Sold, Withdrawn | Yes | |
| StockNumber | String | Yes | ||
| Publishing/Site/Name | String | No | ||
| Publishing/Site/Properties/Report | String | No | ||
| Publishing/Site/Properties/InitialBid | int | No | ||
| Publishing/Site/Properties/Reserve | int | No | ||
| Publishing/Site/Properties/BuyNowPrice | int | No | ||
| Publishing/Site/Properties/ListingEndDate | DateTime | No | ||
| Market | String | No | ||
| Group | String | No | ||
| Category | String | Yes | ||
| Subcategory | String | Trucks: All Wheel Drive, Beavertail, Belly Dumper, Bottle Truck, Box Body, Cab-Chassis, Car Transporters, Catering Vehicle, Cherry Picker, Compactor, Concrete, Crane Truck, Curtainsider, Dual Cab, Ex Military, Fire Trucks, Fitters Truck, Flat Deck, Glass A Frame, Gull Wing, Hooklift & Bi Fold, Horse Truck, Light Trucks, Livestock Truck, Logging Truck, Pantech, Prime Mover, Refrigerated Truck, Refrigerated Van, Removal, Road Train, Service Vehicle, Skel Tray, Skip Bin Loader, Spreader, Tail Lift, Tanker, Tipper, Tipping Tray, Tow & Tilt, Tow Motor, Tractor Unit, Trailer Jockey, Transporter, Tray, Tray Dropside, Vans, Vintage, Walking Floor, Waste Disposal, Water Truck, Wrecking | Yes | |
| Make | String | No | ||
| Model | String | No | ||
| BuildYear | int | No | ||
| BuildMonth | int | No | ||
| ComplianceYear | int | No | ||
| ComplianceMonth | int | No | ||
| Series | string | No | ||
| Badge | string | No | ||
| IgcPrice | int | No | ||
| EgcPrice | int | No | ||
| Comments | string | No | ||
| RegistrationNumber | string | No | ||
| RegistrationExpiry | string | No | Format: "YYYY-MM-DD" | |
| VIN | string | No | ||
| Kilometres | int | No | ||
| Hours | int | No | ||
| Bodystyle | String | No | ||
| Doors | int | No | ||
| Seats | int | No | ||
| Cylinders | int | No | ||
| Gears | int | No | ||
| GearType | String | No | ||
| DriveType | String | No | ||
| EngineCapacity | int | No | ||
| EngineType | String | No | ||
| Fuel | String | No | ||
| RedbookCode | String | No | ||
| GlassesCode | String | No | ||
| GenericColour | String | Beige, Blue, Black, Bronze, Brown, Burgundy, Grey, Green, Gold, Maroon, Magenta, Orange, Pink, Purple, Red, Silver, White, Yellow | No | |
| Colour | String | No | ||
| InteriorColour | String | No | ||
| MaterialCode | String | No | ||
| Trim | String | No | ||
| Paint | String | No | ||
| Features/Feature | String | No | ||
| Photoes/Photo | String | No | ||
| ItemCondition | String | Excellent, Good, Fair, Poor, Wrecking | No | |
| MaxlminPressure | String | No | ||
| GearsReverse | String | No | ||
| FuelCapacity | String | No | ||
| PressureOutletsMax | String | No | ||
| SerialNumber | String | No | ||
| SizeRear | String | No | FeaureGroup: Tyres & Wheels | |
| EngineMake | String | No | ||
| Description | String | No | ||
| GearsForward | String | No | ||
| TurningCircle | String | No | ||
| TowBar | String | No | ||
| PressureOutletsStd | String | No | ||
| Size | String | No | ||
| RemoteOutletsStdMax | String | No | ||
| ConditionRear | String | No | Feature Group: Tyres & Wheels | |
| TransmissionType | String | No | ||
| EnginePower | String | No | ||
| Stereo | String | No | ||
| AxleWidth | String | No | ||
| Warranty | String | No | ||
| ErgClass | String | No | ||
| Brakes | String | No | ||
| Guidance | String | No | ||
| SizeFront | String | No | FeatureGroup: Tyres & Wheels | |
| TypeRear | String | No | Feature Group: Tyres & Wheels | |
| TypeFront | String | No | Feature Group: Tyres & Wheels | |
| Rops | String | Frame Only, Cab with ROPS | No | |
| ConditionFront | String | No | Feature Group: Tyres & Wheels | |
| Capacity | String | No | ||
| MaximumOperating | String | No | ||
| SteeringType | String | No | ||
| AirConditioning | String | No | ||
| EngineNumber | String | No | ||
| HighLowShuttle | String | No | ||
| PumpType | String | No | ||
| TransmissionModel | String | No | ||
| SoundLevelInCab | String | No | ||
| SpareTyres | String | No | ||
| Radio | String | No | ||
| Currency | String | No | ||
| Gcm | int | No | ||
| Gvm | int | No |
{
"DealerIdentifier": "b8e14a12-15c0-40ec-9c5e-5ffdd0170791",
"Type": "Truck",
"ListingType": "Used",
"Status": "For Sale",
"StockNumber": "U0001",
"Publishing": [
{"Name": "Carsales"},
{
"Name": "Livetrade",
"Properties": {
"Report": "http://sample.com/report/123456",
"InitialBid": "1000",
"Reserve": "5000",
"BuyNowPrice": "5990",
"ListingEndDate": "2015-07-31T17:00:00"
}
}
],
"Category": "Trucks",
"Subcategory": "Prime Mover",
"Make": "Holden",
"Model": "Commodore",
"BuildYear": "2014",
"BuildMonth": "9",
"ComplianceYear": "2014",
"ComplianceMonth": "10",
"Series": "VF",
"Badge": "SV6",
"IgcPrice": "39990",
"EgcPrice": "37500",
"Comments": "Sample Comments",
"RegistrationNumber": "ABC123",
"RegistrationExpiry": "2015-10-26",
"VIN": "6G1FB5E##FL000000",
"Kilometres": "22234",
"Hours": "0",
"Bodystyle": "Sedan",
"Doors": "4",
"Seats": "5",
"Cylinders": "6",
"Gears": "6",
"GearType": "Manual",
"DriveType": "Rear Wheel Drive",
"EngineCapacity": "3564",
"EngineType": "Aspirated Piston",
"Fuel": "Petrol - Unleaded ULP",
"RedbookCode": "AUVMERC2015AEJ7",
"Colour": "Black",
"InteriorColour": "Grey",
"Features": [
"Cruise Control",
"Towbar"
],
"Photos": [
"http://th08.deviantart.net/fs70/PRE/f/2013/151/c/a/render_car_tron_by_mateoart-d67auwe.png",
"http://th08.deviantart.net/fs70/PRE/f/2013/151/c/a/render_car_tron_by_mateoart-d67auwe.png"
],
"Currency": "AUD"
}
b8e14a12-15c0-40ec-9c5e-5ffdd0170791 Truck Used For Sale U0001 Carsales Livetrade http://sample.com/report/123456 1000 5000 5990 2015-07-31T17:00:00 Trucks Prime Mover Holden Commodore 2014 9 2014 10 VF SV6 39990 37500 Sample Comments ABC123 2015-10-26 6G1FB5E##FL000000 22234 0 Sedan 4 5 6 6 Manual Rear Wheel Drive 3564 Aspirated Piston Petrol - Unleaded ULP AUVMERC2015AEJ7 Black Grey 2 3 Cruise Control Towbar http://th08.deviantart.net/fs70/PRE/f/2013/151/c/a/render_car_tron_by_mateoart-d67auwe.png http://th08.deviantart.net/fs70/PRE/f/2013/151/c/a/render_car_tron_by_mateoart-d67auwe.png AUD