stock API documentation

about 8 hours ago

Change #7704c83e

1.0

Compare

3 structure changes including:

2 Additions

1 Modification

Modified 1

PATCH /v1/stock/{stockId}

Body
application/json content type Modified
- property Removed

Added 2

POST /v1/listings/{listingId}/mark-as-not-sold

POST /v1/listings/{listingId}/mark-as-provisional

25 days ago

Change #a74cb4e7

1.0

Compare

3 structure changes including:

3 Modifications

Modified 3

GET /v1/stock/{stockId}

Response
200 response Modified
- application/json content type Modified
  - additionalData property Modified
    - test_name, test_group properties Added

PATCH /v1/stock/{stockId}

Response
200 response Modified
- application/json content type Modified
  - additionalData property Modified
    - test_name, test_group properties Added

POST /v1/stock

Body
application/json content type Modified
- additionalData property Modified
  - test_name, test_group properties Added
Response
200 response Modified
- application/json content type Modified
  - additionalData property Modified
    - test_name, test_group properties Added

Mar 13, 2025

Change #8d0e349e

1.0

Compare

2 structure changes including:

2 Modifications

Modified 2

GET /v1/stock

Query
customerId query parameter Modified
- Type is now array[string]

PATCH /v1/stock/{stockId}

Body
application/json content type Modified
- property Added

Mar 13, 2025

Change #0af0355d

1.0

Compare

2 structure changes including:

2 Modifications

Modified 2

GET /v1/listings/{listingId}

Response
200 response Modified
- application/json content type Modified
  - negotiation property Modified
    - buyer property Modified
  - sale property Modified
    - buyer property Modified

POST /v1/listings/{listingId}/mark-as-sold

Response
200 response Modified
- application/json content type Modified
  - negotiation property Modified
    - buyer property Modified
  - sale property Modified
    - buyer property Modified

Feb 25, 2025

Change #88d0b231

1.0

Compare

2 structure changes including:

2 Modifications

Modified 2

GET /v1/listings/{listingId}

Response
200 response Modified
- application/json content type Modified
  - negotiation property Modified
    - price, buyer properties Added

POST /v1/listings/{listingId}/mark-as-sold

Response
200 response Modified
- application/json content type Modified
  - negotiation property Modified
    - price, buyer properties Added

Feb 25, 2025

Change #dba504a9

1.0

Compare

4 structure changes including:

1 Addition

3 Modifications

Modified 3

GET /v1/stock/{stockId}

Response
200 response Modified
- application/json content type Modified
  - additionalData property Modified
    - v5c_in_different_name property Added

PATCH /v1/stock/{stockId}

Response
200 response Modified
- application/json content type Modified
  - additionalData property Modified
    - v5c_in_different_name property Added

POST /v1/stock

Body
application/json content type Modified
- additionalData property Modified
  - v5c_in_different_name property Added
Response
200 response Modified
- application/json content type Modified
  - additionalData property Modified
    - v5c_in_different_name property Added

Added 1

POST /v1/listings/{listingId}/mark-as-sold

Nov 19, 2024

Change #adf9cdc3

1.0

Compare

4 structure changes including:

4 Modifications

Modified 4

GET /v1/stock

Query
deleted query parameter Added

GET /v1/stock/{stockId}

Response
200 response Modified
- application/json content type Modified
  - additionalData property Modified
    - c2b_top_nav_journey property Added

PATCH /v1/stock/{stockId}

Response
200 response Modified
- application/json content type Modified
  - additionalData property Modified
    - c2b_top_nav_journey property Added

POST /v1/stock

Body
application/json content type Modified
- additionalData property Modified
  - c2b_top_nav_journey property Added
Response
200 response Modified
- application/json content type Modified
  - additionalData property Modified
    - c2b_top_nav_journey property Added

Sep 11, 2024

Change #af674d08

1.0

Compare

3 structure changes including:

3 Modifications

Modified 3

GET /v1/stock/{stockId}

Response
200 response Modified
- application/json content type Modified
  - images property Modified
    - platformUrl property Added

PATCH /v1/stock/{stockId}

Response
200 response Modified
- application/json content type Modified
  - images property Modified
    - platformUrl property Added

POST /v1/stock

Response
200 response Modified
- application/json content type Modified
  - images property Modified
    - platformUrl property Added

Aug 7, 2024

Change #8bcb5c38

1.0

Breaking

Compare

3 structure changes including:

3 Modifications

Modified 3 Breaking

GET /v1/stock/{stockId}

Response
200 response Modified
- application/json content type Modified
  - additionalData property Modified

PATCH /v1/stock/{stockId}

Response
200 response Modified
- application/json content type Modified
  - additionalData property Modified

POST /v1/stock

Body
application/json content type Modified
- additionalData property Modified
  - electrical_dashboard_working, electrical_speakers_working, electrical_satnav_working, panel_any_respray, panel_any_replaced, panel_note properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - electrical_dashboard_not_working, electrical_speakers_not_working, electrical_satnav_not_working, bodywork_repairs, bodywork_repairs_note, bodywork_issues, bodywork_issues_note, vehicle_modifications, vehicle_modifications_note properties Added
Response
200 response Modified
- application/json content type Modified
  - additionalData property Modified

Jul 11, 2024

Change #98ee171c

1.0

Compare

1 structure change including:

1 Addition

Added 1

POST /v1/testing/set-auction-end-time

Jun 21, 2024

Change #7ae71112

1.0

Breaking

Compare

2 structure changes including:

1 Addition

1 Modification

Modified 1 Breaking

GET /v1/listings/{listingId}

Response
200 response Modified
- application/json content type Modified
  - sellerDocumentation property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

Added 1

GET /v1/vehicle-documentation/{stockId}

Jun 21, 2024

Change #6f8e4477

1.0

Breaking

Compare

1 structure change including:

1 Modification

Modified 1 Breaking

GET /v1/listings/{listingId}

Response
200 response Modified
- application/json content type Modified
  - secureDocuments property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - sellerDocumentation property Added

Jun 21, 2024

Change #8ed9c180

1.0

Compare

1 structure change including:

1 Modification

Modified 1

GET /v1/listings/{listingId}

Response
200 response Modified
- application/json content type Modified
  - secureDocuments property Added

Jun 6, 2024

Change #c3474eff

1.0

Breaking

Compare

5 structure changes including:

5 Modifications

Modified 5 Breaking

GET /v1/listings/{listingId}

Response
200 response Modified
- application/json content type Modified
  - auction, negotiation properties Modified
  - sale property Modified
    - Full types went from object | null to object
      Breaking
400 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking
  - errors property Modified
    - Full types went from array[object | null] | null to array[object]
      Breaking
403 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking
404 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking
409 response Modified
- application/json content type Modified
  - vrm property Modified
    - Full types went from string | null to string
      Breaking
502 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking

GET /v1/stock

Query
customerId query parameter Modified
- Full types is no longer string
  Breaking
Response
200 response Modified
- application/json content type Modified
  - stockItems property Modified
400 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking
  - errors property Modified
    - Full types went from array[object | null] | null to array[object]
      Breaking
403 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking
404 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking
409 response Modified
- application/json content type Modified
  - vrm property Modified
    - Full types went from string | null to string
      Breaking
502 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking

GET /v1/stock/{stockId}

Response
200 response Modified
- application/json content type Modified
  - listingId, lifecycleState, conditionReportUrl, videoUrl, requestedNetwork properties Modified
    - Full types went from string | null to string
      Breaking
  - updatedDate, availableUntil properties Modified
    - Full types went from string(date-time) | null to string(date-time)
      Breaking
  - metadata, vehicle, features, capTaxonomy properties Modified
  - advert, condition, advertiser, additionalData properties Modified
    - Full types went from object | null to object
      Breaking
  - images property Modified
    - Full types went from array[object | null] | null to array[object]
      Breaking
400 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking
  - errors property Modified
    - Full types went from array[object | null] | null to array[object]
      Breaking
403 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking
404 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking
409 response Modified
- application/json content type Modified
  - vrm property Modified
    - Full types went from string | null to string
      Breaking
502 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking

PATCH /v1/stock/{stockId}

Body
application/json content type Modified
- string-1 property Removed
Response
200 response Modified
- application/json content type Modified
  - listingId, lifecycleState, conditionReportUrl, videoUrl, requestedNetwork properties Modified
    - Full types went from string | null to string
      Breaking
  - updatedDate, availableUntil properties Modified
    - Full types went from string(date-time) | null to string(date-time)
      Breaking
  - metadata, vehicle, features, capTaxonomy properties Modified
  - advert, condition, advertiser, additionalData properties Modified
    - Full types went from object | null to object
      Breaking
  - images property Modified
    - Full types went from array[object | null] | null to array[object]
      Breaking
400 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking
  - errors property Modified
    - Full types went from array[object | null] | null to array[object]
      Breaking
403 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking
404 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking
409 response Modified
- application/json content type Modified
  - vrm property Modified
    - Full types went from string | null to string
      Breaking
502 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking

POST /v1/stock

Body
application/json content type Modified
- metadata property Modified
  - externalStockId, externalVendorId properties Modified
    - Full types went from string | null to string
      Breaking
- vehicle property Modified
  - vrm, vin, derivative, trim, bodyType, fuelType, transmissionType, driveTrain, insuranceGroup, insuranceSecurityCode, colour, engineNumber, serviceHistory, plate properties Modified
    - Full types went from string | null to string
      Breaking
  - mileage, yearOfManufacture, doors, keys, cylinders, previousOwners properties Modified
    - Full types went from integer(int32) | null to integer(int32)
      Breaking
  - dateOfRegistration, motExpiry properties Modified
    - Full types went from string(date) | null to string(date)
      Breaking
  - v5CertificationSupplied, exDemo properties Modified
    - Full types went from boolean | null to boolean
      Breaking
  - engineSize property Modified
    - Full types went from object | null to object
      Breaking
- advert property Modified
  - Full types went from object | null to object
    Breaking
  - state, attentionGrabber, description, tradeVatStatus, externalUrl properties Modified
    - Full types went from string | null to string
      Breaking
  - auction property Modified
    - Full types went from object | null to object
      Breaking
  - startDate, endDate properties Modified
    - Full types went from string(date-time) | null to string(date-time)
- features property Modified
- conditionReportUrl property Modified
  - Full types went from string | null to string
    Breaking
  - conditionReportUrl property Modified
    - Full types went from string | null to string
      Breaking
- condition property Modified
  - Full types went from object | null to object
    Breaking
  - externalConditionGrade, surecheckGrade properties Modified
    - Full types went from string | null to string
      Breaking
  - damageItems property Modified
    - Full types went from array[object | null] | null to array[object]
      Breaking
- videoUrl property Modified
  - Full types went from string | null to string
    Breaking
  - videoUrl property Modified
    - Full types went from string | null to string
      Breaking
- images property Modified
  - Full types went from array[object | null] | null to array[object]
    Breaking
- availableUntil property Modified
  - Full types went from string(date-time) | null to string(date-time)
    Breaking
  - availableUntil property Modified
    - Full types went from string(date-time) | null to string(date-time)
      Breaking
- requestedNetwork property Modified
  - Full types went from string | null to string
    Breaking
  - requestedNetwork property Modified
    - Full types went from string | null to string
      Breaking
- advertiser property Modified
  - Full types went from object | null to object
    Breaking
  - address, contact properties Modified
    - Full types went from object | null to object
      Breaking
- additionalData property Modified
  - Full types went from object | null to object
    Breaking
  - Additional properties, key properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - mechanical_fails_start, mechanical_bad_gearbox, mechanical_unusual_noise, mechanical_veers, mechanical_warning_light, mechanical_exhaust_smoke, mechanical_leaks, mechanical_note, electrical_aircon_not_cold, electrical_dashboard_working, electrical_speakers_working, electrical_satnav_working, electrical_note, odour_smoke, odour_pet, odour_damp, odour_note, panel_any_respray, panel_any_replaced, panel_note, Additional properties are NOT allowed properties Added
Response
200 response Modified
- application/json content type Modified
  - listingId, lifecycleState, conditionReportUrl, videoUrl, requestedNetwork properties Modified
    - Full types went from string | null to string
      Breaking
  - updatedDate, availableUntil properties Modified
    - Full types went from string(date-time) | null to string(date-time)
      Breaking
  - metadata, vehicle, features, capTaxonomy properties Modified
  - advert, condition, advertiser, additionalData properties Modified
    - Full types went from object | null to object
      Breaking
  - images property Modified
    - Full types went from array[object | null] | null to array[object]
      Breaking
400 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking
  - errors property Modified
    - Full types went from array[object | null] | null to array[object]
      Breaking
403 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking
404 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking
409 response Modified
- application/json content type Modified
  - vrm property Modified
    - Full types went from string | null to string
      Breaking
502 response Modified
- application/json content type Modified
  - errorMessage property Modified
    - Full types went from string | null to string
      Breaking

Apr 11, 2024

Change #b35ca18c

1.0

Breaking

Compare

5 structure changes including:

5 Modifications

Modified 5 Breaking

GET /v1/listings/{listingId}

Response
200 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
400 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
403 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
404 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
409 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
502 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added

GET /v1/stock

Response
200 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
400 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
403 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
404 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
409 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
502 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added

GET /v1/stock/{stockId}

Response
200 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
400 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
403 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
404 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
409 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
502 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added

PATCH /v1/stock/{stockId}

Response
200 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
400 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
403 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
404 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
409 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
502 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added

POST /v1/stock

Response
200 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
400 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
403 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
404 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
409 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added
502 response Modified
- */* content type Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- application/json content type Added

Apr 8, 2024

Change #93d75d08

1.0

Compare

3 structure changes including:

3 Modifications

Modified 3

GET /v1/stock/{stockId}

Response
200 response Modified
- */* content type Modified
  - additionalData property Added

PATCH /v1/stock/{stockId}

Response
200 response Modified
- */* content type Modified
  - additionalData property Added

POST /v1/stock

Body
application/json content type Modified
- additionalData property Added
Response
200 response Modified
- */* content type Modified
  - additionalData property Added

Apr 2, 2024

Change #cc234750

1.0

Compare

3 structure changes including:

3 Modifications

Modified 3

GET /v1/stock/{stockId}

Response
200 response Modified
- */* content type Modified
  - images property Modified

PATCH /v1/stock/{stockId}

Response
200 response Modified
- */* content type Modified
  - images property Modified

POST /v1/stock

Body
application/json content type Modified
- images property Modified
Response
200 response Modified
- */* content type Modified
  - images property Modified

Jul 25, 2023

Change #4a6cda1d

1.0

Compare

3 structure changes including:

3 Modifications

Modified 3

GET /v1/stock/{stockId}

Response
200 response Modified
- features, images properties Modified

PATCH /v1/stock/{stockId}

Response
200 response Modified
- features, images properties Modified

POST /v1/stock

Body
content type Modified
- features property Modified
Response
200 response Modified
- features, images properties Modified

Jun 15, 2023

Change #7674cd20

1.0

Compare

3 structure changes including:

3 Modifications

Modified 3

GET /v1/stock/{stockId}

Response
200 response Modified
- advert property Modified

PATCH /v1/stock/{stockId}

Response
200 response Modified
- advert property Modified

POST /v1/stock

Body
content type Modified
- advert property Modified
Response
200 response Modified
- advert property Modified

Jun 14, 2023

Change #70e6c85d

1.0

Breaking

Compare

5 structure changes including:

5 Breaking changes

5 Modifications

Modified 5 Breaking

GET /v1/listings/{listingId}

GET /v1/stock

GET /v1/stock/{stockId}

PATCH /v1/stock/{stockId}

POST /v1/stock

Do not miss any stock API changes, ever again

Changelog

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed