stock API documentation

Change #c3474eff

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

Do not miss any stock API changes, ever again

Jun 6, 2024

API structure has changed