Qodex.ai

Get Listing

GET https://api.boomandbucket.com/listingservice/listing/{listingId}

This API endpoint retrieves details for a specific listing based on its Id.

Path Parameters

  • listingId: Unique identifier for the listing.

This endpoint retrieves detailed information about a specific listing, identified by its listingId.

Response Format

The response is a JSON object containing various details about the listing, including:

  • id: A unique identifier for the listing.
  • priceStrategyType, originalEquipmentCostInCents: Details about pricing strategy and original equipment cost.
  • workflowState, displayState: States representing the workflow and display status of the listing.
  • fleetAdvisorId, buyerId, buyerCompanyId, sellerCompanyId, listingCompanyId: IDs associated with the listing, including fleet advisor, buyer, and seller.
  • equipmentId: The ID of the equipment being listed.
  • stockNumber: Stock number of the listing.
  • totalViewCount, marketplaceViewCount: View counts on the listing.
  • advertisedPriceHistory: An array of price history objects, each with a timestamp (item1) and price (item2).
  • soldDateTimeUTC, sellByDateTimeUtc, availableDateTimeUTC: Timestamps for various listing states.
  • marketplaceDescription: A description of the listing, with translations for different languages.
  • backofficeNotes: Notes for internal use, with language-specific translations.
  • flair: An object indicating special attributes of the listing, like 'Demo'.
  • lienTitleCheckDownload: A link to download the lien title check (if available).
  • thirdPartyStockNumber, isThirdPartyListing: Information about third-party listings.
  • dateTimeUtcActiveOnMarketplaceEmailSent, dateTimeUtcWentOnMarketplace, dateTimeUtcWentOffMarketplace: Timestamps related to marketplace activity.
  • lienAmountInCents: The lien amount (if any) in cents.
  • sellerContactId, equipmentLocationOfficeId, inspectionContactId: Contact and location information for the listing.
  • inventoryType, inventoryTypeOption: Details about the type of inventory.
  • dispositionStrategy: The strategy for disposing of the equipment.
  • valueProps: An array of value proposition objects with translations for titles and descriptions.

ListingDisplayState

The displayState field in the listing response represents the current display status of a listing. It is an enumeration defined by the ListingDisplayState class, with each value representing a distinct state of listing visibility. The possible values are:

  • 0: NotDisplayed - Indicates the listing is not currently displayed in the marketplace.
  • 1: OnMarketplace - The listing is actively displayed and available on the marketplace.
  • 2: OnMarketplaceAsInactive - The listing is displayed on the marketplace but marked as inactive, indicating it's not currently available for sale or other reasons.
  • 3: (Obsolete) - This status is obsolete and should not be used, but it is retained for historical records in the event store.

The displayState provides crucial information regarding the visibility and activity status of a listing in the marketplace.

DispositionStrategy

The dispositionStrategy field in the listing response represents the strategy used for disposing of the listed equipment.

  • DirectToAuction: This strategy indicates that the equipment will be sold directly through an auction. It is suitable for quick sales where market price determination is preferred.
  • DirectToAuctionWithReserve: Similar to the Direct to Auction strategy, but with a reserve price set. This ensures the equipment is not sold below a specified minimum price.
  • BlendedDisposition: This is a mixed approach, possibly combining direct sale and auction methods. It offers flexibility in how the equipment is sold.
  • BlendedDispositionWithReserve: A blend of sales methods with the inclusion of a reserve price for auctioned items. It combines the flexibility of the blended approach with the security of a minimum price guarantee.

The dispositionStrategy provides insights into the sales approach chosen for the equipment, influencing how potential buyers might engage with the listing.

RESPONSES

status: OK

{"id":"4f9efd68-38bb-4d64-b756-1c280565f5e2","priceStrategyType":0,"originalEquipmentCostInCents":0,"workflowState":2,"displayState":1,"fleetAdvisorId":"bf863471-5d58-4aa0-8bc4-5b17f936e87a","buyerId":null,"buyerCompanyId":null,"sellerCompanyId":"b163a2e9-c112-48a7-a6ed-33008b8b463a","listingCompanyId":"b163a2e9-c112-48a7-a6ed-33008b8b463a","equipmentId":"d5333509-40d8-4ee8-872c-ea67be1a0bca","stockNumber":"A4368382","totalViewCount":680,"marketplaceViewCount":114,"advertisedPriceHistory":[{"item1":"2022-07-11T00:00:00Z","item2":287995},{"item1":"2022-07-11T00:00:00Z","item2":277995}],"soldDateTimeUTC":null,"sellByDateTimeUtc":null,"availableDateTimeUTC":"2022-10-14T00:00:00Z","marketplaceDescription":{"translations":[{"languageId":0,"languageShortCode":"en_US","text":"This 2008 Caterpillar D9T is being sold by a large municipality. It comes equipped with the Caterpillar waste handling configuration which provides additional strength and durability to the frame. In 2020, this D9T had its undercarriage completely serviced/replaced by Quinn CAT (a $67k work order). As a government owned asset, it has been subject to a comprehensive preventative maintenance program throughout its life (full work order history is available for download). The inspection report for this dozer shows that it is in good overall condition (see operating video as well).","description":""},{"languageId":1,"languageShortCode":"es_MX","text":"","description":""},{"languageId":2,"languageShortCode":"fr_CA","text":"","description":""}]},"backofficeNotes":{"translations":[{"languageId":0,"languageShortCode":"en_US","text":"This is a DEMO page. The purpose of this demo page is for fleet advisors to have a good example of what a seller's listing will look like on the Boom \u0026 Bucket platform.","description":""},{"languageId":1,"languageShortCode":"es_MX","text":"","description":""},{"languageId":2,"languageShortCode":"fr_CA","text":"","description":""}]},"flair":{"name":null,"translationKey":"enum.demo","rawTranslationKey":"Demo","id":4},"lienTitleCheckDownload":null,"thirdPartyStockNumber":"","synonyms":[],"isThirdPartyListing":false,"dateTimeUtcActiveOnMarketplaceEmailSent":null,"dateTimeUtcWentOnMarketplace":"2022-07-11T21:53:53.239838Z","dateTimeUtcWentOffMarketplace":"0001-01-01T00:00:00","lienAmountInCents":0,"sellerContactId":null,"equipmentLocationOfficeId":{"value":"5e024559-7f7b-4aac-9ef5-becb30a94fce"},"inspectionContactId":null,"inventoryType":{"name":null,"translationKey":"enum.owned","rawTranslationKey":"Owned","id":1},"inventoryTypeOption":1,"dispositionStrategy":null,"valueProps":[{"id":"00000000-0000-0000-1111-000000000014","sortOrder":0,"slug":"powerhouse-protection","title":{"translations":[{"languageId":0,"languageShortCode":"en_US","text":"Powerhouse Protection","description":"title"},{"languageId":1,"languageShortCode":"es_MX","text":"Protección de la central eléctrica","description":"title"},{"languageId":2,"languageShortCode":"fr_CA","text":"","description":""}]},"description":{"translations":[{"languageId":0,"languageShortCode":"en_US","text":"Our buyer guarantee protects your purchase against anything missed during inspection.","description":"description"},{"languageId":1,"languageShortCode":"es_MX","text":"Nuestra garantía del comprador protege su compra contra cualquier cosa omitida durante la inspección.","description":"description"},{"languageId":2,"languageShortCode":"fr_CA","text":"","description":""}]}},{"id":"00000000-0000-0000-1111-000000000016","sortOrder":1,"slug":"no-payments-for-90-days","title":{"translations":[{"languageId":0,"languageShortCode":"en_US","text":"No Payments For 90 Days","description":"title"},{"languageId":1,"languageShortCode":"es_MX","text":"Sin pagos durante 90 días","description":"title"},{"languageId":2,"languageShortCode":"fr_CA","text":"","description":""}]},"description":{"translations":[{"languageId":0,"languageShortCode":"en_US","text":"Buy now, pay later for well qualified borrowers. Don't let heavy cost slow you down.","description":"description"},{"languageId":1,"languageShortCode":"es_MX","text":"Compre ahora y pague después para prestatarios bien calificados. No permita que los costos elevados lo ralenticen.","description":"description"},{"languageId":2,"languageShortCode":"fr_CA","text":"","description":""}]}}]}