Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id string
  • listingId string

    Your listing ID. You can retrieve real time listing information from the Listings resource using this identifier

  • createdDate string(date-time)
  • updatedDate string(date-time)
  • publicReference string

    Forms part of the public url for the listing

  • metadata object Required

    Additional vendor specific identifiers. You can associate your own vendor and stock identifier to our stock record via these fields. Child fields are optional, however this top level field is mandatory.

    Additional properties are allowed.

    Hide metadata attributes Show metadata attributes object

    • externalStockId string

      A vehicle identifier in the calling system

    • externalVendorId string

      A seller identifier in the calling system

  • lifecycleState string

    The status of the vehicle

    Values are FORECOURT, SALE_IN_PROGRESS, SOLD, WASTEBIN, or DELETED.

  • customerId string Required

    Our customer ID that has been assigned to you. Depending on account setup, you may have multiple customer account IDs assigned to you.

  • vehicle object Required

    Write-off categories and insurance group values are based on industry standards.

    More information is available here

    Additional properties are allowed.

    Hide vehicle attributes Show vehicle attributes object

    • vrm string
    • category string Required

      Type of vehicle

      Values are Car, Bike, or Van.

    • mileage integer(int32)
    • yearOfManufacture integer(int32)
    • dateOfRegistration string(date)
    • ownershipCondition string Required

      Values are NEW or USED.

    • vin string
    • make string Required
    • model string Required
    • derivative string
    • derivativeId string

      AutoTrader vehicle derivative ID. This is resolved by us and used to provide AutoTrader valuations

    • trim string
    • bodyType string
    • fuelType string
    • transmissionType string
    • driveTrain string
    • doors integer(int32)
    • keys integer(int32)
    • insuranceGroup string

      Industry standard insurance group rating

    • insuranceSecurityCode string

      Industry standard insurance code

    • v5CertificationSupplied boolean
    • colour string
    • engineNumber string
    • cylinders integer(int32)
    • engineSize object

      Additional properties are allowed.

      Hide engineSize attributes Show engineSize attributes object

      • unit string Required

        Values are LITRE or CUBIC_CENTIMETRE.

      • value number(double) Required
    • motExpiry string(date)
    • serviceHistory string

      Values are FULL_SERVICE_HISTORY, FULL_DEALERSHIP_HISTORY, PARTIAL_SERVICE_HISTORY, or NO_SERVICE_HISTORY.

    • plate string

      The numerical part of the VRM

    • previousOwners integer(int32)

      The number of previous owners, not including the current seller

    • exDemo boolean
    • stolen boolean Required
    • imported boolean Required
    • exported boolean Required
    • scrapped boolean Required
    • writeoffCategory string

      Insurance write-off category

      Values are C, D, S, or N.

  • advert object

    An advert portion of the stock item is not mandatory.

    However, if there is no advert against the stock item then it will not be advertised and so will not be visible to customers browsing the DA platform.

    Once the advert portion is added, it can never be removed, however the advert can be deactivated by patching its state.

    Additional properties are allowed.

    Hide advert attributes Show advert attributes object

    • state string

      Indicates whether a listing is live.

      This field can be used to activate and de-activate a listing.

      We recommend using this field, rather than adjusting startDate or endDate

      Values are ACTIVE or INACTIVE.

    • createdDate string(date-time)
    • updatedDate string(date-time)
    • auction object

      For an auction to be considered valid, you must supply a reserve price greater than £50.

      For a buy now listing to be considered valid, you must supply a buy now price that is greater than zero.

      All price fields will be rounded down to the nearest pound. Pence will be ignored. For example 10.50 becomes 10.

      Additional properties are allowed.

      Hide auction attributes Show auction attributes object

      • type string Required

        Values are BID, BUY_NOW, SEALED_BID, or PHYSICAL.

      • lotId string

        Used for physical auctions

      • startingPrice object

        Optional starting price for an biddable auction. Bids under this value will be rejected

        Additional properties are allowed.

        Hide startingPrice attributes Show startingPrice attributes object

        • value number Required
        • currency string Required

          Value is GBP.

      • reservePrice object

        Optional starting price for an biddable auction. Bids under this value will be rejected

        Additional properties are allowed.

        Hide reservePrice attributes Show reservePrice attributes object

        • value number Required
        • currency string Required

          Value is GBP.

      • askingPrice object

        Optional starting price for an biddable auction. Bids under this value will be rejected

        Additional properties are allowed.

        Hide askingPrice attributes Show askingPrice attributes object

        • value number Required
        • currency string Required

          Value is GBP.

      • buyNowPrice object

        Optional starting price for an biddable auction. Bids under this value will be rejected

        Additional properties are allowed.

        Hide buyNowPrice attributes Show buyNowPrice attributes object

        • value number Required
        • currency string Required

          Value is GBP.

      • startDate string(date-time)

        The date and time that you would like the auction to start

      • endDate string(date-time)

        The date and time that you would like the auction to end

    • startDate string(date-time) Deprecated

      Setting start and end dates for your advert can control if an advert is active.

      However, we recommend updating the advert state directly, rather than adjusting these dates.

    • endDate string(date-time) Deprecated

      Setting start and end dates for your advert can control if an advert is active.

      However, we recommend updating the advert state directly, rather than adjusting these dates.

    • attentionGrabber string

      A small piece of text that appears on the search results.

      Maximum length is 100.

    • description string

      A text description block of the advert. Linebreaks can be inserted with \n character. HTML tags will be stripped out. Only plain text is allowed.

      Maximum length is 2000.

    • tradeVatStatus string

      Values are MARGINAL, VAT_QUALIFYING, PLUS_VAT, or NO_VAT.

    • externalUrl string

      A link to a page that contains more information about the vehicle

  • features array[object] Required

    List of features. If you don't have any, just provide an empty list

    Hide features attributes Show features attributes object

    • description string Required

      Description of the item

    • standard boolean

      Comes as standard

    • category string Deprecated

      Category grouping

  • conditionReportUrl string

    An externally hosted condition report can be associated to the stock item. This report must be in PDF format. When a condition report is added to a stock item, it will be asynchronously downloaded. The report is then scanned for viruses before being uploaded to our CDN.

    Maximum length is 500.

  • condition object

    A block of data containing optional information on the condition of the vehicle. Empty values indicate no corresponding grading. Can contain a list of damage items that are displayed as a visual diagram on our platform. These are sometimes referred to as "splat" diagrams.

    Additional properties are allowed.

    Hide condition attributes Show condition attributes object

    • externalConditionGrade string

      NAMA grade

      Values are 1, 2, 3, 4, or U.

    • surecheckGrade string

      Values are BRONZE, SILVER, GOLD, LCV, or EV.

    • damageItems array[object]

      If damage items are set, then a diagram will be rendered in the listing, detailing the damage.

      An interactive diagram is available here

      Hide damageItems attributes Show damageItems attributes object

      • zone string Required

        The location of the damage item

        Values are WINDSCREEN, WINDSCREEN_REAR, BOOTLID, ROOF, BONNET, MIRROR_COVER_NEAR_SIDE, MIRROR_COVER_FAR_SIDE, DOOR_FRONT_FAR_SIDE, DOOR_FRONT_NEAR_SIDE, DOOR_REAR_FAR_SIDE, DOOR_REAR_NEAR_SIDE, WING_FRONT_NEAR_SIDE, WING_FRONT_FAR_SIDE, WING_REAR_FAR_SIDE, WING_REAR_NEAR_SIDE, WHEELS_FRONT_NEAR_SIDE, WHEELS_FRONT_FAR_SIDE, WHEELS_REAR_NEAR_SIDE, WHEELS_REAR_FAR_SIDE, BUMPER_FRONT, BUMPER_REAR, NUMBER_PLATE_FRONT, NUMBER_PLATE_REAR, WINDOW_FRONT_NEAR_SIDE, WINDOW_FRONT_FAR_SIDE, WINDOW_REAR_NEAR_SIDE, WINDOW_REAR_FAR_SIDE, WINDOW_REAR_QUARTER_NEAR_SIDE, WINDOW_REAR_QUARTER_FAR_SIDE, TAIL_LIGHT_NEAR_SIDE, TAIL_LIGHT_FAR_SIDE, HEAD_LIGHT_NEAR_SIDE, or HEAD_LIGHT_FAR_SIDE.

      • damageType string Required

        Values are BROKEN, BIRD_DEPOSITS, CHIP, CRACK, DENT, DENT_LOCAL_REPAIR, FADE, MULTIPLE_CHIPS, OFF_COLOUR_PANEL, PREVIOUS_REPAIR, RUST, SCUFF, SCRATCH, SCRATCH_LOCAL_REPAIR, WHEEL_SCUFF, STAINED, TORN_RIPPED, WORN, DIRTY, MISSING, BURNT, or OTHER.

  • videoUrl string

    An externally hosted video URL that we will embed in our listing page. Currently we only support YouTube.

  • images array[object] Required

    A list of image URLs that will be downloaded and then uploaded to our CDN. Images must be publicly accessible. We will require at least one image.

    Images will be displayed on the advert in the order that they are given. If you wish to reorder the images then resubmit the URLs in the order you would like.

    Hide images attributes Show images attributes object

    • url string

      A URL to a publicly hosted image that we will download

    • platformUrl string

      Our copy of your image, hosted on our CDN

    • uploaded boolean

      Indicates that we have downloaded your image and uploaded it to our CDN

    • tags array[string]

      A set of fixed values that are used to classify the image.

  • capTaxonomy object

    Cap taxonomy information that we have resolved via an experian lookup

    Additional properties are allowed.

    Hide capTaxonomy attributes Show capTaxonomy attributes object

    • id string
    • code string
    • make string
    • model string
    • variant string
    • derivative string
  • availableUntil string(date-time)

    We will not attempt to sell the vehicle past this point in time. If an availableUntil is specified, auction time must end before or at this point. Any ongoing negotiations for provisional vehicles will also be abandoned past this point.

  • requestedNetwork string

    The network that you would like the vehicle to be placed into.

    Depending on your account configuration, there may be multiple networks available to you. If no network is specified, then we will choose the most suitable network for the vehicle.

  • advertiser object

    Specifying an advertiser allows the sender to override default contact and location based information held against our customer record.

    This is useful when the vehicle needs to be collected from an alternative location or be handled by an alternative contact.

    Additional properties are allowed.

    Hide advertiser attributes Show advertiser attributes object

    • address object

      If an address is specified here, it overrides the default location pulled from our customer account

      Additional properties are allowed.

      Hide address attributes Show address attributes object

      • address1 string
      • address2 string
      • town string
      • county string
      • postcode string
      • country string
      • latLong object

        This field is required for us to support distance searches.

        If an address is specified but no latLong is included then we will accept the vehicle but buyers will not be able to conduct a distance based search.

        For example, searching for vehicles in a 12 mile radius

        Additional properties are allowed.

        Hide latLong attributes Show latLong attributes object

        • latitude number Required
        • longitude number Required
    • contact object

      If a contact is specified here, it overrides the default contact information pulled from our customer account

      Additional properties are allowed.

      Hide contact attributes Show contact attributes object

      • email string
      • title string
      • firstName string
      • lastName string
      • mobileNumber string
      • landlineNumber string
  • additionalData object

    A collection of questions and answers and notes from consumers selling vehicles through Consumer Direct

    Additional properties are NOT allowed.

    Hide additionalData attributes Show additionalData attributes object

    • mechanical_fails_start boolean
    • mechanical_bad_gearbox boolean
    • mechanical_unusual_noise boolean
    • mechanical_veers boolean
    • mechanical_warning_light boolean
    • mechanical_exhaust_smoke boolean
    • mechanical_leaks boolean
    • mechanical_note string
    • electrical_aircon_not_cold boolean
    • electrical_dashboard_not_working boolean
    • electrical_speakers_not_working boolean
    • electrical_satnav_not_working boolean
    • electrical_note string
    • odour_smoke boolean
    • odour_pet boolean
    • odour_damp boolean
    • odour_note string
    • bodywork_repairs boolean
    • bodywork_repairs_note string
    • bodywork_issues boolean
    • bodywork_issues_note string
    • vehicle_modifications boolean
    • vehicle_modifications_note string
    • c2b_top_nav_journey boolean
• 400 application/json

  Bad Request

  Hide response attributes Show response attributes object

  • errorCode string Required
  • errorMessage string
  • errors array[object]
    Hide errors attributes Show errors attributes object

    • message string Required
    • key string
• 403 application/json

  Forbidden

  Hide response attributes Show response attributes object

  • errorCode string Required
  • errorMessage string
• 404 application/json

  Not Found

  Hide response attributes Show response attributes object

  • errorCode string Required
  • errorMessage string
• 409 application/json

  Conflict

  Hide response attributes Show response attributes object

  • errorCode string Required
  • vrm string
• 502 application/json

  Bad Gateway

  Hide response attributes Show response attributes object

  • errorCode string Required
  • errorMessage string