Download OpenAPI specification:Download
Accept | any Example: application/vnd.api+json |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "1",
- "type": "light_photo"
}, - {
- "id": "2",
- "type": "light_photo"
}, - {
- "id": "3",
- "type": "light_photo"
}
]
}
{- "data": [
- {
- "id": "3",
- "type": "light_photo"
}, - {
- "id": "2",
- "type": "light_photo"
}, - {
- "id": "1",
- "type": "light_photo"
}
]
}
id | number Example: 1 |
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Token _aRYJrqapi-7Cy9PzKLy |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": 1,
- "nameplate_id": 1,
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "production_year": 2015,
- "created_at": "2024-11-05T13:42:52.819Z",
- "updated_at": "2024-11-05T13:42:52.819Z",
- "msrp_price": "32563.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "state": "used",
- "status": "stock",
- "delivery_date": "2024-11-12",
- "transmission": "manual",
- "vin": null,
- "mileage": 913319,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "hev"
], - "power": 324,
- "video_url": null,
- "owner_id": 79,
- "color_id": 8,
- "features_standard": null,
- "features_optional": null,
- "model_year": null,
- "external_id": "8c3f29",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "model_code": null,
- "footnote": "Deserunt est aut iure et enim rem nobis natus consectetur.",
- "config_url": null,
- "subscribe_price": null,
- "vehicle_batch_upload_id": null,
- "order_number": null,
- "metadata": null,
- "locked_until": null,
- "lock_id": null,
- "code5000": null,
- "price_metadata": { },
- "manual_update_attributes": [ ],
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null
}
}
id | number Example: 20 |
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Token XJydLd_3J-qqBa5GSgZr |
Content-Type | any Example: application/vnd.api+json |
{- "status": "reserved",
- "nameplate_id": 20,
- "owner_id": 103,
- "color_id": 27,
- "power": 303,
- "msrp_price": "35761.0",
- "base_price": null,
- "features_optional": null,
- "id": 20,
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "production_year": 2015,
- "created_at": "2024-11-05T13:42:53.802Z",
- "updated_at": "2024-11-05T13:42:53.820Z",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "state": "approved",
- "delivery_date": "2024-11-09",
- "transmission": "manual",
- "vin": null,
- "mileage": 497592,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "hev"
], - "video_url": null,
- "features_standard": null,
- "model_year": null,
- "external_id": "11d877",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "model_code": null,
- "footnote": "Deserunt est aut iure et enim rem nobis natus consectetur.",
- "config_url": null,
- "subscribe_price": null,
- "vehicle_batch_upload_id": null,
- "order_number": null,
- "metadata": null,
- "locked_until": null,
- "lock_id": null,
- "code5000": null,
- "price_metadata": { },
- "manual_update_attributes": [ ],
- "disclaimers": { },
- "price_breakdown": false,
- "total_price": null
}
Action is used to lock vehicle after successful booking. It locks vehicle for 15 minutes in order to enable user completing the booking payment. In response it returns lock_id, which can be further used to perform acquire
action to permanently reserve or mark vehicle as sold.
Request Path
PUT /integration_api/buy_online/vehicles/:id/lock
Request Header
Authorization: "Bearer {dealer authorization token}"
Request Body Structure
param | example | type | required | description |
---|---|---|---|---|
id |
2 | integer | yes (in request path) | Id of the vehicle in StockLocator |
Response
Request response is JSON. Vehicle details are returned under data
, while booking details (lock_id
and locked_until
) are returned under meta
> lock_data
.
When vehicle is not found, 404 status is returned.
When lock cannot be performed (because vehicle has reserved
or sold
status or it has already been locked), 422 status is returned.
id | number Example: 3 |
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Token ZcDZdvBRgrpkEd2c2qdq |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "lock_id": "b19a",
- "locked_until": "2024-11-05T13:57:53.008Z",
- "nameplate_id": 3,
- "owner_id": 81,
- "id": 3,
- "color_id": 10,
- "power": 196,
- "msrp_price": "20717.0",
- "base_price": null,
- "features_optional": null,
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "production_year": 2015,
- "created_at": "2024-11-05T13:42:52.997Z",
- "updated_at": "2024-11-05T13:42:53.033Z",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "state": "used",
- "status": "stock",
- "delivery_date": "2024-11-20",
- "transmission": "manual",
- "vin": null,
- "mileage": 310329,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "petrol"
], - "video_url": null,
- "features_standard": null,
- "model_year": null,
- "external_id": "bb3f12",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "model_code": null,
- "footnote": "Deserunt est aut iure et enim rem nobis natus consectetur.",
- "config_url": null,
- "subscribe_price": null,
- "vehicle_batch_upload_id": null,
- "order_number": null,
- "metadata": null,
- "code5000": null,
- "price_metadata": { },
- "manual_update_attributes": [ ],
- "disclaimers": { },
- "price_breakdown": false,
- "total_price": null
}, - "meta": {
- "lock_data": {
- "locked_until": "2024-11-05T13:57:53.008Z",
- "lock_id": "b19a"
}
}
}
Action is used to unlock soft-locked vehicle. By providing vehicle id and its lock_id lock can be cancelled before expiration time.
Request Path
PUT /integration_api/buy_online/vehicles/:id/unlock/:lock_id
Request Header
Authorization: "Bearer {dealer authorization token}"
Request Body Structure
param | example | type | required | description |
---|---|---|---|---|
id |
2 | integer | yes (in request path) | Id of the vehicle in StockLocator |
lock_id |
44c2 |
string | yes (in request path) | Lock ID of the vehicle |
Response
Request response is JSON. Vehicle details are returned under data
.
When vehicle is not found or is not locked, 404 status is returned.
When unlock fails, 422 status is returned.
Parameters
10
(number, required)lock-id
(string, required)Request returns 200 status when vehicle with lock_id is found
id | number Example: 10 |
lock_id | string Example: lock-id |
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Token _bCwVqbcKKUcs_4SGQCR |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "lock_id": null,
- "locked_until": null,
- "nameplate_id": 10,
- "owner_id": 88,
- "color_id": 17,
- "power": 217,
- "msrp_price": "41336.0",
- "base_price": null,
- "features_optional": null,
- "id": 10,
- "version": "Multiversity",
- "drivetrain": "Detective Comics",
- "short_description": "Eius amet ut natus molestiae aliquid dignissimos soluta omnis esse.",
- "production_year": 2018,
- "created_at": "2024-11-05T13:42:53.314Z",
- "updated_at": "2024-11-05T13:42:53.347Z",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Molestiae ex nihil earum amet natus eos excepturi labore consectetur veritatis sit veniam corrupti qui vel facilis est et maiores.",
- "state": "used",
- "status": "demo",
- "delivery_date": "2024-11-15",
- "transmission": "auto",
- "vin": null,
- "mileage": 632825,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "petrol"
], - "video_url": null,
- "features_standard": null,
- "model_year": null,
- "external_id": "f6a8ae",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "model_code": null,
- "footnote": "Quae expedita possimus laboriosam quis sint aspernatur consectetur enim error.",
- "config_url": null,
- "subscribe_price": null,
- "vehicle_batch_upload_id": null,
- "order_number": null,
- "metadata": null,
- "code5000": null,
- "price_metadata": { },
- "manual_update_attributes": [ ],
- "disclaimers": { },
- "price_breakdown": false,
- "total_price": null
}
}
Action is used to permanently reserve or mark vehicle as sold. It is verified by lock id provided by lock
action and optionally removes vehicle from all listings.
Request Path
PUT /integration_api/buy_online/vehicles/:id/acquire
Request Header
Authorization: "Bearer {dealer authorization token}"
Request Body Structure
param | example | type | required | description |
---|---|---|---|---|
id |
2 | integer | yes (in request path) | Id of the vehicle in StockLocator |
status |
reserved |
string | yes | requested status, possible values are reserved and sold |
lock_id |
12ab |
string | yes if vehicle has lock_id attr | used to check lock identity, if vehicle has matching lock_id, lock is overridden and status is changed |
remove_listings |
true | boolean | no | when set to true vehicle is removed from all listings |
Response
Request response is JSON. Vehicle details are returned under data
key.
When vehicle is not found, 404 status is returned.
When lock cannot be performed (when status param is invalid or lock ids don't match), 422 status is returned.
id | number Example: 15 |
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Token BTNAy6yLPXcnAk6VsPB5 |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "status": "reserved",
- "manual_update_attributes": [
- "status"
], - "lock_id": null,
- "locked_until": null,
- "nameplate_id": 15,
- "owner_id": 98,
- "color_id": 22,
- "power": 310,
- "msrp_price": "26564.0",
- "base_price": null,
- "features_optional": null,
- "id": 15,
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "production_year": 2015,
- "created_at": "2024-11-05T13:42:53.551Z",
- "updated_at": "2024-11-05T13:42:53.574Z",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "state": "used",
- "delivery_date": "2024-11-25",
- "transmission": "auto",
- "vin": null,
- "mileage": 604819,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "phev_rev"
], - "video_url": null,
- "features_standard": null,
- "model_year": null,
- "external_id": "4b44b1",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "model_code": null,
- "footnote": "Deserunt est aut iure et enim rem nobis natus consectetur.",
- "config_url": null,
- "subscribe_price": null,
- "vehicle_batch_upload_id": null,
- "order_number": null,
- "metadata": null,
- "code5000": null,
- "price_metadata": { },
- "disclaimers": { },
- "price_breakdown": false,
- "total_price": null
}
}
Authentication is implemented using the HTTP Bearer token.
Every request needs to include that token.
Example Authorization: Token abc123
- where abc123 is the token value.
Accept | any Example: application/json |
Content-Type | any Example: application/json |
Authorization | any Example: Token DtCQdx5uBEzv8PVs4xVV |
{- "vehicle": {
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "footnote": "Deserunt est aut iure et enim rem nobis natus consectetur.",
- "production_year": 2015,
- "state": "new",
- "status": "on_demand",
- "transmission": "auto",
- "engine_type": [
- "phev"
], - "delivery_date": "2024-11-13",
- "power": 230,
- "msrp_price": 43682,
- "interior_color": "Ebony",
- "mileage": 51259,
- "type": "ActiveVehicle",
- "metadata": {
- "test": 1
}, - "external_id": "0911cf",
- "features_optional": null,
- "features_standard": null,
- "nameplate_name": "Hooloovoo",
- "color_name": "Chocolate Concrete",
}
}
{- "id": 25,
- "nameplate_id": 31,
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "production_year": 2015,
- "created_at": "2024-11-05T13:42:54.298Z",
- "updated_at": "2024-11-05T13:42:54.306Z",
- "msrp_price": "37593.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "state": "new",
- "status": "stock",
- "delivery_date": "2024-11-23",
- "transmission": "manual",
- "vin": null,
- "mileage": 149257,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "petrol"
], - "power": 219,
- "video_url": null,
- "owner_id": 116,
- "color_id": 39,
- "features_standard": null,
- "features_optional": null,
- "model_year": null,
- "external_id": "efc3d1",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "model_code": null,
- "footnote": null,
- "config_url": null,
- "subscribe_price": null,
- "vehicle_batch_upload_id": null,
- "order_number": null,
- "metadata": {
- "test": 1
}, - "locked_until": null,
- "lock_id": null,
- "code5000": null,
- "price_metadata": { },
- "manual_update_attributes": [ ],
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null
}
This endpoint allows you to create or update a vehicle in the Stock Locator system. For vehicle creation, you need to provide a set of required attributes (described below) but there are some extra, non-obligatory attributes which may be worth filling in to keep the vehicle description as complete as possible. For vehicle update, the attributes marked as required are no longer required - if they are not provided, the Stock Locator application assumes that they don't have to be updated.
One attribute which is important in this API is external_id
- in general it is optional in the Stock Locator system, however in this API you should
consider it as required. This attribute allows you to set an ID (you should set your own value or use value from your stock management system). The
external_id
is later used to identify a vehicle you may want to update od remove from the system.
param | example | type | description |
---|---|---|---|
color_name |
'Eiger Grey' | string | See /colors endpoint for available colors. You can alternatively pass 'color_id' instead of the ID of the Color |
nameplate_name |
'F-Pace' | string | See /nameplates endpoint for available nameplates. You can alternatively pass nameplate_id instead with the ID of the Nameplate |
version |
'HSE' | string | Version/Trim Level name/description |
drivetrain |
'P300 AWD' | string | Drivetrain (Engine, gearbox etc) description |
state |
'new' | enum | Vehicle state. New, User or Approved |
status |
'stock' | enum | Stock status of the Vehicle |
transmission |
'auto' | enum | type of transmission, auto by default |
mileage |
123000 | number | vehicle mileage in ower company units |
engine_type |
['petrol', 'mhev'] | array | kind of engine, as a strings array |
production_year |
2020 | integer | Year when vehicle was manufacturedd |
msrp_price |
123000 | decimal(18,2) | Retailer price |
external_id |
'abd-3345' | string | External ID (of your choice) for the vehicle. Required to allow vehicle update/removal |
param | example | type | description |
---|---|---|---|
short_description |
'Lorem ipsum' | string | Short description paragraph |
sale_price |
120000 | decimal(18,2) | Sale Price |
monthly_price |
2500.01 | decimal(18,2) | Monthly price |
subscribe_price |
2700.00 | decimal(18,2) | Subscribe price |
long_description |
'Lorem ...' | string | Full description copy (potentialy HTML) |
delivery_date |
2020-02-02 | date | Date of delivery |
vin |
'XXX' | string | Vehicle Vin number |
engine_capacity |
1999 | number | engine capacity in ccm |
battery_capacity |
2020 | number | battery capacity in owner company units |
power |
200 | number | vehicle power in owner company units |
video_url |
'https://youtu.be/bJqimfimHjE' | string | youtube video url |
photos |
['http://site.com/1.png'] | array | photos url (first photo will become a cover photo) |
attachment |
'http://example.com/file.pdf' | string | attachment link |
features_standard |
[{"code": "S1", "label": "Label1"}, ...] | [Feature] | array of Feature-type objects, described below |
features_optional |
[{"code": "O1", "label": "Label2"}, ...] | [Feature] | array of Feature-type objects, described below |
interior_color |
'Snow white' | string | interior color |
price_hidden |
false | boolean | defines if the price should be hidden for visitors (default: false ) |
prices_type |
'incl_taxes' | string | defines if the price includes taxes |
metadata |
{ "some_key": "some_value" } | json | any metadata you'd like to set for the vehicle, not displayed in Stock Locator |
listing_ids |
[] | [integer] | array of liting IDs the vehicle should be published to. Empty array unpublishes the vehicle from all listings |
config_url |
'https://config.url/conf213' | string | link to configuration of the vehicle |
type |
DraftVehicle |
string | ActiveVehicle (default) or DraftVehicle |
Feature
type objectsEach "feature" is a JSON object with 3 possible attributes:
Allowed values for category
are:
state
valuesnew
used
approved
status
valuesstock
- Vehicles in stockdelivery
- Vehicle in deliveryreserved
- Reserved Vehicle (will be user later)in_production
- Vehicle in productionavailable_soon
- Vehicle will be available soonon_demand
- Vehicle is available on demandsold
- Vehicle has been soldtranssmision
valuesauto
manual
engine_type
valuespetrol
diesel
bev
- Electric Vehiclehev
- Hybridmhev
- Mild Hybridphev
- Plug-In Hybridprices_type
valuesincl_taxes
(if the price includes taxes)excl_taxes
(if the prices does not include taxes)null
/ empty - not specifiedAccept | any Example: application/vnd.api+json |
Authorization | any Example: Token LHg-FW3cdbwBum45Mn2R |
Content-Type | any Example: application/vnd.api+json |
{- "vehicle": {
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "footnote": "Deserunt est aut iure et enim rem nobis natus consectetur.",
- "production_year": 2015,
- "state": "used",
- "status": "in_production",
- "transmission": "manual",
- "engine_type": [
- "petrol"
], - "delivery_date": "2024-11-05",
- "power": 448,
- "msrp_price": 26677,
- "interior_color": "Ebony",
- "mileage": 154632,
- "type": "ActiveVehicle",
- "metadata": {
- "test": 1
}, - "external_id": "1503d5",
- "features_optional": null,
- "features_standard": null,
- "nameplate_name": "Hooloovoo",
- "color_name": "Chocolate Concrete",
}
}
{- "id": 26,
- "nameplate_id": 32,
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "production_year": 2015,
- "created_at": "2024-11-05T13:42:54.391Z",
- "updated_at": "2024-11-05T13:42:54.398Z",
- "msrp_price": "26677.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "state": "used",
- "status": "in_production",
- "delivery_date": "2024-11-05",
- "transmission": "manual",
- "vin": null,
- "mileage": 154632,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "petrol"
], - "power": 448,
- "video_url": null,
- "owner_id": 118,
- "color_id": 41,
- "features_standard": null,
- "features_optional": null,
- "model_year": null,
- "external_id": "1503d5",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "model_code": null,
- "footnote": null,
- "config_url": null,
- "subscribe_price": null,
- "vehicle_batch_upload_id": null,
- "order_number": null,
- "metadata": {
- "test": 1
}, - "locked_until": null,
- "lock_id": null,
- "code5000": null,
- "price_metadata": { },
- "manual_update_attributes": [ ],
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null
}
external_id | string Example: f017cbbb-32dd-484e-b127-6093e3917ed2 |
external_id required | string Example: external_id=external_system_id_string Uniq Id from integrated system alowing to find particular vehicle |
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Token utQge_WshkM5aCT6Xs_P |
Content-Type | any Example: application/vnd.api+json |
{- "id": 27,
- "nameplate_id": 33,
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "production_year": 2015,
- "created_at": "2024-11-05T13:42:54.452Z",
- "updated_at": "2024-11-05T13:42:54.452Z",
- "msrp_price": "45078.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "state": "approved",
- "status": "delivery",
- "delivery_date": "2024-11-17",
- "transmission": "manual",
- "vin": null,
- "mileage": 66338,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "phev"
], - "power": 199,
- "video_url": null,
- "owner_id": 121,
- "color_id": 42,
- "features_standard": null,
- "features_optional": null,
- "model_year": null,
- "external_id": "f017cbbb-32dd-484e-b127-6093e3917ed2",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "model_code": null,
- "footnote": "Deserunt est aut iure et enim rem nobis natus consectetur.",
- "config_url": null,
- "subscribe_price": null,
- "vehicle_batch_upload_id": null,
- "order_number": null,
- "metadata": null,
- "locked_until": null,
- "lock_id": null,
- "code5000": null,
- "price_metadata": { },
- "manual_update_attributes": [ ],
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null
}
Authentication is implemented using the HTTP Bearer token.
Every request needs to include that token.
Example Authorization: Token abc123
- where abc123 is the token value.
Accept | any Example: application/json |
Content-Type | any Example: application/json |
Authorization | any Example: Token EQZ-Qfqey9bvh1vSrg4b |
[ ]
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Token PweEMmhsqcSk-nFXgSpT |
Content-Type | any Example: application/vnd.api+json |
[- {
- "id": 29,
- "name": "Puce Steel",
- "canonical": "white",
- "owner_type": "Company",
- "owner_id": 107,
- "created_at": "2024-11-05T13:42:53.914Z",
- "updated_at": "2024-11-05T13:42:53.914Z"
}, - {
- "id": 30,
- "name": "Cerulean Granite",
- "canonical": "blue",
- "owner_type": "Company",
- "owner_id": 107,
- "created_at": "2024-11-05T13:42:53.916Z",
- "updated_at": "2024-11-05T13:42:53.916Z"
}, - {
- "id": 31,
- "name": "Periwinkle Rubber",
- "canonical": "orange",
- "owner_type": "Company",
- "owner_id": 107,
- "created_at": "2024-11-05T13:42:53.917Z",
- "updated_at": "2024-11-05T13:42:53.917Z"
}
]
Authentication is implemented using the HTTP Bearer token.
Every request needs to include that token.
Example Authorization: Token abc123
- where abc123 is the token value.
Accept | any Example: application/json |
Content-Type | any Example: application/json |
Authorization | any Example: Token zy2kmY9EJF3Jmcz4DRKR |
[ ]
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Token GyptZUVsXRAnF5gKuz7Y |
Content-Type | any Example: application/vnd.api+json |
[- {
- "id": 22,
- "name": "Mattress",
- "brand_id": 56,
- "created_at": "2024-11-05T13:42:53.972Z",
- "updated_at": "2024-11-05T13:42:53.972Z",
- "model_code_years": null,
- "model_group": null,
- "external_code_long": null
}, - {
- "id": 23,
- "name": "Hooloovoo",
- "brand_id": 57,
- "created_at": "2024-11-05T13:42:53.974Z",
- "updated_at": "2024-11-05T13:42:53.974Z",
- "model_code_years": null,
- "model_group": null,
- "external_code_long": null
}, - {
- "id": 24,
- "name": "Belcerebon",
- "brand_id": 58,
- "created_at": "2024-11-05T13:42:53.976Z",
- "updated_at": "2024-11-05T13:42:53.976Z",
- "model_code_years": null,
- "model_group": null,
- "external_code_long": null
}, - {
- "id": 25,
- "name": "Sarkopsi",
- "brand_id": 59,
- "created_at": "2024-11-05T13:42:53.978Z",
- "updated_at": "2024-11-05T13:42:53.978Z",
- "model_code_years": null,
- "model_group": null,
- "external_code_long": null
}, - {
- "id": 26,
- "name": "Jatravartid",
- "brand_id": 60,
- "created_at": "2024-11-05T13:42:53.981Z",
- "updated_at": "2024-11-05T13:42:53.981Z",
- "model_code_years": null,
- "model_group": null,
- "external_code_long": null
}
]
vehicle_external_id | string Example: abc123 |
Accept | any Example: application/json |
Authorization | any Example: Token invalid_token |
Content-Type | any Example: application/json |
{
}
[- {
- "id": 4,
- "sequence": 0,
- "vehicle_id": 23,
- "created_at": "2024-11-05T13:42:54.133Z",
- "updated_at": "2024-11-05T13:42:54.146Z"
}
]
id | number Example: 1 |
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Token _aRYJrqapi-7Cy9PzKLy |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": 1,
- "nameplate_id": 1,
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "production_year": 2015,
- "created_at": "2024-11-05T13:42:52.819Z",
- "updated_at": "2024-11-05T13:42:52.819Z",
- "msrp_price": "32563.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "state": "used",
- "status": "stock",
- "delivery_date": "2024-11-12",
- "transmission": "manual",
- "vin": null,
- "mileage": 913319,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "hev"
], - "power": 324,
- "video_url": null,
- "owner_id": 79,
- "color_id": 8,
- "features_standard": null,
- "features_optional": null,
- "model_year": null,
- "external_id": "8c3f29",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "model_code": null,
- "footnote": "Deserunt est aut iure et enim rem nobis natus consectetur.",
- "config_url": null,
- "subscribe_price": null,
- "vehicle_batch_upload_id": null,
- "order_number": null,
- "metadata": null,
- "locked_until": null,
- "lock_id": null,
- "code5000": null,
- "price_metadata": { },
- "manual_update_attributes": [ ],
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null
}
}
id | number Example: 20 |
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Token XJydLd_3J-qqBa5GSgZr |
Content-Type | any Example: application/vnd.api+json |
{- "status": "reserved",
- "nameplate_id": 20,
- "owner_id": 103,
- "color_id": 27,
- "power": 303,
- "msrp_price": "35761.0",
- "base_price": null,
- "features_optional": null,
- "id": 20,
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "production_year": 2015,
- "created_at": "2024-11-05T13:42:53.802Z",
- "updated_at": "2024-11-05T13:42:53.820Z",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "state": "approved",
- "delivery_date": "2024-11-09",
- "transmission": "manual",
- "vin": null,
- "mileage": 497592,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "hev"
], - "video_url": null,
- "features_standard": null,
- "model_year": null,
- "external_id": "11d877",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "model_code": null,
- "footnote": "Deserunt est aut iure et enim rem nobis natus consectetur.",
- "config_url": null,
- "subscribe_price": null,
- "vehicle_batch_upload_id": null,
- "order_number": null,
- "metadata": null,
- "locked_until": null,
- "lock_id": null,
- "code5000": null,
- "price_metadata": { },
- "manual_update_attributes": [ ],
- "disclaimers": { },
- "price_breakdown": false,
- "total_price": null
}
Action is used to lock vehicle after successful booking. It locks vehicle for 15 minutes in order to enable user completing the booking payment. In response it returns lock_id, which can be further used to perform acquire
action to permanently reserve or mark vehicle as sold.
Request Path
PUT /integration_api/buy_online/vehicles/:id/lock
Request Header
Authorization: "Bearer {dealer authorization token}"
Request Body Structure
param | example | type | required | description |
---|---|---|---|---|
id |
2 | integer | yes (in request path) | Id of the vehicle in StockLocator |
Response
Request response is JSON. Vehicle details are returned under data
, while booking details (lock_id
and locked_until
) are returned under meta
> lock_data
.
When vehicle is not found, 404 status is returned.
When lock cannot be performed (because vehicle has reserved
or sold
status or it has already been locked), 422 status is returned.
id | number Example: 3 |
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Token ZcDZdvBRgrpkEd2c2qdq |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "lock_id": "b19a",
- "locked_until": "2024-11-05T13:57:53.008Z",
- "nameplate_id": 3,
- "owner_id": 81,
- "id": 3,
- "color_id": 10,
- "power": 196,
- "msrp_price": "20717.0",
- "base_price": null,
- "features_optional": null,
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "production_year": 2015,
- "created_at": "2024-11-05T13:42:52.997Z",
- "updated_at": "2024-11-05T13:42:53.033Z",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "state": "used",
- "status": "stock",
- "delivery_date": "2024-11-20",
- "transmission": "manual",
- "vin": null,
- "mileage": 310329,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "petrol"
], - "video_url": null,
- "features_standard": null,
- "model_year": null,
- "external_id": "bb3f12",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "model_code": null,
- "footnote": "Deserunt est aut iure et enim rem nobis natus consectetur.",
- "config_url": null,
- "subscribe_price": null,
- "vehicle_batch_upload_id": null,
- "order_number": null,
- "metadata": null,
- "code5000": null,
- "price_metadata": { },
- "manual_update_attributes": [ ],
- "disclaimers": { },
- "price_breakdown": false,
- "total_price": null
}, - "meta": {
- "lock_data": {
- "locked_until": "2024-11-05T13:57:53.008Z",
- "lock_id": "b19a"
}
}
}
Action is used to unlock soft-locked vehicle. By providing vehicle id and its lock_id lock can be cancelled before expiration time.
Request Path
PUT /integration_api/buy_online/vehicles/:id/unlock/:lock_id
Request Header
Authorization: "Bearer {dealer authorization token}"
Request Body Structure
param | example | type | required | description |
---|---|---|---|---|
id |
2 | integer | yes (in request path) | Id of the vehicle in StockLocator |
lock_id |
44c2 |
string | yes (in request path) | Lock ID of the vehicle |
Response
Request response is JSON. Vehicle details are returned under data
.
When vehicle is not found or is not locked, 404 status is returned.
When unlock fails, 422 status is returned.
Parameters
10
(number, required)lock-id
(string, required)Request returns 200 status when vehicle with lock_id is found
id | number Example: 10 |
lock_id | string Example: lock-id |
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Token _bCwVqbcKKUcs_4SGQCR |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "lock_id": null,
- "locked_until": null,
- "nameplate_id": 10,
- "owner_id": 88,
- "color_id": 17,
- "power": 217,
- "msrp_price": "41336.0",
- "base_price": null,
- "features_optional": null,
- "id": 10,
- "version": "Multiversity",
- "drivetrain": "Detective Comics",
- "short_description": "Eius amet ut natus molestiae aliquid dignissimos soluta omnis esse.",
- "production_year": 2018,
- "created_at": "2024-11-05T13:42:53.314Z",
- "updated_at": "2024-11-05T13:42:53.347Z",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Molestiae ex nihil earum amet natus eos excepturi labore consectetur veritatis sit veniam corrupti qui vel facilis est et maiores.",
- "state": "used",
- "status": "demo",
- "delivery_date": "2024-11-15",
- "transmission": "auto",
- "vin": null,
- "mileage": 632825,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "petrol"
], - "video_url": null,
- "features_standard": null,
- "model_year": null,
- "external_id": "f6a8ae",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "model_code": null,
- "footnote": "Quae expedita possimus laboriosam quis sint aspernatur consectetur enim error.",
- "config_url": null,
- "subscribe_price": null,
- "vehicle_batch_upload_id": null,
- "order_number": null,
- "metadata": null,
- "code5000": null,
- "price_metadata": { },
- "manual_update_attributes": [ ],
- "disclaimers": { },
- "price_breakdown": false,
- "total_price": null
}
}
Action is used to permanently reserve or mark vehicle as sold. It is verified by lock id provided by lock
action and optionally removes vehicle from all listings.
Request Path
PUT /integration_api/buy_online/vehicles/:id/acquire
Request Header
Authorization: "Bearer {dealer authorization token}"
Request Body Structure
param | example | type | required | description |
---|---|---|---|---|
id |
2 | integer | yes (in request path) | Id of the vehicle in StockLocator |
status |
reserved |
string | yes | requested status, possible values are reserved and sold |
lock_id |
12ab |
string | yes if vehicle has lock_id attr | used to check lock identity, if vehicle has matching lock_id, lock is overridden and status is changed |
remove_listings |
true | boolean | no | when set to true vehicle is removed from all listings |
Response
Request response is JSON. Vehicle details are returned under data
key.
When vehicle is not found, 404 status is returned.
When lock cannot be performed (when status param is invalid or lock ids don't match), 422 status is returned.
id | number Example: 15 |
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Token BTNAy6yLPXcnAk6VsPB5 |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "status": "reserved",
- "manual_update_attributes": [
- "status"
], - "lock_id": null,
- "locked_until": null,
- "nameplate_id": 15,
- "owner_id": 98,
- "color_id": 22,
- "power": 310,
- "msrp_price": "26564.0",
- "base_price": null,
- "features_optional": null,
- "id": 15,
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "production_year": 2015,
- "created_at": "2024-11-05T13:42:53.551Z",
- "updated_at": "2024-11-05T13:42:53.574Z",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "state": "used",
- "delivery_date": "2024-11-25",
- "transmission": "auto",
- "vin": null,
- "mileage": 604819,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "phev_rev"
], - "video_url": null,
- "features_standard": null,
- "model_year": null,
- "external_id": "4b44b1",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "model_code": null,
- "footnote": "Deserunt est aut iure et enim rem nobis natus consectetur.",
- "config_url": null,
- "subscribe_price": null,
- "vehicle_batch_upload_id": null,
- "order_number": null,
- "metadata": null,
- "code5000": null,
- "price_metadata": { },
- "disclaimers": { },
- "price_breakdown": false,
- "total_price": null
}
}
Authentication is implemented using the HTTP Bearer token.
Every request needs to include that token.
Example Authorization: Token abc123
- where abc123 is the token value.
Accept | any Example: application/json |
Content-Type | any Example: application/json |
Authorization | any Example: Token DtCQdx5uBEzv8PVs4xVV |
{- "vehicle": {
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "footnote": "Deserunt est aut iure et enim rem nobis natus consectetur.",
- "production_year": 2015,
- "state": "new",
- "status": "on_demand",
- "transmission": "auto",
- "engine_type": [
- "phev"
], - "delivery_date": "2024-11-13",
- "power": 230,
- "msrp_price": 43682,
- "interior_color": "Ebony",
- "mileage": 51259,
- "type": "ActiveVehicle",
- "metadata": {
- "test": 1
}, - "external_id": "0911cf",
- "features_optional": null,
- "features_standard": null,
- "nameplate_name": "Hooloovoo",
- "color_name": "Chocolate Concrete",
}
}
{- "id": 25,
- "nameplate_id": 31,
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "production_year": 2015,
- "created_at": "2024-11-05T13:42:54.298Z",
- "updated_at": "2024-11-05T13:42:54.306Z",
- "msrp_price": "37593.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "state": "new",
- "status": "stock",
- "delivery_date": "2024-11-23",
- "transmission": "manual",
- "vin": null,
- "mileage": 149257,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "petrol"
], - "power": 219,
- "video_url": null,
- "owner_id": 116,
- "color_id": 39,
- "features_standard": null,
- "features_optional": null,
- "model_year": null,
- "external_id": "efc3d1",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "model_code": null,
- "footnote": null,
- "config_url": null,
- "subscribe_price": null,
- "vehicle_batch_upload_id": null,
- "order_number": null,
- "metadata": {
- "test": 1
}, - "locked_until": null,
- "lock_id": null,
- "code5000": null,
- "price_metadata": { },
- "manual_update_attributes": [ ],
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null
}
This endpoint allows you to create or update a vehicle in the Stock Locator system. For vehicle creation, you need to provide a set of required attributes (described below) but there are some extra, non-obligatory attributes which may be worth filling in to keep the vehicle description as complete as possible. For vehicle update, the attributes marked as required are no longer required - if they are not provided, the Stock Locator application assumes that they don't have to be updated.
One attribute which is important in this API is external_id
- in general it is optional in the Stock Locator system, however in this API you should
consider it as required. This attribute allows you to set an ID (you should set your own value or use value from your stock management system). The
external_id
is later used to identify a vehicle you may want to update od remove from the system.
param | example | type | description |
---|---|---|---|
color_name |
'Eiger Grey' | string | See /colors endpoint for available colors. You can alternatively pass 'color_id' instead of the ID of the Color |
nameplate_name |
'F-Pace' | string | See /nameplates endpoint for available nameplates. You can alternatively pass nameplate_id instead with the ID of the Nameplate |
version |
'HSE' | string | Version/Trim Level name/description |
drivetrain |
'P300 AWD' | string | Drivetrain (Engine, gearbox etc) description |
state |
'new' | enum | Vehicle state. New, User or Approved |
status |
'stock' | enum | Stock status of the Vehicle |
transmission |
'auto' | enum | type of transmission, auto by default |
mileage |
123000 | number | vehicle mileage in ower company units |
engine_type |
['petrol', 'mhev'] | array | kind of engine, as a strings array |
production_year |
2020 | integer | Year when vehicle was manufacturedd |
msrp_price |
123000 | decimal(18,2) | Retailer price |
external_id |
'abd-3345' | string | External ID (of your choice) for the vehicle. Required to allow vehicle update/removal |
param | example | type | description |
---|---|---|---|
short_description |
'Lorem ipsum' | string | Short description paragraph |
sale_price |
120000 | decimal(18,2) | Sale Price |
monthly_price |
2500.01 | decimal(18,2) | Monthly price |
subscribe_price |
2700.00 | decimal(18,2) | Subscribe price |
long_description |
'Lorem ...' | string | Full description copy (potentialy HTML) |
delivery_date |
2020-02-02 | date | Date of delivery |
vin |
'XXX' | string | Vehicle Vin number |
engine_capacity |
1999 | number | engine capacity in ccm |
battery_capacity |
2020 | number | battery capacity in owner company units |
power |
200 | number | vehicle power in owner company units |
video_url |
'https://youtu.be/bJqimfimHjE' | string | youtube video url |
photos |
['http://site.com/1.png'] | array | photos url (first photo will become a cover photo) |
attachment |
'http://example.com/file.pdf' | string | attachment link |
features_standard |
[{"code": "S1", "label": "Label1"}, ...] | [Feature] | array of Feature-type objects, described below |
features_optional |
[{"code": "O1", "label": "Label2"}, ...] | [Feature] | array of Feature-type objects, described below |
interior_color |
'Snow white' | string | interior color |
price_hidden |
false | boolean | defines if the price should be hidden for visitors (default: false ) |
prices_type |
'incl_taxes' | string | defines if the price includes taxes |
metadata |
{ "some_key": "some_value" } | json | any metadata you'd like to set for the vehicle, not displayed in Stock Locator |
listing_ids |
[] | [integer] | array of liting IDs the vehicle should be published to. Empty array unpublishes the vehicle from all listings |
config_url |
'https://config.url/conf213' | string | link to configuration of the vehicle |
type |
DraftVehicle |
string | ActiveVehicle (default) or DraftVehicle |
Feature
type objectsEach "feature" is a JSON object with 3 possible attributes:
Allowed values for category
are:
state
valuesnew
used
approved
status
valuesstock
- Vehicles in stockdelivery
- Vehicle in deliveryreserved
- Reserved Vehicle (will be user later)in_production
- Vehicle in productionavailable_soon
- Vehicle will be available soonon_demand
- Vehicle is available on demandsold
- Vehicle has been soldtranssmision
valuesauto
manual
engine_type
valuespetrol
diesel
bev
- Electric Vehiclehev
- Hybridmhev
- Mild Hybridphev
- Plug-In Hybridprices_type
valuesincl_taxes
(if the price includes taxes)excl_taxes
(if the prices does not include taxes)null
/ empty - not specifiedAccept | any Example: application/vnd.api+json |
Authorization | any Example: Token LHg-FW3cdbwBum45Mn2R |
Content-Type | any Example: application/vnd.api+json |
{- "vehicle": {
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "footnote": "Deserunt est aut iure et enim rem nobis natus consectetur.",
- "production_year": 2015,
- "state": "used",
- "status": "in_production",
- "transmission": "manual",
- "engine_type": [
- "petrol"
], - "delivery_date": "2024-11-05",
- "power": 448,
- "msrp_price": 26677,
- "interior_color": "Ebony",
- "mileage": 154632,
- "type": "ActiveVehicle",
- "metadata": {
- "test": 1
}, - "external_id": "1503d5",
- "features_optional": null,
- "features_standard": null,
- "nameplate_name": "Hooloovoo",
- "color_name": "Chocolate Concrete",
}
}
{- "id": 26,
- "nameplate_id": 32,
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "production_year": 2015,
- "created_at": "2024-11-05T13:42:54.391Z",
- "updated_at": "2024-11-05T13:42:54.398Z",
- "msrp_price": "26677.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "state": "used",
- "status": "in_production",
- "delivery_date": "2024-11-05",
- "transmission": "manual",
- "vin": null,
- "mileage": 154632,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "petrol"
], - "power": 448,
- "video_url": null,
- "owner_id": 118,
- "color_id": 41,
- "features_standard": null,
- "features_optional": null,
- "model_year": null,
- "external_id": "1503d5",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "model_code": null,
- "footnote": null,
- "config_url": null,
- "subscribe_price": null,
- "vehicle_batch_upload_id": null,
- "order_number": null,
- "metadata": {
- "test": 1
}, - "locked_until": null,
- "lock_id": null,
- "code5000": null,
- "price_metadata": { },
- "manual_update_attributes": [ ],
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null
}
external_id | string Example: f017cbbb-32dd-484e-b127-6093e3917ed2 |
external_id required | string Example: external_id=external_system_id_string Uniq Id from integrated system alowing to find particular vehicle |
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Token utQge_WshkM5aCT6Xs_P |
Content-Type | any Example: application/vnd.api+json |
{- "id": 27,
- "nameplate_id": 33,
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "production_year": 2015,
- "created_at": "2024-11-05T13:42:54.452Z",
- "updated_at": "2024-11-05T13:42:54.452Z",
- "msrp_price": "45078.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "state": "approved",
- "status": "delivery",
- "delivery_date": "2024-11-17",
- "transmission": "manual",
- "vin": null,
- "mileage": 66338,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "phev"
], - "power": 199,
- "video_url": null,
- "owner_id": 121,
- "color_id": 42,
- "features_standard": null,
- "features_optional": null,
- "model_year": null,
- "external_id": "f017cbbb-32dd-484e-b127-6093e3917ed2",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "model_code": null,
- "footnote": "Deserunt est aut iure et enim rem nobis natus consectetur.",
- "config_url": null,
- "subscribe_price": null,
- "vehicle_batch_upload_id": null,
- "order_number": null,
- "metadata": null,
- "locked_until": null,
- "lock_id": null,
- "code5000": null,
- "price_metadata": { },
- "manual_update_attributes": [ ],
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null
}
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Token token |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "204",
- "type": "company",
- "attributes": {
- "name": "Ritchie-Kunde",
- "uuid": "62365e5d-f4da-450a-8673-f835bce41595"
}
}, - {
- "id": "205",
- "type": "company",
- "attributes": {
- "name": "Barton Inc",
- "uuid": "068c6394-786f-4e7e-b3ed-42fe2591500a"
}
}, - {
- "id": "206",
- "type": "company",
- "attributes": {
- "name": "Marquardt-Kozey",
- "uuid": "3b7bfff1-66b7-4cb1-b5ec-421138250653"
}
}
]
}
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Token token |
Content-Type | any Example: application/vnd.api+json |
{- "data": "digraph G {\n \"207\" [label=\"Ritchie-Kunde\"]\n}\n"
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: bb2d804b-5a34-4093-8169-0d1f36432ad0 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [ ]
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 1bf623bf-7f24-4361-ac2e-8ff1edc73f49 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "attributes": {
- "name": "Ligier",
- "brand_code": "jlr"
}
}
}
{- "data": {
- "id": "4",
- "type": "brand",
- "attributes": {
- "name": "Ligier"
}, - "relationships": {
- "nameplates": {
- "data": [ ]
}, - "colors": {
- "data": [ ]
}
}, - "links": {
- "self": "/brands/4",
- "all": "/brands"
}
}
}
id | number Example: 3 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 27a8cb7c-7f32-421a-9bca-bdc8671f5818 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "3",
- "type": "brand",
- "attributes": {
- "name": "Ligier"
}, - "relationships": {
- "nameplates": {
- "data": [ ]
}, - "colors": {
- "data": [ ]
}
}, - "links": {
- "self": "/brands/3",
- "all": "/brands"
}
}
}
id | number Example: 5 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 25c6d4ef-5b49-4f8a-b0c0-d0487a31108d |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "attributes": {
- "name": "Barton Inc",
- "brand_code": "jlr"
}
}
}
{- "data": {
- "id": "5",
- "type": "brand",
- "attributes": {
- "name": "Barton Inc"
}, - "relationships": {
- "nameplates": {
- "data": [ ]
}, - "colors": {
- "data": [ ]
}
}, - "links": {
- "self": "/brands/5",
- "all": "/brands"
}
}
}
attr | type | required | example | notes |
---|---|---|---|---|
label |
string | yes | "Main set" | ButtonSet name |
buttons |
array | no | [{"label": "Click here", ...}] | Nested buttons attributes (see table below) |
button_set_type |
string | yes | "extended" | Can be either "standard" or "extended" |
reservation_fee |
decimal(18,2) | if extended(*) | 2000.00 | Reservation fee |
financing_options |
array | if extended(*) | ["cash"] | Multiselect - array can contain some or all of following values: ['cash', 'lease', 'rent'] |
(*) - reservation_fee
and financing_options
attributes are required only, if button_set_type
value is set to extended
attr | type | required | example | notes |
---|---|---|---|---|
label | string | yes | "Click here" | Button label displayed to user |
target | string | yes | "john@doe.com" | Target URL, phone, code (embed) etc. |
button_type | enum | yes | "secondary" | A type of a button (primary/secondary) |
target_action | enum | yes | "self" | Defines what happens on button click |
target_type | enum | yes | "email" | Defines a type of a target action |
Button type can be either primary
or secondary
. Please note that only 1 primary button is allowed for a company. Secondary buttons are optional.
Defines what happens when the button is clicked. Accepted values:
self
- executes defined action in current browser's tabnew_tab
- executes defined action in a new tabmodal
- executes defined action in a modalattr | type | reqiured | example | notes |
---|---|---|---|---|
name | string | yes | "Firenze Red" | Display name of the color showed to end user |
canonical | enum | yes | "red" | Canonical color mapping, used for filtering |
Brand Color name can not be very descriptive, also local retailers sometimes want to add their own colors named in local language like "Niebieski".
On the other hand customers looking for a vehicle do not want to find "Fuji White" vehicles. They are interested in selecting actuall color like brown.
Thats why all Colors in the system require to be mapped to predetermined color pallet through the canonical
attribute.
This attribute is strongly validated againts list determined by system and only available options are:
This endpoint will return two combined sets of Colors
Brand
objectsX-Company-UUID
headerAccept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: cd44a8d4-1bd4-4e89-a784-f295c8f441b4 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "2",
- "type": "color",
- "attributes": {
- "name": "Azure Wool",
- "canonical": "gray"
}, - "relationships": {
- "owner": {
- "data": {
- "id": "33",
- "type": "company"
}
}
}, - "links": {
- "self": "/brands/2",
- "all": "/brands"
}
}
]
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 32985d8f-01b5-44b4-a5f5-dc61ae41d8a9 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "attributes": {
- "name": "Puce Steel",
- "canonical": "yellow"
}
}
}
{- "data": {
- "id": "4",
- "type": "color",
- "attributes": {
- "name": "Puce Steel",
- "canonical": "yellow"
}, - "relationships": {
- "owner": {
- "data": {
- "id": "35",
- "type": "company"
}
}
}, - "links": {
- "self": "/brands/4",
- "all": "/brands"
}
}
}
This endpoint will return color only if it is in one of the disinct sets
Brand
objectsX-Company-UUID
headerNote: Colors owned by other Companies will trigger 404
response.
id | number Example: 3 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 86bb3c47-c652-402b-a88a-ee9dea5d4e18 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "3",
- "type": "color",
- "attributes": {
- "name": "Puce Steel",
- "canonical": "red"
}, - "relationships": {
- "owner": {
- "data": {
- "id": "34",
- "type": "company"
}
}
}, - "links": {
- "self": "/brands/3",
- "all": "/brands"
}
}
}
Owner is defined based on required X-Company-UUID
header.
API does not allow for modification of Colors other then owned by a Company specified by X-Company-UUID
header.
There is no option to modify Brand
owned colors through this API.
id | number Example: 5 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: fe3e1f78-8243-4c92-aca5-931d4e2e5725 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "attributes": {
- "name": "King and Sons",
- "canonical": "bronze"
}
}
}
{- "data": {
- "id": "5",
- "type": "color",
- "attributes": {
- "name": "King and Sons",
- "canonical": "bronze"
}, - "relationships": {
- "owner": {
- "data": {
- "id": "37",
- "type": "company"
}
}
}, - "links": {
- "self": "/brands/5",
- "all": "/brands"
}
}
}
Owner is defined based on required X-Company-UUID
header.
API does not allow to delete Colors not owned by a Company specified
by X-Company-UUID
header.
This also means Brand
owner colors cannot be deleted through the API.
id | number Example: 7 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: fcb121b4-e6cd-433d-83a4-c1b52bead726 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
Represents Company data.
All API actions are to be executed in the context of selected Company.
uuid
parameterCompany object is by default equiped with randomly generate uuid
attribute.
It's purpose is to be Company unique indentifier used in X-Company-UUID
header
to filter all action and resources in the API requests.
NOTE: uuid
value cannot be modified directly through the api calls.
All API Actions performed on Companies are scoped to current company instance.
The current company is found based on the X-Company-UUID
header value.
Due to this the some Company controller actions and URLs were changed.
Verb | Old URL | New URL | Behaviour (after changes) |
---|---|---|---|
GET | /companies | (same) | It list only current company and its Subcompanies |
POST | /companies | (same) | Creates compnany owned by current company |
GET | /company | /companies/{id} | Fetches Current Company |
PATCH | /company | /companies/{id} | Updates Current Company |
For easier transition both new and old URLs are working simultanously.
Company Deleting endpoit was turned off
All actions performed on Company
objects need to happen in context of current Company
object.
Current Company is determined based on X-Company-UUID
header value. This value should contain uuid
attribute of
Company
obejct.
If header is not present API will raise 400 - Bad Request
response with information about missing header
If header is present but no Company with provided uuid
values is present in the database the 404 - Not Found
response is given.
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
X-Company-UUID | any Example: bad-uuid-value |
{- "errors": [
- {
- "status": 400,
- "source": null,
- "title": "Bad Request",
- "detail": "X-Company-UUID header is missing"
}
]
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 95b72505-1dd0-42b1-b40b-80987c988c11 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "42",
- "type": "company",
- "attributes": {
- "uuid": "95b72505-1dd0-42b1-b40b-80987c988c11",
- "name": "Ritchie-Kunde",
- "city": "Hermistonshire",
- "address": "99667 Major Corners, Antoniomouth, LA 39348-8794",
- "phone": "+994 987.432.9120",
- "locale": "en_IE",
- "currency": "GBP",
- "zipcode": null,
- "timezone": "UTC",
- "mileage_unit": "km",
- "power_unit": "bhp",
- "engine_capacity_unit": "cc",
- "opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "contact_details": "31019 Velvet Rest\nLake Irafurt",
- "skip_company_name_in_location": false,
- "config_locale": null,
- "account_type": "importer",
- "state": null,
- "dealer_codes": [ ],
- "operating_states": [
- "NSW",
- "VIC"
], - "feature_flag_policies": [ ]
}, - "relationships": {
- "parent": {
- "data": null
}, - "children": {
- "data": [ ]
}, - "descendants": {
- "data": [ ]
}, - "ancestors": {
- "data": [ ]
}, - "colors": {
- "data": [ ]
}
}, - "links": {
- "all": "/companies"
}, - "meta": {
- "power_units": [
- "bhp",
- "kw"
], - "mileage_units": [
- "km",
- "mi"
], - "engine_capacity_units": [
- "cc",
- "l"
]
}
}
]
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 9ff1f487-895e-40f9-8cf1-2688c99f1b56 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "attributes": {
- "name": "Barton Inc",
- "city": "Randellshire",
- "address": "Apt. 836 403 Marks Points, New Deonton, SD 94716-7763",
- "phone": "+685 1-379-505-1252 x131",
- "locale": "en_IE",
- "currency": "JMD",
- "contact_details": "87669 Kathrin Pass\nLarkinborough",
- "opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "skip_company_name_in_location": false,
- "account_type": "retailer",
- "operating_states": [
- "NSW",
- "VIC"
]
}
}
}
{- "data": {
- "id": "61",
- "type": "company",
- "attributes": {
- "uuid": "f5860b84-3a03-4923-8c75-e7604c1ba8bb",
- "name": "Barton Inc",
- "city": "Randellshire",
- "address": "Apt. 836 403 Marks Points, New Deonton, SD 94716-7763",
- "phone": "+685 1-379-505-1252 x131",
- "locale": "en_IE",
- "currency": "JMD",
- "zipcode": null,
- "timezone": "UTC",
- "mileage_unit": "km",
- "power_unit": "bhp",
- "engine_capacity_unit": "cc",
- "opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "contact_details": "87669 Kathrin Pass\nLarkinborough",
- "skip_company_name_in_location": false,
- "config_locale": null,
- "account_type": null,
- "state": null,
- "dealer_codes": [ ],
- "operating_states": [
- "NSW",
- "VIC"
], - "feature_flag_policies": [ ]
}, - "relationships": {
- "parent": {
- "data": {
- "id": "60",
- "type": "company"
}
}, - "children": {
- "data": [ ]
}, - "descendants": {
- "data": [ ]
}, - "ancestors": {
- "data": [
- {
- "id": "60",
- "type": "company"
}
]
}, - "colors": {
- "data": [ ]
}
}, - "links": {
- "all": "/companies"
}, - "meta": {
- "power_units": [
- "bhp",
- "kw"
], - "mileage_units": [
- "km",
- "mi"
], - "engine_capacity_units": [
- "cc",
- "l"
]
}
}
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: e81edad1-a0e1-43fc-bcaa-04b53c70cbb3 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [ ]
}
This endpoints provide option to fetch all Timezones needed to update Compane Time Zone setting.
It is possible to filter this list to only specific country based on country ISO code but list of all available 151 zones is also available.
TimeZone name
and id
attributes are the same value and it should be used as value for time_zone company attribute when updating data.
country_code | string Example: IN |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 648d83dc-6c01-4ab3-a15c-397e94689465 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "Chennai",
- "type": "time_zone",
- "attributes": {
- "name": "Chennai",
- "label": "Chennai [GMT+05:30]",
- "formatted_offset": "+05:30",
- "tz_identifier": "Asia/Kolkata"
}
}, - {
- "id": "Kolkata",
- "type": "time_zone",
- "attributes": {
- "name": "Kolkata",
- "label": "Kolkata [GMT+05:30]",
- "formatted_offset": "+05:30",
- "tz_identifier": "Asia/Kolkata"
}
}, - {
- "id": "Mumbai",
- "type": "time_zone",
- "attributes": {
- "name": "Mumbai",
- "label": "Mumbai [GMT+05:30]",
- "formatted_offset": "+05:30",
- "tz_identifier": "Asia/Kolkata"
}
}, - {
- "id": "New Delhi",
- "type": "time_zone",
- "attributes": {
- "name": "New Delhi",
- "label": "New Delhi [GMT+05:30]",
- "formatted_offset": "+05:30",
- "tz_identifier": "Asia/Kolkata"
}
}
]
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 9427574d-71d1-4fd7-904f-1b809c6f4341 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "58",
- "type": "company",
- "attributes": {
- "uuid": "9427574d-71d1-4fd7-904f-1b809c6f4341",
- "name": "Ritchie-Kunde",
- "city": "Hermistonshire",
- "address": "99667 Major Corners, Antoniomouth, LA 39348-8794",
- "phone": "+994 987.432.9120",
- "locale": "en_IE",
- "currency": "GBP",
- "zipcode": null,
- "timezone": "UTC",
- "mileage_unit": "km",
- "power_unit": "bhp",
- "engine_capacity_unit": "cc",
- "opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "contact_details": "31019 Velvet Rest\nLake Irafurt",
- "skip_company_name_in_location": false,
- "config_locale": null,
- "account_type": "retailer",
- "state": null,
- "dealer_codes": [ ],
- "operating_states": [
- "NSW",
- "VIC"
], - "feature_flag_policies": [ ]
}, - "relationships": {
- "parent": {
- "data": null
}, - "children": {
- "data": [ ]
}, - "descendants": {
- "data": [ ]
}, - "ancestors": {
- "data": [ ]
}, - "colors": {
- "data": [ ]
}
}, - "links": {
- "all": "/companies"
}, - "meta": {
- "power_units": [
- "bhp",
- "kw"
], - "mileage_units": [
- "km",
- "mi"
], - "engine_capacity_units": [
- "cc",
- "l"
]
}
}
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: f7f93738-b297-4fce-88a4-3fa1c2baddf3 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "attributes": {
- "name": "Barton Inc",
- "city": "Dwayneborough",
- "address": "4039 Saundra Underpass, Port Bryanna, GA 71677",
- "phone": "+1-268 716-279-5051 x252",
- "locale": "pl_PL",
- "currency": "VND",
- "contact_details": "411 Armstrong Brook\nArmstrongfurt",
- "opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "skip_company_name_in_location": false,
- "account_type": "retailer",
- "operating_states": [
- "NSW",
- "VIC"
]
}
}
}
{- "data": {
- "id": "63",
- "type": "company",
- "attributes": {
- "uuid": "f7f93738-b297-4fce-88a4-3fa1c2baddf3",
- "name": "Barton Inc",
- "city": "Dwayneborough",
- "address": "4039 Saundra Underpass, Port Bryanna, GA 71677",
- "phone": "+1-268 716-279-5051 x252",
- "locale": "pl_PL",
- "currency": "VND",
- "zipcode": null,
- "timezone": "UTC",
- "mileage_unit": "km",
- "power_unit": "bhp",
- "engine_capacity_unit": "cc",
- "opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "contact_details": "411 Armstrong Brook\nArmstrongfurt",
- "skip_company_name_in_location": false,
- "config_locale": null,
- "account_type": "importer",
- "state": null,
- "dealer_codes": [ ],
- "operating_states": [
- "NSW",
- "VIC"
], - "feature_flag_policies": [ ]
}, - "relationships": {
- "parent": {
- "data": null
}, - "children": {
- "data": [ ]
}, - "descendants": {
- "data": [ ]
}, - "ancestors": {
- "data": [ ]
}, - "colors": {
- "data": [ ]
}
}, - "links": {
- "all": "/companies"
}, - "meta": {
- "power_units": [
- "bhp",
- "kw"
], - "mileage_units": [
- "km",
- "mi"
], - "engine_capacity_units": [
- "cc",
- "l"
]
}
}
}
GET /feature_flag_policies/flags
This endpoint is used to get flags for owner defined in params.
param | example | type | required | description |
---|---|---|---|---|
company_uuid |
1 | integer | yes | uuid of the company |
brand_ids |
1 | integer | no | ids of brands (spearated by comma) |
To fetch flags only for company, we define only company_uuid
paramater. If we want to get additional brand flags we have to define specific brand_ids
.
status 200
Returns array with flags for defined owners. If there is no flags array will be empty.
status 404
Company defined in params does not exist.
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: f7a4b8a9-65ca-44d5-8149-f4359045374a |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "company_uuid": "f7a4b8a9-65ca-44d5-8149-f4359045374a"
}
{- "data": [
- "avl_field"
]
}
GET /job_results/:job_uid
This endpoint is used to fetch the result of completed asynchronous job.
param | example | type | required | description |
---|---|---|---|---|
job_uid |
1 | string | yes (in url) | uid of the job |
status 200
Job result was found and it has follwing attributes:
job_uid
- uid of the job
data
- data of the job result
status 404
Job result was not found
job_uid | string Example: bHxaJdGG9y5ZYRjt |
Accept | any Example: application/json |
X-Company-UUID | any Example: 78257231-eb4e-4622-9966-c8673a9a58ef |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/json |
{- "job_uid": "bHxaJdGG9y5ZYRjt",
- "data": {
- "data": "details"
}
}
POST /osvd/vehicle_import
This endpoint is used to trigger vehicle mapper job to fetch data for the vehicle from OSVD API
param | example | type | required | description |
---|---|---|---|---|
vehicle_id |
SALVT1BG1EH795896 | string | yes (in url) | VIN or order number of the vehicle |
job_uid
- uid of the job
vehicle_id
- id of the vehicle
vehicle_id_type
- id type, can be 'vin' in case alphabetic characters are dected in vehicle in id or 'order_number' otherwise
Accept | any Example: application/json |
X-Company-UUID | any Example: 67021c7c-045e-438f-b456-105fe70b5503 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/json |
{- "data": {
- "attributes": {
- "vehicle_id": "SALVT1BG1EH795896"
}
}
}
{- "vehicle_id": "SALVT1BG1EH795896",
- "vehicle_id_type": "vin",
- "job_uid": null
}
attr | type | reqiured | example | notes |
---|---|---|---|---|
title | string | yes | "Winter Sale" | Display name of the list to be displayed in system |
uuid
parameterListing object is by default equiped with randomly generate uuid
attribute.
It's purpose is to be Listing unique indentifier used when fetchin vehicles on external websites
through the API.
NOTE: uuid
value cannot be modified directly through the api calls.
All actions performed on Listing
objects need to happen in context of Company
object.
The Company is determined based on X-Company-UUID
header value. This value should contain uuid
attribute of
Company
obejct.
If header is not present API will raise 400 - Bad Request
response with information about missing header
If header is present but no Company with provided uuid
values is present in the database the 404 - Not Found
response is given.
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
X-Company-UUID | any Example: bad-uuid-value |
{- "errors": [
- {
- "status": 400,
- "source": null,
- "title": "Bad Request",
- "detail": "X-Company-UUID header is missing"
}
]
}
This endpoint will return Listings owned by a Company specified by X-Company-UUID
header
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: ed712440-f20e-4e3c-9249-bb0de304b192 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "3",
- "type": "listing",
- "attributes": {
- "title": "Arepas 3",
- "uuid": "a04cecb5-7e38-4650-83c9-caa1d90c8343",
- "sort_order": "asc",
- "sort_attribute": "status_sort",
- "disclaimers": { },
- "allowed_vehicle_states": [
- "new",
- "used",
- "approved"
], - "owner_name": "Marquardt-Kozey",
- "owner_city": "West Donitachester"
}, - "relationships": {
- "owner": {
- "data": {
- "id": "141",
- "type": "company"
}
}, - "button_set": {
- "data": {
- "id": "36",
- "type": "button_set"
}
}, - "vehicles": {
- "data": [ ]
}
}, - "links": {
- "self": "/listings/3",
- "all": "/listings"
}, - "meta": {
- "sort_order": [
- "asc",
- "desc"
], - "sort_attribute": [
- "production_year",
- "created_at",
- "mileage",
- "display_price",
- "status_sort"
]
}
}, - {
- "id": "4",
- "type": "listing",
- "attributes": {
- "title": "Teriyaki Chicken Donburi 4",
- "uuid": "0ebeb7a5-550a-4074-af4e-aba233ddc51d",
- "sort_order": "asc",
- "sort_attribute": "display_price",
- "disclaimers": { },
- "allowed_vehicle_states": [
- "new",
- "used",
- "approved"
], - "owner_name": "Marquardt-Kozey",
- "owner_city": "West Donitachester"
}, - "relationships": {
- "owner": {
- "data": {
- "id": "141",
- "type": "company"
}
}, - "button_set": {
- "data": {
- "id": "37",
- "type": "button_set"
}
}, - "vehicles": {
- "data": [ ]
}
}, - "links": {
- "self": "/listings/4",
- "all": "/listings"
}, - "meta": {
- "sort_order": [
- "asc",
- "desc"
], - "sort_attribute": [
- "production_year",
- "created_at",
- "mileage",
- "display_price",
- "status_sort"
]
}
}
]
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: dc14f034-ae66-4065-80ae-290d45241f81 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "attributes": {
- "title": "Arepas 8",
- "sort_order": "asc",
- "sort_attribute": "created_at",
- "allowed_vehicle_states": [
- "new",
- "used",
- "approved"
]
}, - "relationships": {
- "button_set": {
- "data": {
- "type": "button_set",
- "id": 55
}
}
}
}
}
{- "data": {
- "id": "8",
- "type": "listing",
- "attributes": {
- "title": "Arepas 8",
- "uuid": "035f5d1c-d981-48e3-a4b7-2d0e8f70f4cb",
- "sort_order": "asc",
- "sort_attribute": "created_at",
- "disclaimers": { },
- "allowed_vehicle_states": [
- "new",
- "used",
- "approved"
], - "owner_name": "Marquardt-Kozey",
- "owner_city": "West Donitachester"
}, - "relationships": {
- "owner": {
- "data": {
- "id": "168",
- "type": "company"
}
}, - "button_set": {
- "data": {
- "id": "55",
- "type": "button_set"
}
}, - "vehicles": {
- "data": [ ]
}
}, - "links": {
- "self": "/listings/8",
- "all": "/listings"
}, - "meta": {
- "sort_order": [
- "asc",
- "desc"
], - "sort_attribute": [
- "production_year",
- "created_at",
- "mileage",
- "display_price",
- "status_sort"
]
}
}, - "included": [
- {
- "id": "55",
- "type": "button_set",
- "attributes": {
- "button_set_type": "standard",
- "created_at": "2024-11-05T13:42:55.183Z",
- "defined_by": null,
- "financing_options": null,
- "name": "non 53",
- "reservation_fee": null
}, - "relationships": {
- "button_set_setups": {
- "data": [
- {
- "id": "39",
- "type": "button_set_setup"
}, - {
- "id": "40",
- "type": "button_set_setup"
}
]
}, - "listings": {
- "data": [
- {
- "id": "8",
- "type": "listing"
}
]
}
}
}
]
}
This endpoint will return Listings owned by a Company specified by X-Company-UUID
header.
Note: Colors owned by other Companies will trigger 404
response.
id | number Example: 7 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: db7f7154-4191-4700-bcfd-9f73b4777f35 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "7",
- "type": "listing",
- "attributes": {
- "title": "Arepas 7",
- "uuid": "66c7c221-76cf-4ffa-bef2-503c5a2cdbca",
- "sort_order": "desc",
- "sort_attribute": "created_at",
- "disclaimers": { },
- "allowed_vehicle_states": [
- "new",
- "used",
- "approved"
], - "owner_name": "Marquardt-Kozey",
- "owner_city": "West Donitachester"
}, - "relationships": {
- "owner": {
- "data": {
- "id": "160",
- "type": "company"
}
}, - "button_set": {
- "data": {
- "id": "50",
- "type": "button_set"
}
}, - "vehicles": {
- "data": [ ]
}
}, - "links": {
- "self": "/listings/7",
- "all": "/listings"
}, - "meta": {
- "sort_order": [
- "asc",
- "desc"
], - "sort_attribute": [
- "production_year",
- "created_at",
- "mileage",
- "display_price",
- "status_sort"
]
}
}, - "included": [
- {
- "id": "50",
- "type": "button_set",
- "attributes": {
- "button_set_type": "standard",
- "created_at": "2024-11-05T13:42:55.083Z",
- "defined_by": null,
- "financing_options": null,
- "name": "reiciendis 48",
- "reservation_fee": null
}, - "relationships": {
- "button_set_setups": {
- "data": [ ]
}, - "listings": {
- "data": [
- {
- "id": "7",
- "type": "listing"
}
]
}
}
}
]
}
Owner is defined based on required X-Company-UUID
header.
id | number Example: 9 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 9a0f195a-1fcb-4f24-8e14-679195a471ee |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "attributes": {
- "title": "Arepas 11",
- "sort_order": "desc",
- "sort_attribute": "created_at",
- "allowed_vehicle_states": [
- "new",
- "used",
- "approved"
]
}, - "relationships": {
- "button_set": {
- "data": {
- "type": "button_set",
- "id": 65
}
}
}
}
}
{- "data": {
- "id": "9",
- "type": "listing",
- "attributes": {
- "title": "Arepas 11",
- "uuid": "692c9541-790b-460e-9d27-1706e06b6959",
- "sort_order": "desc",
- "sort_attribute": "created_at",
- "disclaimers": { },
- "allowed_vehicle_states": [
- "new",
- "used",
- "approved"
], - "owner_name": "Marquardt-Kozey",
- "owner_city": "West Donitachester"
}, - "relationships": {
- "owner": {
- "data": {
- "id": "182",
- "type": "company"
}
}, - "button_set": {
- "data": {
- "id": "65",
- "type": "button_set"
}
}, - "vehicles": {
- "data": [ ]
}
}, - "links": {
- "self": "/listings/9",
- "all": "/listings"
}, - "meta": {
- "sort_order": [
- "asc",
- "desc"
], - "sort_attribute": [
- "production_year",
- "created_at",
- "mileage",
- "display_price",
- "status_sort"
]
}
}, - "included": [
- {
- "id": "65",
- "type": "button_set",
- "attributes": {
- "button_set_type": "standard",
- "created_at": "2024-11-05T13:42:55.393Z",
- "defined_by": null,
- "financing_options": null,
- "name": "non 63",
- "reservation_fee": null
}, - "relationships": {
- "button_set_setups": {
- "data": [
- {
- "id": "47",
- "type": "button_set_setup"
}, - {
- "id": "48",
- "type": "button_set_setup"
}
]
}, - "listings": {
- "data": [
- {
- "id": "9",
- "type": "listing"
}
]
}
}
}
]
}
Owner is defined based on required X-Company-UUID
header.
API does not allow to delete Listings not owned by a Company specified
by X-Company-UUID
header.
id | number Example: 11 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: a9be43a3-840f-44d5-80c2-c80720c48d86 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
Publishing controller is very simple in usage. All parameters are passed in the URLs as showed below.
PUT
request adds vehicle to listingDELETE
request removes vehicle from listingAdding or removing vehicle twice will not raise any error. The Vehicle will simply not be added/removed again and response will reflect actual state.
NOTE: Both Vehile and Listing need to be owned by the same company that is passed through X-Company-UUID
header value
id | number Example: 55 |
vehicle_id | number Example: 230 |
id required | number Example: id=2 Listing ID |
vehicle_id required | number Example: vehicle_id=2 Vehicle ID |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 5c08a0ad-0e5a-4671-9735-03398416a85b |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "55",
- "type": "listing",
- "attributes": {
- "title": "Linguine with Clams 57",
- "uuid": "e4540d6a-0ef4-4151-a063-dbfc994556ec",
- "sort_order": "desc",
- "sort_attribute": "display_price",
- "disclaimers": { },
- "allowed_vehicle_states": [
- "new",
- "used",
- "approved"
], - "owner_name": "Marquardt-Kozey",
- "owner_city": "West Donitachester"
}, - "relationships": {
- "owner": {
- "data": {
- "id": "575",
- "type": "company"
}
}, - "button_set": {
- "data": {
- "id": "206",
- "type": "button_set"
}
}, - "vehicles": {
- "data": [
- {
- "id": "230",
- "type": "vehicle"
}
]
}
}, - "links": {
- "self": "/listings/55",
- "all": "/listings"
}, - "meta": {
- "sort_order": [
- "asc",
- "desc"
], - "sort_attribute": [
- "production_year",
- "created_at",
- "mileage",
- "display_price",
- "status_sort"
]
}
}
}
Represents Nameplate like Jaguar XE or Land Rover Discovery
Note: Requires Brand
association to exist
Accept | any Example: application/json |
X-Company-UUID | any Example: af3449ff-57f7-4592-8556-c78dc1615c71 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/json |
{- "data": [
- {
- "id": "36",
- "type": "nameplate",
- "attributes": {
- "name": "Algolian Suntiger",
- "model_group": null
}, - "relationships": {
- "brand": {
- "data": {
- "id": "76",
- "type": "brand"
}
}, - "vehicles": {
- "data": [ ]
}
}, - "links": {
- "self": "/nameplates/36",
- "all": "/nameplates"
}
}
]
}
Accept | any Example: application/json |
X-Company-UUID | any Example: 3bb31437-8a43-4a66-86b1-425e658ac9e8 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/json |
{- "data": {
- "attributes": {
- "name": "Algolian Suntiger",
- "brand_id": 82
}, - "relationships": {
- "brand": {
- "data": {
- "id": 82
}
}
}
}
}
{- "data": {
- "id": "40",
- "type": "nameplate",
- "attributes": {
- "name": "Algolian Suntiger",
- "model_group": null
}, - "relationships": {
- "brand": {
- "data": {
- "id": "82",
- "type": "brand"
}
}, - "vehicles": {
- "data": [ ]
}
}, - "links": {
- "self": "/nameplates/40",
- "all": "/nameplates"
}
}
}
id | number Example: 38 |
Accept | any Example: application/json |
X-Company-UUID | any Example: b506751e-6c7b-4ed4-bff1-52de7651675a |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/json |
{- "data": {
- "id": "38",
- "type": "nameplate",
- "attributes": {
- "name": "Algolian Suntiger",
- "model_group": null
}, - "relationships": {
- "brand": {
- "data": {
- "id": "79",
- "type": "brand"
}
}, - "vehicles": {
- "data": [ ]
}
}, - "links": {
- "self": "/nameplates/38",
- "all": "/nameplates"
}
}
}
id | number Example: 41 |
Accept | any Example: application/json |
X-Company-UUID | any Example: d6dae948-d892-4952-8260-478288a1310b |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/json |
{- "data": {
- "attributes": {
- "name": "Red Tornado",
- "brand_id": 86
}, - "relationships": {
- "brand": {
- "data": {
- "id": 86
}
}
}
}
}
{- "data": {
- "id": "42",
- "type": "nameplate",
- "attributes": {
- "name": "Red Tornado",
- "model_group": null
}, - "relationships": {
- "brand": {
- "data": {
- "id": "86",
- "type": "brand"
}
}, - "vehicles": {
- "data": [ ]
}
}, - "links": {
- "self": "/nameplates/42",
- "all": "/nameplates"
}
}
}
id | number Example: 44 |
Accept | any Example: application/json |
X-Company-UUID | any Example: b3e42cf9-0571-4e34-b9a5-9d61e0324157 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/json |
{- "errors": [
- {
- "status": "404",
- "source": null,
- "title": "Not Found",
- "detail": null
}
]
}
Accept | any Example: application/json |
Content-Type | any Example: application/json |
X-Company-UUID | any Example: 1eb1c2d0-27ef-42f5-bd63-6af4c66977b7 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
{- "data": [
- {
- "id": "4",
- "type": "pdf_translations_config",
- "attributes": {
- "key": "en",
- "label": "Test#1",
- "pdf_type": "window_display"
}
}, - {
- "id": "5",
- "type": "pdf_translations_config",
- "attributes": {
- "key": "en",
- "label": "Test#2",
- "pdf_type": "silent_salesman"
}
}, - {
- "id": "6",
- "type": "pdf_translations_config",
- "attributes": {
- "key": "pl",
- "label": "Test#3",
- "pdf_type": "silent_salesman"
}
}
]
}
Accept | any Example: application/json |
X-Company-UUID | any Example: ef3551c7-7f96-448a-83e4-98efb98e9e47 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/json |
{- "type": "window_display",
- "data": {
- "color_name": "Red",
- "mileage_unit": "Km",
- "currency": "PLN",
- "power_unit": "bhp",
- "special_equipment": [
- {
- "label": "Autobiography Exterior Pack"
}
], - "msrp_price": "A$364986.19",
- "first_registration": "2024-10-26",
- "mileage": "1000",
- "transmission": "automatic",
- "engine_type": [
- "petrol"
], - "power": 530,
- "version": "Long Wheelbase Seven Seats Autobiography",
- "nameplate_name": " ",
- "nameplate_brand_name": "Range Rover",
- "msrp_price_disclaimer": "Test disclaimer",
- "language": "en"
}
}
ASCII-8BIT stream
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "7",
- "type": "photo",
- "attributes": {
- "sequence": 0,
- "file": {
- "name": "file",
- "record": {
- "id": 7,
- "sequence": 0,
- "vehicle_id": null,
- "created_at": "2024-11-05T13:42:56.499Z",
- "updated_at": "2024-11-05T13:42:56.502Z"
}
}, - "thumb_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "image_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "small_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "medium_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "big_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "full_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "quarter_hd_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "hd_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg"
}, - "relationships": {
- "vehicle": {
- "data": null
}
}, - "links": {
- "self": "/photos/7",
- "all": "/photos",
- "thumb": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "image": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "small": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "big": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "full": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg"
}
}, - {
- "id": "8",
- "type": "photo",
- "attributes": {
- "sequence": 0,
- "file": {
- "name": "file",
- "record": {
- "id": 8,
- "sequence": 0,
- "vehicle_id": null,
- "created_at": "2024-11-05T13:42:56.512Z",
- "updated_at": "2024-11-05T13:42:56.515Z"
}
}, - "thumb_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "image_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "small_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "medium_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "big_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "full_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "quarter_hd_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "hd_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg"
}, - "relationships": {
- "vehicle": {
- "data": null
}
}, - "links": {
- "self": "/photos/8",
- "all": "/photos",
- "thumb": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "image": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "small": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "big": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "full": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6OSwicHVyIjoiYmxvYl9pZCJ9fQ==--48fd0a6ae5ba1017fb9803303a1d213d98158c1b/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg"
}
}
]
}
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "attributes": {
- "sequence": 0,
- "file": "eyJfcmFpbHMiOnsiZGF0YSI6MTEsInB1ciI6ImJsb2JfaWQifX0=--f28be6febb8c02b050597b835c9030bf4c6ae750"
}
}
}
{- "data": {
- "id": "12",
- "type": "photo",
- "attributes": {
- "sequence": 0,
- "file": {
- "name": "file",
- "record": {
- "id": 12,
- "sequence": 0,
- "vehicle_id": null,
- "created_at": "2024-11-05T13:42:56.580Z",
- "updated_at": "2024-11-05T13:42:56.583Z"
}
}, - "thumb_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTEsInB1ciI6ImJsb2JfaWQifX0=--f28be6febb8c02b050597b835c9030bf4c6ae750/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "image_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTEsInB1ciI6ImJsb2JfaWQifX0=--f28be6febb8c02b050597b835c9030bf4c6ae750/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "small_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTEsInB1ciI6ImJsb2JfaWQifX0=--f28be6febb8c02b050597b835c9030bf4c6ae750/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "medium_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTEsInB1ciI6ImJsb2JfaWQifX0=--f28be6febb8c02b050597b835c9030bf4c6ae750/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "big_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTEsInB1ciI6ImJsb2JfaWQifX0=--f28be6febb8c02b050597b835c9030bf4c6ae750/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "full_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTEsInB1ciI6ImJsb2JfaWQifX0=--f28be6febb8c02b050597b835c9030bf4c6ae750/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "quarter_hd_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTEsInB1ciI6ImJsb2JfaWQifX0=--f28be6febb8c02b050597b835c9030bf4c6ae750/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "hd_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTEsInB1ciI6ImJsb2JfaWQifX0=--f28be6febb8c02b050597b835c9030bf4c6ae750/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg"
}, - "relationships": {
- "vehicle": {
- "data": null
}
}, - "links": {
- "self": "/photos/12",
- "all": "/photos",
- "thumb": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTEsInB1ciI6ImJsb2JfaWQifX0=--f28be6febb8c02b050597b835c9030bf4c6ae750/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "image": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTEsInB1ciI6ImJsb2JfaWQifX0=--f28be6febb8c02b050597b835c9030bf4c6ae750/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "small": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTEsInB1ciI6ImJsb2JfaWQifX0=--f28be6febb8c02b050597b835c9030bf4c6ae750/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTEsInB1ciI6ImJsb2JfaWQifX0=--f28be6febb8c02b050597b835c9030bf4c6ae750/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "big": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTEsInB1ciI6ImJsb2JfaWQifX0=--f28be6febb8c02b050597b835c9030bf4c6ae750/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "full": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTEsInB1ciI6ImJsb2JfaWQifX0=--f28be6febb8c02b050597b835c9030bf4c6ae750/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTEsInB1ciI6ImJsb2JfaWQifX0=--f28be6febb8c02b050597b835c9030bf4c6ae750/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTEsInB1ciI6ImJsb2JfaWQifX0=--f28be6febb8c02b050597b835c9030bf4c6ae750/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg"
}
}
}
id | number Example: 10 |
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "10",
- "type": "photo",
- "attributes": {
- "sequence": 0,
- "file": {
- "name": "file",
- "record": {
- "id": 10,
- "sequence": 0,
- "vehicle_id": null,
- "created_at": "2024-11-05T13:42:56.549Z",
- "updated_at": "2024-11-05T13:42:56.551Z"
}
}, - "thumb_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTAsInB1ciI6ImJsb2JfaWQifX0=--949cda02e81e458720e58ccce5190e1bda7f26ae/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "image_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTAsInB1ciI6ImJsb2JfaWQifX0=--949cda02e81e458720e58ccce5190e1bda7f26ae/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "small_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTAsInB1ciI6ImJsb2JfaWQifX0=--949cda02e81e458720e58ccce5190e1bda7f26ae/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "medium_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTAsInB1ciI6ImJsb2JfaWQifX0=--949cda02e81e458720e58ccce5190e1bda7f26ae/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "big_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTAsInB1ciI6ImJsb2JfaWQifX0=--949cda02e81e458720e58ccce5190e1bda7f26ae/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "full_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTAsInB1ciI6ImJsb2JfaWQifX0=--949cda02e81e458720e58ccce5190e1bda7f26ae/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "quarter_hd_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTAsInB1ciI6ImJsb2JfaWQifX0=--949cda02e81e458720e58ccce5190e1bda7f26ae/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "hd_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTAsInB1ciI6ImJsb2JfaWQifX0=--949cda02e81e458720e58ccce5190e1bda7f26ae/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg"
}, - "relationships": {
- "vehicle": {
- "data": null
}
}, - "links": {
- "self": "/photos/10",
- "all": "/photos",
- "thumb": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTAsInB1ciI6ImJsb2JfaWQifX0=--949cda02e81e458720e58ccce5190e1bda7f26ae/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "image": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTAsInB1ciI6ImJsb2JfaWQifX0=--949cda02e81e458720e58ccce5190e1bda7f26ae/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "small": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTAsInB1ciI6ImJsb2JfaWQifX0=--949cda02e81e458720e58ccce5190e1bda7f26ae/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTAsInB1ciI6ImJsb2JfaWQifX0=--949cda02e81e458720e58ccce5190e1bda7f26ae/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "big": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTAsInB1ciI6ImJsb2JfaWQifX0=--949cda02e81e458720e58ccce5190e1bda7f26ae/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "full": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTAsInB1ciI6ImJsb2JfaWQifX0=--949cda02e81e458720e58ccce5190e1bda7f26ae/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTAsInB1ciI6ImJsb2JfaWQifX0=--949cda02e81e458720e58ccce5190e1bda7f26ae/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTAsInB1ciI6ImJsb2JfaWQifX0=--949cda02e81e458720e58ccce5190e1bda7f26ae/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg"
}
}
}
id | number Example: 15 |
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "attributes": {
- "sequence": 10
}
}
}
{- "data": {
- "id": "15",
- "type": "photo",
- "attributes": {
- "sequence": 10,
- "file": {
- "name": "file",
- "record": {
- "sequence": 10,
- "id": 15,
- "vehicle_id": null,
- "created_at": "2024-11-05T13:42:56.629Z",
- "updated_at": "2024-11-05T13:42:56.641Z"
}
}, - "thumb_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTUsInB1ciI6ImJsb2JfaWQifX0=--aa945e87f8d7d79d04c4ca9200b2261ecf042981/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "image_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTUsInB1ciI6ImJsb2JfaWQifX0=--aa945e87f8d7d79d04c4ca9200b2261ecf042981/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "small_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTUsInB1ciI6ImJsb2JfaWQifX0=--aa945e87f8d7d79d04c4ca9200b2261ecf042981/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "medium_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTUsInB1ciI6ImJsb2JfaWQifX0=--aa945e87f8d7d79d04c4ca9200b2261ecf042981/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "big_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTUsInB1ciI6ImJsb2JfaWQifX0=--aa945e87f8d7d79d04c4ca9200b2261ecf042981/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "full_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTUsInB1ciI6ImJsb2JfaWQifX0=--aa945e87f8d7d79d04c4ca9200b2261ecf042981/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "quarter_hd_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTUsInB1ciI6ImJsb2JfaWQifX0=--aa945e87f8d7d79d04c4ca9200b2261ecf042981/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "hd_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTUsInB1ciI6ImJsb2JfaWQifX0=--aa945e87f8d7d79d04c4ca9200b2261ecf042981/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg"
}, - "relationships": {
- "vehicle": {
- "data": null
}
}, - "links": {
- "self": "/photos/15",
- "all": "/photos",
- "thumb": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTUsInB1ciI6ImJsb2JfaWQifX0=--aa945e87f8d7d79d04c4ca9200b2261ecf042981/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "image": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTUsInB1ciI6ImJsb2JfaWQifX0=--aa945e87f8d7d79d04c4ca9200b2261ecf042981/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "small": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTUsInB1ciI6ImJsb2JfaWQifX0=--aa945e87f8d7d79d04c4ca9200b2261ecf042981/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTUsInB1ciI6ImJsb2JfaWQifX0=--aa945e87f8d7d79d04c4ca9200b2261ecf042981/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "big": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTUsInB1ciI6ImJsb2JfaWQifX0=--aa945e87f8d7d79d04c4ca9200b2261ecf042981/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "full": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTUsInB1ciI6ImJsb2JfaWQifX0=--aa945e87f8d7d79d04c4ca9200b2261ecf042981/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTUsInB1ciI6ImJsb2JfaWQifX0=--aa945e87f8d7d79d04c4ca9200b2261ecf042981/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTUsInB1ciI6ImJsb2JfaWQifX0=--aa945e87f8d7d79d04c4ca9200b2261ecf042981/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg"
}
}
}
GET /sidekiq/:id
This endpoint is used to get a status of the sidekiq job.
param | example | type | required | description |
---|---|---|---|---|
id |
991c3dc1a0bcf01ce93ae34 | string | yes (in url) | id of the job |
job_id
- id of the job
status
- status of the job, possible values are queued
, working
, complete
, failed
, interrupted
, when value is null it means job does not exist
id | string Example: a08d743254f6a94ef2e415a9 |
Accept | any Example: application/json |
X-Company-UUID | any Example: 57e73120-5a95-4790-817f-bc2ddb6034bb |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/json |
{- "job_id": "a08d743254f6a94ef2e415a9",
- "status": "complete"
}
Stores files and data (photo status and vehicle errors) associated with vehicle batch uploads. It tracks status of upload job.
id | number Example: 1 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 06407798-11d2-4e36-9f2f-5585487ec60f |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "1",
- "type": "vehicle_batch_upload",
- "attributes": {
- "id": 1,
- "state": null,
- "total_vehicle_count": null,
- "successful_upload_count": 0,
- "failed_upload_count": 0,
- "failed_uploads": [ ],
- "photo_status": [ ],
- "overwrite_permitted": false
}
}
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: c07a772f-3ad1-404b-b217-4ceda6e350d7 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1 |
"{\n \"file\": {\n \"filename\": \"valid_file.csv\",\n \"type\": \"text/csv\",\n \"name\": \"file\",\n \"tempfile\": \"#<File:0x00007f133f8f6a70>\",\n \"head\": \"content-disposition: form-data; name=\\\"file\\\"; filename=\\\"valid_file.csv\\\"\\r\\ncontent-type: text/csv\\r\\ncontent-length: 3666\\r\\n\"\n }\n}"
{- "data": {
- "id": "3",
- "type": "vehicle_batch_upload",
- "attributes": {
- "id": 3,
- "state": "init",
- "total_vehicle_count": 1,
- "successful_upload_count": 0,
- "failed_upload_count": 0,
- "failed_uploads": [ ],
- "photo_status": [ ],
- "overwrite_permitted": false
}
}
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: c1dac7dc-1650-4313-ba75-826783b231ae |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "pending_upload_id": null
}
Vehicles list is always paginated.
By default API will return up to 20 items but it can be overriden using items
parameter.
Here we use items=2
bo brevity but it's optional and set to 20 by default.
Paginated results include pagination metadata in the meta
object like this:
"meta": {
"pagination": {
//URL template to fetch additonal pages (PAGE_NUM) should be replaced by page number
"scaffold_url": "...?items=2&page=PAGE_NUM",
"count": 50, // Overall amount of vehicles in collection
"page": 3, // Current page number
"items": 2, // Amount of items page page
"pages": 25, // Amount of all pages
"last": 25, // Last page number
"from": 5, // index of first item on current page
"to": 6, // index of last item on current page
"prev": 2, // previous page number, null if no previous page
"next": 4 // next page number, null if no next page
}
}
page required | number Example: page=2 Pagination page to be requested (default: 1) |
items required | number Example: items=3 Amount of items per page (default: 20) |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: a064770f-5d1c-4009-beea-d9d01f081eb8 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "5",
- "type": "vehicle_operation_request",
- "attributes": {
- "request_type": "publication",
- "updated_at": "2024-11-05T13:43:14.118Z",
- "status": "rejected",
- "owner_name": "Marquardt-Kozey",
- "owner_id": 617,
- "requester_name": "Marquardt-Kozey",
- "requester_id": 617,
- "listing_title": "Linguine with Clams 61",
- "listing_id": 59,
- "transfer_to_name": null,
- "transfer_to_id": null,
- "vehicle_id": 237,
- "vehicle_model_display_name": "Renault Belcerebon",
- "vehicle_owner_name": "Abbott-Harvey",
- "vehicle_cover_photo_thumb": null
}
}, - {
- "id": "6",
- "type": "vehicle_operation_request",
- "attributes": {
- "request_type": "publication",
- "updated_at": "2024-11-05T13:43:14.174Z",
- "status": "rejected",
- "owner_name": "Marquardt-Kozey",
- "owner_id": 617,
- "requester_name": "Marquardt-Kozey",
- "requester_id": 617,
- "listing_title": "Linguine with Clams 61",
- "listing_id": 59,
- "transfer_to_name": null,
- "transfer_to_id": null,
- "vehicle_id": 238,
- "vehicle_model_display_name": "Subaru Silver Tongued Devils",
- "vehicle_owner_name": "Erdman, Powlowski and Terry",
- "vehicle_cover_photo_thumb": null
}
}
], - "meta": {
- "pagination": {
- "scaffold_url": "/vehicle_operation_requests/publications?items=2&page=PAGE_NUM",
- "count": 50,
- "page": 3,
- "items": 2,
- "pages": 25,
- "last": 25,
- "from": 5,
- "to": 6,
- "prev": 2,
- "next": 4
}, - "company_account_type": "importer"
}
}
Filtering mechanism utilises quite powerful Ransack gem engine
Prefilters are parameters used to filter vehicles before any counting or dynamic filtering takes place. They are simple filters without any predicates. There are two perfilters:
forced_brands_names - filters vehicles by brand names separated by comma, ex. forced_brands_names=Land Rover,Jaguar
forced_dealer_codes - filters vehicles by owner dealer codes, separated by comma, ex. forced_dealer_codes=50001,50002
forced_statuses - filters vehicles by statuses, separated by comma, ex. forced_dealer_codes=reserved,sold
filter
attributeTo filter results one should use filter[]
GET parameter
object with each search/filter criteria as a separate parameter entry.
this parameters entries should adher to format of filter[:attribute_filtered:_:matcher_operator:]=value1
.
attribute_filter
partIn general it's possible to filter by all object parameters that can be seen in
a typical API response. For vehicles it includes version
, drivetrain
, production_year
etc.
However, there's one non-standard attribute that you can filter by - display_price
. It filters/sorts vehicles
by the actual Vehicle price (so it checks whether a vehicle has sale_price
value - if not, it takes msrp_price
for that vehicle as the current price).
On top of that one can filter based on selected related models by concatenating relationship name and related obejct attribute. For example Nameplate
name is not stored in the Vehicle
model but it can ge used as filter parameter as nameplate_name
.
This kind of relationship searches can go deeper. Since Brand
is related to Nameplate
not Vechile
itself, to filter vehicles by Brand
name we should user nameplate_brand_name
attributes.
matcher
partFull list of all available matcher operators can be seen here: https://github.com/activerecord-hackery/ransack#search-matchers
Most usefull and important ones are:
Matcher | Description |
---|---|
_eq | Equality |
_gt | Greater then |
_gteq | Greater than or equal |
_lt | Less then |
_lteq | Less than or equal |
_start | Starts with |
_i_cont | Contains value with (case insensitive) |
_cont | Contains value with (case sensitive) |
_in | Match any values separated by comma Eg: filter[name_in]=Bob,Alice |
To return vehicles which match one of multiple filters, or
operator has to be used. For example, to search for vehicles which vin
or order_number
start with some value filter should looke like this:
filter[vin_or_order_number_start]=123
engine_types
and owner_dealers_codes
are specific parameters due to the fact they are stored as array in the database so
simple string-based cont
predicates will not work. To filter based on this array content new predicate _includes
was added. So to filter for all "Petrol" powered vehicles request should look like this:
filter[engine_type_includes]=petrol
This will return both hybrid and non-hybrid Vehicles as long as they also include petrol in engine_type
array
Multiple engine types can be searched separated by comma:
filter[engine_type_includes]=petrol,bev
Will return petrol as well as bev engines
financing options
is a specific parameter based on scope and does not have any predicates. To use it chosen values separated by comma have to be provided:
filter[financing_options]=cash,lease,rent
status
filter is based on two attributes. It filters vehicles by status
attribute and also checks lock_id
which indicates that vehicle is soft-locked. In case it is soft-locked it is searched as it would be of reserved
status. Because of that status
filter is processed outside ransack and accepts _eq
and _in
predicates only.
To Search Vechiles with production year beetween 2015 and 2018:
filter[production_year_gteq]=2015&filter[production_year_lteq]=2018
To Search all Jaguars
filter[nameplate_brand_name_eq]=Jaguar
To Search all Vechiles with HSE in version
filter[version_i_cont]=HSE
filter required | object |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 7bb5fbdc-e4fa-4931-ad70-b9b4c10d6546 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "102",
- "type": "vehicle_operation_request",
- "attributes": {
- "request_type": "publication",
- "updated_at": "2024-11-05T13:43:17.357Z",
- "status": "rejected",
- "owner_name": "Marquardt-Kozey",
- "owner_id": 725,
- "requester_name": "Marquardt-Kozey",
- "requester_id": 725,
- "listing_title": "Linguine with Clams 63",
- "listing_id": 61,
- "transfer_to_name": null,
- "transfer_to_id": null,
- "vehicle_id": 334,
- "vehicle_model_display_name": "Ram Grebulons",
- "vehicle_owner_name": "Zemlak, O'Hara and Nader",
- "vehicle_cover_photo_thumb": null
}
}
], - "meta": {
- "pagination": {
- "scaffold_url": "/vehicle_operation_requests/publications?filter%5Bstatus_eq%5D=rejected&page=PAGE_NUM",
- "count": 1,
- "page": 1,
- "items": 1,
- "pages": 1,
- "last": 1,
- "from": 1,
- "to": 1,
- "prev": null,
- "next": null
}, - "company_account_type": "importer"
}
}
Simliast to Filtering the sorting mechanism utilises quite powerful Ransack gem engine
sort
attributeTo sort results one should use sort
GET parameter as a list of collumns that records should be sorted by.
By default sorting works in natura ascending order. To use the ascending order (usefull for prices) column name should
be predicated with minus (-
, U+002D HYPHEN-MINUS) character
To Sort Vechiles in ascending order by msrp_price
sort=msrp_price
To Sort Vechiles in descending order by msrp_price
sort=-msrp_price
To Sort Vechiles in ascending order by production year and then in descending order by msrp_price
sort=production_year,-msrp_price
sort required | string Example: sort=status_sort Comma separated list of columns to sort VehicleOperationRequest by |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 57a48b86-d078-419a-97f3-85bf35ab0a22 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "106",
- "type": "vehicle_operation_request",
- "attributes": {
- "request_type": "publication",
- "updated_at": "2024-11-05T13:43:17.519Z",
- "status": "pending",
- "owner_name": "Marquardt-Kozey",
- "owner_id": 732,
- "requester_name": "Marquardt-Kozey",
- "requester_id": 732,
- "listing_title": "Linguine with Clams 64",
- "listing_id": 62,
- "transfer_to_name": null,
- "transfer_to_id": null,
- "vehicle_id": 338,
- "vehicle_model_display_name": "Alpine Damogran Frond Crested Eagle",
- "vehicle_owner_name": "Okuneva, Prohaska and Farrell",
- "vehicle_cover_photo_thumb": null
}
}, - {
- "id": "105",
- "type": "vehicle_operation_request",
- "attributes": {
- "request_type": "publication",
- "updated_at": "2024-11-05T13:43:17.493Z",
- "status": "rejected",
- "owner_name": "Marquardt-Kozey",
- "owner_id": 732,
- "requester_name": "Marquardt-Kozey",
- "requester_id": 732,
- "listing_title": "Linguine with Clams 64",
- "listing_id": 62,
- "transfer_to_name": null,
- "transfer_to_id": null,
- "vehicle_id": 337,
- "vehicle_model_display_name": "Ram Grebulons",
- "vehicle_owner_name": "Zemlak, O'Hara and Nader",
- "vehicle_cover_photo_thumb": null
}
}, - {
- "id": "104",
- "type": "vehicle_operation_request",
- "attributes": {
- "request_type": "publication",
- "updated_at": "2024-11-05T13:43:17.468Z",
- "status": "approved",
- "owner_name": "Marquardt-Kozey",
- "owner_id": 732,
- "requester_name": "Marquardt-Kozey",
- "requester_id": 732,
- "listing_title": "Linguine with Clams 64",
- "listing_id": 62,
- "transfer_to_name": null,
- "transfer_to_id": null,
- "vehicle_id": 336,
- "vehicle_model_display_name": "Ferrari Boghog",
- "vehicle_owner_name": "Boehm, Pfannerstill and Stiedemann",
- "vehicle_cover_photo_thumb": null
}
}
], - "meta": {
- "pagination": {
- "scaffold_url": "/vehicle_operation_requests/publications?sort=status_sort&page=PAGE_NUM",
- "count": 3,
- "page": 1,
- "items": 3,
- "pages": 1,
- "last": 1,
- "from": 1,
- "to": 3,
- "prev": null,
- "next": null
}, - "company_account_type": "importer"
}
}
id | number Example: 107 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: cc061d41-8b7b-43cd-a9ef-d1432bcc7071 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "107",
- "type": "vehicle_operation_request",
- "attributes": {
- "request_type": "publication",
- "updated_at": "2024-11-05T13:43:17.614Z",
- "status": "pending",
- "owner_name": "Ritchie-Kunde",
- "owner_id": 737,
- "requester_name": "Bailey, Ondricka and Donnelly",
- "requester_id": 742,
- "listing_title": "Barbecue Ribs 65",
- "listing_id": 63,
- "transfer_to_name": "Barton Inc",
- "transfer_to_id": 738,
- "vehicle_id": 339,
- "vehicle_model_display_name": "Ferrari Boghog",
- "vehicle_owner_name": "Boehm, Pfannerstill and Stiedemann",
- "vehicle_cover_photo_thumb": null
}
}
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: f5ea594e-13b4-4b3b-b5bc-4c52463cc433 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "111",
- "type": "vehicle_operation_request",
- "attributes": {
- "request_type": "publication",
- "updated_at": "2024-11-05T13:43:18.035Z",
- "status": "rejected",
- "owner_name": "Marquardt-Kozey",
- "owner_id": 766,
- "requester_name": "Marquardt-Kozey",
- "requester_id": 766,
- "listing_title": "Linguine with Clams 69",
- "listing_id": 67,
- "transfer_to_name": null,
- "transfer_to_id": null,
- "vehicle_id": 343,
- "vehicle_model_display_name": "Ferrari Boghog",
- "vehicle_owner_name": "Boehm, Pfannerstill and Stiedemann",
- "vehicle_cover_photo_thumb": null
}
}, - {
- "id": "112",
- "type": "vehicle_operation_request",
- "attributes": {
- "request_type": "publication",
- "updated_at": "2024-11-05T13:43:18.061Z",
- "status": "pending",
- "owner_name": "Marquardt-Kozey",
- "owner_id": 766,
- "requester_name": "Marquardt-Kozey",
- "requester_id": 766,
- "listing_title": "Linguine with Clams 69",
- "listing_id": 67,
- "transfer_to_name": null,
- "transfer_to_id": null,
- "vehicle_id": 344,
- "vehicle_model_display_name": "Ram Grebulons",
- "vehicle_owner_name": "Zemlak, O'Hara and Nader",
- "vehicle_cover_photo_thumb": null
}
}
], - "meta": {
- "pagination": {
- "scaffold_url": "/vehicle_operation_requests/publications?page=PAGE_NUM",
- "count": 2,
- "page": 1,
- "items": 2,
- "pages": 1,
- "last": 1,
- "from": 1,
- "to": 2,
- "prev": null,
- "next": null
}, - "company_account_type": "importer"
}
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 0a92a549-8885-4571-b8ad-b855263c59f3 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [ ],
- "meta": {
- "pagination": {
- "scaffold_url": "/vehicle_operation_requests/stock_transfer?page=PAGE_NUM",
- "count": 0,
- "page": 1,
- "items": 20,
- "pages": 1,
- "last": 1,
- "from": 0,
- "to": 0,
- "prev": null,
- "next": null
}
}
}
id | number Example: 123 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 550acbcd-7891-4a91-8f7a-f4f222031407 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "125",
- "type": "vehicle_operation_request",
- "attributes": {
- "request_type": "publication",
- "updated_at": "2024-11-05T13:43:18.955Z",
- "status": "approved",
- "owner_name": "O'Conner, Parker and Lind",
- "owner_id": 818,
- "requester_name": "Murray, Rowe and Hermann",
- "requester_id": 820,
- "listing_title": "Tiramisù 80",
- "listing_id": 78,
- "transfer_to_name": null,
- "transfer_to_id": null,
- "vehicle_id": 357,
- "vehicle_model_display_name": "Mitsubishi Cow",
- "vehicle_owner_name": "Rosenbaum-Bashirian",
- "vehicle_cover_photo_thumb": null
}
}
}
id | number Example: 126 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: fab7382e-30b9-45b4-98a2-4470b66e05bf |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "126",
- "type": "vehicle_operation_request",
- "attributes": {
- "request_type": "publication",
- "updated_at": "2024-11-05T13:43:19.060Z",
- "status": "rejected",
- "owner_name": "O'Conner, Parker and Lind",
- "owner_id": 823,
- "requester_name": "Murray, Rowe and Hermann",
- "requester_id": 825,
- "listing_title": "Tiramisù 81",
- "listing_id": 79,
- "transfer_to_name": null,
- "transfer_to_id": null,
- "vehicle_id": 358,
- "vehicle_model_display_name": "Mitsubishi Cow",
- "vehicle_owner_name": "Rosenbaum-Bashirian",
- "vehicle_cover_photo_thumb": null
}
}
}
id | number Example: 127 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: c91d485c-4386-4a84-927d-46dfb72fa7d1 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "3",
- "type": "vehicle_operation_log_entry",
- "attributes": {
- "log_entry_type": "approved",
- "data": {
- "model_name": "Kutch Inc",
- "status_name": "available_soon",
- "publication_list_name": "Tacos"
}, - "created_at": "2024-11-05T13:43:19.160Z"
}
}, - {
- "id": "4",
- "type": "vehicle_operation_log_entry",
- "attributes": {
- "log_entry_type": "rejected",
- "data": {
- "model_name": "Pagac-Herzog",
- "status_name": "on_demand",
- "publication_list_name": "Tacos"
}, - "created_at": "2024-11-05T13:43:19.161Z"
}
}, - {
- "id": "5",
- "type": "vehicle_operation_log_entry",
- "attributes": {
- "log_entry_type": "approved",
- "data": {
- "model_name": "Tromp-Dietrich",
- "status_name": "on_demand",
- "publication_list_name": "Bruschette with Tomato"
}, - "created_at": "2024-11-05T13:43:19.163Z"
}
}
]
}
id | number Example: 130 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 7961b1eb-5bd5-4d7d-b925-6b9d38a97581 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "362",
- "type": "active_vehicle",
- "attributes": {
- "version": "Crisis On Infinite Earths",
- "drivetrain": "The Sinestro Corps War",
- "production_year": 2015,
- "short_description": "Blanditiis quia laudantium numquam voluptate et eos earum quaerat quae.",
- "msrp_price": "30696.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Id laborum perferendis eaque illo repellendus autem quo aut iste enim explicabo doloremque voluptas alias suscipit culpa hic aut non.",
- "state": "approved",
- "delivery_date": "2024-11-26",
- "transmission": "manual",
- "vin": null,
- "mileage": 637263,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "phev"
], - "power": 253,
- "video_url": null,
- "created_at": "2024-11-05T13:43:19.394Z",
- "updated_at": "2024-11-05T13:43:19.405Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Hooloovoo",
- "nameplate_brand_name": "Acura",
- "owner_locale": "es_MX",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "external_id": "1bb2e7",
- "footnote": "Deserunt est aut iure et enim rem nobis natus consectetur.",
- "config_url": null,
- "subscribe_price": null,
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "Acura Hooloovoo",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "sold",
- "color_name": "Chocolate Concrete",
- "color_canonical": "yellow",
- "cover_photo": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "cover_photo_thumb": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "cover_photo_small": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "cover_photo_medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "cover_photo_big": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "cover_photo_full": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "cover_photo_quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "cover_photo_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg",
- "attachment_url": null
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "370",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "707",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "377",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "844",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [
- {
- "id": "157",
- "type": "photo"
}
]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/362",
- "all": "/vehicles"
}
}, - "included": [
- {
- "id": "157",
- "type": "photo",
- "attributes": {
- "sequence": 0,
- "file": {
- "name": "file",
- "record": {
- "id": 157,
- "sequence": 0,
- "vehicle_id": 362,
- "created_at": "2024-11-05T13:43:19.400Z",
- "updated_at": "2024-11-05T13:43:19.404Z"
}
}, - "thumb_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "image_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "small_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "medium_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "big_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "full_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "quarter_hd_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "hd_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg"
}, - "relationships": {
- "vehicle": {
- "data": {
- "id": "362",
- "type": "vehicle"
}
}
}, - "links": {
- "self": "/photos/157",
- "all": "/photos",
- "thumb": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "image": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "small": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "big": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "full": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY0LCJwdXIiOiJibG9iX2lkIn19--2511c4e2cd1e46d673603872c7af5c8f92307f6f/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg"
}
}, - {
- "id": "844",
- "type": "company",
- "attributes": {
- "uuid": "7961b1eb-5bd5-4d7d-b925-6b9d38a97581",
- "name": "Ritchie-Kunde",
- "city": "Hermistonshire",
- "address": "99667 Major Corners, Antoniomouth, LA 39348-8794",
- "phone": "+994 987.432.9120",
- "locale": "es_MX",
- "currency": "GBP",
- "zipcode": null,
- "timezone": "UTC",
- "mileage_unit": "km",
- "power_unit": "bhp",
- "engine_capacity_unit": "cc",
- "opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "contact_details": "31019 Velvet Rest\nLake Irafurt",
- "skip_company_name_in_location": false,
- "config_locale": null,
- "account_type": null,
- "state": null,
- "dealer_codes": [ ],
- "operating_states": [
- "NSW",
- "VIC"
], - "feature_flag_policies": [ ]
}, - "relationships": {
- "parent": {
- "data": null
}, - "children": {
- "data": [ ]
}, - "descendants": {
- "data": [ ]
}, - "ancestors": {
- "data": [ ]
}, - "colors": {
- "data": [ ]
}
}, - "links": {
- "all": "/companies"
}, - "meta": {
- "power_units": [
- "bhp",
- "kw"
], - "mileage_units": [
- "km",
- "mi"
], - "engine_capacity_units": [
- "cc",
- "l"
]
}
}
]
}
Returns ids and count of all vehicles. (works with filters and sorting)
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: d7b45eac-31b5-45a5-892e-77dd375a3a55 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "ids": [
- 363
], - "count": 1
}
ids | string Example: 364,365 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 0a967280-1c90-4ada-b152-6d1da609eef8 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "364",
- "type": "vehicle_batch",
- "attributes": {
- "version": "Swamp Thing: The Anatomy Lesson",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2015,
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "msrp_price": "29320.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "new",
- "status": "stock",
- "delivery_date": "2024-11-22",
- "transmission": "manual",
- "vin": null,
- "mileage": 593012,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "diesel"
], - "power": 256,
- "video_url": null,
- "created_at": "2024-11-05T13:43:19.578Z",
- "updated_at": "2024-11-05T13:43:19.578Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "en_GB",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "external_id": "a84f8b",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "config_url": null,
- "subscribe_price": null,
- "type": "ActiveVehicle",
- "color_name": "Cerulean Granite",
- "color_canonical": "blue"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "372",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "710",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "379",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "852",
- "type": "company"
}
}
}
}, - {
- "id": "365",
- "type": "vehicle_batch",
- "attributes": {
- "version": "Teen Titans: The Judas Contract",
- "drivetrain": "The Coyote Gospel",
- "production_year": 2015,
- "short_description": "Voluptate similique iure consequatur placeat nisi et quos laudantium libero.",
- "msrp_price": "46452.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Et iste voluptates fuga tempore dolore ut suscipit facilis nihil culpa quia vitae eum quo deserunt in architecto ratione accusantium.",
- "state": "new",
- "status": "stock",
- "delivery_date": "2024-11-15",
- "transmission": "manual",
- "vin": null,
- "mileage": 474497,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "phev"
], - "power": 267,
- "video_url": null,
- "created_at": "2024-11-05T13:43:19.588Z",
- "updated_at": "2024-11-05T13:43:19.588Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "en_GB",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "external_id": "c1d492",
- "footnote": "Dolorem aut animi veniam similique laborum modi quis deleniti dicta.",
- "config_url": null,
- "subscribe_price": null,
- "type": "ActiveVehicle",
- "color_name": "Cerulean Granite",
- "color_canonical": "blue"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "372",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "710",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "379",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "852",
- "type": "company"
}
}
}
}
]
}
ids | string Example: 376,377 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 1625b84a-27f5-44d8-a494-fbb41acc1388 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [ ]
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 2b22ec78-8ec5-41b5-9d51-02f6c7d15522 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": 368,
- "attributes": {
- "version": "new version"
}
}, - {
- "id": 369,
- "attributes": {
- "drivetrain": "new-data"
}
}
]
}
{- "data": [
- {
- "id": "368",
- "type": "vehicle_batch",
- "attributes": {
- "version": "new version",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2015,
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "msrp_price": "39610.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "new",
- "status": "sold",
- "delivery_date": "2024-11-10",
- "transmission": "auto",
- "vin": null,
- "mileage": 521632,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "hev"
], - "power": 357,
- "video_url": null,
- "created_at": "2024-11-05T13:43:19.669Z",
- "updated_at": "2024-11-05T13:43:19.695Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "ro_RO",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "external_id": "c80fb5",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "config_url": null,
- "subscribe_price": null,
- "type": "ActiveVehicle",
- "color_name": "Cerulean Granite",
- "color_canonical": "blue"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "374",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "712",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "381",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "854",
- "type": "company"
}
}
}
}, - {
- "id": "369",
- "type": "vehicle_batch",
- "attributes": {
- "version": "Teen Titans: The Judas Contract",
- "drivetrain": "new-data",
- "production_year": 2015,
- "short_description": "Voluptate similique iure consequatur placeat nisi et quos laudantium libero.",
- "msrp_price": "49045.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Et iste voluptates fuga tempore dolore ut suscipit facilis nihil culpa quia vitae eum quo deserunt in architecto ratione accusantium.",
- "state": "used",
- "status": "sold",
- "delivery_date": "2024-11-30",
- "transmission": "auto",
- "vin": null,
- "mileage": 736156,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "phev"
], - "power": 397,
- "video_url": null,
- "created_at": "2024-11-05T13:43:19.680Z",
- "updated_at": "2024-11-05T13:43:19.705Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "ro_RO",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "external_id": "704f65",
- "footnote": "Dolorem aut animi veniam similique laborum modi quis deleniti dicta.",
- "config_url": null,
- "subscribe_price": null,
- "type": "ActiveVehicle",
- "color_name": "Cerulean Granite",
- "color_canonical": "blue"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "374",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "712",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "381",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "854",
- "type": "company"
}
}
}
}
]
}
All actions performed on Vehicle
objects need to happen in context of Company
object.
The Company is determined based on X-Company-UUID
header value. This value should contain uuid
attribute of
Company
obejct.
If header is not present API will raise 400 - Bad Request
response with information about missing header
If header is present but no Company with provided uuid
values is present in the database the 404 - Not Found
response is given.
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
X-Company-UUID | any Example: bad-uuid-value |
{- "errors": [
- {
- "status": 400,
- "source": null,
- "title": "Bad Request",
- "detail": "X-Company-UUID header is missing"
}
]
}
Vehicle Standard and optional feature lists are stored in separate attributes (features_standard
and features_optional
) as validated JSON array.
Validation happens based on JSON Schema defined like this:
{
"type": "array",
"items": {
"type": "object",
"required": [
"label"
],
"properties": {
"code": {
"type": "string"
},
"label": {
"type": "string",
"minLength": 1
},
"category": {
"type": "string",
"enum": [
"exterior",
"interior",
"lights",
"safety",
"wheels",
"seats",
"performance",
"infotainment",
"convenience"
]
}
},
"additionalProperties": false
}
}
To put it more clearly each feature shoudl be simple object with string properties.
Only one property is required (label
). Properties code
and category
are optional.
label
needs to contain at least 1 character, meaning it cannot be emoty string!
category
values are expected to come from closed list of values:
"exterior", "interior", "lights", "safety", "wheels", "seats", "performance", "infotainment", "convenience"
[
{
"code": "XXX123",
"label": "Heated Windshield",
"category": "convenience"
},
{
"label": "22' Bespoke Wheels",
"category": "wheels"
},
{
"code": "YYYZZZ",
"label": "Custom Paint"
},
]
Each JSON Schema validation error will be returned as a separate validation error with human readable description message.
Validation Example can be seen bellow in test cases.
NOTE: Those messages should not be presented to the end user. Their intent is to be used for debuging purposes only!
id | number Example: 380 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 2da610e6-6c2e-4ede-af5d-83a1d877287c |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "attributes": {
- "features_optional": [
- {
- "label": "Feature Label",
- "category": "lights"
}
]
}, - "relationships": {
- "owner": {
- "data": {
- "id": 860
}
}
}
}
}
{- "data": {
- "id": "380",
- "type": "vehicle",
- "attributes": {
- "version": "Multiversity",
- "drivetrain": "Detective Comics",
- "production_year": 2018,
- "short_description": "Eius amet ut natus molestiae aliquid dignissimos soluta omnis esse.",
- "msrp_price": "29086.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Molestiae ex nihil earum amet natus eos excepturi labore consectetur veritatis sit veniam corrupti qui vel facilis est et maiores.",
- "state": "approved",
- "delivery_date": "2024-12-02",
- "transmission": "manual",
- "vin": null,
- "mileage": 568320,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "diesel"
], - "power": 218,
- "video_url": null,
- "created_at": "2024-11-05T13:43:20.048Z",
- "updated_at": "2024-11-05T13:43:20.079Z",
- "power_unit": "bhp",
- "currency": "FJD",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [
- {
- "label": "Feature Label",
- "category": "lights"
}
], - "nameplate_name": "Human",
- "nameplate_brand_name": "Mitsubishi",
- "owner_locale": "en_GB",
- "owner_name": "Cummings-Wiza",
- "owner_city": "New Cliff",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "56510 Nedra Roads\nMileston",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "external_id": "f5acd6",
- "footnote": "Quae expedita possimus laboriosam quis sint aspernatur consectetur enim error.",
- "config_url": null,
- "subscribe_price": null,
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "Mitsubishi Human",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": "0.0",
- "status": "reserved",
- "color_name": "Chocolate Iron",
- "color_canonical": "silver",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": null
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "380",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "718",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "387",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "860",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/380",
- "all": "/vehicles"
}
}
}
Filtering mechanism utilises quite powerful Ransack gem engine
Prefilters are parameters used to filter vehicles before any counting or dynamic filtering takes place. They are simple filters without any predicates. There are two perfilters:
forced_brands_names - filters vehicles by brand names separated by comma, ex. forced_brands_names=Land Rover,Jaguar
forced_dealer_codes - filters vehicles by owner dealer codes, separated by comma, ex. forced_dealer_codes=50001,50002
forced_statuses - filters vehicles by statuses, separated by comma, ex. forced_dealer_codes=reserved,sold
filter
attributeTo filter results one should use filter[]
GET parameter
object with each search/filter criteria as a separate parameter entry.
this parameters entries should adher to format of filter[:attribute_filtered:_:matcher_operator:]=value1
.
attribute_filter
partIn general it's possible to filter by all object parameters that can be seen in
a typical API response. For vehicles it includes version
, drivetrain
, production_year
etc.
However, there's one non-standard attribute that you can filter by - display_price
. It filters/sorts vehicles
by the actual Vehicle price (so it checks whether a vehicle has sale_price
value - if not, it takes msrp_price
for that vehicle as the current price).
On top of that one can filter based on selected related models by concatenating relationship name and related obejct attribute. For example Nameplate
name is not stored in the Vehicle
model but it can ge used as filter parameter as nameplate_name
.
This kind of relationship searches can go deeper. Since Brand
is related to Nameplate
not Vechile
itself, to filter vehicles by Brand
name we should user nameplate_brand_name
attributes.
matcher
partFull list of all available matcher operators can be seen here: https://github.com/activerecord-hackery/ransack#search-matchers
Most usefull and important ones are:
Matcher | Description |
---|---|
_eq | Equality |
_gt | Greater then |
_gteq | Greater than or equal |
_lt | Less then |
_lteq | Less than or equal |
_start | Starts with |
_i_cont | Contains value with (case insensitive) |
_cont | Contains value with (case sensitive) |
_in | Match any values separated by comma Eg: filter[name_in]=Bob,Alice |
To return vehicles which match one of multiple filters, or
operator has to be used. For example, to search for vehicles which vin
or order_number
start with some value filter should looke like this:
filter[vin_or_order_number_start]=123
engine_types
and owner_dealers_codes
are specific parameters due to the fact they are stored as array in the database so
simple string-based cont
predicates will not work. To filter based on this array content new predicate _includes
was added. So to filter for all "Petrol" powered vehicles request should look like this:
filter[engine_type_includes]=petrol
This will return both hybrid and non-hybrid Vehicles as long as they also include petrol in engine_type
array
Multiple engine types can be searched separated by comma:
filter[engine_type_includes]=petrol,bev
Will return petrol as well as bev engines
financing options
is a specific parameter based on scope and does not have any predicates. To use it chosen values separated by comma have to be provided:
filter[financing_options]=cash,lease,rent
status
filter is based on two attributes. It filters vehicles by status
attribute and also checks lock_id
which indicates that vehicle is soft-locked. In case it is soft-locked it is searched as it would be of reserved
status. Because of that status
filter is processed outside ransack and accepts _eq
and _in
predicates only.
To Search Vechiles with production year beetween 2015 and 2018:
filter[production_year_gteq]=2015&filter[production_year_lteq]=2018
To Search all Jaguars
filter[nameplate_brand_name_eq]=Jaguar
To Search all Vechiles with HSE in version
filter[version_i_cont]=HSE
filter required | object |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: bc666635-8046-4fdf-ba83-3b9721b1fe7b |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "383",
- "type": "vehicle",
- "attributes": {
- "version": "Kingdom Come",
- "drivetrain": "JLA: Tower Of Babel",
- "production_year": 2014,
- "short_description": "Nemo commodi dolorem quam similique cumque sint quia iure quia.",
- "msrp_price": "25064.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "used",
- "delivery_date": "2024-11-17",
- "transmission": "auto",
- "vin": null,
- "mileage": 882701,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "petrol",
- "phev"
], - "power": 226,
- "video_url": null,
- "created_at": "2024-11-05T13:43:20.234Z",
- "updated_at": "2024-11-05T13:43:20.234Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Hooloovoo",
- "nameplate_brand_name": "MG",
- "owner_locale": "pl_PL",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "external_id": "6f6718",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "config_url": null,
- "subscribe_price": null,
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Hooloovoo",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "stock",
- "color_name": "Olive Paper",
- "color_canonical": "orange",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": null
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "383",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "725",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "390",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "863",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/383",
- "all": "/vehicles"
}
}
], - "meta": {
- "pagination": {
- "scaffold_url": "/vehicles?filter%5Bengine_type_includes%5D=phev&page=PAGE_NUM",
- "count": 1,
- "page": 1,
- "items": 1,
- "pages": 1,
- "last": 1,
- "from": 1,
- "to": 1,
- "prev": null,
- "next": null
}
}
}
Simliast to Filtering the sorting mechanism utilises quite powerful Ransack gem engine
sort
attributeTo sort results one should use sort
GET parameter as a list of collumns that records should be sorted by.
By default sorting works in natura ascending order. To use the ascending order (usefull for prices) column name should
be predicated with minus (-
, U+002D HYPHEN-MINUS) character
To Sort Vechiles in ascending order by msrp_price
sort=msrp_price
To Sort Vechiles in descending order by msrp_price
sort=-msrp_price
To Sort Vechiles in ascending order by production year and then in descending order by msrp_price
sort=production_year,-msrp_price
sort required | string Example: sort=msrp_price Comma separated list of columns to sort vehicles by |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: bec52dd6-ddab-4a8f-910e-42b40d2542fc |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "390",
- "type": "vehicle",
- "attributes": {
- "version": "Kingdom Come",
- "drivetrain": "Multiversity",
- "production_year": 2011,
- "short_description": "Molestiae eos et illo dignissimos ullam eius corporis dolor eum.",
- "msrp_price": "2000.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Molestiae illum amet provident hic qui quia odio voluptatem optio est nisi ut deserunt suscipit a reiciendis architecto qui vitae.",
- "state": "used",
- "delivery_date": "2024-12-01",
- "transmission": "manual",
- "vin": null,
- "mileage": 358397,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "mhev"
], - "power": 194,
- "video_url": null,
- "created_at": "2024-11-05T13:43:20.504Z",
- "updated_at": "2024-11-05T13:43:20.504Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "ro_RO",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "external_id": "ca26b5",
- "footnote": "Fugiat quo animi veniam similique laborum modi quis deleniti dicta.",
- "config_url": null,
- "subscribe_price": null,
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "on_demand",
- "color_name": "Olive Marble",
- "color_canonical": "bronze",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": null
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "393",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "738",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "397",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "867",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/390",
- "all": "/vehicles"
}
}, - {
- "id": "389",
- "type": "vehicle",
- "attributes": {
- "version": "Teen Titans: The Judas Contract",
- "drivetrain": "Batman: Year One",
- "production_year": 2011,
- "short_description": "Nemo ea fugiat esse error optio excepturi quia voluptas quia.",
- "msrp_price": "1000.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "new",
- "delivery_date": "2024-11-15",
- "transmission": "auto",
- "vin": null,
- "mileage": 195176,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "mhev"
], - "power": 348,
- "video_url": null,
- "created_at": "2024-11-05T13:43:20.489Z",
- "updated_at": "2024-11-05T13:43:20.489Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "ro_RO",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "external_id": "eb41ca",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "config_url": null,
- "subscribe_price": null,
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "sold",
- "color_name": "Olive Paper",
- "color_canonical": "orange",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": null
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "393",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "738",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "396",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "867",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/389",
- "all": "/vehicles"
}
}
], - "meta": {
- "pagination": {
- "scaffold_url": "/vehicles?sort=-msrp_price&page=PAGE_NUM",
- "count": 2,
- "page": 1,
- "items": 2,
- "pages": 1,
- "last": 1,
- "from": 1,
- "to": 2,
- "prev": null,
- "next": null
}
}
}
Vehicles list is always paginated.
By default API will return up to 20 items but it can be overriden using items
parameter.
Here we use items=2
bo brevity but it's optional and set to 20 by default.
Paginated results include pagination metadata in the meta
object like this:
"meta": {
"pagination": {
//URL template to fetch additonal pages (PAGE_NUM) should be replaced by page number
"scaffold_url": "...?items=2&page=PAGE_NUM",
"count": 50, // Overall amount of vehicles in collection
"page": 3, // Current page number
"items": 2, // Amount of items page page
"pages": 25, // Amount of all pages
"last": 25, // Last page number
"from": 5, // index of first item on current page
"to": 6, // index of last item on current page
"prev": 2, // previous page number, null if no previous page
"next": 4 // next page number, null if no next page
}
}
page required | number Example: page=2 Pagination page to be requested (default: 1) |
items required | number Example: items=3 Amount of items per page (default: 20) |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: e23d5849-ecf2-4120-9247-7df2868d2363 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "401",
- "type": "vehicle",
- "attributes": {
- "version": "Grant Morrison's Animal Man",
- "drivetrain": "JLA: Earth 2",
- "production_year": 2009,
- "short_description": "Fuga libero eius quo quod quis earum quia voluptas eveniet.",
- "msrp_price": "41214.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Error deserunt non delectus praesentium totam dolor hic voluptatem possimus cupiditate ut exercitationem consectetur aperiam maiores nisi accusamus quia repellendus.",
- "state": "approved",
- "delivery_date": "2024-11-10",
- "transmission": "manual",
- "vin": null,
- "mileage": 334630,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "petrol"
], - "power": 275,
- "video_url": null,
- "created_at": "2024-11-05T13:43:20.819Z",
- "updated_at": "2024-11-05T13:43:20.819Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "en_GB",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "external_id": "3f8d0a",
- "footnote": "Cumque accusamus voluptatem eos quaerat dolores velit tempora id qui.",
- "config_url": null,
- "subscribe_price": null,
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "reserved",
- "color_name": "Cerulean Granite",
- "color_canonical": "orange",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": null
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "396",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "749",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "404",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "872",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/401",
- "all": "/vehicles"
}
}, - {
- "id": "402",
- "type": "vehicle",
- "attributes": {
- "version": "Doom Patrol",
- "drivetrain": "Superman: Red Son",
- "production_year": 2013,
- "short_description": "Voluptatem nemo et et facilis ullam dolor id non commodi.",
- "msrp_price": "29224.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Sed ab blanditiis doloribus eligendi tenetur hic et aut illo officia tempore eos ducimus placeat sed harum sint sunt quisquam.",
- "state": "used",
- "delivery_date": "2024-11-16",
- "transmission": "auto",
- "vin": null,
- "mileage": 670991,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "diesel"
], - "power": 280,
- "video_url": null,
- "created_at": "2024-11-05T13:43:20.831Z",
- "updated_at": "2024-11-05T13:43:20.831Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "en_GB",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "external_id": "b8a381",
- "footnote": "Voluptates et culpa voluptas ipsam corrupti sapiente officiis et inventore.",
- "config_url": null,
- "subscribe_price": null,
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "on_demand",
- "color_name": "Cerulean Granite",
- "color_canonical": "orange",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": null
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "396",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "749",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "404",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "872",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/402",
- "all": "/vehicles"
}
}
], - "meta": {
- "pagination": {
- "scaffold_url": "/vehicles?items=2&page=PAGE_NUM",
- "count": 50,
- "page": 3,
- "items": 2,
- "pages": 25,
- "last": 25,
- "from": 5,
- "to": 6,
- "prev": 2,
- "next": 4
}
}
}
Photos
are attached through relationship to Vehicle
like in example below.
Photos
order in request will be maintained.
Photos
can be assigne during Vehicle
creation and update actions.
Previously assigned photos will be deleted if their ids are ommited from relationship payload.
If payload photos section is empty then photos collection will be emptied!
To not make any changes to photos attached to vehicles it's relationship section in payload should be removed completly.
To inluce photos into the response additional parameter need to be passed in the url.
Photos object will be added in separate included
array in the payload as shown on the last example.
include=photos
id | number Example: 497 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: e22635ba-720c-4a04-972b-ae5c0acffcf8 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "relationships": {
- "photos": {
- "data": [
- {
- "id": 161
}, - {
- "id": 160
}, - {
- "id": 159
}
]
}, - "owner": {
- "data": {
- "id": 874
}
}
}
}
}
{- "data": {
- "id": "497",
- "type": "vehicle",
- "attributes": {
- "version": "Swamp Thing: The Anatomy Lesson",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2015,
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "msrp_price": "29619.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "approved",
- "delivery_date": "2024-12-04",
- "transmission": "manual",
- "vin": null,
- "mileage": 637032,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "petrol"
], - "power": 200,
- "video_url": null,
- "created_at": "2024-11-05T13:43:22.126Z",
- "updated_at": "2024-11-05T13:43:22.244Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "ro_RO",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": "incl_taxes",
- "external_id": "ebd63e",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "subscribe_price": "1700.0",
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": "0.0",
- "status": "sold",
- "color_name": "Cerulean Granite",
- "color_canonical": "red",
- "cover_photo": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY5LCJwdXIiOiJibG9iX2lkIn19--634aa7e7398e0c80eaf158657a94f532fb5ed3e0/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "cover_photo_thumb": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY5LCJwdXIiOiJibG9iX2lkIn19--634aa7e7398e0c80eaf158657a94f532fb5ed3e0/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "cover_photo_small": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY5LCJwdXIiOiJibG9iX2lkIn19--634aa7e7398e0c80eaf158657a94f532fb5ed3e0/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "cover_photo_medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY5LCJwdXIiOiJibG9iX2lkIn19--634aa7e7398e0c80eaf158657a94f532fb5ed3e0/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "cover_photo_big": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY5LCJwdXIiOiJibG9iX2lkIn19--634aa7e7398e0c80eaf158657a94f532fb5ed3e0/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "cover_photo_full": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY5LCJwdXIiOiJibG9iX2lkIn19--634aa7e7398e0c80eaf158657a94f532fb5ed3e0/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "cover_photo_quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY5LCJwdXIiOiJibG9iX2lkIn19--634aa7e7398e0c80eaf158657a94f532fb5ed3e0/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "cover_photo_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY5LCJwdXIiOiJibG9iX2lkIn19--634aa7e7398e0c80eaf158657a94f532fb5ed3e0/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg",
- "attachment_url": "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTY1LCJwdXIiOiJibG9iX2lkIn19--ee66a48ab7df2eec02e81218bcba946b4b0b63fe/1.pdf"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "398",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "801",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "455",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "874",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [
- {
- "id": "161",
- "type": "photo"
}, - {
- "id": "160",
- "type": "photo"
}, - {
- "id": "159",
- "type": "photo"
}
]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/497",
- "all": "/vehicles"
}
}
}
id | number Example: 502 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: fe94f74b-f29e-46db-9b7c-0ea6df4d7904 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "502",
- "type": "vehicle",
- "attributes": {
- "version": "Batman: The Long Halloween",
- "drivetrain": "Gotham Central",
- "production_year": 2007,
- "short_description": "Consequuntur aliquid reprehenderit voluptas qui tempore odit debitis ut quo.",
- "msrp_price": "33667.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Provident iusto deleniti reprehenderit et nihil similique maxime facilis dolorem dicta est eum laboriosam odio quidem sint libero quos dolorum.",
- "state": "approved",
- "delivery_date": "2024-12-02",
- "transmission": "auto",
- "vin": null,
- "mileage": 190469,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "petrol"
], - "power": 183,
- "video_url": null,
- "created_at": "2024-11-05T13:43:22.659Z",
- "updated_at": "2024-11-05T13:43:22.671Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Arcturan Megagrasshopper",
- "nameplate_brand_name": "Tesla",
- "owner_locale": "es_MX",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": "incl_taxes",
- "external_id": "331bf9",
- "footnote": "Accusamus reprehenderit cupiditate quia enim maxime ut nam earum ut.",
- "subscribe_price": "1700.0",
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "Tesla Arcturan Megagrasshopper",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "stock",
- "color_name": "Burgundy Silk",
- "color_canonical": "yellow",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTc0LCJwdXIiOiJibG9iX2lkIn19--16352c861f8f4e7f2aa1271738209ac4ff85a046/1.pdf"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "403",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "809",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "460",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "876",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [
- {
- "id": "131",
- "type": "vehicle_operation_request"
}
]
}
}, - "links": {
- "self": "/vehicles/502",
- "all": "/vehicles"
}
}, - "included": [
- {
- "id": "131",
- "type": "vehicle_operation_request",
- "attributes": {
- "request_type": "stock_transfer",
- "updated_at": "2024-11-05T13:43:22.676Z",
- "status": "pending",
- "owner_name": "Oberbrunner and Sons",
- "owner_id": 880,
- "requester_name": "Stoltenberg, Kris and Rath",
- "requester_id": 882,
- "listing_title": "Barbecue Ribs 86",
- "listing_id": 84,
- "transfer_to_name": "Barton Inc",
- "transfer_to_id": 877,
- "vehicle_id": 502,
- "vehicle_model_display_name": "Tesla Arcturan Megagrasshopper",
- "vehicle_owner_name": "Ritchie-Kunde",
- "vehicle_cover_photo_thumb": null
}
}
]
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: a50fb29e-3b11-4ba0-925b-9605ed0e79b9 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "503",
- "type": "vehicle",
- "attributes": {
- "version": "Swamp Thing: The Anatomy Lesson",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2015,
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "msrp_price": "30105.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "approved",
- "delivery_date": "2024-11-14",
- "transmission": "auto",
- "vin": null,
- "mileage": 10727,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "hev"
], - "power": 387,
- "video_url": null,
- "created_at": "2024-11-05T13:43:22.732Z",
- "updated_at": "2024-11-05T13:43:22.747Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "se_SE",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": "incl_taxes",
- "external_id": "955c23",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "subscribe_price": "1700.0",
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "stock",
- "color_name": "Cerulean Granite",
- "color_canonical": "blue",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTc1LCJwdXIiOiJibG9iX2lkIn19--08540114bcd29261ee72db271674e042b5933fb3/1.pdf"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "404",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "810",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "461",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "895",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/503",
- "all": "/vehicles"
}
}, - {
- "id": "504",
- "type": "vehicle",
- "attributes": {
- "version": "Swamp Thing: The Anatomy Lesson",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2015,
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "msrp_price": "30105.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "approved",
- "delivery_date": "2024-11-14",
- "transmission": "auto",
- "vin": null,
- "mileage": 10727,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "hev"
], - "power": 387,
- "video_url": null,
- "created_at": "2024-11-05T13:43:22.768Z",
- "updated_at": "2024-11-05T13:43:22.776Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "se_SE",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": "incl_taxes",
- "external_id": "955c23",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "subscribe_price": "1700.0",
- "type": "DraftVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "stock",
- "color_name": "Cerulean Granite",
- "color_canonical": "blue",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTc1LCJwdXIiOiJibG9iX2lkIn19--08540114bcd29261ee72db271674e042b5933fb3/1.pdf"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "404",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "810",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "461",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "895",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/504",
- "all": "/vehicles"
}
}
], - "meta": {
- "pagination": {
- "scaffold_url": "/vehicles?page=PAGE_NUM",
- "count": 2,
- "page": 1,
- "items": 2,
- "pages": 1,
- "last": 1,
- "from": 1,
- "to": 2,
- "prev": null,
- "next": null
}
}
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: fe227392-cb34-4b0f-8c3a-65aabf9fdac4 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "attributes": {
- "version": "Swamp Thing: The Anatomy Lesson",
- "drivetrain": "Grant Morrison's Animal Man",
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "production_year": 2015,
- "state": "approved",
- "status": "in_production",
- "transmission": "manual",
- "engine_type": [
- "mhev"
], - "delivery_date": "2024-11-30",
- "power": 181,
- "msrp_price": 48419,
- "interior_color": "Ebony",
- "mileage": 586971,
- "type": "ActiveVehicle",
- "metadata": null,
- "external_id": "862163",
- "features_optional": null,
- "features_standard": null,
- "color_id": 463,
- "attachment": "eyJfcmFpbHMiOnsiZGF0YSI6MTc3LCJwdXIiOiJibG9iX2lkIn19--564ee892ffc85b0a2e43e359c311be716d774f6f",
- "subscribe_price": 1700,
- "prices_type": "incl_taxes"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": 406
}
}, - "owner": {
- "data": {
- "id": 897
}
}, - "color": {
- "data": {
- "id": 463
}
}
}
}
}
{- "data": {
- "id": "506",
- "type": "vehicle",
- "attributes": {
- "version": "Swamp Thing: The Anatomy Lesson",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2015,
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "msrp_price": "48419.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "approved",
- "delivery_date": "2024-11-30",
- "transmission": "manual",
- "vin": null,
- "mileage": 586971,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "mhev"
], - "power": 181,
- "video_url": null,
- "created_at": "2024-11-05T13:43:22.905Z",
- "updated_at": "2024-11-05T13:43:22.911Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "es_MX",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": "test user",
- "price_hidden": false,
- "prices_type": "incl_taxes",
- "external_id": null,
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "subscribe_price": "1700.0",
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": "0.0",
- "status": "in_production",
- "color_name": "Cerulean Granite",
- "color_canonical": "bronze",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTc3LCJwdXIiOiJibG9iX2lkIn19--564ee892ffc85b0a2e43e359c311be716d774f6f/1.pdf"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "406",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "812",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "463",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "897",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/506",
- "all": "/vehicles"
}
}
}
id | number Example: 505 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 9f006b8d-76f3-4447-8b20-1982e39e9f62 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "505",
- "type": "vehicle",
- "attributes": {
- "version": "Swamp Thing: The Anatomy Lesson",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2015,
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "msrp_price": "43056.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "approved",
- "delivery_date": "2024-12-04",
- "transmission": "manual",
- "vin": null,
- "mileage": 131168,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "bev"
], - "power": 372,
- "video_url": null,
- "created_at": "2024-11-05T13:43:22.835Z",
- "updated_at": "2024-11-05T13:43:22.848Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "pl_PL",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": "incl_taxes",
- "external_id": "e81e3a",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "subscribe_price": "1700.0",
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "available_soon",
- "color_name": "Cerulean Granite",
- "color_canonical": "silver",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTc2LCJwdXIiOiJibG9iX2lkIn19--4862399f83aba9c6487dd7fe841c83d7aed65862/1.pdf"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "405",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "811",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "462",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "896",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/505",
- "all": "/vehicles"
}
}
}
id | number Example: 508 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 20dcd8f4-86f9-4408-b5c6-5c2cadc08209 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "attributes": {
- "version": "Starro",
- "drivetrain": "Grant Morrison's Animal Man",
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "production_year": 2015,
- "state": "approved",
- "status": "in_production",
- "transmission": "auto",
- "engine_type": [
- "diesel"
], - "delivery_date": "2024-11-16",
- "power": 411,
- "msrp_price": 46705,
- "interior_color": "Ebony",
- "mileage": 219435,
- "type": "ActiveVehicle",
- "metadata": null,
- "external_id": "e95f2c",
- "features_optional": null,
- "features_standard": null,
- "color_id": 466,
- "attachment": "eyJfcmFpbHMiOnsiZGF0YSI6MTgwLCJwdXIiOiJibG9iX2lkIn19--83351f4ddb57a72606d7cbacfb970ee342b8c2af",
- "subscribe_price": 1700,
- "prices_type": "incl_taxes"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": 409
}
}, - "owner": {
- "data": {
- "id": 901
}
}, - "color": {
- "data": {
- "id": 466
}
}
}
}
}
{- "data": {
- "id": "508",
- "type": "vehicle",
- "attributes": {
- "version": "Starro",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2015,
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "msrp_price": "46705.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "approved",
- "delivery_date": "2024-11-16",
- "transmission": "auto",
- "vin": null,
- "mileage": 219435,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "diesel"
], - "power": 411,
- "video_url": null,
- "created_at": "2024-11-05T13:43:23.111Z",
- "updated_at": "2024-11-05T13:43:23.152Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "es_MX",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": "incl_taxes",
- "external_id": "e95f2c",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "subscribe_price": "1700.0",
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": "0.0",
- "status": "in_production",
- "color_name": "Cerulean Granite",
- "color_canonical": "white",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTgwLCJwdXIiOiJibG9iX2lkIn19--83351f4ddb57a72606d7cbacfb970ee342b8c2af/1.pdf"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "409",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "815",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "466",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "901",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/508",
- "all": "/vehicles"
}
}
}
id | number Example: 516 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: f0ba835e-1ea4-4eba-917d-093bb6c08b09 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "516",
- "type": "vehicle",
- "attributes": {
- "version": "Swamp Thing: The Anatomy Lesson",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2015,
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "msrp_price": "30925.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "approved",
- "delivery_date": "2024-11-26",
- "transmission": "manual",
- "vin": null,
- "mileage": 130594,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "bev"
], - "power": 403,
- "video_url": null,
- "created_at": "2024-11-05T13:43:23.667Z",
- "updated_at": "2024-11-05T13:43:23.692Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "pl_PL",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": "incl_taxes",
- "external_id": "c9988e",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "subscribe_price": "1700.0",
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "delivery",
- "color_name": "Cerulean Granite",
- "color_canonical": "gray",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTg3LCJwdXIiOiJibG9iX2lkIn19--77694a52379f4b1b7c3eb9dd0128e5ca611c40e7/1.pdf"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "419",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "828",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "476",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "910",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "all": "/vehicles"
}
}
}
This endpoint will return duplicated data for a Vehicle
based on the Vehicle
with :id
passed in the url.
This endpoint returns only data, it will not create new Vehicle
record in database.
The exchanged data/relationships listed below will be omitted
id | number Example: 507 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 9e220d45-707c-4b2d-9ee8-2bf60a47dea1 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": null,
- "type": "vehicle",
- "attributes": {
- "version": "Swamp Thing: The Anatomy Lesson",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2015,
- "short_description": null,
- "msrp_price": "46633.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "approved",
- "delivery_date": "2024-11-18",
- "transmission": "manual",
- "vin": null,
- "mileage": 638381,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "phev_rev"
], - "power": 319,
- "video_url": null,
- "created_at": null,
- "updated_at": null,
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "se_SE",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": "test user",
- "price_hidden": false,
- "prices_type": "incl_taxes",
- "external_id": "e2b27b",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "subscribe_price": "1700.0",
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "demo",
- "color_name": "Cerulean Granite",
- "color_canonical": "white",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": null
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "408",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "814",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "465",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "900",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "all": "/vehicles"
}
}
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: ac705ac9-6744-4ac4-8f0d-0a171a7b4089 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
VIN,Order Number,Added date,Number of images,Owner account name,Car State,Car Status,Price,Model,Version,Fuel Type,Engine capacity,Engine power,Transmission,Color
uuid | string Example: a117302f-7b28-4667-a9b0-cb78fe27d364 |
vehicle_id | number Example: 28 |
Accept | any Example: application/vnd.api+json |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "28",
- "type": "vehicle",
- "attributes": {
- "nameplate_name": "Range Rover Evoque",
- "trim": "HSE",
- "drivetrain": "P300",
- "state": "used",
- "msrp_price": "23398.0",
- "currency": "USD",
- "sale_price": null,
- "engine_type": [
- "phev"
], - "power": 367,
- "power_unit": "bhp",
- "mileage": 334673,
- "mileage_unit": "km",
- "engine_capacity": 2998,
- "disclaimers": { },
- "model_year": 2010,
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_address": "99667 Major Corners, Antoniomouth, LA 39348-8794",
- "vin": "XXXYYYZZZ",
- "features_standard": [
- "Standard Feature 0",
- "Standard Feature 1"
], - "features_optional": [ ],
- "cover_photo": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NywicHVyIjoiYmxvYl9pZCJ9fQ==--3e54cc4b7f2a7a134e6d3e6c11ca125fedd1fdcb/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "primary_cta_type": "contact",
- "secondary_cta_url": null,
- "secondary_cta_type": null,
- "color_name": "Cyan Copper"
}
}
}
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
X-Company-UUID | any Example: bad-uuid-value |
{- "data": {
- "attributes": {
- "file": "eyJfcmFpbHMiOnsiZGF0YSI6MTkwLCJwdXIiOiJibG9iX2lkIn19--e5081c65839340de746ef980be0829cc5a286e8a"
}
}
}
{- "data": {
- "id": null,
- "type": "active_vehicle",
- "attributes": {
- "version": null,
- "drivetrain": null,
- "production_year": null,
- "short_description": null,
- "msrp_price": null,
- "sale_price": null,
- "monthly_price": null,
- "long_description": null,
- "state": "new",
- "delivery_date": null,
- "transmission": "auto",
- "vin": null,
- "mileage": 0,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": null,
- "power": null,
- "video_url": null,
- "created_at": null,
- "updated_at": null,
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [
- {
- "category": "performance",
- "code": "020BE",
- "label": "Czerwone zaciski hamulcowe"
}, - {
- "code": "020KA",
- "label": "Brake Booster - Performance"
}, - {
- "code": "021AO",
- "label": "Standard Battery"
}, - {
- "code": "022CF",
- "label": "A/C Refrigerant - HF01234YF without IHX"
}, - {
- "code": "022DB",
- "label": "Label - A/C Charge"
}, - {
- "code": "025EZ",
- "label": "Voice Control"
}, - {
- "category": "infotainment",
- "code": "025LN",
- "label": "Meridian Surround Sound 825W - 17 głośników"
}, - {
- "code": "025NE",
- "label": "NGI Head Unit - Mid"
}, - {
- "code": "025OA",
- "label": "Navigation Centre"
}, - {
- "code": "025QA",
- "label": "Telematics TCU Module - ROW"
}, - {
- "code": "025QF",
- "label": "SOS/Assistance Call"
}, - {
- "code": "026FK",
- "label": "S/B - Elr/PLP LHD Pretensioner"
}, - {
- "code": "028FE",
- "label": "Towing Eye Cover - Black"
}, - {
- "category": null,
- "code": "028MG",
- "label": "Dojazdowe koło zapasowe SV"
}, - {
- "code": "029BA",
- "label": "Tyres Pirelli"
}, - {
- "code": "030BV",
- "label": "Ext Mirror Finish - Black Gloss"
}, - {
- "code": "030NW",
- "label": "Sensor Occupant (ROW) with PACOS)"
}, - {
- "code": "030YX",
- "label": "265/40 R22 All Season Tyre"
}, - {
- "code": "031BG",
- "label": "External mirrors convex"
}, - {
- "code": "031CG",
- "label": "Auto Dimming Rear View Mirror"
}, - {
- "code": "033GP",
- "label": "Cooled/heated front seats"
}, - {
- "code": "033IP",
- "label": "Drv/Pas Elec Ft Seat Memory"
}, - {
- "code": "033IR",
- "label": "Rear Seat Recline - Power"
}, - {
- "code": "033LM",
- "label": "RR Centre Armrest & Cupholder"
}, - {
- "code": "033LP",
- "label": "Split Fold Rear Seat - 40:20:40"
}, - {
- "code": "033LQ",
- "label": "Cushion Extension"
}, - {
- "code": "033WU",
- "label": "20-Way D&P Mem Mass Htd/Cld Front St Pk"
}, - {
- "code": "033XJ",
- "label": "Heated Rear Seats"
}, - {
- "code": "033XL",
- "label": "40:20:40 Fld Pwr Rcln Cntr A/Rst Htd Pk"
}, - {
- "code": "035AB",
- "label": "Fire Extinguisher"
}, - {
- "code": "036AC",
- "label": "Euro/Russia 3YR Connected Service Pack"
}, - {
- "code": "037AX",
- "label": "Downpipe - Sport"
}, - {
- "code": "038AP",
- "label": "KPH Speedometer"
}, - {
- "code": "040AQ",
- "label": "Heated Front Washer Jets (Windscreen)"
}, - {
- "code": "046AJ",
- "label": "Tank Pet w/o Leak Detection Std Filter"
}, - {
- "category": "interior",
- "code": "048BW",
- "label": "Metalowa nakładka na próg bagażnika"
}, - {
- "code": "049AS",
- "label": "Steering Column Lock"
}, - {
- "code": "053AP",
- "label": "Filler Neck Pet Non ORVR"
}, - {
- "code": "053BI",
- "label": "Fuel Filler Flap - Central Locking"
}, - {
- "category": null,
- "code": "054AQ",
- "label": "Pakiet Power Socket 1"
}, - {
- "code": "055AF",
- "label": "Non Locking Wheel Nuts"
}, - {
- "code": "056AY",
- "label": "Warning Triangle"
}, - {
- "code": "056DC",
- "label": "Service Interval 12 Months"
}, - {
- "code": "056EE",
- "label": "Service Distance 26,000 km"
}, - {
- "code": "057JL",
- "label": "Fam Badge-Range Rover Chrome Blk Knurled"
}, - {
- "code": "062DB",
- "label": "TPMS Warning Light Spec 20%"
}, - {
- "code": "064BU",
- "label": "Daytime Running Lamps"
}, - {
- "category": "interior",
- "code": "064EC",
- "label": "Oświetlenie wnętrza"
}, - {
- "code": "064HD",
- "label": "Grille - Graphite Atlas"
}, - {
- "code": "064HL",
- "label": "Headlamp Operation LHD -right justify"
}, - {
- "code": "066AC",
- "label": "Passive Entry/Push Button Start"
}, - {
- "code": "076CW",
- "label": "Dual Note Electric Horn"
}, - {
- "code": "076DF",
- "label": "434 MHz/non UWB Door Lock Frequency"
}, - {
- "code": "076EI",
- "label": "Double Locking"
}, - {
- "code": "076ER",
- "label": "Security sounder - No BBUS"
}, - {
- "code": "077BB",
- "label": "Vehicle Protection Cat 2"
}, - {
- "category": "exterior",
- "code": "080AN",
- "label": "Dach kontrastowy, czarny"
}, - {
- "code": "080ES",
- "label": "Bumpers- Autobiography"
}, - {
- "code": "080GL",
- "label": "Bumper Lower Valance Narvik Black"
}, - {
- "code": "080ST",
- "label": "Bodyside Cladding - Body Colour"
}, - {
- "code": "080TF",
- "label": "Side Vents - Graphite"
}, - {
- "code": "081EK",
- "label": "Bonnet Louvre - Graphite"
}, - {
- "code": "086IB",
- "label": "Forward Facing Camera"
}, - {
- "code": "087XL",
- "label": "Nav - Reg 1 Europe"
}, - {
- "category": null,
- "code": "088IE",
- "label": "System Terrain Response z programem Dynamicznym"
}, - {
- "code": "088JB",
- "label": "Handbook - Leather Cover"
}, - {
- "category": "interior",
- "code": "088JW",
- "label": "Shadow Aluminium"
}, - {
- "code": "095DB",
- "label": "Export Shipping ROW"
}, - {
- "code": "095JB",
- "label": "NGPTSQ (Low)"
}, - {
- "code": "095RD",
- "label": "Mapcare - Euro/Russ 3yr"
}, - {
- "code": "096FA",
- "label": "Fuel Label - ROW"
}, - {
- "code": "096TA",
- "label": "Pictoral -Air bag label -ROW,Jap,Mexico"
}, - {
- "code": "096TL",
- "label": "E Approval Label"
}, - {
- "code": "096UF",
- "label": "Tyre Recommended Plate - non English"
}, - {
- "code": "097AJ",
- "label": "Whole Vehicle Type Approval"
}, - {
- "code": "099AA",
- "label": "5 Door Estate"
}, - {
- "code": "100LR",
- "label": "Land Rover"
}, - {
- "code": "101AG",
- "label": "Standard Wheelbase (SWB)"
}, - {
- "code": "109AA",
- "label": "All Wheel Drive"
}, - {
- "code": "121AE",
- "label": "Engine Cooling Fan 850W"
}, - {
- "code": "129AC",
- "label": "No Onboard TV"
}, - {
- "code": "130AB",
- "label": "Air Cleaner- Dry /Single Stage"
}, - {
- "code": "145BM",
- "label": "Vin prefix position 10 - L"
}, - {
- "code": "145CE",
- "label": "2020 Model Year Parts"
}, - {
- "code": "153BC",
- "label": "Extra Engine Cooling"
}, - {
- "code": "180AC",
- "label": "Seat Cushion Power Fore/Aft"
}, - {
- "code": "180BC",
- "label": "Seat Cushion Power Height"
}, - {
- "code": "180CA",
- "label": "Seat Cushion Power Tilt"
}, - {
- "code": "180DB",
- "label": "Seat Squab Power Recline"
}, - {
- "code": "180FC",
- "label": "Front Headrest Power Height"
}, - {
- "code": "180GA",
- "label": "Front Headrest Manual Winged"
}, - {
- "code": "180HA",
- "label": "Seat Massage Front"
}, - {
- "code": "180JA",
- "label": "Front Seat Bolster - Power"
}, - {
- "code": "180KB",
- "label": "Front Seat Lumbar - 4 Way"
}, - {
- "code": "200DN",
- "label": "5L AJ133G2 P8 S/C SV"
}, - {
- "code": "219AA",
- "label": "KSK Instrument Panel Harness"
}, - {
- "code": "220AA",
- "label": "KSK Cabin Harness"
}, - {
- "code": "252SF",
- "label": "LHD"
}, - {
- "category": "seats",
- "code": "300BD",
- "label": "Wentylowane fotele przednie regulowane elektrycznie w 20 kierunkach z pamięcią ustawień i masażem, tylne podgrzewane"
}, - {
- "code": "300SE",
- "label": "L560 - Velar"
}, - {
- "code": "370AC",
- "label": "D7a"
}, - {
- "code": "800PG",
- "label": "Poland"
}, - {
- "code": "900AD",
- "label": "Solihull Assembly (UK)"
}, - {
- "code": "HM560",
- "label": "L560 5.0 SC AJ133 AWD 5DR SWB"
}, - {
- "code": "352QU",
- "label": "SVAutobiography Dyna 550PS Auto"
}, - {
- "code": "002BX",
- "label": "Polish Literature Pack"
}, - {
- "category": null,
- "code": "011BJ",
- "label": "InControl Remote"
}, - {
- "category": null,
- "code": "020JF",
- "label": "Przednie i tylne tarcze hamulcowe 395mm"
}, - {
- "code": "021HF",
- "label": "Trim level VR1"
}, - {
- "category": "interior",
- "code": "022BC",
- "label": "Klimatyzacja czterostrefowa"
}, - {
- "category": null,
- "code": "025JB",
- "label": "Radio DAB"
}, - {
- "category": null,
- "code": "025RC",
- "label": "Pro Services"
}, - {
- "category": null,
- "code": "027CW",
- "label": "System Adaptive Dynamics"
}, - {
- "category": null,
- "code": "027DC",
- "label": "Aktywny mechanizm różnicowy sterowany elektronicznie z systemem Torque Vectoring by Braking"
}, - {
- "category": null,
- "code": "027DE",
- "label": "Zawieszenie sportowe"
}, - {
- "category": "interior",
- "code": "030DH",
- "label": "Zamykany, chłodzony schowek przedni"
}, - {
- "category": null,
- "code": "030IA",
- "label": "Opony wielosezonowe"
}, - {
- "category": "exterior",
- "code": "030NK",
- "label": "Lusterka zewnętrzne, elektrochromatyczne, składane, podgrzewane"
}, - {
- "code": "030NT",
- "label": "Auto High Beam Assist"
}, - {
- "code": "032BU",
- "label": "Ebony Headlining"
}, - {
- "category": "convenience",
- "code": "032DV",
- "label": "Podgrzewana kierownica"
}, - {
- "category": "seats",
- "code": "032HN",
- "label": "Pakiet skórzane wnętrze SV z kontrastowym przeszyciem"
}, - {
- "category": "interior",
- "code": "032LH",
- "label": "Sportowa kierownica skórzana"
}, - {
- "category": "exterior",
- "code": "032MQ",
- "label": "Pakiet SV"
}, - {
- "code": "033TC",
- "label": "Windsor Leather Perforated AB Pattern"
}, - {
- "category": null,
- "code": "038ID",
- "label": "Interaktywny zestaw wskaźników 12,3\""
}, - {
- "category": "interior",
- "code": "041CZ",
- "label": "Otwierany dach panoramiczny"
}, - {
- "code": "041GJ",
- "label": "Version - SVA"
}, - {
- "category": "interior",
- "code": "048CB",
- "label": "Podświetlane (tylko z przodu), metalowe nakładki progowe drzwi"
}, - {
- "category": "interior",
- "code": "049AP",
- "label": "Elektrycznie regulowana kolumna kierownicza"
}, - {
- "category": "interior",
- "code": "051AJ",
- "label": "Jasne nakładki na pedały"
}, - {
- "code": "054EB",
- "label": "PowerPack 01"
}, - {
- "category": "exterior",
- "code": "057PL",
- "label": "Oznaczenie SVAutobiography Dynamic"
}, - {
- "code": "057YB",
- "label": "Badge Removal"
}, - {
- "category": null,
- "code": "062AD",
- "label": "System monitorowania ciśnienia w oponach (TPMS)"
}, - {
- "category": null,
- "code": "064AP",
- "label": "Światła przeciwmgielne"
}, - {
- "code": "064BV",
- "label": "Headlamp Power Washers"
}, - {
- "category": null,
- "code": "065EC",
- "label": "Układ hamowania awaryjnego"
}, - {
- "category": "exterior",
- "code": "070AR",
- "label": "Spoiler pokrywy bagażnika"
}, - {
- "category": "exterior",
- "code": "070AV",
- "label": "Elektrycznie sterowana pokrywa bagażnika"
}, - {
- "category": null,
- "code": "076EL",
- "label": "Czujnik włamania"
}, - {
- "category": "interior",
- "code": "078CP",
- "label": "Aluminiowe łopatki zmiany biegów"
}, - {
- "category": "interior",
- "code": "079DR",
- "label": "Maty gumowe super Premium"
}, - {
- "category": "safety",
- "code": "086BG",
- "label": "Asystent urzymywania pasie ruchu"
}, - {
- "category": "safety",
- "code": "086DC",
- "label": "System rozpozawania znaków drogowych i adaptacyjny ogranicznik prędkości"
}, - {
- "category": "safety",
- "code": "086DH",
- "label": "System monitorujący zmęczenie kierowcy"
}, - {
- "category": "safety",
- "code": "086GM",
- "label": "Asystent martwego pola widzenia"
}, - {
- "category": "safety",
- "code": "086KB",
- "label": "System monitorowania ruchu poprzecznego podczas cofania"
}, - {
- "category": "safety",
- "code": "086MB",
- "label": "Asystent parkowania"
}, - {
- "category": null,
- "code": "087AU",
- "label": "Nawigacja Pro"
}, - {
- "category": null,
- "code": "087CB",
- "label": "Układ hamowania awaryjnego z dużych prędkości"
}, - {
- "code": "088HE",
- "label": "Headlining - Suedecloth"
}, - {
- "category": "interior",
- "code": "089AQ",
- "label": "Chromowane nakładki boczne deski rozdzielczej"
}, - {
- "category": null,
- "code": "184AB",
- "label": "Konfigurowalny tryb dynamiczny"
}, - {
- "category": null,
- "code": "189AF",
- "label": "Czujniki parkowania 360⁰"
}
], - "features_optional": [
- {
- "category": null,
- "code": "017TE",
- "label": "Pakiet Driver Assist",
- "price": "4130.00"
}, - {
- "category": "interior",
- "code": "034BA",
- "label": "Dźwigienki składania tylnych foteli w bagazniku",
- "price": "730.00"
}, - {
- "code": "065AJ",
- "label": "ACC + Adaptive Lane Control"
}, - {
- "category": "exterior",
- "code": "040AK",
- "label": "Podgrzewana szyba czołowa",
- "price": "1890.00"
}, - {
- "category": "safety",
- "code": "086GC",
- "label": "System kamer Surround"
}, - {
- "category": "interior",
- "code": "022GB",
- "label": "Jonizator powietrza w kabinie",
- "price": "730.00"
}, - {
- "category": "exterior",
- "code": "047AB",
- "label": "Przyciemnione szyby tylne",
- "price": "2540.00"
}, - {
- "category": null,
- "code": "028EJ",
- "label": "Elektrycznie wysuwany hak holowniczy",
- "price": "6970.00"
}, - {
- "category": "exterior",
- "code": "031WH",
- "label": "22\" Style 5113, 5 split-spoke, Gloss Dark Grey",
- "price": "8390.00"
}, - {
- "category": "lights",
- "code": "064QD",
- "label": "Reflektory Matrix -Laser LED ze światłami do jazdy dziennej LED",
- "price": "11100.00"
}
], - "nameplate_name": "Range Rover Velar",
- "nameplate_brand_name": "Land Rover",
- "owner_locale": "pl-PL",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": null,
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "external_id": null,
- "footnote": null,
- "config_url": null,
- "subscribe_price": null,
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "Land Rover Range Rover Velar",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "stock",
- "color_name": "Eiger Grey",
- "color_canonical": "gray",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": null
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "426",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "839",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "482",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "919",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "all": "/vehicles"
}
}, - "included": [ ]
}
Represents vocabulary (and translations) stored in the database and used in feature suggestions. In fact, the database representation of Vocabulary
is FeatureSuggestion
but to make it more adjusted to the actual needs of the Vocabulary tab of the application, it is a separate resource in the API with separate data structure definition.
Vocabulary list is always paginated.
By default API will return up to 20 items.
Paginated results include pagination metadata in the meta
object like this:
"meta": {
"pagination": {
//URL template to fetch additonal pages (PAGE_NUM) should be replaced by page number
"scaffold_url": "...?page=PAGE_NUM",
"count": 50, // Overall amount of vehicles in collection
"page": 3, // Current page number
"items": 20, // Amount of items page page
"pages": 3, // Amount of all pages
"last": 3, // Last page number
"from": 20, // index of first item on current page
"to": 30, // index of last item on current page
"prev": 2, // previous page number, null if no previous page
"next": 4 // next page number, null if no next page
}
}
page required | number Example: page=2 Pagination page to be requested (default: 1) |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 4919fa70-fb4d-4b7a-ae06-de099283e1a5 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "meta": {
- "pagination": {
- "scaffold_url": "/vocabulary?page=PAGE_NUM",
- "count": 51,
- "page": 3,
- "items": 0,
- "pages": 2,
- "last": 2,
- "from": 0,
- "to": 0,
- "prev": 2,
- "next": null
}
}, - "data": [ ]
}
Filtering mechanism utilises quite powerful Ransack gem engine
filter
attributeTo filter results one should use filter[]
GET parameter
object with each search/filter criteria as a separate parameter entry.
this parameters entries should adher to format of filter[:attribute_filtered:_:matcher_operator:]=value1
.
attribute_filter
partIn general it's possible to filter by all object parameters that can be seen in
a typical API response. For vocabulary it includes code
, category
, brand_code
etc.
matcher
partFull list of all available matcher operators can be seen here: https://github.com/activerecord-hackery/ransack#search-matchers
Most usefull and important ones are:
Matcher | Description |
---|---|
_eq | Equality |
_gt | Greater then |
_gteq | Greater than or equal |
_lt | Less then |
_lteq | Less than or equal |
_start | Starts with |
_i_cont | Contains value with (case insensitive) |
_cont | Contains value with (case sensitive) |
_in | Match any values in an array. Eg: filter[name_in][]=Alice&filter[name_in][]=Bob |
search
allows you to filter objects by several attributes at once category
, code
, original_description
, label
or brand_code
It should be pair with macher from above for example filter[search_cont]=mazda
filter[search_cont] required | string Example: filter[search_cont]=020BE Filtred items to be requested |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 6d9a7861-c78c-4013-a5e5-895954149901 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "127",
- "type": "vocabulary",
- "attributes": {
- "code": "0739A1",
- "original_description": null,
- "category": "infotainment",
- "brand_code": "mazda",
- "owner_id": 935,
- "translation": "Crucio St. Mungo's Hospital for Magical Maladies and Injuries"
}
}, - {
- "id": "133",
- "type": "vocabulary",
- "attributes": {
- "code": "114422",
- "original_description": null,
- "category": "infotainment",
- "brand_code": "mazda",
- "owner_id": 935,
- "translation": "Reparo Honeydukes"
}
}, - {
- "id": "126",
- "type": "vocabulary",
- "attributes": {
- "code": "193CE6",
- "original_description": null,
- "category": "convenience",
- "brand_code": "mazda",
- "owner_id": 935,
- "translation": "Expelliarmus Magical Menagerie"
}
}, - {
- "id": "129",
- "type": "vocabulary",
- "attributes": {
- "code": "19A8FE",
- "original_description": null,
- "category": "interior",
- "brand_code": "mazda",
- "owner_id": 935,
- "translation": "Crucio Florean Fortescue's Ice Cream Parlour"
}
}, - {
- "id": "131",
- "type": "vocabulary",
- "attributes": {
- "code": "31FFA1",
- "original_description": null,
- "category": "seats",
- "brand_code": "mazda",
- "owner_id": 935,
- "translation": "Expecto Patronum Durmstrang"
}
}, - {
- "id": "130",
- "type": "vocabulary",
- "attributes": {
- "code": "527093",
- "original_description": null,
- "category": "performance",
- "brand_code": "mazda",
- "owner_id": 935,
- "translation": "Alohomora Eeylops Owl Emporium"
}
}, - {
- "id": "128",
- "type": "vocabulary",
- "attributes": {
- "code": "612CB7",
- "original_description": null,
- "category": "interior",
- "brand_code": "mazda",
- "owner_id": 935,
- "translation": "Reparo Slug and Jiggers Apothecary"
}
}, - {
- "id": "134",
- "type": "vocabulary",
- "attributes": {
- "code": "933C5E",
- "original_description": null,
- "category": "seats",
- "brand_code": "mazda",
- "owner_id": 935,
- "translation": "Avada Kedavra Slug and Jiggers Apothecary"
}
}, - {
- "id": "132",
- "type": "vocabulary",
- "attributes": {
- "code": "E56C3A",
- "original_description": null,
- "category": "exterior",
- "brand_code": "mazda",
- "owner_id": 935,
- "translation": "Crucio Weasleys' Wizard Wheezes"
}
}, - {
- "id": "125",
- "type": "vocabulary",
- "attributes": {
- "code": "EEF4EB",
- "original_description": null,
- "category": "convenience",
- "brand_code": "mazda",
- "owner_id": 935,
- "translation": "Reparo Zonko's Joke Shop"
}
}
], - "meta": {
- "pagination": {
- "scaffold_url": "/vocabulary?filter%5Bsearch_cont%5D=mazda&page=PAGE_NUM",
- "count": 10,
- "page": 1,
- "items": 10,
- "pages": 1,
- "last": 1,
- "from": 1,
- "to": 10,
- "prev": null,
- "next": null
}
}
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: b658af2c-277c-4fd7-873f-1902e4de8d1f |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "137",
- "type": "vocabulary",
- "attributes": {
- "code": "A1",
- "original_description": "Lumos Gambol and Japes",
- "category": "interior",
- "brand_code": "jlr",
- "owner_id": 938,
- "translation": "Wingardium Leviosa Stalls"
}
}, - {
- "id": "138",
- "type": "vocabulary",
- "attributes": {
- "code": "B1",
- "original_description": null,
- "category": "performance",
- "brand_code": "jlr",
- "owner_id": 937,
- "translation": "Obliviate Hogwarts"
}
}, - {
- "id": "140",
- "type": "vocabulary",
- "attributes": {
- "code": "C1",
- "original_description": "Avada Kedavra Slug and Jiggers Apothecary",
- "category": "interior",
- "brand_code": "jlr",
- "owner_id": 937,
- "translation": "Accio Potage's Cauldron Shop"
}
}
], - "meta": {
- "pagination": {
- "scaffold_url": "/vocabulary?page=PAGE_NUM",
- "count": 3,
- "page": 1,
- "items": 3,
- "pages": 1,
- "last": 1,
- "from": 1,
- "to": 3,
- "prev": null,
- "next": null
}
}
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 0805a8c3-63d5-4ba3-9f50-6009c7585717 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "attributes": {
- "code": "ABC",
- "category": "lights",
- "label": "Some label",
- "brand_code": "jlr"
}
}
}
{- "data": {
- "id": "143",
- "type": "vocabulary",
- "attributes": {
- "code": "ABC",
- "original_description": null,
- "category": "lights",
- "brand_code": "jlr",
- "owner_id": 940,
- "translation": "Some label"
}
}
}
code | string Example: A1 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: f4175d93-5a7b-4b4e-b5a3-5cd231f399d5 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "attributes": {
- "category": "lights",
- "label": "Lampy Matrycowe LED",
- "brand_code": "jlr"
}
}
}
{- "data": {
- "id": "149",
- "type": "vocabulary",
- "attributes": {
- "code": "A1",
- "original_description": "Lumos Gambol and Japes",
- "category": "lights",
- "brand_code": "jlr",
- "owner_id": 949,
- "translation": "Lampy Matrycowe LED"
}
}
}
All actions performed on Vehicle
objects need to happen in context of Company
object.
The Company is determined based on X-Company-UUID
header value. This value should contain uuid
attribute of
Company
obejct.
If header is not present API will raise 400 - Bad Request
response with information about missing header
If header is present but no Company with provided uuid
values is present in the database the 404 - Not Found
response is given.
Accept | any Example: application/vnd.api+json |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
X-Company-UUID | any Example: bad-uuid-value |
{- "errors": [
- {
- "status": 400,
- "source": null,
- "title": "Bad Request",
- "detail": "X-Company-UUID header is missing"
}
]
}
Vehicle Standard and optional feature lists are stored in separate attributes (features_standard
and features_optional
) as validated JSON array.
Validation happens based on JSON Schema defined like this:
{
"type": "array",
"items": {
"type": "object",
"required": [
"label"
],
"properties": {
"code": {
"type": "string"
},
"label": {
"type": "string",
"minLength": 1
},
"category": {
"type": "string",
"enum": [
"exterior",
"interior",
"lights",
"safety",
"wheels",
"seats",
"performance",
"infotainment",
"convenience"
]
}
},
"additionalProperties": false
}
}
To put it more clearly each feature shoudl be simple object with string properties.
Only one property is required (label
). Properties code
and category
are optional.
label
needs to contain at least 1 character, meaning it cannot be emoty string!
category
values are expected to come from closed list of values:
"exterior", "interior", "lights", "safety", "wheels", "seats", "performance", "infotainment", "convenience"
[
{
"code": "XXX123",
"label": "Heated Windshield",
"category": "convenience"
},
{
"label": "22' Bespoke Wheels",
"category": "wheels"
},
{
"code": "YYYZZZ",
"label": "Custom Paint"
},
]
Each JSON Schema validation error will be returned as a separate validation error with human readable description message.
Validation Example can be seen bellow in test cases.
NOTE: Those messages should not be presented to the end user. Their intent is to be used for debuging purposes only!
id | number Example: 380 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 2da610e6-6c2e-4ede-af5d-83a1d877287c |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "attributes": {
- "features_optional": [
- {
- "label": "Feature Label",
- "category": "lights"
}
]
}, - "relationships": {
- "owner": {
- "data": {
- "id": 860
}
}
}
}
}
{- "data": {
- "id": "380",
- "type": "vehicle",
- "attributes": {
- "version": "Multiversity",
- "drivetrain": "Detective Comics",
- "production_year": 2018,
- "short_description": "Eius amet ut natus molestiae aliquid dignissimos soluta omnis esse.",
- "msrp_price": "29086.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Molestiae ex nihil earum amet natus eos excepturi labore consectetur veritatis sit veniam corrupti qui vel facilis est et maiores.",
- "state": "approved",
- "delivery_date": "2024-12-02",
- "transmission": "manual",
- "vin": null,
- "mileage": 568320,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "diesel"
], - "power": 218,
- "video_url": null,
- "created_at": "2024-11-05T13:43:20.048Z",
- "updated_at": "2024-11-05T13:43:20.079Z",
- "power_unit": "bhp",
- "currency": "FJD",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [
- {
- "label": "Feature Label",
- "category": "lights"
}
], - "nameplate_name": "Human",
- "nameplate_brand_name": "Mitsubishi",
- "owner_locale": "en_GB",
- "owner_name": "Cummings-Wiza",
- "owner_city": "New Cliff",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "56510 Nedra Roads\nMileston",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "external_id": "f5acd6",
- "footnote": "Quae expedita possimus laboriosam quis sint aspernatur consectetur enim error.",
- "config_url": null,
- "subscribe_price": null,
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "Mitsubishi Human",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": "0.0",
- "status": "reserved",
- "color_name": "Chocolate Iron",
- "color_canonical": "silver",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": null
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "380",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "718",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "387",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "860",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/380",
- "all": "/vehicles"
}
}
}
Filtering mechanism utilises quite powerful Ransack gem engine
Prefilters are parameters used to filter vehicles before any counting or dynamic filtering takes place. They are simple filters without any predicates. There are two perfilters:
forced_brands_names - filters vehicles by brand names separated by comma, ex. forced_brands_names=Land Rover,Jaguar
forced_dealer_codes - filters vehicles by owner dealer codes, separated by comma, ex. forced_dealer_codes=50001,50002
forced_statuses - filters vehicles by statuses, separated by comma, ex. forced_dealer_codes=reserved,sold
filter
attributeTo filter results one should use filter[]
GET parameter
object with each search/filter criteria as a separate parameter entry.
this parameters entries should adher to format of filter[:attribute_filtered:_:matcher_operator:]=value1
.
attribute_filter
partIn general it's possible to filter by all object parameters that can be seen in
a typical API response. For vehicles it includes version
, drivetrain
, production_year
etc.
However, there's one non-standard attribute that you can filter by - display_price
. It filters/sorts vehicles
by the actual Vehicle price (so it checks whether a vehicle has sale_price
value - if not, it takes msrp_price
for that vehicle as the current price).
On top of that one can filter based on selected related models by concatenating relationship name and related obejct attribute. For example Nameplate
name is not stored in the Vehicle
model but it can ge used as filter parameter as nameplate_name
.
This kind of relationship searches can go deeper. Since Brand
is related to Nameplate
not Vechile
itself, to filter vehicles by Brand
name we should user nameplate_brand_name
attributes.
matcher
partFull list of all available matcher operators can be seen here: https://github.com/activerecord-hackery/ransack#search-matchers
Most usefull and important ones are:
Matcher | Description |
---|---|
_eq | Equality |
_gt | Greater then |
_gteq | Greater than or equal |
_lt | Less then |
_lteq | Less than or equal |
_start | Starts with |
_i_cont | Contains value with (case insensitive) |
_cont | Contains value with (case sensitive) |
_in | Match any values separated by comma Eg: filter[name_in]=Bob,Alice |
To return vehicles which match one of multiple filters, or
operator has to be used. For example, to search for vehicles which vin
or order_number
start with some value filter should looke like this:
filter[vin_or_order_number_start]=123
engine_types
and owner_dealers_codes
are specific parameters due to the fact they are stored as array in the database so
simple string-based cont
predicates will not work. To filter based on this array content new predicate _includes
was added. So to filter for all "Petrol" powered vehicles request should look like this:
filter[engine_type_includes]=petrol
This will return both hybrid and non-hybrid Vehicles as long as they also include petrol in engine_type
array
Multiple engine types can be searched separated by comma:
filter[engine_type_includes]=petrol,bev
Will return petrol as well as bev engines
financing options
is a specific parameter based on scope and does not have any predicates. To use it chosen values separated by comma have to be provided:
filter[financing_options]=cash,lease,rent
status
filter is based on two attributes. It filters vehicles by status
attribute and also checks lock_id
which indicates that vehicle is soft-locked. In case it is soft-locked it is searched as it would be of reserved
status. Because of that status
filter is processed outside ransack and accepts _eq
and _in
predicates only.
To Search Vechiles with production year beetween 2015 and 2018:
filter[production_year_gteq]=2015&filter[production_year_lteq]=2018
To Search all Jaguars
filter[nameplate_brand_name_eq]=Jaguar
To Search all Vechiles with HSE in version
filter[version_i_cont]=HSE
filter required | object |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: bc666635-8046-4fdf-ba83-3b9721b1fe7b |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "383",
- "type": "vehicle",
- "attributes": {
- "version": "Kingdom Come",
- "drivetrain": "JLA: Tower Of Babel",
- "production_year": 2014,
- "short_description": "Nemo commodi dolorem quam similique cumque sint quia iure quia.",
- "msrp_price": "25064.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "used",
- "delivery_date": "2024-11-17",
- "transmission": "auto",
- "vin": null,
- "mileage": 882701,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "petrol",
- "phev"
], - "power": 226,
- "video_url": null,
- "created_at": "2024-11-05T13:43:20.234Z",
- "updated_at": "2024-11-05T13:43:20.234Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Hooloovoo",
- "nameplate_brand_name": "MG",
- "owner_locale": "pl_PL",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "external_id": "6f6718",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "config_url": null,
- "subscribe_price": null,
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Hooloovoo",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "stock",
- "color_name": "Olive Paper",
- "color_canonical": "orange",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": null
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "383",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "725",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "390",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "863",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/383",
- "all": "/vehicles"
}
}
], - "meta": {
- "pagination": {
- "scaffold_url": "/vehicles?filter%5Bengine_type_includes%5D=phev&page=PAGE_NUM",
- "count": 1,
- "page": 1,
- "items": 1,
- "pages": 1,
- "last": 1,
- "from": 1,
- "to": 1,
- "prev": null,
- "next": null
}
}
}
Simliast to Filtering the sorting mechanism utilises quite powerful Ransack gem engine
sort
attributeTo sort results one should use sort
GET parameter as a list of collumns that records should be sorted by.
By default sorting works in natura ascending order. To use the ascending order (usefull for prices) column name should
be predicated with minus (-
, U+002D HYPHEN-MINUS) character
To Sort Vechiles in ascending order by msrp_price
sort=msrp_price
To Sort Vechiles in descending order by msrp_price
sort=-msrp_price
To Sort Vechiles in ascending order by production year and then in descending order by msrp_price
sort=production_year,-msrp_price
sort required | string Example: sort=msrp_price Comma separated list of columns to sort vehicles by |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: bec52dd6-ddab-4a8f-910e-42b40d2542fc |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "390",
- "type": "vehicle",
- "attributes": {
- "version": "Kingdom Come",
- "drivetrain": "Multiversity",
- "production_year": 2011,
- "short_description": "Molestiae eos et illo dignissimos ullam eius corporis dolor eum.",
- "msrp_price": "2000.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Molestiae illum amet provident hic qui quia odio voluptatem optio est nisi ut deserunt suscipit a reiciendis architecto qui vitae.",
- "state": "used",
- "delivery_date": "2024-12-01",
- "transmission": "manual",
- "vin": null,
- "mileage": 358397,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "mhev"
], - "power": 194,
- "video_url": null,
- "created_at": "2024-11-05T13:43:20.504Z",
- "updated_at": "2024-11-05T13:43:20.504Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "ro_RO",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "external_id": "ca26b5",
- "footnote": "Fugiat quo animi veniam similique laborum modi quis deleniti dicta.",
- "config_url": null,
- "subscribe_price": null,
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "on_demand",
- "color_name": "Olive Marble",
- "color_canonical": "bronze",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": null
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "393",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "738",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "397",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "867",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/390",
- "all": "/vehicles"
}
}, - {
- "id": "389",
- "type": "vehicle",
- "attributes": {
- "version": "Teen Titans: The Judas Contract",
- "drivetrain": "Batman: Year One",
- "production_year": 2011,
- "short_description": "Nemo ea fugiat esse error optio excepturi quia voluptas quia.",
- "msrp_price": "1000.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "new",
- "delivery_date": "2024-11-15",
- "transmission": "auto",
- "vin": null,
- "mileage": 195176,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "mhev"
], - "power": 348,
- "video_url": null,
- "created_at": "2024-11-05T13:43:20.489Z",
- "updated_at": "2024-11-05T13:43:20.489Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "ro_RO",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "external_id": "eb41ca",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "config_url": null,
- "subscribe_price": null,
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "sold",
- "color_name": "Olive Paper",
- "color_canonical": "orange",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": null
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "393",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "738",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "396",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "867",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/389",
- "all": "/vehicles"
}
}
], - "meta": {
- "pagination": {
- "scaffold_url": "/vehicles?sort=-msrp_price&page=PAGE_NUM",
- "count": 2,
- "page": 1,
- "items": 2,
- "pages": 1,
- "last": 1,
- "from": 1,
- "to": 2,
- "prev": null,
- "next": null
}
}
}
Vehicles list is always paginated.
By default API will return up to 20 items but it can be overriden using items
parameter.
Here we use items=2
bo brevity but it's optional and set to 20 by default.
Paginated results include pagination metadata in the meta
object like this:
"meta": {
"pagination": {
//URL template to fetch additonal pages (PAGE_NUM) should be replaced by page number
"scaffold_url": "...?items=2&page=PAGE_NUM",
"count": 50, // Overall amount of vehicles in collection
"page": 3, // Current page number
"items": 2, // Amount of items page page
"pages": 25, // Amount of all pages
"last": 25, // Last page number
"from": 5, // index of first item on current page
"to": 6, // index of last item on current page
"prev": 2, // previous page number, null if no previous page
"next": 4 // next page number, null if no next page
}
}
page required | number Example: page=2 Pagination page to be requested (default: 1) |
items required | number Example: items=3 Amount of items per page (default: 20) |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: e23d5849-ecf2-4120-9247-7df2868d2363 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "401",
- "type": "vehicle",
- "attributes": {
- "version": "Grant Morrison's Animal Man",
- "drivetrain": "JLA: Earth 2",
- "production_year": 2009,
- "short_description": "Fuga libero eius quo quod quis earum quia voluptas eveniet.",
- "msrp_price": "41214.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Error deserunt non delectus praesentium totam dolor hic voluptatem possimus cupiditate ut exercitationem consectetur aperiam maiores nisi accusamus quia repellendus.",
- "state": "approved",
- "delivery_date": "2024-11-10",
- "transmission": "manual",
- "vin": null,
- "mileage": 334630,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "petrol"
], - "power": 275,
- "video_url": null,
- "created_at": "2024-11-05T13:43:20.819Z",
- "updated_at": "2024-11-05T13:43:20.819Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "en_GB",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "external_id": "3f8d0a",
- "footnote": "Cumque accusamus voluptatem eos quaerat dolores velit tempora id qui.",
- "config_url": null,
- "subscribe_price": null,
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "reserved",
- "color_name": "Cerulean Granite",
- "color_canonical": "orange",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": null
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "396",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "749",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "404",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "872",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/401",
- "all": "/vehicles"
}
}, - {
- "id": "402",
- "type": "vehicle",
- "attributes": {
- "version": "Doom Patrol",
- "drivetrain": "Superman: Red Son",
- "production_year": 2013,
- "short_description": "Voluptatem nemo et et facilis ullam dolor id non commodi.",
- "msrp_price": "29224.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Sed ab blanditiis doloribus eligendi tenetur hic et aut illo officia tempore eos ducimus placeat sed harum sint sunt quisquam.",
- "state": "used",
- "delivery_date": "2024-11-16",
- "transmission": "auto",
- "vin": null,
- "mileage": 670991,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "diesel"
], - "power": 280,
- "video_url": null,
- "created_at": "2024-11-05T13:43:20.831Z",
- "updated_at": "2024-11-05T13:43:20.831Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "en_GB",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": null,
- "external_id": "b8a381",
- "footnote": "Voluptates et culpa voluptas ipsam corrupti sapiente officiis et inventore.",
- "config_url": null,
- "subscribe_price": null,
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "on_demand",
- "color_name": "Cerulean Granite",
- "color_canonical": "orange",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": null
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "396",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "749",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "404",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "872",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/402",
- "all": "/vehicles"
}
}
], - "meta": {
- "pagination": {
- "scaffold_url": "/vehicles?items=2&page=PAGE_NUM",
- "count": 50,
- "page": 3,
- "items": 2,
- "pages": 25,
- "last": 25,
- "from": 5,
- "to": 6,
- "prev": 2,
- "next": 4
}
}
}
Photos
are attached through relationship to Vehicle
like in example below.
Photos
order in request will be maintained.
Photos
can be assigne during Vehicle
creation and update actions.
Previously assigned photos will be deleted if their ids are ommited from relationship payload.
If payload photos section is empty then photos collection will be emptied!
To not make any changes to photos attached to vehicles it's relationship section in payload should be removed completly.
To inluce photos into the response additional parameter need to be passed in the url.
Photos object will be added in separate included
array in the payload as shown on the last example.
include=photos
id | number Example: 497 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: e22635ba-720c-4a04-972b-ae5c0acffcf8 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "relationships": {
- "photos": {
- "data": [
- {
- "id": 161
}, - {
- "id": 160
}, - {
- "id": 159
}
]
}, - "owner": {
- "data": {
- "id": 874
}
}
}
}
}
{- "data": {
- "id": "497",
- "type": "vehicle",
- "attributes": {
- "version": "Swamp Thing: The Anatomy Lesson",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2015,
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "msrp_price": "29619.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "approved",
- "delivery_date": "2024-12-04",
- "transmission": "manual",
- "vin": null,
- "mileage": 637032,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "petrol"
], - "power": 200,
- "video_url": null,
- "created_at": "2024-11-05T13:43:22.126Z",
- "updated_at": "2024-11-05T13:43:22.244Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "ro_RO",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": "incl_taxes",
- "external_id": "ebd63e",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "subscribe_price": "1700.0",
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": "0.0",
- "status": "sold",
- "color_name": "Cerulean Granite",
- "color_canonical": "red",
- "cover_photo": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY5LCJwdXIiOiJibG9iX2lkIn19--634aa7e7398e0c80eaf158657a94f532fb5ed3e0/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "cover_photo_thumb": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY5LCJwdXIiOiJibG9iX2lkIn19--634aa7e7398e0c80eaf158657a94f532fb5ed3e0/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "cover_photo_small": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY5LCJwdXIiOiJibG9iX2lkIn19--634aa7e7398e0c80eaf158657a94f532fb5ed3e0/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "cover_photo_medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY5LCJwdXIiOiJibG9iX2lkIn19--634aa7e7398e0c80eaf158657a94f532fb5ed3e0/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "cover_photo_big": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY5LCJwdXIiOiJibG9iX2lkIn19--634aa7e7398e0c80eaf158657a94f532fb5ed3e0/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "cover_photo_full": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY5LCJwdXIiOiJibG9iX2lkIn19--634aa7e7398e0c80eaf158657a94f532fb5ed3e0/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "cover_photo_quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY5LCJwdXIiOiJibG9iX2lkIn19--634aa7e7398e0c80eaf158657a94f532fb5ed3e0/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "cover_photo_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTY5LCJwdXIiOiJibG9iX2lkIn19--634aa7e7398e0c80eaf158657a94f532fb5ed3e0/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg",
- "attachment_url": "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTY1LCJwdXIiOiJibG9iX2lkIn19--ee66a48ab7df2eec02e81218bcba946b4b0b63fe/1.pdf"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "398",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "801",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "455",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "874",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [
- {
- "id": "161",
- "type": "photo"
}, - {
- "id": "160",
- "type": "photo"
}, - {
- "id": "159",
- "type": "photo"
}
]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/497",
- "all": "/vehicles"
}
}
}
id | number Example: 502 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: fe94f74b-f29e-46db-9b7c-0ea6df4d7904 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "502",
- "type": "vehicle",
- "attributes": {
- "version": "Batman: The Long Halloween",
- "drivetrain": "Gotham Central",
- "production_year": 2007,
- "short_description": "Consequuntur aliquid reprehenderit voluptas qui tempore odit debitis ut quo.",
- "msrp_price": "33667.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Provident iusto deleniti reprehenderit et nihil similique maxime facilis dolorem dicta est eum laboriosam odio quidem sint libero quos dolorum.",
- "state": "approved",
- "delivery_date": "2024-12-02",
- "transmission": "auto",
- "vin": null,
- "mileage": 190469,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "petrol"
], - "power": 183,
- "video_url": null,
- "created_at": "2024-11-05T13:43:22.659Z",
- "updated_at": "2024-11-05T13:43:22.671Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Arcturan Megagrasshopper",
- "nameplate_brand_name": "Tesla",
- "owner_locale": "es_MX",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": "incl_taxes",
- "external_id": "331bf9",
- "footnote": "Accusamus reprehenderit cupiditate quia enim maxime ut nam earum ut.",
- "subscribe_price": "1700.0",
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "Tesla Arcturan Megagrasshopper",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "stock",
- "color_name": "Burgundy Silk",
- "color_canonical": "yellow",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTc0LCJwdXIiOiJibG9iX2lkIn19--16352c861f8f4e7f2aa1271738209ac4ff85a046/1.pdf"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "403",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "809",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "460",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "876",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [
- {
- "id": "131",
- "type": "vehicle_operation_request"
}
]
}
}, - "links": {
- "self": "/vehicles/502",
- "all": "/vehicles"
}
}, - "included": [
- {
- "id": "131",
- "type": "vehicle_operation_request",
- "attributes": {
- "request_type": "stock_transfer",
- "updated_at": "2024-11-05T13:43:22.676Z",
- "status": "pending",
- "owner_name": "Oberbrunner and Sons",
- "owner_id": 880,
- "requester_name": "Stoltenberg, Kris and Rath",
- "requester_id": 882,
- "listing_title": "Barbecue Ribs 86",
- "listing_id": 84,
- "transfer_to_name": "Barton Inc",
- "transfer_to_id": 877,
- "vehicle_id": 502,
- "vehicle_model_display_name": "Tesla Arcturan Megagrasshopper",
- "vehicle_owner_name": "Ritchie-Kunde",
- "vehicle_cover_photo_thumb": null
}
}
]
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: a50fb29e-3b11-4ba0-925b-9605ed0e79b9 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "503",
- "type": "vehicle",
- "attributes": {
- "version": "Swamp Thing: The Anatomy Lesson",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2015,
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "msrp_price": "30105.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "approved",
- "delivery_date": "2024-11-14",
- "transmission": "auto",
- "vin": null,
- "mileage": 10727,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "hev"
], - "power": 387,
- "video_url": null,
- "created_at": "2024-11-05T13:43:22.732Z",
- "updated_at": "2024-11-05T13:43:22.747Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "se_SE",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": "incl_taxes",
- "external_id": "955c23",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "subscribe_price": "1700.0",
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "stock",
- "color_name": "Cerulean Granite",
- "color_canonical": "blue",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTc1LCJwdXIiOiJibG9iX2lkIn19--08540114bcd29261ee72db271674e042b5933fb3/1.pdf"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "404",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "810",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "461",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "895",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/503",
- "all": "/vehicles"
}
}, - {
- "id": "504",
- "type": "vehicle",
- "attributes": {
- "version": "Swamp Thing: The Anatomy Lesson",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2015,
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "msrp_price": "30105.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "approved",
- "delivery_date": "2024-11-14",
- "transmission": "auto",
- "vin": null,
- "mileage": 10727,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "hev"
], - "power": 387,
- "video_url": null,
- "created_at": "2024-11-05T13:43:22.768Z",
- "updated_at": "2024-11-05T13:43:22.776Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "se_SE",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": "incl_taxes",
- "external_id": "955c23",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "subscribe_price": "1700.0",
- "type": "DraftVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "stock",
- "color_name": "Cerulean Granite",
- "color_canonical": "blue",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTc1LCJwdXIiOiJibG9iX2lkIn19--08540114bcd29261ee72db271674e042b5933fb3/1.pdf"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "404",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "810",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "461",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "895",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/504",
- "all": "/vehicles"
}
}
], - "meta": {
- "pagination": {
- "scaffold_url": "/vehicles?page=PAGE_NUM",
- "count": 2,
- "page": 1,
- "items": 2,
- "pages": 1,
- "last": 1,
- "from": 1,
- "to": 2,
- "prev": null,
- "next": null
}
}
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: fe227392-cb34-4b0f-8c3a-65aabf9fdac4 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "attributes": {
- "version": "Swamp Thing: The Anatomy Lesson",
- "drivetrain": "Grant Morrison's Animal Man",
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "production_year": 2015,
- "state": "approved",
- "status": "in_production",
- "transmission": "manual",
- "engine_type": [
- "mhev"
], - "delivery_date": "2024-11-30",
- "power": 181,
- "msrp_price": 48419,
- "interior_color": "Ebony",
- "mileage": 586971,
- "type": "ActiveVehicle",
- "metadata": null,
- "external_id": "862163",
- "features_optional": null,
- "features_standard": null,
- "color_id": 463,
- "attachment": "eyJfcmFpbHMiOnsiZGF0YSI6MTc3LCJwdXIiOiJibG9iX2lkIn19--564ee892ffc85b0a2e43e359c311be716d774f6f",
- "subscribe_price": 1700,
- "prices_type": "incl_taxes"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": 406
}
}, - "owner": {
- "data": {
- "id": 897
}
}, - "color": {
- "data": {
- "id": 463
}
}
}
}
}
{- "data": {
- "id": "506",
- "type": "vehicle",
- "attributes": {
- "version": "Swamp Thing: The Anatomy Lesson",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2015,
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "msrp_price": "48419.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "approved",
- "delivery_date": "2024-11-30",
- "transmission": "manual",
- "vin": null,
- "mileage": 586971,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "mhev"
], - "power": 181,
- "video_url": null,
- "created_at": "2024-11-05T13:43:22.905Z",
- "updated_at": "2024-11-05T13:43:22.911Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "es_MX",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": "test user",
- "price_hidden": false,
- "prices_type": "incl_taxes",
- "external_id": null,
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "subscribe_price": "1700.0",
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": "0.0",
- "status": "in_production",
- "color_name": "Cerulean Granite",
- "color_canonical": "bronze",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTc3LCJwdXIiOiJibG9iX2lkIn19--564ee892ffc85b0a2e43e359c311be716d774f6f/1.pdf"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "406",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "812",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "463",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "897",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/506",
- "all": "/vehicles"
}
}
}
id | number Example: 505 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 9f006b8d-76f3-4447-8b20-1982e39e9f62 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "505",
- "type": "vehicle",
- "attributes": {
- "version": "Swamp Thing: The Anatomy Lesson",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2015,
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "msrp_price": "43056.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "approved",
- "delivery_date": "2024-12-04",
- "transmission": "manual",
- "vin": null,
- "mileage": 131168,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "bev"
], - "power": 372,
- "video_url": null,
- "created_at": "2024-11-05T13:43:22.835Z",
- "updated_at": "2024-11-05T13:43:22.848Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "pl_PL",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": "incl_taxes",
- "external_id": "e81e3a",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "subscribe_price": "1700.0",
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "available_soon",
- "color_name": "Cerulean Granite",
- "color_canonical": "silver",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTc2LCJwdXIiOiJibG9iX2lkIn19--4862399f83aba9c6487dd7fe841c83d7aed65862/1.pdf"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "405",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "811",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "462",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "896",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/505",
- "all": "/vehicles"
}
}
}
id | number Example: 508 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 20dcd8f4-86f9-4408-b5c6-5c2cadc08209 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "attributes": {
- "version": "Starro",
- "drivetrain": "Grant Morrison's Animal Man",
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "production_year": 2015,
- "state": "approved",
- "status": "in_production",
- "transmission": "auto",
- "engine_type": [
- "diesel"
], - "delivery_date": "2024-11-16",
- "power": 411,
- "msrp_price": 46705,
- "interior_color": "Ebony",
- "mileage": 219435,
- "type": "ActiveVehicle",
- "metadata": null,
- "external_id": "e95f2c",
- "features_optional": null,
- "features_standard": null,
- "color_id": 466,
- "attachment": "eyJfcmFpbHMiOnsiZGF0YSI6MTgwLCJwdXIiOiJibG9iX2lkIn19--83351f4ddb57a72606d7cbacfb970ee342b8c2af",
- "subscribe_price": 1700,
- "prices_type": "incl_taxes"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": 409
}
}, - "owner": {
- "data": {
- "id": 901
}
}, - "color": {
- "data": {
- "id": 466
}
}
}
}
}
{- "data": {
- "id": "508",
- "type": "vehicle",
- "attributes": {
- "version": "Starro",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2015,
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "msrp_price": "46705.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "approved",
- "delivery_date": "2024-11-16",
- "transmission": "auto",
- "vin": null,
- "mileage": 219435,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "diesel"
], - "power": 411,
- "video_url": null,
- "created_at": "2024-11-05T13:43:23.111Z",
- "updated_at": "2024-11-05T13:43:23.152Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "es_MX",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": "incl_taxes",
- "external_id": "e95f2c",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "subscribe_price": "1700.0",
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": "0.0",
- "status": "in_production",
- "color_name": "Cerulean Granite",
- "color_canonical": "white",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTgwLCJwdXIiOiJibG9iX2lkIn19--83351f4ddb57a72606d7cbacfb970ee342b8c2af/1.pdf"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "409",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "815",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "466",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "901",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "self": "/vehicles/508",
- "all": "/vehicles"
}
}
}
id | number Example: 516 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: f0ba835e-1ea4-4eba-917d-093bb6c08b09 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "516",
- "type": "vehicle",
- "attributes": {
- "version": "Swamp Thing: The Anatomy Lesson",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2015,
- "short_description": "Nemo commodi debitis quam sunt repellat similique quia iure quia.",
- "msrp_price": "30925.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "approved",
- "delivery_date": "2024-11-26",
- "transmission": "manual",
- "vin": null,
- "mileage": 130594,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "bev"
], - "power": 403,
- "video_url": null,
- "created_at": "2024-11-05T13:43:23.667Z",
- "updated_at": "2024-11-05T13:43:23.692Z",
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "pl_PL",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": null,
- "price_hidden": false,
- "prices_type": "incl_taxes",
- "external_id": "c9988e",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "subscribe_price": "1700.0",
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "delivery",
- "color_name": "Cerulean Granite",
- "color_canonical": "gray",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": "/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTg3LCJwdXIiOiJibG9iX2lkIn19--77694a52379f4b1b7c3eb9dd0128e5ca611c40e7/1.pdf"
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "419",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "828",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "476",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "910",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "all": "/vehicles"
}
}
}
This endpoint will return duplicated data for a Vehicle
based on the Vehicle
with :id
passed in the url.
This endpoint returns only data, it will not create new Vehicle
record in database.
The exchanged data/relationships listed below will be omitted
id | number Example: 507 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 9e220d45-707c-4b2d-9ee8-2bf60a47dea1 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": null,
- "type": "vehicle",
- "attributes": {
- "version": "Swamp Thing: The Anatomy Lesson",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2015,
- "short_description": null,
- "msrp_price": "46633.0",
- "sale_price": null,
- "monthly_price": null,
- "long_description": "Maxime temporibus sed consectetur aut id doloremque sint a vitae perferendis quidem illo cumque vel et assumenda cupiditate porro eaque.",
- "state": "approved",
- "delivery_date": "2024-11-18",
- "transmission": "manual",
- "vin": null,
- "mileage": 638381,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "phev_rev"
], - "power": 319,
- "video_url": null,
- "created_at": null,
- "updated_at": null,
- "power_unit": "bhp",
- "currency": "GBP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Mattress",
- "nameplate_brand_name": "MG",
- "owner_locale": "se_SE",
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "owner_contact_details": "31019 Velvet Rest\nLake Irafurt",
- "interior_color": "Ebony",
- "created_by": "test user",
- "price_hidden": false,
- "prices_type": "incl_taxes",
- "external_id": "e2b27b",
- "footnote": "Et aspernatur libero quisquam et fuga quas est et minima.",
- "subscribe_price": "1700.0",
- "type": "ActiveVehicle",
- "order_number": null,
- "model_display_name": "MG Mattress",
- "price_metadata": { },
- "contains_drive_away_prices": false,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "demo",
- "color_name": "Cerulean Granite",
- "color_canonical": "white",
- "cover_photo": null,
- "cover_photo_thumb": null,
- "cover_photo_small": null,
- "cover_photo_medium": null,
- "cover_photo_big": null,
- "cover_photo_full": null,
- "cover_photo_quarter_hd": null,
- "cover_photo_hd": null,
- "attachment_url": null
}, - "relationships": {
- "nameplate": {
- "data": {
- "id": "408",
- "type": "nameplate"
}
}, - "brand": {
- "data": {
- "id": "814",
- "type": "brand"
}
}, - "color": {
- "data": {
- "id": "465",
- "type": "color"
}
}, - "owner": {
- "data": {
- "id": "900",
- "type": "company"
}
}, - "listings": {
- "data": [ ]
}, - "photos": {
- "data": [ ]
}, - "pending_operation_requests": {
- "data": [ ]
}
}, - "links": {
- "all": "/vehicles"
}
}
}
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: ac705ac9-6744-4ac4-8f0d-0a171a7b4089 |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
VIN,Order Number,Added date,Number of images,Owner account name,Car State,Car Status,Price,Model,Version,Fuel Type,Engine capacity,Engine power,Transmission,Color
uuid | string Example: a117302f-7b28-4667-a9b0-cb78fe27d364 |
vehicle_id | number Example: 28 |
Accept | any Example: application/vnd.api+json |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "28",
- "type": "vehicle",
- "attributes": {
- "nameplate_name": "Range Rover Evoque",
- "trim": "HSE",
- "drivetrain": "P300",
- "state": "used",
- "msrp_price": "23398.0",
- "currency": "USD",
- "sale_price": null,
- "engine_type": [
- "phev"
], - "power": 367,
- "power_unit": "bhp",
- "mileage": 334673,
- "mileage_unit": "km",
- "engine_capacity": 2998,
- "disclaimers": { },
- "model_year": 2010,
- "owner_name": "Ritchie-Kunde",
- "owner_city": "Hermistonshire",
- "owner_address": "99667 Major Corners, Antoniomouth, LA 39348-8794",
- "vin": "XXXYYYZZZ",
- "features_standard": [
- "Standard Feature 0",
- "Standard Feature 1"
], - "features_optional": [ ],
- "cover_photo": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NywicHVyIjoiYmxvYl9pZCJ9fQ==--3e54cc4b7f2a7a134e6d3e6c11ca125fedd1fdcb/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "primary_cta_type": "contact",
- "secondary_cta_url": null,
- "secondary_cta_type": null,
- "color_name": "Cyan Copper"
}
}
}
Accept | any Example: application/vnd.api+json |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "91",
- "type": "brand",
- "attributes": {
- "name": "Dodge"
}, - "links": {
- "nameplates": "/public_api/brands/91/nameplates"
}
}
]
}
id | number Example: 92 |
Accept | any Example: application/vnd.api+json |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "49",
- "type": "nameplate",
- "attributes": {
- "name": "Vl'Hurg",
- "model_group": null
}
}, - {
- "id": "50",
- "type": "nameplate",
- "attributes": {
- "name": "Damogran Frond Crested Eagle",
- "model_group": null
}
}, - {
- "id": "51",
- "type": "nameplate",
- "attributes": {
- "name": "Sarkopsi",
- "model_group": null
}
}
]
}
Is used to store config for origin urls.
It contains config_type
attribute with possible values default
, cash
, lease
, subscription
and additional
. Each origin can have single config per each type.
GET /public_api/company_config/all
This endpoint is used to fetch configs for declared origin. By default it returns all configs for that origin.
To fetch config for the specific origin, it has to be declared in Company-Config
header . For example:
Company-Config: 'https://jaguar.com'
param | example | type | required | description |
---|---|---|---|---|
config_type | additional,cash | string | no | used to filter config types, multiple types have to be separated by comma |
Response is an array of configs for origin declared in the header. Each of the contains attributes data
and config_type
Accept | any Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5 |
{- "data": [
- {
- "id": "1",
- "type": "company_config",
- "attributes": {
- "data": {
- "a": 1
}, - "config_type": "default"
}
}, - {
- "id": "2",
- "type": "company_config",
- "attributes": {
- "data": {
- "a": 1
}, - "config_type": "additional"
}
}, - {
- "id": "3",
- "type": "company_config",
- "attributes": {
- "data": {
- "a": 1
}, - "config_type": "cash"
}
}
]
}
GET /public_api/company_config/(:config_type)
This endpoint is used to fetch a specific config for declared origin. By default it returns default config for that origin.
To fetch config for the specific origin, it has to be declared in Company-Config
header . For example:
Company-Config: 'https://jaguar.com'
param | example | type | required | description |
---|---|---|---|---|
config_type | additional | string | no | used to fetch config of specific type |
Response is an config object containing attributes data
and config_type
Accept | any Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5 |
{- "data": {
- "id": "26",
- "type": "company_config",
- "attributes": {
- "data": {
- "a": 1
}, - "config_type": "default"
}
}
}
/public_api
section is intended to be freely used on all websites and provide data to StockLocator widgets.
Its behaviour is mostly modeled based on private /vehicles
controller but lacks authorization, returns only active vehicles and is
optimized for typical website usecases.
Basic required attribute to use it is Listing
object uuid
value.
As far as I know this value is currently not displayed on the SL frontend (to be fixed) so ask Badyl for it if you need
one :)
config_url required | string |
Accept | any Example: application/json |
Content-Type | any Example: application/json |
{- "data": {
- "nameplate_name": "Discovery",
- "nameplate_brand_name": "Land Rover",
- "nameplate_model_group": "Discovery",
- "version": "DISCOVERY S",
- "gross_price": "370010.00",
- "gross_currency": "EUR-PL",
- "net_price": "370010.00",
- "net_currency": "EUR-PL",
- "color": "Fuji White",
- "engine_type": [
- "diesel",
- "mhev"
], - "delivery_date": "To be confirmed"
}
}
Filtering mechanism utilises quite powerful Ransack gem engine
Prefilters are parameters used to filter vehicles before any counting or dynamic filtering takes place. They are simple filters without any predicates. There are two perfilters:
forced_brands_names - filters vehicles by brand names separated by comma, ex. forced_brands_names=Land Rover,Jaguar
forced_dealer_codes - filters vehicles by owner dealer codes, separated by comma, ex. forced_dealer_codes=50001,50002
forced_statuses - filters vehicles by statuses, separated by comma, ex. forced_dealer_codes=reserved,sold
filter
attributeTo filter results one should use filter[]
GET parameter
object with each search/filter criteria as a separate parameter entry.
this parameters entries should adher to format of filter[:attribute_filtered:_:matcher_operator:]=value1
.
attribute_filter
partIn general it's possible to filter by all object parameters that can be seen in
a typical API response. For vehicles it includes version
, drivetrain
, production_year
etc.
However, there's one non-standard attribute that you can filter by - display_price
. It filters/sorts vehicles
by the actual Vehicle price (so it checks whether a vehicle has sale_price
value - if not, it takes msrp_price
for that vehicle as the current price).
On top of that one can filter based on selected related models by concatenating relationship name and related obejct attribute. For example Nameplate
name is not stored in the Vehicle
model but it can ge used as filter parameter as nameplate_name
.
This kind of relationship searches can go deeper. Since Brand
is related to Nameplate
not Vechile
itself, to filter vehicles by Brand
name we should user nameplate_brand_name
attributes.
matcher
partFull list of all available matcher operators can be seen here: https://github.com/activerecord-hackery/ransack#search-matchers
Most usefull and important ones are:
Matcher | Description |
---|---|
_eq | Equality |
_gt | Greater then |
_gteq | Greater than or equal |
_lt | Less then |
_lteq | Less than or equal |
_start | Starts with |
_i_cont | Contains value with (case insensitive) |
_cont | Contains value with (case sensitive) |
_in | Match any values separated by comma Eg: filter[name_in]=Bob,Alice |
To return vehicles which match one of multiple filters, or
operator has to be used. For example, to search for vehicles which vin
or order_number
start with some value filter should looke like this:
filter[vin_or_order_number_start]=123
engine_types
and owner_dealers_codes
are specific parameters due to the fact they are stored as array in the database so
simple string-based cont
predicates will not work. To filter based on this array content new predicate _includes
was added. So to filter for all "Petrol" powered vehicles request should look like this:
filter[engine_type_includes]=petrol
This will return both hybrid and non-hybrid Vehicles as long as they also include petrol in engine_type
array
Multiple engine types can be searched separated by comma:
filter[engine_type_includes]=petrol,bev
Will return petrol as well as bev engines
financing options
is a specific parameter based on scope and does not have any predicates. To use it chosen values separated by comma have to be provided:
filter[financing_options]=cash,lease,rent
status
filter is based on two attributes. It filters vehicles by status
attribute and also checks lock_id
which indicates that vehicle is soft-locked. In case it is soft-locked it is searched as it would be of reserved
status. Because of that status
filter is processed outside ransack and accepts _eq
and _in
predicates only.
To Search Vechiles with production year beetween 2015 and 2018:
filter[production_year_gteq]=2015&filter[production_year_lteq]=2018
To Search all Jaguars
filter[nameplate_brand_name_eq]=Jaguar
To Search all Vechiles with HSE in version
filter[version_i_cont]=HSE
uuids | string Example: 4cf63b78-0752-45d9-9c26-5c0432a5989a |
filter required | object |
Accept | any Example: application/vnd.api+json |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "59",
- "type": "listing_vehicles",
- "attributes": {
- "version": "JLA: Earth 2",
- "drivetrain": "Superman For All Seasons",
- "production_year": 2021,
- "short_description": "Et repellat rem est id aperiam quo inventore quasi fuga.",
- "state": "approved",
- "delivery_date": "2024-11-21",
- "transmission": "manual",
- "vin": null,
- "mileage": 4846,
- "engine_capacity": null,
- "engine_type": [
- "diesel"
], - "power": 140,
- "video_url": null,
- "created_at": "2024-11-05T13:42:57.966Z",
- "power_unit": "bhp",
- "currency": "KPW",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "nameplate_name": "Vl'Hurg",
- "nameplate_brand_name": "Brand 1",
- "owner_city": "Faustinotown",
- "price_hidden": false,
- "prices_type": null,
- "external_id": "e93de7",
- "model_display_name": "Brand 1 Vl'Hurg",
- "order_number": null,
- "nameplate_model_group": "Discovery",
- "metadata": null,
- "owner_phone": "+263 1-893-221-6168 x6372",
- "owner_zipcode": null,
- "owner_address": "Apt. 517 3007 Herb Motorway, South Candra, SD 33134-9739",
- "owner_state": null,
- "owner_metadata": { },
- "interior_color": "Ebony",
- "price_metadata": { },
- "code5000": null,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "sold",
- "color_name": "Red Silk",
- "color_canonical": "silver",
- "owner_name": "O'Hara, Morissette and Goyette",
- "msrp_price": "180000.0",
- "sale_price": null,
- "monthly_price": null,
- "subscribe_price": "9000.0",
- "photos": [ ],
- "cover_photo": null,
- "cover_photo_medium": null,
- "cover_photo_hd": null,
- "cover_photo_quarter_hd": null,
- "owner_opening_hours": "<p>Mon-Fri: 9:00 - 19:00<br>\nSat: 11:00 - 18:00<br>\nSun: Closed</p>\n",
- "owner_contact_details": "<p>502 Keely Pine<br>\nPort Tabetha</p>\n",
- "financing_options": {
- "cash": true,
- "lease": false,
- "rent": true
}
}
}, - {
- "id": "58",
- "type": "listing_vehicles",
- "attributes": {
- "version": "Jack Kirby's New Gods",
- "drivetrain": "Doom Patrol",
- "production_year": 2021,
- "short_description": "Autem et saepe itaque a et nemo et autem in.",
- "state": "new",
- "delivery_date": "2024-11-14",
- "transmission": "manual",
- "vin": null,
- "mileage": 13706,
- "engine_capacity": null,
- "engine_type": [
- "diesel"
], - "power": 200,
- "video_url": null,
- "created_at": "2024-11-05T13:42:57.943Z",
- "power_unit": "bhp",
- "currency": "COP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "nameplate_name": "Nameplate 4",
- "nameplate_brand_name": "Brand 2",
- "owner_city": "Bonnieton",
- "price_hidden": false,
- "prices_type": null,
- "external_id": "64f6a1",
- "model_display_name": "Brand 2 Nameplate 4",
- "order_number": null,
- "nameplate_model_group": null,
- "metadata": null,
- "owner_phone": "+675 847.191.1373 x705",
- "owner_zipcode": null,
- "owner_address": "37396 Hoppe Pines, Maggioport, DE 25181",
- "owner_state": null,
- "owner_metadata": { },
- "interior_color": "Ebony",
- "price_metadata": { },
- "code5000": null,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "sold",
- "color_name": "Raspberry Plastic",
- "color_canonical": "white",
- "owner_name": "Blick-Predovic",
- "msrp_price": "180000.0",
- "sale_price": null,
- "monthly_price": null,
- "subscribe_price": "9000.0",
- "photos": [ ],
- "cover_photo": null,
- "cover_photo_medium": null,
- "cover_photo_hd": null,
- "cover_photo_quarter_hd": null,
- "owner_opening_hours": "<p>Mon-Fri: 9:00 - 19:00<br>\nSat: 11:00 - 18:00<br>\nSun: Closed</p>\n",
- "owner_contact_details": "<p>65804 Sirena Course<br>\nLake Janeen</p>\n",
- "financing_options": {
- "cash": true,
- "lease": false,
- "rent": true
}
}
}, - {
- "id": "56",
- "type": "listing_vehicles",
- "attributes": {
- "version": "Gotham Central",
- "drivetrain": "Crisis On Infinite Earths",
- "production_year": 2014,
- "short_description": "Ullam molestias qui asperiores quis ad aut aperiam voluptas eius.",
- "state": "used",
- "delivery_date": "2024-11-21",
- "transmission": "auto",
- "vin": null,
- "mileage": 22184,
- "engine_capacity": null,
- "engine_type": [
- "petrol",
- "phev"
], - "power": 160,
- "video_url": null,
- "created_at": "2024-11-05T13:42:57.898Z",
- "power_unit": "bhp",
- "currency": "KMF",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "nameplate_name": "Nameplate 3",
- "nameplate_brand_name": "Brand 2",
- "owner_city": "West Cassie",
- "price_hidden": false,
- "prices_type": null,
- "external_id": "109945",
- "model_display_name": "Brand 2 Nameplate 3",
- "order_number": null,
- "nameplate_model_group": null,
- "metadata": null,
- "owner_phone": "+218 (693) 382-1207 x4974",
- "owner_zipcode": null,
- "owner_address": "Suite 304 14113 Danelle Valleys, Salvadorfort, NM 91809",
- "owner_state": null,
- "owner_metadata": { },
- "interior_color": "Ebony",
- "price_metadata": { },
- "code5000": null,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "stock",
- "color_name": "Aquamarine Cotton",
- "color_canonical": "black",
- "owner_name": "Williamson Group",
- "msrp_price": "160000.0",
- "sale_price": "140000.0",
- "monthly_price": null,
- "subscribe_price": "8000.0",
- "photos": [ ],
- "cover_photo": null,
- "cover_photo_medium": null,
- "cover_photo_hd": null,
- "cover_photo_quarter_hd": null,
- "owner_opening_hours": "<p>Mon-Fri: 9:00 - 19:00<br>\nSat: 11:00 - 18:00<br>\nSun: Closed</p>\n",
- "owner_contact_details": "<p>7685 Marcelino Valleys<br>\nSouth Zoraida</p>\n",
- "financing_options": {
- "cash": true,
- "lease": false,
- "rent": true
}
}
}
], - "meta": {
- "pagination": {
- "scaffold_url": "/public_api/listing/4cf63b78-0752-45d9-9c26-5c0432a5989a?filter%5Bengine_type_includes%5D=phev%2Cdiesel&page=PAGE_NUM",
- "count": 3,
- "page": 1,
- "items": 3,
- "pages": 1,
- "last": 1,
- "from": 1,
- "to": 3,
- "prev": null,
- "next": null
}, - "dealers": [
- {
- "id": 252,
- "name": "Dare, Weissnat and Kautzer",
- "city": "Bentonmouth",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 253,
- "name": "Blick-Predovic",
- "city": "Bonnieton",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 254,
- "name": "O'Hara, Morissette and Goyette",
- "city": "Faustinotown",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 250,
- "name": "Lueilwitz LLC",
- "city": "New Valport",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 251,
- "name": "Williamson Group",
- "city": "West Cassie",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 249,
- "name": "Conn, Trantow and Bernhard",
- "city": "West Charlena",
- "dealer_codes": [ ],
- "metadata": { }
}
], - "disclaimers": [
- {
- "uuid": "4cf63b78-0752-45d9-9c26-5c0432a5989a",
- "disclaimers": { }
}
], - "owner_units": {
- "currency": "GBP",
- "mileage": "km",
- "engine_capacity": "cc",
- "engine_power": "bhp"
}, - "counters": {
- "brands": {
- "Brand 1": 3,
- "Brand 2": 3
}, - "models": {
- "Nameplate 1": 1,
- "Nameplate 2": 1,
- "Nameplate 3": 1,
- "Nameplate 4": 2,
- "Vl'Hurg": 1
}, - "statuses": {
- "sold": 2,
- "reserved": 2,
- "available_soon": 1,
- "stock": 1
}, - "states": {
- "new": 3,
- "used": 1,
- "approved": 2
}, - "engine_types": {
- "petrol": 3,
- "diesel": 2,
- "bev": 1,
- "mhev": 1,
- "phev": 1
}, - "transmissions": {
- "auto": 2,
- "manual": 4
}, - "colors": {
- "black": 2,
- "blue": 1,
- "silver": 1,
- "white": 2
}, - "specific_colors": {
- "Brown Wool": 1,
- "Lime Plastic": 1,
- "Aquamarine Cotton": 1,
- "Salmon Wool": 1,
- "Raspberry Plastic": 1,
- "Red Silk": 1
}, - "financing_options": {
- "cash": 6,
- "lease": 1,
- "rent": 3
}, - "dealers": {
- "249": 1,
- "250": 1,
- "251": 1,
- "252": 1,
- "253": 1,
- "254": 1
}
}, - "sort_attribute": "created_at",
- "sort_order": "desc",
- "msrp_price": {
- "min": "100000.0",
- "max": "180000.0"
}, - "display_price": {
- "min": "100000.0",
- "max": "180000.0"
}, - "mileage": {
- "min": 4846,
- "max": 703310
}, - "power": {
- "min": 140,
- "max": 200
}, - "production_year": {
- "min": 2010,
- "max": 2021
}, - "nameplates": [
- {
- "id": 68,
- "name": "Nameplate 3"
}, - {
- "id": 69,
- "name": "Nameplate 4"
}, - {
- "id": 70,
- "name": "Vl'Hurg"
}
], - "brands": [
- {
- "id": 125,
- "name": "Brand 1"
}, - {
- "id": 128,
- "name": "Brand 2"
}
]
}
}
Action is used to fetch ONLY lowest-level companies from listings owners hierarchies (leaves) ordered by name.
Request Path
GET /public_api/listing/{listing_uuids separated by comma}/companies
Request Body Structure
param | example | type | required | source in configurator json | description |
---|---|---|---|---|---|
uuids |
"dea07f,dc4cd" | string | yes (in request path) | not present | Ids of listings containing requested vehicles separated by comma (no comma needed for single listing) |
Response
Response JSON contains ordered array with companies.
uuids | string Example: 972d8580-213d-4a87-8a31-190764bbf15e |
uuids required | string Example: uuids=d6af041b-8a7b-4560-bfaa-d5b8f502710c Listing UUID values |
Accept | any Example: application/json |
Content-Type | any Example: application/json |
{- "data": [
- {
- "id": "331",
- "type": "companies",
- "attributes": {
- "uuid": "a80ef647-db2c-49bd-9f13-201eaf549b96",
- "name": "Ritchie-Kunde",
- "city": "Hermistonshire",
- "address": "99667 Major Corners, Antoniomouth, LA 39348-8794",
- "phone": "+994 987.432.9120",
- "locale": "en_IE",
- "currency": "USD",
- "zipcode": null,
- "timezone": "UTC",
- "mileage_unit": "km",
- "power_unit": "bhp",
- "engine_capacity_unit": "cc",
- "opening_hours": "Mon-Fri: 9:00 - 19:00\nSat: 11:00 - 18:00\nSun: Closed\n",
- "contact_details": "4821 Little Fields\nNew Velvet",
- "skip_company_name_in_location": false,
- "account_type": "retailer",
- "state": null,
- "dealer_codes": [ ],
- "operating_states": [
- "NSW",
- "VIC"
], - "metadata": { }
}, - "meta": {
- "power_units": [
- "bhp",
- "kw"
], - "mileage_units": [
- "km",
- "mi"
], - "engine_capacity_units": [
- "cc",
- "l"
]
}
}
]
}
Simliast to Filtering the sorting mechanism utilises quite powerful Ransack gem engine
sort
attributeTo sort results one should use sort
GET parameter as a list of collumns that records should be sorted by.
By default sorting works in natura ascending order. To use the ascending order (usefull for prices) column name should
be predicated with minus (-
, U+002D HYPHEN-MINUS) character
To Sort Vechiles in ascending order by msrp_price
sort=msrp_price
To Sort Vechiles in descending order by msrp_price
sort=-msrp_price
To Sort Vechiles in ascending order by production year and then in descending order by msrp_price
sort=production_year,-msrp_price
uuids | string Example: 168c5ce7-ffe2-4faf-9a50-7cc5e2768607 |
sort required | string Example: sort=msrp_price Comma separated list of columns to sort vehicles by |
Accept | any Example: application/vnd.api+json |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "121",
- "type": "listing_vehicles",
- "attributes": {
- "version": "Teen Titans: The Judas Contract",
- "drivetrain": "The Killing Joke",
- "production_year": 2011,
- "short_description": "Officiis accusamus quia quidem non ratione et quia sit sunt.",
- "state": "approved",
- "delivery_date": "2024-11-30",
- "transmission": "manual",
- "vin": null,
- "mileage": 594194,
- "engine_capacity": null,
- "engine_type": [
- "petrol"
], - "power": 190,
- "video_url": null,
- "created_at": "2024-11-05T13:43:01.570Z",
- "power_unit": "bhp",
- "currency": "ISK",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "nameplate_name": "Boghog",
- "nameplate_brand_name": "Ford",
- "owner_city": "New Valport",
- "price_hidden": false,
- "prices_type": null,
- "external_id": "51261f",
- "model_display_name": "Ford Boghog",
- "order_number": null,
- "nameplate_model_group": null,
- "metadata": null,
- "owner_phone": "+1 1-199-087-8658 x1543",
- "owner_zipcode": null,
- "owner_address": "270 Keneth Trafficway, Jaymouth, IA 38036-8607",
- "owner_state": null,
- "owner_metadata": { },
- "interior_color": "Ebony",
- "price_metadata": { },
- "code5000": null,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "stock",
- "color_name": "Erin Rubber",
- "color_canonical": "red",
- "owner_name": "Lueilwitz LLC",
- "msrp_price": "2000.0",
- "sale_price": null,
- "monthly_price": null,
- "subscribe_price": null,
- "photos": [ ],
- "cover_photo": null,
- "cover_photo_medium": null,
- "cover_photo_hd": null,
- "cover_photo_quarter_hd": null,
- "owner_opening_hours": "<p>Mon-Fri: 9:00 - 19:00<br>\nSat: 11:00 - 18:00<br>\nSun: Closed</p>\n",
- "owner_contact_details": "<p>80588 Spinka Circles<br>\nSilvaville</p>\n",
- "financing_options": {
- "cash": true,
- "lease": false,
- "rent": false
}
}
}, - {
- "id": "120",
- "type": "listing_vehicles",
- "attributes": {
- "version": "The Coyote Gospel",
- "drivetrain": "Gotham Central",
- "production_year": 2011,
- "short_description": "Ab et voluptas consectetur dolore enim vel aut quia et.",
- "state": "new",
- "delivery_date": "2024-11-22",
- "transmission": "auto",
- "vin": null,
- "mileage": 486281,
- "engine_capacity": null,
- "engine_type": [
- "diesel"
], - "power": 198,
- "video_url": null,
- "created_at": "2024-11-05T13:43:01.541Z",
- "power_unit": "bhp",
- "currency": "BWP",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "nameplate_name": "Perfectly Normal Beast",
- "nameplate_brand_name": "Bugatti",
- "owner_city": "West Charlena",
- "price_hidden": false,
- "prices_type": null,
- "external_id": "deccfd",
- "model_display_name": "Bugatti Perfectly Normal Beast",
- "order_number": null,
- "nameplate_model_group": null,
- "metadata": null,
- "owner_phone": "+66 881-923-7747 x8991",
- "owner_zipcode": null,
- "owner_address": "62288 Jast Shore, Port Becky, OH 41599",
- "owner_state": null,
- "owner_metadata": { },
- "interior_color": "Ebony",
- "price_metadata": { },
- "code5000": null,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "demo",
- "color_name": "Mauve Granite",
- "color_canonical": "gray",
- "owner_name": "Conn, Trantow and Bernhard",
- "msrp_price": "1000.0",
- "sale_price": null,
- "monthly_price": null,
- "subscribe_price": null,
- "photos": [ ],
- "cover_photo": null,
- "cover_photo_medium": null,
- "cover_photo_hd": null,
- "cover_photo_quarter_hd": null,
- "owner_opening_hours": "<p>Mon-Fri: 9:00 - 19:00<br>\nSat: 11:00 - 18:00<br>\nSun: Closed</p>\n",
- "owner_contact_details": "<p>740 Schroeder Skyway<br>\nMonicamouth</p>\n",
- "financing_options": {
- "cash": true,
- "lease": false,
- "rent": false
}
}
}
], - "meta": {
- "pagination": {
- "scaffold_url": "/public_api/listing/168c5ce7-ffe2-4faf-9a50-7cc5e2768607?sort=-msrp_price&page=PAGE_NUM",
- "count": 2,
- "page": 1,
- "items": 2,
- "pages": 1,
- "last": 1,
- "from": 1,
- "to": 2,
- "prev": null,
- "next": null
}, - "dealers": [
- {
- "id": 338,
- "name": "Lueilwitz LLC",
- "city": "New Valport",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 337,
- "name": "Conn, Trantow and Bernhard",
- "city": "West Charlena",
- "dealer_codes": [ ],
- "metadata": { }
}
], - "disclaimers": [
- {
- "uuid": "168c5ce7-ffe2-4faf-9a50-7cc5e2768607",
- "disclaimers": { }
}
], - "owner_units": {
- "currency": "GBP",
- "mileage": "km",
- "engine_capacity": "cc",
- "engine_power": "bhp"
}, - "counters": {
- "brands": {
- "Bugatti": 1,
- "Ford": 1
}, - "models": {
- "Perfectly Normal Beast": 1,
- "Boghog": 1
}, - "statuses": {
- "demo": 1,
- "stock": 1
}, - "states": {
- "new": 1,
- "approved": 1
}, - "engine_types": {
- "petrol": 1,
- "diesel": 1
}, - "transmissions": {
- "auto": 1,
- "manual": 1
}, - "colors": {
- "gray": 1,
- "red": 1
}, - "specific_colors": {
- "Mauve Granite": 1,
- "Erin Rubber": 1
}, - "financing_options": {
- "cash": 2
}, - "dealers": {
- "337": 1,
- "338": 1
}
}, - "sort_attribute": "created_at",
- "sort_order": "asc",
- "msrp_price": {
- "min": "1000.0",
- "max": "2000.0"
}, - "display_price": {
- "min": "1000.0",
- "max": "2000.0"
}, - "mileage": {
- "min": 486281,
- "max": 594194
}, - "power": {
- "min": 190,
- "max": 198
}, - "production_year": {
- "min": 2011,
- "max": 2011
}, - "nameplates": [
- {
- "id": 122,
- "name": "Perfectly Normal Beast"
}, - {
- "id": 123,
- "name": "Boghog"
}
], - "brands": [
- {
- "id": 217,
- "name": "Bugatti"
}, - {
- "id": 219,
- "name": "Ford"
}
]
}
}
Vehicles list is always paginated.
By default API will return up to 20 items but it can be overriden using items
parameter.
Here we use items=2
bo brevity but it's optional and set to 20 by default.
Paginated results include pagination metadata in the meta
object like this:
"meta": {
"pagination": {
//URL template to fetch additonal pages (PAGE_NUM) should be replaced by page number
"scaffold_url": "...?items=2&page=PAGE_NUM",
"count": 50, // Overall amount of vehicles in collection
"page": 3, // Current page number
"items": 2, // Amount of items page page
"pages": 25, // Amount of all pages
"last": 25, // Last page number
"from": 5, // index of first item on current page
"to": 6, // index of last item on current page
"prev": 2, // previous page number, null if no previous page
"next": 4 // next page number, null if no next page
}
}
uuids | string Example: 9641b498-4d7c-4c99-997d-5abf43b95372 |
page required | number Example: page=2 Pagination page to be requested (default: 1) |
items required | number Example: items=3 Amount of items per page (default: 20) |
Accept | any Example: application/vnd.api+json |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "142",
- "type": "listing_vehicles",
- "attributes": {
- "version": "Multiversity",
- "drivetrain": "Crisis On Infinite Earths",
- "production_year": 2005,
- "short_description": "Voluptatem et aut id dolores accusantium autem quia dolorem et.",
- "state": "approved",
- "delivery_date": "2024-11-17",
- "transmission": "manual",
- "vin": null,
- "mileage": 436000,
- "engine_capacity": null,
- "engine_type": [
- "diesel"
], - "power": 198,
- "video_url": null,
- "created_at": "2024-11-05T13:43:03.026Z",
- "power_unit": "bhp",
- "currency": "BMD",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "nameplate_name": "Babel Fish",
- "nameplate_brand_name": "Aston Martin",
- "owner_city": "McKenziestad",
- "price_hidden": false,
- "prices_type": null,
- "external_id": "e2fc5e",
- "model_display_name": "Aston Martin Babel Fish",
- "order_number": null,
- "nameplate_model_group": null,
- "metadata": null,
- "owner_phone": "+690 (884) 081-7295",
- "owner_zipcode": null,
- "owner_address": "59703 Trent Key, Lindsayfurt, LA 56935",
- "owner_state": null,
- "owner_metadata": { },
- "interior_color": "Ebony",
- "price_metadata": { },
- "code5000": null,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "demo",
- "color_name": "Violet Cotton",
- "color_canonical": "bronze",
- "owner_name": "Lind, Schulist and Hills",
- "msrp_price": "130000.0",
- "sale_price": null,
- "monthly_price": null,
- "subscribe_price": null,
- "photos": [ ],
- "cover_photo": null,
- "cover_photo_medium": null,
- "cover_photo_hd": null,
- "cover_photo_quarter_hd": null,
- "owner_opening_hours": "<p>Mon-Fri: 9:00 - 19:00<br>\nSat: 11:00 - 18:00<br>\nSun: Closed</p>\n",
- "owner_contact_details": "<p>26187 Reichel Well<br>\nPriceton</p>\n",
- "financing_options": {
- "cash": true,
- "lease": false,
- "rent": false
}
}
}, - {
- "id": "139",
- "type": "listing_vehicles",
- "attributes": {
- "version": "Detective Comics",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2020,
- "short_description": "Aspernatur eos tempore cupiditate delectus ullam voluptates rerum quis vero.",
- "state": "approved",
- "delivery_date": "2024-12-02",
- "transmission": "manual",
- "vin": null,
- "mileage": 303000,
- "engine_capacity": null,
- "engine_type": [
- "diesel"
], - "power": 238,
- "video_url": null,
- "created_at": "2024-11-05T13:43:02.952Z",
- "power_unit": "bhp",
- "currency": "ZAR",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "nameplate_name": "Hingefreel",
- "nameplate_brand_name": "PGO",
- "owner_city": "Suzyshire",
- "price_hidden": false,
- "prices_type": null,
- "external_id": "4300cc",
- "model_display_name": "PGO Hingefreel",
- "order_number": null,
- "nameplate_model_group": null,
- "metadata": null,
- "owner_phone": "+1-670 867-855-6976 x2906",
- "owner_zipcode": null,
- "owner_address": "70658 Effertz Gateway, West Dianna, NE 77974-2786",
- "owner_state": null,
- "owner_metadata": { },
- "interior_color": "Ebony",
- "price_metadata": { },
- "code5000": null,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "available_soon",
- "color_name": "Pink Linen",
- "color_canonical": "orange",
- "owner_name": "Von-Witting",
- "msrp_price": "853000.0",
- "sale_price": null,
- "monthly_price": null,
- "subscribe_price": null,
- "photos": [ ],
- "cover_photo": null,
- "cover_photo_medium": null,
- "cover_photo_hd": null,
- "cover_photo_quarter_hd": null,
- "owner_opening_hours": "<p>Mon-Fri: 9:00 - 19:00<br>\nSat: 11:00 - 18:00<br>\nSun: Closed</p>\n",
- "owner_contact_details": "<p>23768 Kovacek Landing<br>\nLake Lenitaborough</p>\n",
- "financing_options": {
- "cash": true,
- "lease": false,
- "rent": false
}
}
}
], - "meta": {
- "pagination": {
- "scaffold_url": "/public_api/listing/9641b498-4d7c-4c99-997d-5abf43b95372?items=2&page=PAGE_NUM",
- "count": 12,
- "page": 3,
- "items": 2,
- "pages": 6,
- "last": 6,
- "from": 5,
- "to": 6,
- "prev": 2,
- "next": 4
}, - "dealers": [
- {
- "id": 369,
- "name": "Hoeger, Streich and Sporer",
- "city": "Boyerborough",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 376,
- "name": "Huels, Crist and Christiansen",
- "city": "Lake Jayneton",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 378,
- "name": "Reinger-Jerde",
- "city": "Langworthberg",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 375,
- "name": "McClure, McKenzie and Cruickshank",
- "city": "McDermotttown",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 374,
- "name": "Lind, Schulist and Hills",
- "city": "McKenziestad",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 373,
- "name": "Tillman, Heller and McClure",
- "city": "Mollyhaven",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 377,
- "name": "Haag-Gulgowski",
- "city": "Mosciskiville",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 370,
- "name": "Borer, Doyle and Torphy",
- "city": "New Amie",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 372,
- "name": "Boyle Inc",
- "city": "North Noble",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 367,
- "name": "Conn and Sons",
- "city": "South Elissatown",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 371,
- "name": "Von-Witting",
- "city": "Suzyshire",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 368,
- "name": "Williamson Inc",
- "city": "West Lucien",
- "dealer_codes": [ ],
- "metadata": { }
}
], - "disclaimers": [
- {
- "uuid": "9641b498-4d7c-4c99-997d-5abf43b95372",
- "disclaimers": { }
}
], - "owner_units": {
- "currency": "ILS",
- "mileage": "km",
- "engine_capacity": "cc",
- "engine_power": "bhp"
}, - "counters": {
- "brands": {
- "Lada": 1,
- "Acura": 1,
- "Dacia": 1,
- "Saleen": 1,
- "PGO": 1,
- "NEVS": 1,
- "Ram": 1,
- "Aston Martin": 1,
- "Luxgen": 1,
- "Pagani": 1,
- "Dongfeng Fengshen": 1
}, - "models": {
- "Golgafrinchan": 1,
- "Hingefreel": 1,
- "Perfectly Normal Beast": 1,
- "Hooloovoo": 1,
- "Dentrassis": 1,
- "Mattress": 1,
- "Babel Fish": 1,
- "Ravenous Bugblatter Beast of Traal": 1,
- "Sarkopsi": 1,
- "Silastic Armorfiends": 1
}, - "statuses": {
- "sold": 1,
- "reserved": 1,
- "in_production": 5,
- "demo": 2,
- "available_soon": 2,
- "stock": 1
}, - "states": {
- "new": 3,
- "used": 4,
- "approved": 5
}, - "engine_types": {
- "petrol": 2,
- "diesel": 3,
- "hev": 1,
- "mhev": 1,
- "phev": 2,
- "phev_rev": 3
}, - "transmissions": {
- "auto": 7,
- "manual": 5
}, - "colors": {
- "black": 1,
- "bronze": 3,
- "gray": 2,
- "orange": 2,
- "red": 1,
- "silver": 2,
- "white": 1
}, - "specific_colors": {
- "Gray Linen": 1,
- "Green Copper": 1,
- "Violet Cotton": 1,
- "Raspberry Marble": 1,
- "Grey Granite": 1,
- "Olive Concrete": 1,
- "Azure Wool": 1,
- "Lime Copper": 1,
- "Bronze Plastic": 1,
- "Pink Linen": 1,
- "Ochre Iron": 1,
- "Raspberry Linen": 1
}, - "financing_options": {
- "cash": 12
}, - "dealers": {
- "367": 1,
- "368": 1,
- "369": 1,
- "370": 1,
- "371": 1,
- "372": 1,
- "373": 1,
- "374": 1,
- "375": 1,
- "376": 1,
- "377": 1,
- "378": 1
}
}, - "sort_attribute": "mileage",
- "sort_order": "desc",
- "msrp_price": {
- "min": "13000.0",
- "max": "950000.0"
}, - "display_price": {
- "min": "13000.0",
- "max": "950000.0"
}, - "mileage": {
- "min": 48000,
- "max": 946000
}, - "power": {
- "min": 198,
- "max": 448
}, - "production_year": {
- "min": 2005,
- "max": 2024
}, - "nameplates": [
- {
- "id": 137,
- "name": "Silastic Armorfiends"
}, - {
- "id": 138,
- "name": "Perfectly Normal Beast"
}, - {
- "id": 139,
- "name": "Dentrassis"
}, - {
- "id": 140,
- "name": "Hooloovoo"
}, - {
- "id": 141,
- "name": "Hingefreel"
}, - {
- "id": 142,
- "name": "Golgafrinchan"
}, - {
- "id": 143,
- "name": "Sarkopsi"
}, - {
- "id": 144,
- "name": "Babel Fish"
}, - {
- "id": 145,
- "name": "Mattress"
}, - {
- "id": 146,
- "name": "Ravenous Bugblatter Beast of Traal"
}, - {
- "id": 147,
- "name": "Perfectly Normal Beast"
}, - {
- "id": 148,
- "name": "Hooloovoo"
}
], - "brands": [
- {
- "id": 247,
- "name": "Lada"
}, - {
- "id": 249,
- "name": "Acura"
}, - {
- "id": 251,
- "name": "Dacia"
}, - {
- "id": 253,
- "name": "Saleen"
}, - {
- "id": 255,
- "name": "PGO"
}, - {
- "id": 257,
- "name": "NEVS"
}, - {
- "id": 259,
- "name": "Ram"
}, - {
- "id": 261,
- "name": "Aston Martin"
}, - {
- "id": 263,
- "name": "Aston Martin"
}, - {
- "id": 265,
- "name": "Luxgen"
}, - {
- "id": 267,
- "name": "Pagani"
}, - {
- "id": 269,
- "name": "Dongfeng Fengshen"
}
]
}
}
This endpoint inherits a lot of behaviour and data format from private /vehicles
endpoint but some
details were adapted to better match publich "widget" use case. Differences are
photos
and lisitings
relationships are listed. owner
, color
, nameplate
etc are ommittedmeta
includes max/min values for msrp_price
and mileage
values.photos
in all vehicles listinguuids | string Example: 233a9686-da2e-4d83-95d3-11092717f26b |
uuid required | string Example: uuid=d6af041b-8a7b-4560-bfaa-d5b8f502710c Listing UUID value |
Accept | any Example: application/vnd.api+json |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "164",
- "type": "listing_vehicles",
- "attributes": {
- "version": "For The Man Who Has Everything",
- "drivetrain": "Jack Kirby's New Gods",
- "production_year": 2006,
- "short_description": "Culpa harum facilis odio animi quidem dolores ipsa reprehenderit nostrum.",
- "state": "used",
- "delivery_date": "2024-11-08",
- "transmission": "manual",
- "vin": null,
- "mileage": 579000,
- "engine_capacity": null,
- "engine_type": [
- "phev"
], - "power": 386,
- "video_url": null,
- "created_at": "2024-11-05T13:43:04.475Z",
- "power_unit": "bhp",
- "currency": "CZK",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "nameplate_name": "Ravenous Bugblatter Beast of Traal",
- "nameplate_brand_name": "Venucia",
- "owner_city": "Jacobsonbury",
- "price_hidden": false,
- "prices_type": null,
- "external_id": "b2d094",
- "model_display_name": "Venucia Ravenous Bugblatter Beast of Traal",
- "order_number": null,
- "nameplate_model_group": null,
- "metadata": null,
- "owner_phone": "+268 490.354.8560 x6236",
- "owner_zipcode": null,
- "owner_address": "6491 Debera Neck, Chongfort, MA 70532-2245",
- "owner_state": null,
- "owner_metadata": { },
- "interior_color": "Ebony",
- "price_metadata": { },
- "code5000": null,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "on_demand",
- "color_name": "Viridian Linen",
- "color_canonical": "bronze",
- "owner_name": "Kulas, DuBuque and Williamson",
- "msrp_price": "713000.0",
- "sale_price": null,
- "monthly_price": null,
- "subscribe_price": null,
- "photos": [
- {
- "sequence": 0,
- "normal": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDUsInB1ciI6ImJsb2JfaWQifX0=--30cb18cad3a4434dfa8a101d11e1864f09d03841/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDUsInB1ciI6ImJsb2JfaWQifX0=--30cb18cad3a4434dfa8a101d11e1864f09d03841/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDUsInB1ciI6ImJsb2JfaWQifX0=--30cb18cad3a4434dfa8a101d11e1864f09d03841/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg",
- "quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDUsInB1ciI6ImJsb2JfaWQifX0=--30cb18cad3a4434dfa8a101d11e1864f09d03841/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg"
}, - {
- "sequence": 0,
- "normal": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDYsInB1ciI6ImJsb2JfaWQifX0=--fbc7b9859f8853d06af733b92443ad903548292a/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDYsInB1ciI6ImJsb2JfaWQifX0=--fbc7b9859f8853d06af733b92443ad903548292a/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDYsInB1ciI6ImJsb2JfaWQifX0=--fbc7b9859f8853d06af733b92443ad903548292a/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg",
- "quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDYsInB1ciI6ImJsb2JfaWQifX0=--fbc7b9859f8853d06af733b92443ad903548292a/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg"
}, - {
- "sequence": 0,
- "normal": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDcsInB1ciI6ImJsb2JfaWQifX0=--f4abc3e9c14bcff509231974d36cbf524d0516ab/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDcsInB1ciI6ImJsb2JfaWQifX0=--f4abc3e9c14bcff509231974d36cbf524d0516ab/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDcsInB1ciI6ImJsb2JfaWQifX0=--f4abc3e9c14bcff509231974d36cbf524d0516ab/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg",
- "quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDcsInB1ciI6ImJsb2JfaWQifX0=--f4abc3e9c14bcff509231974d36cbf524d0516ab/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg"
}
], - "cover_photo": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDUsInB1ciI6ImJsb2JfaWQifX0=--30cb18cad3a4434dfa8a101d11e1864f09d03841/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "cover_photo_medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDUsInB1ciI6ImJsb2JfaWQifX0=--30cb18cad3a4434dfa8a101d11e1864f09d03841/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "cover_photo_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDUsInB1ciI6ImJsb2JfaWQifX0=--30cb18cad3a4434dfa8a101d11e1864f09d03841/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg",
- "cover_photo_quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDUsInB1ciI6ImJsb2JfaWQifX0=--30cb18cad3a4434dfa8a101d11e1864f09d03841/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "owner_opening_hours": "<p>Mon-Fri: 9:00 - 19:00<br>\nSat: 11:00 - 18:00<br>\nSun: Closed</p>\n",
- "owner_contact_details": "<p>71758 Dickinson Estates<br>\nEast Yong</p>\n",
- "financing_options": {
- "cash": true,
- "lease": false,
- "rent": false
}
}
}, - {
- "id": "162",
- "type": "listing_vehicles",
- "attributes": {
- "version": "Identity Crisis",
- "drivetrain": "Grant Morrison's Animal Man",
- "production_year": 2006,
- "short_description": "Laborum eum corporis alias sunt in quibusdam neque nisi atque.",
- "state": "used",
- "delivery_date": "2024-11-06",
- "transmission": "manual",
- "vin": null,
- "mileage": 124000,
- "engine_capacity": null,
- "engine_type": [
- "mhev"
], - "power": 304,
- "video_url": null,
- "created_at": "2024-11-05T13:43:04.417Z",
- "power_unit": "bhp",
- "currency": "TWD",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "nameplate_name": "Nanites",
- "nameplate_brand_name": "Holden (HSV)",
- "owner_city": "Mitchellville",
- "price_hidden": true,
- "prices_type": null,
- "external_id": "c598a1",
- "model_display_name": "Holden (HSV) Nanites",
- "order_number": null,
- "nameplate_model_group": null,
- "metadata": null,
- "owner_phone": "+230 (417) 326-6929 x68515",
- "owner_zipcode": null,
- "owner_address": "798 Medhurst Hill, Marionchester, CT 03629-3466",
- "owner_state": null,
- "owner_metadata": { },
- "interior_color": "Ebony",
- "price_metadata": { },
- "code5000": null,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "demo",
- "color_name": "Silver Rubber",
- "color_canonical": "orange",
- "owner_name": "Brakus-Botsford",
- "msrp_price": "0",
- "sale_price": null,
- "monthly_price": null,
- "subscribe_price": null,
- "photos": [
- {
- "sequence": 0,
- "normal": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MzksInB1ciI6ImJsb2JfaWQifX0=--8cd919728b1b38fd14e80c026b359b5cce4bb974/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MzksInB1ciI6ImJsb2JfaWQifX0=--8cd919728b1b38fd14e80c026b359b5cce4bb974/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MzksInB1ciI6ImJsb2JfaWQifX0=--8cd919728b1b38fd14e80c026b359b5cce4bb974/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg",
- "quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MzksInB1ciI6ImJsb2JfaWQifX0=--8cd919728b1b38fd14e80c026b359b5cce4bb974/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg"
}, - {
- "sequence": 0,
- "normal": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDAsInB1ciI6ImJsb2JfaWQifX0=--39db1b950437cfa4646be88af740e4ea3d120391/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDAsInB1ciI6ImJsb2JfaWQifX0=--39db1b950437cfa4646be88af740e4ea3d120391/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDAsInB1ciI6ImJsb2JfaWQifX0=--39db1b950437cfa4646be88af740e4ea3d120391/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg",
- "quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDAsInB1ciI6ImJsb2JfaWQifX0=--39db1b950437cfa4646be88af740e4ea3d120391/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg"
}, - {
- "sequence": 0,
- "normal": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDEsInB1ciI6ImJsb2JfaWQifX0=--dc682ec1b4b13c259cd82361f51710db946160a5/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDEsInB1ciI6ImJsb2JfaWQifX0=--dc682ec1b4b13c259cd82361f51710db946160a5/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDEsInB1ciI6ImJsb2JfaWQifX0=--dc682ec1b4b13c259cd82361f51710db946160a5/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg",
- "quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDEsInB1ciI6ImJsb2JfaWQifX0=--dc682ec1b4b13c259cd82361f51710db946160a5/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg"
}
], - "cover_photo": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MzksInB1ciI6ImJsb2JfaWQifX0=--8cd919728b1b38fd14e80c026b359b5cce4bb974/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "cover_photo_medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MzksInB1ciI6ImJsb2JfaWQifX0=--8cd919728b1b38fd14e80c026b359b5cce4bb974/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "cover_photo_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MzksInB1ciI6ImJsb2JfaWQifX0=--8cd919728b1b38fd14e80c026b359b5cce4bb974/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg",
- "cover_photo_quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MzksInB1ciI6ImJsb2JfaWQifX0=--8cd919728b1b38fd14e80c026b359b5cce4bb974/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "owner_opening_hours": "<p>Mon-Fri: 9:00 - 19:00<br>\nSat: 11:00 - 18:00<br>\nSun: Closed</p>\n",
- "owner_contact_details": "<p>1281 Mattie River<br>\nDeckowburgh</p>\n",
- "financing_options": {
- "cash": true,
- "lease": true,
- "rent": false
}
}
}, - {
- "id": "163",
- "type": "listing_vehicles",
- "attributes": {
- "version": "Crisis On Infinite Earths",
- "drivetrain": "Multiversity",
- "production_year": 2008,
- "short_description": "Qui commodi sapiente at minima occaecati minus sit dolores quia.",
- "state": "used",
- "delivery_date": "2024-11-22",
- "transmission": "manual",
- "vin": null,
- "mileage": 67000,
- "engine_capacity": null,
- "engine_type": [
- "phev_rev"
], - "power": 368,
- "video_url": null,
- "created_at": "2024-11-05T13:43:04.447Z",
- "power_unit": "bhp",
- "currency": "XFU",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "nameplate_name": "Arcturan Megagrasshopper",
- "nameplate_brand_name": "Škoda",
- "owner_city": "Kuphalmouth",
- "price_hidden": false,
- "prices_type": null,
- "external_id": "585db5",
- "model_display_name": "Škoda Arcturan Megagrasshopper",
- "order_number": null,
- "nameplate_model_group": null,
- "metadata": null,
- "owner_phone": "+64 779-991-3947 x73914",
- "owner_zipcode": null,
- "owner_address": "Apt. 211 396 Ruthe Parkways, Lake Emeldamouth, MI 33654",
- "owner_state": null,
- "owner_metadata": { },
- "interior_color": "Ebony",
- "price_metadata": { },
- "code5000": null,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "demo",
- "color_name": "Raspberry Aluminum",
- "color_canonical": "bronze",
- "owner_name": "Zieme, Harris and Leuschke",
- "msrp_price": "260000.0",
- "sale_price": null,
- "monthly_price": null,
- "subscribe_price": null,
- "photos": [
- {
- "sequence": 0,
- "normal": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDQsInB1ciI6ImJsb2JfaWQifX0=--45d9e9519b210efb7ec7508c27f3536d9478217a/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDQsInB1ciI6ImJsb2JfaWQifX0=--45d9e9519b210efb7ec7508c27f3536d9478217a/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDQsInB1ciI6ImJsb2JfaWQifX0=--45d9e9519b210efb7ec7508c27f3536d9478217a/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg",
- "quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDQsInB1ciI6ImJsb2JfaWQifX0=--45d9e9519b210efb7ec7508c27f3536d9478217a/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg"
}, - {
- "sequence": 0,
- "normal": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDIsInB1ciI6ImJsb2JfaWQifX0=--8db579d6dba6cf426436b7b1fcd877605174cc3c/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDIsInB1ciI6ImJsb2JfaWQifX0=--8db579d6dba6cf426436b7b1fcd877605174cc3c/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDIsInB1ciI6ImJsb2JfaWQifX0=--8db579d6dba6cf426436b7b1fcd877605174cc3c/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg",
- "quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDIsInB1ciI6ImJsb2JfaWQifX0=--8db579d6dba6cf426436b7b1fcd877605174cc3c/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg"
}, - {
- "sequence": 0,
- "normal": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDMsInB1ciI6ImJsb2JfaWQifX0=--867fa4477afc3d0ade9bae9a9f1f1493f399e958/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDMsInB1ciI6ImJsb2JfaWQifX0=--867fa4477afc3d0ade9bae9a9f1f1493f399e958/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDMsInB1ciI6ImJsb2JfaWQifX0=--867fa4477afc3d0ade9bae9a9f1f1493f399e958/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg",
- "quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDMsInB1ciI6ImJsb2JfaWQifX0=--867fa4477afc3d0ade9bae9a9f1f1493f399e958/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg"
}
], - "cover_photo": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDQsInB1ciI6ImJsb2JfaWQifX0=--45d9e9519b210efb7ec7508c27f3536d9478217a/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "cover_photo_medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDQsInB1ciI6ImJsb2JfaWQifX0=--45d9e9519b210efb7ec7508c27f3536d9478217a/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "cover_photo_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDQsInB1ciI6ImJsb2JfaWQifX0=--45d9e9519b210efb7ec7508c27f3536d9478217a/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg",
- "cover_photo_quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NDQsInB1ciI6ImJsb2JfaWQifX0=--45d9e9519b210efb7ec7508c27f3536d9478217a/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "owner_opening_hours": "<p>Mon-Fri: 9:00 - 19:00<br>\nSat: 11:00 - 18:00<br>\nSun: Closed</p>\n",
- "owner_contact_details": "<p>2535 Nery Ridges<br>\nNew Ward</p>\n",
- "avl_field": { },
- "financing_options": {
- "cash": true,
- "lease": false,
- "rent": false
}
}
}
], - "meta": {
- "pagination": {
- "scaffold_url": "/public_api/listing/233a9686-da2e-4d83-95d3-11092717f26b?page=PAGE_NUM",
- "count": 3,
- "page": 1,
- "items": 3,
- "pages": 1,
- "last": 1,
- "from": 1,
- "to": 3,
- "prev": null,
- "next": null
}, - "dealers": [
- {
- "id": 414,
- "name": "Kulas, DuBuque and Williamson",
- "city": "Jacobsonbury",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 413,
- "name": "Zieme, Harris and Leuschke",
- "city": "Kuphalmouth",
- "dealer_codes": [ ],
- "metadata": { }
}, - {
- "id": 412,
- "name": "Brakus-Botsford",
- "city": "Mitchellville",
- "dealer_codes": [ ],
- "metadata": { }
}
], - "disclaimers": [
- {
- "uuid": "233a9686-da2e-4d83-95d3-11092717f26b",
- "disclaimers": { }
}
], - "owner_units": {
- "currency": "ILS",
- "mileage": "km",
- "engine_capacity": "cc",
- "engine_power": "bhp"
}, - "counters": {
- "brands": {
- "Venucia": 1,
- "Holden (HSV)": 1,
- "Škoda": 1
}, - "models": {
- "Nanites": 1,
- "Arcturan Megagrasshopper": 1,
- "Ravenous Bugblatter Beast of Traal": 1
}, - "statuses": {
- "on_demand": 1,
- "demo": 2
}, - "states": {
- "used": 3
}, - "engine_types": {
- "mhev": 1,
- "phev": 1,
- "phev_rev": 1
}, - "transmissions": {
- "manual": 3
}, - "colors": {
- "bronze": 2,
- "orange": 1
}, - "specific_colors": {
- "Silver Rubber": 1,
- "Raspberry Aluminum": 1,
- "Viridian Linen": 1
}, - "financing_options": {
- "cash": 3,
- "lease": 1
}, - "dealers": {
- "412": 1,
- "413": 1,
- "414": 1
}
}, - "sort_attribute": "mileage",
- "sort_order": "desc",
- "msrp_price": {
- "min": "1000.0",
- "max": "713000.0"
}, - "display_price": {
- "min": "900.0",
- "max": "713000.0"
}, - "mileage": {
- "min": 67000,
- "max": 579000
}, - "power": {
- "min": 304,
- "max": 386
}, - "production_year": {
- "min": 2006,
- "max": 2008
}, - "nameplates": [
- {
- "id": 164,
- "name": "Nanites"
}, - {
- "id": 165,
- "name": "Arcturan Megagrasshopper"
}, - {
- "id": 166,
- "name": "Ravenous Bugblatter Beast of Traal"
}
], - "brands": [
- {
- "id": 301,
- "name": "Holden (HSV)"
}, - {
- "id": 303,
- "name": "Škoda"
}, - {
- "id": 305,
- "name": "Venucia"
}
]
}
}
This endpoint fetches vehicles with similar specification with this passed in query params.
Make sure to pass brand and nameplate in query params, this two params are required.
Request Query Params
param | example | type | required | description |
---|---|---|---|---|
brand |
Jaguar | string | yes | Brand name |
nameplate |
XE | string | yes | Vehicle nameplate |
specpack |
R-Dynamic SE | string | no | Vehicle version |
bodystyle |
'LWB' | enum | no | Vehicle bodystyle (LWB, Long Wheelbase, Standard Wheelbase', 'SWB') |
engine |
'P200' | string | no | Vehicle engine |
fuel_type |
'P' | enum | no | Vehicle fuel type (P, D) |
You can add all filters and sort option for example:
/public_api/listing/:uuid/matching_vehicles?brand=Jaguar&nameplate=XE&filter[state_eq]=new
This request will return all vehicles with brand and nameplate match and with state set to 'new'
uuids | string Example: cd2be4e4-2065-4fbf-b278-531c93e32beb |
uuid required | string Example: uuid=d6af041b-8a7b-4560-bfaa-d5b8f502710c Listing UUID value |
Accept | any Example: application/vnd.api+json |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "194",
- "type": "light_listing_vehicles",
- "attributes": {
- "version": "Crisis On Infinite Earths",
- "drivetrain": "Superman: Red Son",
- "production_year": 2022,
- "mileage": 470000,
- "engine_capacity": null,
- "engine_type": [
- "petrol"
], - "power": 236,
- "power_unit": "bhp",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "nameplate_name": "XE",
- "nameplate_brand_name": "Mahindra",
- "price_hidden": false,
- "prices_type": null,
- "video_url": null,
- "state": "approved",
- "order_number": null,
- "model_display_name": "Mahindra XE",
- "price_metadata": { },
- "owner_name": "Dare, Weissnat and Kautzer",
- "owner_metadata": { },
- "disclaimers": { },
- "hybrid_type": [ ],
- "status": "reserved",
- "color_name": "Green Marble",
- "msrp_price": "562000.0",
- "sale_price": null,
- "monthly_price": null,
- "subscribe_price": null,
- "cover_photo": null,
- "cover_photo_medium": null,
- "query_match": {
- "nameplate": true,
- "brand": true
}
}
}, - {
- "id": "195",
- "type": "light_listing_vehicles",
- "attributes": {
- "version": "Multiversity",
- "drivetrain": "Gotham Central",
- "production_year": 2021,
- "mileage": 172000,
- "engine_capacity": null,
- "engine_type": [
- "phev_rev"
], - "power": 374,
- "power_unit": "bhp",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "nameplate_name": "XE",
- "nameplate_brand_name": "Mahindra",
- "price_hidden": false,
- "prices_type": null,
- "video_url": null,
- "state": "approved",
- "order_number": null,
- "model_display_name": "Mahindra XE",
- "price_metadata": { },
- "owner_name": "Predovic LLC",
- "owner_metadata": { },
- "disclaimers": { },
- "hybrid_type": [
- "phev_rev"
], - "status": "available_soon",
- "color_name": "Raspberry Plastic",
- "msrp_price": "225000.0",
- "sale_price": null,
- "monthly_price": null,
- "subscribe_price": null,
- "cover_photo": null,
- "cover_photo_medium": null,
- "query_match": {
- "nameplate": true,
- "brand": true
}
}
}, - {
- "id": "196",
- "type": "light_listing_vehicles",
- "attributes": {
- "version": "JLA: Earth 2",
- "drivetrain": "Superman For All Seasons",
- "production_year": 2006,
- "mileage": 760000,
- "engine_capacity": null,
- "engine_type": [
- "bev"
], - "power": 365,
- "power_unit": "bhp",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "nameplate_name": "XE",
- "nameplate_brand_name": "Mahindra",
- "price_hidden": false,
- "prices_type": null,
- "video_url": null,
- "state": "approved",
- "order_number": null,
- "model_display_name": "Mahindra XE",
- "price_metadata": { },
- "owner_name": "Morissette Group",
- "owner_metadata": { },
- "disclaimers": { },
- "hybrid_type": [ ],
- "status": "available_soon",
- "color_name": "Red Silk",
- "msrp_price": "541000.0",
- "sale_price": null,
- "monthly_price": null,
- "subscribe_price": null,
- "cover_photo": null,
- "cover_photo_medium": null,
- "query_match": {
- "nameplate": true,
- "brand": true
}
}
}
], - "meta": {
- "limit": null,
- "total_vehicle_count": 3,
- "nameplate_name": "XE"
}
}
This endpoint inherits a lot of behaviour and data format from private /vehicles/:id
endpoint but some
details were adapted to better match publich "widget" use case. Differences are:
photos
and lisitings
relationships are listed. owner
, color
, nameplate
etc are ommittedphotos
are included by defaultuuids | string Example: f751d4c8-649f-4901-a70e-71ba180f02e8 |
vehicle_id | number Example: 219 |
uuid required | string Example: uuid=d6af041b-8a7b-4560-bfaa-d5b8f502710c Listing UUID value |
vehicle_id required | number Example: vehicle_id=12 Vehicle ID |
Accept | any Example: application/vnd.api+json |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "219",
- "type": "active_vehicle",
- "attributes": {
- "version": "Crisis On Infinite Earths",
- "drivetrain": "Multiversity",
- "production_year": 2008,
- "short_description": "Qui commodi sapiente at minima occaecati minus sit dolores quia.",
- "long_description": "Aut similique reiciendis et et qui a voluptas libero inventore quis ea at neque unde quo eaque saepe nesciunt dicta.",
- "state": "used",
- "delivery_date": "2024-11-24",
- "transmission": "manual",
- "vin": null,
- "mileage": 423000,
- "engine_capacity": null,
- "battery_capacity": null,
- "engine_type": [
- "petrol"
], - "power": 402,
- "video_url": null,
- "created_at": "2024-11-05T13:43:10.750Z",
- "updated_at": "2024-11-05T13:43:10.965Z",
- "power_unit": "bhp",
- "currency": "XFU",
- "mileage_unit": "km",
- "engine_capacity_unit": "cc",
- "engine_capacity_normalized": null,
- "features_standard": [ ],
- "features_optional": [ ],
- "nameplate_name": "Arcturan Megagrasshopper",
- "nameplate_brand_name": "Škoda",
- "nameplate_external_code": "Y123",
- "external_code": "Y123",
- "external_code_long": "Y123",
- "owner_address": "Apt. 211 396 Ruthe Parkways, Lake Emeldamouth, MI 33654",
- "owner_city": "Kuphalmouth",
- "owner_opening_hours": "<p>Mon-Fri: 9:00 - 19:00<br>\nSat: 11:00 - 18:00<br>\nSun: Closed</p>\n",
- "owner_contact_details": "<p>2535 Nery Ridges<br>\nNew Ward</p>\n",
- "owner_external_code": "DealerCodeXYZ",
- "owner_phone": "+64 779-991-3947 x73914",
- "owner_zipcode": null,
- "owner_skip_company_name_in_location": false,
- "owner_state": null,
- "owner_uuid": "c025ed92-f89d-4791-bd4b-6519751394b3",
- "owner_metadata": { },
- "interior_color": "Ebony",
- "price_hidden": false,
- "prices_type": null,
- "external_id": "013bc8",
- "footnote": "Laboriosam sit modi ab nobis rem ut similique architecto harum.",
- "config_url": null,
- "order_number": null,
- "model_display_name": "Škoda Arcturan Megagrasshopper",
- "nameplate_model_group": null,
- "metadata": null,
- "price_metadata": { },
- "code5000": null,
- "disclaimers": { },
- "price_breakdown": false,
- "base_price": null,
- "total_price": null,
- "status": "on_demand",
- "color_name": "Raspberry Aluminum",
- "color_canonical": "bronze",
- "owner_name": "Zieme, Harris and Leuschke",
- "msrp_price": "262000.0",
- "sale_price": null,
- "monthly_price": null,
- "subscribe_price": null,
- "cover_photo": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTIzLCJwdXIiOiJibG9iX2lkIn19--61cd9a0bb12a7e1ff449661d55271485dd8bc297/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "cover_photo_thumb": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTIzLCJwdXIiOiJibG9iX2lkIn19--61cd9a0bb12a7e1ff449661d55271485dd8bc297/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "cover_photo_small": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTIzLCJwdXIiOiJibG9iX2lkIn19--61cd9a0bb12a7e1ff449661d55271485dd8bc297/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "cover_photo_medium": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTIzLCJwdXIiOiJibG9iX2lkIn19--61cd9a0bb12a7e1ff449661d55271485dd8bc297/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "cover_photo_big": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTIzLCJwdXIiOiJibG9iX2lkIn19--61cd9a0bb12a7e1ff449661d55271485dd8bc297/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "cover_photo_full": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTIzLCJwdXIiOiJibG9iX2lkIn19--61cd9a0bb12a7e1ff449661d55271485dd8bc297/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "cover_photo_quarter_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTIzLCJwdXIiOiJibG9iX2lkIn19--61cd9a0bb12a7e1ff449661d55271485dd8bc297/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "cover_photo_hd": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTIzLCJwdXIiOiJibG9iX2lkIn19--61cd9a0bb12a7e1ff449661d55271485dd8bc297/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg",
- "attachment_url": null,
- "avl_field": { },
- "financing_options": {
- "cash": true,
- "lease": false,
- "rent": false
}
}, - "relationships": {
- "listings": {
- "data": [
- {
- "id": "51",
- "type": "listing"
}
]
}, - "photos": {
- "data": [
- {
- "id": "124",
- "type": "photo"
}, - {
- "id": "125",
- "type": "photo"
}, - {
- "id": "126",
- "type": "photo"
}
]
}, - "owner": {
- "data": {
- "id": "535",
- "type": "company"
}
}, - "current_listing": {
- "data": {
- "id": "51",
- "type": "listing"
}
}
}, - "links": {
- "self": "/public_api/listing/f751d4c8-649f-4901-a70e-71ba180f02e8/vehicle/219",
- "all": "/public_api/listing/f751d4c8-649f-4901-a70e-71ba180f02e8"
}
}, - "meta": {
- "buttons": [
- {
- "id": 79,
- "label": "odio",
- "target_type": "url",
- "target_action": "self",
- "button_type": "secondary",
- "created_at": "2024-11-05T13:43:10.629Z",
- "updated_at": "2024-11-05T13:43:10.670Z",
- "button_set_id": 177,
- "button_set_setup_id": 119
}, - {
- "id": 80,
- "label": "eos",
- "target_type": "url",
- "target_action": "self",
- "button_type": "secondary",
- "created_at": "2024-11-05T13:43:10.643Z",
- "updated_at": "2024-11-05T13:43:10.671Z",
- "button_set_id": 178,
- "button_set_setup_id": 119
}, - {
- "id": 81,
- "label": "ut",
- "target_type": "url",
- "target_action": "self",
- "button_type": "secondary",
- "created_at": "2024-11-05T13:43:10.657Z",
- "updated_at": "2024-11-05T13:43:10.671Z",
- "button_set_id": 179,
- "button_set_setup_id": 119
}
], - "prices": {
- "msrp_price": "262000.0",
- "sale_price": null,
- "monthly_price": null,
- "subscribe_price": null
}
}, - "included": [
- {
- "id": "124",
- "type": "photo",
- "attributes": {
- "sequence": 0,
- "thumb_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTIzLCJwdXIiOiJibG9iX2lkIn19--61cd9a0bb12a7e1ff449661d55271485dd8bc297/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "image_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTIzLCJwdXIiOiJibG9iX2lkIn19--61cd9a0bb12a7e1ff449661d55271485dd8bc297/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "small_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTIzLCJwdXIiOiJibG9iX2lkIn19--61cd9a0bb12a7e1ff449661d55271485dd8bc297/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "medium_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTIzLCJwdXIiOiJibG9iX2lkIn19--61cd9a0bb12a7e1ff449661d55271485dd8bc297/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "big_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTIzLCJwdXIiOiJibG9iX2lkIn19--61cd9a0bb12a7e1ff449661d55271485dd8bc297/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "full_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTIzLCJwdXIiOiJibG9iX2lkIn19--61cd9a0bb12a7e1ff449661d55271485dd8bc297/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "quarter_hd_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTIzLCJwdXIiOiJibG9iX2lkIn19--61cd9a0bb12a7e1ff449661d55271485dd8bc297/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "hd_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTIzLCJwdXIiOiJibG9iX2lkIn19--61cd9a0bb12a7e1ff449661d55271485dd8bc297/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg"
}, - "relationships": {
- "vehicle": {
- "data": {
- "id": "219",
- "type": "vehicle"
}
}
}
}, - {
- "id": "125",
- "type": "photo",
- "attributes": {
- "sequence": 0,
- "thumb_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTI0LCJwdXIiOiJibG9iX2lkIn19--4a9146a1eb405815e69c411c2e307b266d1d2caf/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "image_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTI0LCJwdXIiOiJibG9iX2lkIn19--4a9146a1eb405815e69c411c2e307b266d1d2caf/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "small_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTI0LCJwdXIiOiJibG9iX2lkIn19--4a9146a1eb405815e69c411c2e307b266d1d2caf/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "medium_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTI0LCJwdXIiOiJibG9iX2lkIn19--4a9146a1eb405815e69c411c2e307b266d1d2caf/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "big_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTI0LCJwdXIiOiJibG9iX2lkIn19--4a9146a1eb405815e69c411c2e307b266d1d2caf/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "full_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTI0LCJwdXIiOiJibG9iX2lkIn19--4a9146a1eb405815e69c411c2e307b266d1d2caf/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "quarter_hd_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTI0LCJwdXIiOiJibG9iX2lkIn19--4a9146a1eb405815e69c411c2e307b266d1d2caf/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "hd_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTI0LCJwdXIiOiJibG9iX2lkIn19--4a9146a1eb405815e69c411c2e307b266d1d2caf/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg"
}, - "relationships": {
- "vehicle": {
- "data": {
- "id": "219",
- "type": "vehicle"
}
}
}
}, - {
- "id": "126",
- "type": "photo",
- "attributes": {
- "sequence": 0,
- "thumb_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTI1LCJwdXIiOiJibG9iX2lkIn19--b2605bc1a4fc3d68362ecfbdbf186698a89cc13d/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQwMCwzMDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--5b332f4bc17fb51559915d6363a7724c23a065b9/1.jpg",
- "image_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTI1LCJwdXIiOiJibG9iX2lkIn19--b2605bc1a4fc3d68362ecfbdbf186698a89cc13d/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2MDAsMTIwMCx7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--51441c3b6b84d38bfc960d6336be6f299f10505b/1.jpg",
- "small_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTI1LCJwdXIiOiJibG9iX2lkIn19--b2605bc1a4fc3d68362ecfbdbf186698a89cc13d/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzE2NSw5Mix7ImJhY2tncm91bmQiOlsyMzgsMjM4LDIzOCwyMzhdLCJhbHBoYSI6dHJ1ZX1dLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--b2b1876f5a5c4f28d57c8035c0079f7a53fd8ef6/1.jpg",
- "medium_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTI1LCJwdXIiOiJibG9iX2lkIn19--b2605bc1a4fc3d68362ecfbdbf186698a89cc13d/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzQyMCwyMzYseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--9089f35d04538c3eb95b4b89e8175853eb8d3160/1.jpg",
- "big_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTI1LCJwdXIiOiJibG9iX2lkIn19--b2605bc1a4fc3d68362ecfbdbf186698a89cc13d/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzc1Miw0MjMseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--b1f7576638d6bfc2db8f3925e0310ee2486b307c/1.jpg",
- "full_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTI1LCJwdXIiOiJibG9iX2lkIn19--b2605bc1a4fc3d68362ecfbdbf186698a89cc13d/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfdG9fbGltaXQiOlsxOTIwLDEwODBdLCJzYXZlciI6eyJxdWFsaXR5Ijo4NX19LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f4beb7c0c6e94e078b934802e08e23486ed4a23c/1.jpg",
- "quarter_hd_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTI1LCJwdXIiOiJibG9iX2lkIn19--b2605bc1a4fc3d68362ecfbdbf186698a89cc13d/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6Wzk2MCw1NDAseyJiYWNrZ3JvdW5kIjpbMjM4LDIzOCwyMzgsMjM4XSwiYWxwaGEiOnRydWV9XSwic2F2ZXIiOnsicXVhbGl0eSI6ODV9fSwicHVyIjoidmFyaWF0aW9uIn19--ccc214dd27d0c7796c2a7b853d4e56ffbe267fba/1.jpg",
- "hd_path": "/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTI1LCJwdXIiOiJibG9iX2lkIn19--b2605bc1a4fc3d68362ecfbdbf186698a89cc13d/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJqcGciLCJyZXNpemVfYW5kX3BhZCI6WzEyODAsNzIwLHsiYmFja2dyb3VuZCI6WzIzOCwyMzgsMjM4LDIzOF0sImFscGhhIjp0cnVlfV0sInNhdmVyIjp7InF1YWxpdHkiOjg1fX0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--f290459fadc32eee8a2c0e59960f49fabcbaa2cb/1.jpg"
}, - "relationships": {
- "vehicle": {
- "data": {
- "id": "219",
- "type": "vehicle"
}
}
}
}, - {
- "id": "115",
- "type": "button_set_setup",
- "attributes": {
- "financing_options": [ ],
- "reservation_fee": null,
- "setup_type": "standard"
}, - "relationships": {
- "button_set": {
- "data": {
- "id": "181",
- "type": "button_set"
}
}, - "buttons": {
- "data": [
- {
- "id": "77",
- "type": "button"
}, - {
- "id": "78",
- "type": "button"
}
]
}
}
}, - {
- "id": "119",
- "type": "button_set_setup",
- "attributes": {
- "financing_options": [ ],
- "reservation_fee": null,
- "setup_type": "standard"
}, - "relationships": {
- "button_set": {
- "data": {
- "id": "181",
- "type": "button_set"
}
}, - "buttons": {
- "data": [
- {
- "id": "79",
- "type": "button"
}, - {
- "id": "80",
- "type": "button"
}, - {
- "id": "81",
- "type": "button"
}
]
}
}
}, - {
- "id": "77",
- "type": "button",
- "attributes": {
- "label": "est",
- "button_type": "secondary",
- "target_type": "url",
- "target_action": "self"
}, - "relationships": {
- "button_set": {
- "data": {
- "id": "174",
- "type": "button_set"
}
}
}
}, - {
- "id": "78",
- "type": "button",
- "attributes": {
- "label": "iste",
- "button_type": "secondary",
- "target_type": "url",
- "target_action": "self"
}, - "relationships": {
- "button_set": {
- "data": {
- "id": "175",
- "type": "button_set"
}
}
}
}, - {
- "id": "79",
- "type": "button",
- "attributes": {
- "label": "odio",
- "button_type": "secondary",
- "target_type": "url",
- "target_action": "self"
}, - "relationships": {
- "button_set": {
- "data": {
- "id": "177",
- "type": "button_set"
}
}
}
}, - {
- "id": "80",
- "type": "button",
- "attributes": {
- "label": "eos",
- "button_type": "secondary",
- "target_type": "url",
- "target_action": "self"
}, - "relationships": {
- "button_set": {
- "data": {
- "id": "178",
- "type": "button_set"
}
}
}
}, - {
- "id": "81",
- "type": "button",
- "attributes": {
- "label": "ut",
- "button_type": "secondary",
- "target_type": "url",
- "target_action": "self"
}, - "relationships": {
- "button_set": {
- "data": {
- "id": "179",
- "type": "button_set"
}
}
}
}, - {
- "id": "181",
- "type": "button_set",
- "attributes": {
- "button_set_type": "standard",
- "financing_options": null,
- "name": "nihil 179",
- "reservation_fee": null
}, - "relationships": {
- "buttons": {
- "data": [
- {
- "id": "77",
- "type": "button"
}, - {
- "id": "78",
- "type": "button"
}, - {
- "id": "79",
- "type": "button"
}, - {
- "id": "80",
- "type": "button"
}, - {
- "id": "81",
- "type": "button"
}
]
}, - "button_set_setups": {
- "data": [
- {
- "id": "115",
- "type": "button_set_setup"
}, - {
- "id": "119",
- "type": "button_set_setup"
}
]
}
}
}, - {
- "id": "51",
- "type": "listing",
- "attributes": {
- "disclaimers": { },
- "uuid": "f751d4c8-649f-4901-a70e-71ba180f02e8"
}, - "relationships": {
- "button_set": {
- "data": {
- "id": "181",
- "type": "button_set"
}
}
}
}
]
}
This endpoint fetches Vehicle info from OSVD API and tries to generate a configurator URL for that Vehicle. To make it work properly, the Vehicle should have proper values of either VIN or Order Number.
If some values are null, it means that the endpoint was not able to fetch the requested data from one of the APIs.
uuids | string Example: ec2d961d-4d17-408d-a771-f247a2931bc8 |
vehicle_id | number Example: 224 |
uuid required | string Example: uuid=d6af041b-8a7b-4560-bfaa-d5b8f502710c Listing UUID value |
vehicle_id required | number Example: vehicle_id=12 Vehicle ID |
Accept | any Example: application/vnd.api+json |
Content-Type | any Example: application/vnd.api+json |
{- "data": {
- "id": "224",
- "type": "vehicle_osvd_data",
- "attributes": {
- "vin": "SADHA2B18P1630309",
- "external_code": "X",
- "owner_id": 558,
- "owner_external_code": "DealerCodeXYZ",
- "external_id": "ext_id_val",
- "config_url": {
}, - "engine_no": "Not Applicable",
- "registration_no": null,
- "type": "ActiveVehicle",
- "metadata": null
}
}, - "meta": {
- "errors": [ ]
}
}
uuids | string Example: 32387fc2-1d9b-42d5-a1ef-4eae8d2dcb48 |
uuids required | string Example: uuids=d6af041b-8a7b-4560-bfaa-d5b8f502710c Listing UUID value |
Accept | any Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5 |
{- "32387fc2-1d9b-42d5-a1ef-4eae8d2dcb48": [
- "Range Rover Velar",
- "Discovery"
]
}
Is used to store config for origin urls.
It contains config_type
attribute with possible values default
, cash
, lease
, subscription
and additional
. Each origin can have single config per each type.
GET /public_api/company_config/all
This endpoint is used to fetch configs for declared origin. By default it returns all configs for that origin.
To fetch config for the specific origin, it has to be declared in Company-Config
header . For example:
Company-Config: 'https://jaguar.com'
param | example | type | required | description |
---|---|---|---|---|
config_type | additional,cash | string | no | used to filter config types, multiple types have to be separated by comma |
Response is an array of configs for origin declared in the header. Each of the contains attributes data
and config_type
Accept | any Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5 |
{- "data": [
- {
- "id": "37",
- "type": "company_config",
- "attributes": {
- "data": {
- "a": 1
}, - "config_type": "general_mazda"
}
}, - {
- "id": "38",
- "type": "company_config",
- "attributes": {
- "data": {
- "a": 1
}, - "config_type": "order_online_mazda"
}
}, - {
- "id": "39",
- "type": "company_config",
- "attributes": {
- "data": {
- "a": 1
}, - "config_type": "order_online_steps_page_mazda"
}
}
]
}
GET /public_api/company_config/(:config_type)
This endpoint is used to fetch a specific config for declared origin. By default it returns default config for that origin.
To fetch config for the specific origin, it has to be declared in Company-Config
header . For example:
Company-Config: 'https://jaguar.com'
param | example | type | required | description |
---|---|---|---|---|
config_type | additional | string | no | used to fetch config of specific type |
Response is an config object containing attributes data
and config_type
Accept | any Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5 |
{- "data": {
- "id": "54",
- "type": "company_config",
- "attributes": {
- "data": {
- "a": 1
}, - "config_type": "order_online_mazda"
}
}
}
Is used to store configs for stock matching.
It contains data
attribute to store config and keys
array to identify config
GET /public_api/sl_configurator_journey_configs/:key
This endpoint is used to fetch a specific stock matching config by its key.
param | example | type | required | description |
---|---|---|---|---|
key | first | string | yes (in url) | used to fetch config |
Response is an config object containing attributes data
key | string Example: third |
Accept | any Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5 |
{- "data": {
- "id": "2",
- "type": "stock_matching_config",
- "attributes": {
- "data": {
- "a": 1
}
}
}
}
Is used to store configs for widget translations.
It contains data
attribute to store config and keys
array to identify config
GET /public_api/widget_translations_configs/:key
This endpoint is used to fetch a specific widget translations config by its key.
param | example | type | required | description |
---|---|---|---|---|
key | first | string | yes (in url) | used to fetch config |
Response is an config object containing attributes data
key | string Example: second |
Accept | any Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5 |
{- "data": {
- "id": "2",
- "type": "widget_translations_config",
- "attributes": {
- "data": {
- "test": "test"
}
}
}
}
FeatureSuggestions are dictionary suggestions entries which are inteded to be used as suggestions for user filling out the Vechile form features section either while adding or editing the Cars.
The FeatureSuggestions
list is updated each time Vehicle is saved to database (created or updated).
Thay are not designed to be manipulated through the API directly.
NOTE: Due to this behaviour X-Comapny-UUID
header is required to filter suggestions based on Company
ownership.
As their intended used is a table with Vehicle
features they always contain label
attrbiute and
optionally can contain code
and category
attributes as well depending on the data filed in the vehicle.
code_query | string Example: A12 |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: 9a91e457-db4c-4394-98f5-67b3a4e82c7a |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "2",
- "type": "feature_suggestion",
- "attributes": {
- "code": "A124",
- "label": "downcase word",
- "locale": "en",
- "category": "convenience",
- "depth": 1
}
}, - {
- "id": "1",
- "type": "feature_suggestion",
- "attributes": {
- "code": "A123",
- "label": "Word Capitalized",
- "locale": "en",
- "category": "lights",
- "depth": 0
}
}
]
}
label_query | string Example: word |
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: a76b3c3e-12c5-48a9-ae74-a71282ca090f |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "6",
- "type": "feature_suggestion",
- "attributes": {
- "code": "A124",
- "label": "downcase word",
- "locale": "es_mx",
- "category": "seats",
- "depth": 1
}
}, - {
- "id": "5",
- "type": "feature_suggestion",
- "attributes": {
- "code": "A123",
- "label": "Word Capitalized",
- "locale": "es_mx",
- "category": "convenience",
- "depth": 0
}
}
]
}
SimpleSuggestions are simple string based dictionary suggestions which are inteded to be used as suggestions for user filling out the Vechile form either while adding or editing the Cars
The SimpleSuggestion
s list is updated each time Vehicle is saved to database (created or updated).
Thay are not designed to be manipulated through the API directly.
Suggestions are inherited through the companies hierarchy. If Importer already has one Suggestion
in the database the Dealers will see this Suggestion
as well and it will not be automatically
duplicated when adding a Vehicle
NOTE: Due to this behaviour X-Comapny-UUID
header is required to filter suggestions based on Company
ownership.
SimpleSuggestion
will handle only drivetrain
and version
fields.
Versions suggestions are accessed through /suggestions/versions
endpoint.
Simply calling this endpoint will return all version suggestions available for a Company
To filter only to some selected values the endpoint should be called with URL like this:
/suggestions/versions/Value
This will only list Suggestions with case insensitive "value" string inside content
column
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: fb11301f-d9a6-4f82-8f8a-069c4db2ffea |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "2",
- "type": "simple_suggestion",
- "attributes": {
- "content": "downcase version",
- "locale": "en",
- "kind": "version",
- "depth": 1
}
}, - {
- "id": "1",
- "type": "simple_suggestion",
- "attributes": {
- "content": "Version Capitalized",
- "locale": "en",
- "kind": "version",
- "depth": 0
}
}, - {
- "id": "4",
- "type": "simple_suggestion",
- "attributes": {
- "content": "other content",
- "locale": "en",
- "kind": "version",
- "depth": 0
}
}
]
}
Drivetrains suggestions are accessed through /suggestions/drivetrains
endpoint.
Simply calling this endpoint will return all drivetrain suggestions available for a Company
To filter only to some selected values the endpoint should be called with URL like this:
/suggestions/drivetrains/Petrol
This will only list Suggestions with case insensitive "Petrol" string inside content
column
Accept | any Example: application/vnd.api+json |
X-Company-UUID | any Example: c0d5b144-a12d-43bf-bfdf-6acdbc6fd37c |
Authorization | any Example: Bearer STUB_TOKEN_STRING |
Content-Type | any Example: application/vnd.api+json |
{- "data": [
- {
- "id": "10",
- "type": "simple_suggestion",
- "attributes": {
- "content": "petrol 2",
- "locale": "en",
- "kind": "drivetrain",
- "depth": 1
}
}, - {
- "id": "9",
- "type": "simple_suggestion",
- "attributes": {
- "content": "Petrol 1",
- "locale": "en",
- "kind": "drivetrain",
- "depth": 0
}
}, - {
- "id": "12",
- "type": "simple_suggestion",
- "attributes": {
- "content": "Diesel 1",
- "locale": "en",
- "kind": "drivetrain",
- "depth": 0
}
}
]
}