Change Updates

Do not miss any stock API changes, ever again

Subscribe to the stock API changelog to be up to date on recent changes.

RSS

26 days ago

main
1.0
Compare

API structure has changed

Next change
10 structure changes including:
10 Modifications
Modified 10 Breaking
GET /v1/listings/{listingId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, stockId, status properties Modified
        • Properties are no longer required
      • auction property Modified
        • Property is no longer required
        • created, startTime, bids, reserveMet, type properties Modified
          • Properties are no longer required
      • negotiation property Modified
        • Property is no longer required
        • buyer property Modified
      • sale property Modified
        • buyer property Modified
  • 400 response Modified
    • application/json content type Modified
      • alternative Modified
        • ErrorInfo, BadRequestErrorInfo alternatives Modified
  • 403 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 404 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 409 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 429 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 500 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 502 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
GET /v1/stock
  • Response
  • 200 response Modified
    • application/json content type Modified
      • stockItems property Modified
        • Property is no longer required
        • id, publicReference, customerId, lifecycleState, createDate properties Modified
          • Properties are no longer required
        • advert property Modified
      • paginator property Modified
        • Property is no longer required
        • currentPage, resultsPerPage, totalResults, lastPage properties Modified
          • Properties are no longer required
  • 400 response Modified
    • application/json content type Modified
      • alternative Modified
        • ErrorInfo, BadRequestErrorInfo alternatives Modified
  • 403 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 404 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 409 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 429 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 500 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 502 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
GET /v1/stock/{stockId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • metadata, customerId, images properties Modified
        • Properties are no longer required
      • vehicle property Modified
        • Property is no longer required
        • category, ownershipCondition, stolen, imported, exported, scrapped properties Modified
          • Properties are no longer required
        • engineSize property Modified
      • advert property Modified
        • auction property Modified
      • features property Modified
        • Property is no longer required
        • description property Modified
          • Property is no longer required
      • condition property Modified
        • damageItems property Modified
        • batteryHealthPercentage, batteryReportUrl properties Added
      • advertiser property Modified
        • address property Modified
      • additionalData property Modified
        • Type went from object to string
          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_not_working, electrical_speakers_not_working, electrical_satnav_not_working, electrical_note, odour_smoke, odour_pet, odour_damp, odour_note, bodywork_repairs, bodywork_repairs_note, bodywork_issues, bodywork_issues_note, vehicle_modifications, vehicle_modifications_note, c2b_top_nav_journey, v5c_in_different_name, test_name, test_group, c2b_valuation_range_lower, c2b_valuation_range_upper, taxi properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
  • 400 response Modified
    • application/json content type Modified
      • alternative Modified
        • ErrorInfo, BadRequestErrorInfo alternatives Modified
  • 403 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 404 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 409 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 429 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 500 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 502 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
GET /v1/vehicle-documentation/{stockId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documents property Modified
        • Property is no longer required
        • category, publicUploadUrl, uploaded properties Modified
          • Properties are no longer required
  • 400 response Modified
    • application/json content type Modified
      • alternative Modified
        • ErrorInfo, BadRequestErrorInfo alternatives Modified
  • 403 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 404 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 409 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 429 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 500 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 502 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
PATCH /v1/stock/{stockId}
  • Body
  • application/json content type Modified
    • JsonNode property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • metadata, customerId, images properties Modified
        • Properties are no longer required
      • vehicle property Modified
        • Property is no longer required
        • category, ownershipCondition, stolen, imported, exported, scrapped properties Modified
          • Properties are no longer required
        • engineSize property Modified
      • advert property Modified
        • auction property Modified
      • features property Modified
        • Property is no longer required
        • description property Modified
          • Property is no longer required
      • condition property Modified
        • damageItems property Modified
        • batteryHealthPercentage, batteryReportUrl properties Added
      • advertiser property Modified
        • address property Modified
      • additionalData property Modified
        • Type went from object to string
          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_not_working, electrical_speakers_not_working, electrical_satnav_not_working, electrical_note, odour_smoke, odour_pet, odour_damp, odour_note, bodywork_repairs, bodywork_repairs_note, bodywork_issues, bodywork_issues_note, vehicle_modifications, vehicle_modifications_note, c2b_top_nav_journey, v5c_in_different_name, test_name, test_group, c2b_valuation_range_lower, c2b_valuation_range_upper, taxi properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
  • 400 response Modified
    • application/json content type Modified
      • alternative Modified
        • ErrorInfo, BadRequestErrorInfo alternatives Modified
  • 403 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 404 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 409 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 429 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 500 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 502 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
POST /v1/listings/{listingId}/mark-as-not-sold
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, stockId, status properties Modified
        • Properties are no longer required
      • auction property Modified
        • Property is no longer required
        • created, startTime, bids, reserveMet, type properties Modified
          • Properties are no longer required
      • negotiation property Modified
        • Property is no longer required
        • buyer property Modified
      • sale property Modified
        • buyer property Modified
  • 400 response Modified
    • application/json content type Modified
      • alternative Modified
        • ErrorInfo, BadRequestErrorInfo alternatives Modified
  • 403 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 404 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 409 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 429 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 500 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 502 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
POST /v1/listings/{listingId}/mark-as-provisional
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, stockId, status properties Modified
        • Properties are no longer required
      • auction property Modified
        • Property is no longer required
        • created, startTime, bids, reserveMet, type properties Modified
          • Properties are no longer required
      • negotiation property Modified
        • Property is no longer required
        • buyer property Modified
      • sale property Modified
        • buyer property Modified
  • 400 response Modified
    • application/json content type Modified
      • alternative Modified
        • ErrorInfo, BadRequestErrorInfo alternatives Modified
  • 403 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 404 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 409 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 429 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 500 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 502 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
POST /v1/listings/{listingId}/mark-as-sold
  • Body
  • application/json content type Modified
    • salePrice property Modified
      • Property is no longer required
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, stockId, status properties Modified
        • Properties are no longer required
      • auction property Modified
        • Property is no longer required
        • created, startTime, bids, reserveMet, type properties Modified
          • Properties are no longer required
      • negotiation property Modified
        • Property is no longer required
        • buyer property Modified
      • sale property Modified
        • buyer property Modified
  • 400 response Modified
    • application/json content type Modified
      • alternative Modified
        • ErrorInfo, BadRequestErrorInfo alternatives Modified
  • 403 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 404 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 409 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 429 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 500 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 502 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
POST /v1/stock
  • Body
  • application/json content type Modified
    • metadata, customerId, images properties Modified
      • Properties are no longer required
    • vehicle property Modified
      • Property is no longer required
      • category, ownershipCondition, stolen, imported, exported, scrapped properties Modified
        • Properties are no longer required
      • engineSize property Modified
        • unit, value properties Modified
          • Properties are no longer required
    • advert property Modified
      • auction property Modified
        • type property Modified
          • Property is no longer required
        • startingPrice, reservePrice, askingPrice, buyNowPrice properties Modified
    • features property Modified
      • Property is no longer required
      • description property Modified
        • Property is no longer required
    • condition property Modified
      • damageItems property Modified
        • zone, damageType properties Modified
          • Properties are no longer required
      • batteryHealthPercentage, batteryReportUrl properties Added
    • advertiser property Modified
      • address property Modified
        • latLong property Modified
    • additionalData property Modified
      • Type went from object to string
        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_not_working, electrical_speakers_not_working, electrical_satnav_not_working, electrical_note, odour_smoke, odour_pet, odour_damp, odour_note, bodywork_repairs, bodywork_repairs_note, bodywork_issues, bodywork_issues_note, vehicle_modifications, vehicle_modifications_note, c2b_top_nav_journey, v5c_in_different_name, test_name, test_group, c2b_valuation_range_lower, c2b_valuation_range_upper, taxi properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • metadata, customerId, images properties Modified
        • Properties are no longer required
      • vehicle property Modified
        • Property is no longer required
        • category, ownershipCondition, stolen, imported, exported, scrapped properties Modified
          • Properties are no longer required
        • engineSize property Modified
      • advert property Modified
        • auction property Modified
      • features property Modified
        • Property is no longer required
        • description property Modified
          • Property is no longer required
      • condition property Modified
        • damageItems property Modified
        • batteryHealthPercentage, batteryReportUrl properties Added
      • advertiser property Modified
        • address property Modified
      • additionalData property Modified
        • Type went from object to string
          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_not_working, electrical_speakers_not_working, electrical_satnav_not_working, electrical_note, odour_smoke, odour_pet, odour_damp, odour_note, bodywork_repairs, bodywork_repairs_note, bodywork_issues, bodywork_issues_note, vehicle_modifications, vehicle_modifications_note, c2b_top_nav_journey, v5c_in_different_name, test_name, test_group, c2b_valuation_range_lower, c2b_valuation_range_upper, taxi properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
  • 400 response Modified
    • application/json content type Modified
      • alternative Modified
        • ErrorInfo, BadRequestErrorInfo alternatives Modified
  • 403 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 404 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 409 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 429 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 500 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 502 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
POST /v1/testing/set-auction-end-time
  • Response
  • 400 response Modified
    • application/json content type Modified
      • alternative Modified
        • ErrorInfo, BadRequestErrorInfo alternatives Modified
  • 403 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 404 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 409 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 429 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 500 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required
  • 502 response Modified
    • application/json content type Modified
      • errorCode property Modified
        • Property is no longer required