{"info":{"_postman_id":"2af4d60b-d96d-4356-bf7c-f6d2268706aa","name":"Boom and Bucket - Integration API","description":"

The Boom and Bucket integration API provides endpoints for onboarding machines and for retrieving summarized valuation insights.

Authorization

The Boom and Bucket integration API uses X-API-Key query parameter or as a header to authenticate requests. This parameter needs to be provided with every api request.

For example

https://api.boomandbucket.com/marketplaceservice/marketplace/fleet-management-integration/onboard-equipment?X-API-KEY=

API Rate Limiting Policy

Our API is designed to provide a consistent and reliable service to all users. To ensure this, we have implemented a rate limiting policy that allows a maximum of 10 requests per second.

Rate Limits

The rate limit for our API is 10 requests per second (RPS). This rate limit applies per API key, not per user or application.

How It Works

Every API request you make subtracts from your remaining request quota. If you exceed the limit of 10 requests per second, you will receive a 429 Too Many Requests HTTP status code.

Response Headers (Coming soon)

Every API response includes three headers to help you understand your current rate limit status:

X-RateLimit-Limit: The maximum number of requests you can make per second.
X-RateLimit-Remaining: The number of requests left for the current window.
X-RateLimit-Reset: The time when the rate limit will reset, in UTC epoch seconds.

Exceeding The Rate Limit

When you exceed the rate limit, the API responds with HTTP status 429 Too Many Requests. You should design your application to handle this possibility and implement a backoff strategy. For example, you could wait until the rate limit resets (as specified in the X-RateLimit-Reset header) before making additional requests.

The information provided by this API should be used in conjunction with professional advice and market knowledge to make informed decisions about equipment valuation.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"32551519","collectionId":"2af4d60b-d96d-4356-bf7c-f6d2268706aa","publishedId":"2sA2xiWrh6","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-03-11T23:59:45.000Z"},"item":[{"name":"Onboard Equipment","id":"d76f9ed3-ec5a-4eea-8b14-dacf0a29ba98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"serialNumber\": \"value\",\r\n \"taxonomizedSubCategoryId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"year\": 2024,\r\n \"make\": \"Caterpillar\",\r\n \"model\": \"D4\",\r\n \"hours\": 142,\r\n \"mileage\": 0,\r\n \"highwayType\": 0,\r\n \"fleetIdentifierCompanyId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"fleetIdentifierValue\": \"string\",\r\n \"sellerCompanyName\": \"string\",\r\n \"sellerOfficeAddressLineOne\": \"string\",\r\n \"sellerOfficeAddressLineTwo\": \"string\",\r\n \"sellerOfficeCity\": \"string\",\r\n \"sellerOfficeState\": \"string\",\r\n \"sellerOfficeZipCode\": \"string\",\r\n \"sellerContactFirstName\": \"string\",\r\n \"sellerContactLastName\": \"string\",\r\n \"sellerContactEmail\": \"string\",\r\n \"sellerContactPhone\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.boomandbucket.com/marketplaceservice/marketplace/fleet-management-integration/onboard-equipment","description":"

Please use this endpoint to onboard equipment to the Boom and Bucket platform. You'll need a subcategory and make which can be retrieved from the Boom and Bucket Taxonomy endpoints.

Request Body

serialNumber (string): Serial number of the equipment.
taxonomizedSubCategoryId (string): Unique identifier for the equipment category. It is the entityId.value of a subcategroy from the Taxonomized SubCategories endpoint
year (integer): Manufacturing year of the equipment.
make (string): Make or brand of the equipment. It is the preferredDisplayName of the make from the Taxonomized Makes endpoint
model (string): Model of the equipment.
hours (integer): The operating hours meter reading.
mileage (integer): The odometer of the equipment (can be 0 for off-highway machines).
highwayType (integer): Type of highway usage (1 = OnHighway; 2 = OffHighway).
fleetIdentifierCompanyId (string): The companyId of your company created in Boom and Bucket.
fleetIdentifierValue (string): Unique identifier for the equipment in your system.
sellerCompanyName (string): Name of the seller company.
sellerOfficeAddressLineOne (string): First line of the seller's office address.
sellerOfficeAddressLineTwo (string): Second line of the seller's office address.
sellerOfficeCity (string): City of the seller's office.
sellerOfficeState (string): State of the seller's office.
sellerOfficeZipCode (string): ZIP code of the seller's office.
sellerContactFirstName (string): First name of the seller's contact person.
sellerContactLastName (string): Last name of the seller's contact person.
sellerContactEmail (string): Email address of the seller's contact person.
sellerContactPhone (string): Phone number of the seller's contact person.

Response:

Successful response: HTTP Status 200 OK with the id of the equipment that was onboarded
Error response: HTTP Status 400 Bad Request with details in the response body.

Check Listing Status

You can check the status of the listing once an equipment has been onboarded as follows:

Get the onboarded equipment using the Get Equipment endpoint. The response includes the listingId of the listing tied to that equipment.
Get the listing using the Get Listing endpoint. The response includes the display state of the lising.

To construct the listing url

The url for the listing is as follows:

https://boomandbucket.com/for-sale/{equipmentSlug}/{listingStockNumber}

Use the slug from the Equipment object which can be retrieved from the Get Equipment endpoint
Use the stockNumber from the Listing object which can be retrieved from the Get Listing endpoint
Build the url by concating https://boomandbucket.com/for-sale/ {slug} / {stockNumber} and converting it to lowercase

This endpoint retrieves a list of equipment manufacturers (makes) and detailed taxonomy information.

Response Format

The response is an array of objects, each representing a manufacturer. Each object contains the following fields:

id (string): A unique identifier for the manufacturer.
name (string): The manufacturer's name in uppercase.
preferredDisplayName (string): The manufacturer's name in a more display-friendly format.
taxonomyVerificationStatus (integer): An integer representing the verification status of the taxonomy item.
url (string): The manufacturer's official website URL.

Taxonomy Verification Status

The taxonomyVerificationStatus field is an enumeration representing the verification status, defined as follows:

0: None - Initial default state, no verification done.
\n
1: Unverified - The item has not been verified.
\n
2: SystemProcessed - This status indicates that the information has been sorted and validated using an automated, non-expert system. It relies on both algorithmic and human assessment rather than specialized, expert analysis.
\n
4: VerifiedByExpert - Verified internally by heavy equipment expert.
\n
8: VerifiedByAI - Verified using AI.
\n

The taxonomyVerificationStatus field uses a bitwise representation to allow for combinations of different verification states. For example, a value of 3 (binary 0011) would indicate that the item is both Unverified (1) and SystemProcessed (2).

Sample Response

 [\n  {\n    \"id\": \"66ad635f-2d5f-4b78-8b13-69c8cd3b5d1b\",\n    \"name\": \"CATERPILLAR\",\n    \"preferredDisplayName\": \"Caterpillar\",\n    \"taxonomyVerificationStatus\": 2,\n    \"url\": \"https://www.caterpillar.com\"\n  },\n  {\n    \"id\": \"1bdaede2-16b6-4546-a8dd-2a47885f2d66\",\n    \"name\": \"JOHN DEERE\",\n    \"preferredDisplayName\": \"John Deere\",\n    \"taxonomyVerificationStatus\": 2,\n    \"url\": \"https://www.deere.com/en/index.html\"\n  }\n]\n\n

This endpoint retrieves detailed taxonomy information for a specific subcategory of equipment.

Response Format

The response is a JSON object representing a subcategory, with the following fields:

entityId: An object containing a unique identifier (value) for the subcategory.
name: An object with translations array providing subcategory names in multiple languages.
slug: A string representing a URL-friendly version of the subcategory name.
taxonomizedCategoryId: An object with a value field indicating the associated category ID.
usedForIds: An array of objects, each with a value field indicating IDs for which the subcategory is \"Used For\". \"Used For\" is a way to describe the various industries a piece of equipment may be in.
meterTypeForValuation: An object detailing the type of meter used for valuation, with translations.
marketplaceCategory: An object containing details about the marketplace category, such as ID, slug, synonyms, and image URI.

Translations Object

The translations arrays in name and meterTypeForValuation contain objects for each supported language, each with fields:

languageId (integer): The ID for the language.
languageShortCode (string): A short code representing the language.
text (string): The translated text for the subcategory or meter type.
description (string): A description of the text in the specific language.

Sample Response

[\n  {\n    \"entityId\": {\n      \"value\": \"bf3641e5-7d59-4dc0-92f4-93812620c14c\"\n    },\n    \"name\": {\n      \"translations\": [\n        {\n          \"languageId\": 0,\n          \"languageShortCode\": \"en_US\",\n          \"text\": \"Aerial Work Platforms\",\n          \"description\": \"Aerial Work Platforms\"\n        },\n        {\n          \"languageId\": 1,\n          \"languageShortCode\": \"es_MX\",\n          \"text\": \"\",\n          \"description\": \"\"\n        },\n        {\n          \"languageId\": 2,\n          \"languageShortCode\": \"fr_CA\",\n          \"text\": \"\",\n          \"description\": \"\"\n        }\n      ]\n    },\n    \"slug\": \"aerial-work-platforms\",\n    \"taxonomizedCategoryId\": {\n      \"value\": \"97a349a8-7700-422f-978b-b3be154172e7\"\n    },\n    \"usedForIds\": [\n      {\n        \"value\": 7\n      },\n      {\n        \"value\": 8\n      },\n      {\n        \"value\": 9\n      },\n      {\n        \"value\": 11\n      },\n      {\n        \"value\": 12\n      },\n      {\n        \"value\": 13\n      },\n      {\n        \"value\": 14\n      },\n      {\n        \"value\": 15\n      },\n      {\n        \"value\": 16\n      },\n      {\n        \"value\": 17\n      },\n      {\n        \"value\": 22\n      }\n    ],\n    \"meterTypeForValuation\": {\n      \"displayName\": {\n        \"translations\": [\n          {\n            \"languageId\": 0,\n            \"languageShortCode\": \"en_US\",\n            \"text\": \"Operating Hours\",\n            \"description\": \"Operating hours for an engine\"\n          },\n          {\n            \"languageId\": 1,\n            \"languageShortCode\": \"es_MX\",\n            \"text\": \"\",\n            \"description\": \"\"\n          },\n          {\n            \"languageId\": 2,\n            \"languageShortCode\": \"fr_CA\",\n            \"text\": \"\",\n            \"description\": \"\"\n          }\n        ]\n      },\n      \"name\": \"EngineOperatingTime\",\n      \"id\": 0,\n      \"rawTranslationKey\": \"EngineOperatingTime\",\n      \"translationKey\": \"enum.EngineOperatingTime\"\n    },\n    \"marketplaceCategory\": {\n      \"id\": {\n        \"value\": 47291582\n      },\n      \"slug\": \"lifts\",\n      \"synonyms\": [\n        \"lifts\",\n        \"lift\",\n        \"Articulated Boom Lift\",\n        \"Platform Lift\"\n      ],\n      \"categoryState\": 1,\n      \"imageUri\": \"https://via.placeholder.com/250\",\n      \"translationKey\": \"eq.lifts\",\n      \"category\": null\n    }\n  }\n]\n\n

This endpoint provides detailed information about a specific piece of equipment, identified by its equipmentId.

Path Parameters

equipmentId: Unique identifier for the equipment.

Response Format

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

id: A unique identifier for the equipment.
equipmentCategory & equipmentCategorySlug: Strings representing the equipment category and its URL-friendly slug.
secondaryHours, mileage, model, make: Various attributes of the equipment, like model and make.
image: A URL to an image of the equipment (if available).
year, totalListingCount, hours, activeListingCount: Year of manufacture, listing counts, and operating hours.
listings: An array of listing IDs associated with the equipment.
inspections: An array of inspection IDs.
serialNumbers: An array containing information about the equipment's serial numbers.
fleetIdentifiers: An array of fleet identifiers (if any).
technicalSpecifications: An array of objects, each with translations providing specifications in different languages.
equipmentFeatures: An array of objects detailing features of the equipment, with translations.
dimensions, weight: Physical dimensions and weight of the equipment.
activeListing: The ID of the active listing (if any).
crmEquipmentId: CRM-related identifiers and slugs.
urlSlug: contains the year, make, model, category, and equipment ID to be used in the URL. Note, this contains the listing ID at the end, and that is no longer supported as a means to navigate to a piece of equipment. Stock number is required.
slug: The year, make, model, category that is in the URL for readability, eg boomandbucket.com/for-sale/slug/stocknumber
similarValuations: An array of similar equipment valuations (not used anymore).
emissions: A number to specify the emissions type
vehicleTitle: Objects containing emission standards and vehicle title information.
priorApplication, condition, highwayType: Usage history and condition information.
modelSlug, makeSlug: Slugs (URL friendly) for the model and make.
specificationsSheet: An object containing a link to the specifications sheet.
operatorsManual, originalPurchaseInvoice, vehicleTitleFrontAsset, vehicleTitleBackAsset: Links to relevant documents (if available).
taxonomizedSubCategoryId: The subcategory ID for taxonomy purposes.

Technical Specifications and Features

technicalSpecifications and equipmentFeatures fields include an array of objects with translations to accommodate multiple languages.

EmissionsType

The emissions field in the equipment details response represents the emission standard of the equipment. It is an enumeration defined by the EmissionsType class, with each type corresponding to a specific emission standard. The possible values are:

0: NotSet - Indicates that the emission standard is not set or unknown.
1: Tier1 - Represents the Tier 1 emission standard.
2: Tier2 - Represents the Tier 2 emission standard.
3: Tier3 - Represents the Tier 3 emission standard.
4: Tier4 - Represents the Tier 4 emission standard.
5: Tier4i - Represents the Tier 4i (interim) emission standard.
6: Tier4A - Represents the Tier 4A emission standard.
7: Tier4B - Represents the Tier 4B emission standard.
8: Tier0 - Represents the Tier 0 emission standard, typically for older equipment.

Each EmissionsType has a unique integer ID and a string name that describes the emission standard. This information is crucial for understanding the environmental compliance of the equipment.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"2af4d60b-d96d-4356-bf7c-f6d2268706aa","id":"2af4d60b-d96d-4356-bf7c-f6d2268706aa","name":"Boom and Bucket - Integration API","type":"collection"}},"urlObject":{"protocol":"https","path":["equipmentservice","equipment","{equipmentId}"],"host":["api","boomandbucket","com"],"query":[],"variable":[]}},"response":[{"id":"5a305c96-c971-456e-b24f-c24db21f1c26","name":"Get Example Equipment","originalRequest":{"method":"GET","header":[],"url":"https://api.boomandbucket.com/equipmentservice/equipment/{equipmentId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 15 Mar 2024 19:10:37 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Request-Context","value":"appId=cid-v1:3695f997-cc2f-45f0-8294-f170c1613f5c"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"d5333509-40d8-4ee8-872c-ea67be1a0bca\",\n \"equipmentCategory\": \"eq.bulldozers\",\n \"equipmentCategorySlug\": \"bulldozers\",\n \"secondaryHours\": null,\n \"mileage\": 0,\n \"model\": \"D9T\",\n \"make\": \"Caterpillar\",\n \"image\": null,\n \"year\": 2008,\n \"totalListingCount\": 1,\n \"hours\": 18772,\n \"activeListingCount\": 0,\n \"listings\": [\n \"4f9efd68-38bb-4d64-b756-1c280565f5e2\"\n ],\n \"inspections\": [\n \"ddb8a25d-4901-4299-bbfb-03628f4532c9\"\n ],\n \"serialNumbers\": [\n {\n \"id\": \"e8781985-d79f-4de4-82f2-2fb0a0886095\",\n \"type\": 1,\n \"translationKey\": \"sntype.primary\",\n \"description\": \"\",\n \"serialNumber\": \"DEMORJS01070DEMO\"\n }\n ],\n \"fleetIdentifiers\": [],\n \"technicalSpecifications\": [\n {\n \"id\": \"8583e2dd-ae04-451d-90e9-f1113dbb3d63\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Engine: CAT C18 ACERT 18.1L 435 Hp I6 TurboD\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"5e980676-bf0a-4ae5-84be-2db7831c317d\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Transmission: Powershift 3 FWRD + 3 REV\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"30b31c35-3d6e-4e48-a4cc-9864a9d47fa4\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Track Gauge: 88.6 in\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"3ad698aa-a88c-4871-a0fb-7daab3de1699\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Shoe Size: 24 in\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"bd990967-f2cc-4203-86be-971c5366a933\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Number of Shoes/Rollers: 43 per side, 8 track rollers per side\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"5ee28936-df6d-4c7b-9b55-ead27255b6d3\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Hydraulic Tank Capacity: 23.5 gal\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"389226c5-7469-4a6c-83f0-a02fbb2ab516\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Engine Oil Tank Capacity: 9.7 gal\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"66027c13-d650-44c5-84bf-f661e35344d6\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Coolant Capacity: 25.9 gal\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"65c6b27b-476e-4d07-a1f5-a60ffee44b90\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Hydraulic Relief (Lift): 2800 psi\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"961ada50-59b1-4f81-8bd9-6aa4fda0c030\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Hydraulic Relief (Steering): 5875 psi\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"44add8ff-cf8f-421e-a67c-e77632b3b444\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Blade: SU 17.7 yd3, 169 in, 15,130 lbs\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"a1231624-8ccf-4aa7-bc70-3579ad600d71\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Ripper: 2 Shank (included)\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"718d14b7-83eb-4bd0-9638-f61bdec1d3c6\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Serial Number: RJS01070\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"6d473e84-674a-4eff-a874-7b4166ab531a\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Country of Origin: USA\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n }\n ],\n \"equipmentFeatures\": [\n {\n \"id\": \"d4719736-8dc7-49a5-8f23-16b642032cd4\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Versatile SU blade for a combination of force and material capacity\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"64d867b4-4271-4a74-a82b-de5a6be2cfc0\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Included 2 shank ripper\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"47777b9e-a6b3-4cb2-b4dd-d37fde2178d4\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Included OMM\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"30766f86-f72e-46f4-8412-5126e146ec38\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"CAT Product Link PL542 installed (subscription required) \",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"9b525297-cd91-427a-925f-284bcfcc806d\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Full maintenance and work order history provided\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"b6a563f0-1130-4b08-80cc-96959326dab1\",\n \"translations\": [\n {\n \"languageId\": 0,\n \"languageShortCode\": \"en_US\",\n \"text\": \"Undercarriage replaced by Quinn CAT in July 2020 ($67k Repair)\",\n \"description\": \"\"\n },\n {\n \"languageId\": 1,\n \"languageShortCode\": \"es_MX\",\n \"text\": \"\",\n \"description\": \"\"\n },\n {\n \"languageId\": 2,\n \"languageShortCode\": \"fr_CA\",\n \"text\": \"\",\n \"description\": \"\"\n }\n ]\n }\n ],\n \"dimensions\": \"Length: 193.3\\\" (274.3\\\" with blade), Width: 113.4\\\", Height: $157.5\\\"\",\n \"weight\": \"80,062 lbs\",\n \"activeListing\": \"4f9efd68-38bb-4d64-b756-1c280565f5e2\",\n \"crmEquipmentId\": null,\n \"urlSlug\": \"2008-caterpillar-d9t-bulldozers/4f9efd68-38bb-4d64-b756-1c280565f5e2\",\n \"slug\": \"2008-caterpillar-d9t-bulldozers\",\n \"similarValuations\": [],\n \"emissions\": {\n \"name\": null,\n \"translationKey\": \"enum.tier4\",\n \"rawTranslationKey\": \"Tier4\",\n \"id\": 4\n },\n \"vehicleTitle\": {\n \"name\": null,\n \"translationKey\": \"enum.untitled\",\n \"rawTranslationKey\": \"Untitled\",\n \"id\": 2\n },\n \"priorApplication\": \"Waste Handling\",\n \"condition\": 3,\n \"highwayType\": 2,\n \"modelSlug\": \"D9T\",\n \"makeSlug\": \"Caterpillar\",\n \"specificationsSheet\": {\n \"id\": \"2e48617d-78e7-4427-a475-6304c3d55c41\",\n \"resourceType\": \"raw\",\n \"tags\": [],\n \"altText\": \"\",\n \"sortOrder\": 0,\n \"path\": \"v1657574476/production/d5333509-40d8-4ee8-872c-ea67be1a0bca/documents/lkd9lzafrmqgtqcttrnp.pdf\",\n \"publicId\": \"production/d5333509-40d8-4ee8-872c-ea67be1a0bca/documents/lkd9lzafrmqgtqcttrnp.pdf\",\n \"url\": \"http://res.cloudinary.com/boom-and-bucket/raw/upload/v1657574476/production/d5333509-40d8-4ee8-872c-ea67be1a0bca/documents/lkd9lzafrmqgtqcttrnp.pdf\"\n },\n \"operatorsManual\": null,\n \"originalPurchaseInvoice\": null,\n \"vehicleTitleFrontAsset\": null,\n \"vehicleTitleBackAsset\": null,\n \"taxonomizedSubCategoryId\": \"eb690ae7-d78d-4005-9941-e3e798771856\"\n}"}],"_postman_id":"9a182d45-bda1-4d7a-9d38-9b3a827f4d3f"},{"name":"Get Listing","id":"98446145-6220-458e-a93f-9a9060d745f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.boomandbucket.com/listingservice/listing/{listingId}","description":"

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.

Description

This API endpoint retrieves summarized valuation insights for heavy equipment based on specific criteria including make, model, year, meter reading, and an option to download a detailed report. It is particularly useful for quickly accessing a summarized view of both retail and auction value estimates for a given piece of equipment.

Request Parameters

The endpoint accepts the following parameters in the query string:

make: The manufacturer of the equipment.
model: The specific model of the equipment.
year: The year of manufacture of the equipment.
meter: The meter reading (in hours or miles) indicating usage of the equipment.
taxonomizedSubCategorySlug (optional): provide one of the subcategories that match for this equipment, this enables precision search to match exactly, this is particularly helpful for on-highway equipment.
downloadReport: A boolean parameter (true or false) indicating whether to download a detailed Excel report instead of a JSON version of the valuation summary.

Response Object

The API returns a JSON object containing valuation details with the following fields:

retailConfidenceIntervalHighPriceInCents: The upper limit of the retail price estimate in cents.
retailConfidenceIntervalLowPriceInCents: The lower limit of the retail price estimate in cents.
auctionConfidenceIntervalHighPriceInCents: The upper limit of the auction price estimate in cents.
auctionConfidenceIntervalLowPriceInCents: The lower limit of the auction price estimate in cents.
retailConfidencePercentage: The confidence level of the retail price estimate expressed as a percentage.
retailConfidenceScore: The confidence level of the retail estimate, expressed in text.
auctionConfidencePercentage: The confidence level of the auction price estimate expressed as a percentage.
auctionConfidenceScore: The confidence level of the retail estimate, expressed in text.
retailComparableCount: The number of comparable equipment pieces used to determine the retail valuation.
auctionComparableCount: The number of comparable equipment pieces used to determine the auction valuation.
retailMinPriceInCents: The minimum reasonable retail comparable value in cents.
retailMaxPriceInCents: The maximum reasonable retail comparable value in cents.
auctionMinPriceInCents: The minimum reasonable auction comparable value in cents.

Response Headers

When the downloadReport request parameter is set to true, the response will contain the generated report file with the following headers:

Content-Type: with a value of application/octet-stream
\n
Content-Disposition: with a value of the file name
\n

Disclaimer for Estimations

While this API aims to provide accurate and up-to-date valuation insights, the following factors should be considered:

Variability in Equipment Condition: Valuations are based on standard equipment conditions and may not reflect variations in actual conditions.
Data Accuracy: The accuracy of the valuation is dependent on the correctness of the input parameters (make, model, year, and meter reading).
Market Fluctuations: Equipment values can fluctuate due to market conditions, which may not be immediately reflected in the estimates.
Comparative Data Limitations: The number of comparable equipment pieces affects the confidence level of the valuation. Limited data points can impact the accuracy of the estimate.
Use for Guidance: These valuations should be used as a guide and not as the sole basis for investment or transaction decisions. For a more detailed and personalized valuation, consulting with a Boom and Bucket fleet advisor is recommended.

Precision Search (optional)

The default valuation endpoints are very good at matching equipment, and if it can not find exact matches it uses a fuzzy search to find like makes and models to generate the market report.

We have an optional taxonomizedSubCategorySlug parameter which will ensure that the fuzzy match will only match exclusively to that subcategory.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

taxonomizedSubCategorySlug
\"mini-excavators\"
\"excavators\"
\"long-reach-excavators\"
\"wheel-excavators\"
\"specialty-excavators\"
\"dozers\"
\"wheel-dozers\"
\"wheel-loaders\"
\"track-loaders\"
\"backhoe-loaders\"
\"skip-loaders\"
\"skid-steer-loaders\"
\"compact-track-loaders\"
\"motor-graders\"
\"road-reclaimers\"
\"track-cold-planers\"
\"wheel-cold-planers\"
\"track-asphalt-pavers\"
\"wheel-asphalt-pavers\"
\"screeds\"
\"motor-scrapers\"
\"pull-scrapers\"
\"single-drum-vibratory-rollers\"
\"double-drum-vibratory-rollers\"
\"smooth-rollers\"
\"pneumatic-tire-rollers\"
\"sheepsfoot-rollers\"
\"self-propelled-roller\"
\"telehandlers\"
\"forklifts\"
\"aerial-work-platforms\"
\"boom-lifts\"
\"scissor-lifts\"
\"vertical-mast-lifts\"
\"pipelayers\"
\"trenchers\"
\"foundation--piling-drills\"
\"directional-drills\"
\"blasthole-drills\"
\"articulated-trucks\"
\"rigid-haul-trucks\"
\"hydraulic-shovels\"
\"power-shovels\"
\"draglines\"
\"generators\"
\"mounted-boom-truck-cranes\"
\"mounted-knuckle-boom-cranes\"
\"fuel-trucks\"
\"water-trucks\"
\"vacuum-trucks\"
\"service-trucks\"
\"single-axle-dump-trucks\"
\"multi-axle-dump-trucks\"
\"flatbed-dump-trucks\"
\"flatbed-trucks\"
\"stake-trucks\"
\"dry-van-trucks\"
\"moving-van-trucks\"
\"reefer-trucks\"
\"mixer-trucks\"
\"conventional-day-cab-trucks\"
\"conventional-trucks-with-sleeper\"
\"cabover-trucks-with-sleeper\"
\"chipper-trucks\"
\"curtain-side-trucks\"
\"digger-derrick-trucks\"
\"grapple-trucks\"
\"hooklift-trucks\"
\"logging-trucks\"
\"winch-trucks\"
\"yard-spotter-trucks\"
\"concrete-pump-trucks\"
\"expeditor-trucks\"
\"grain-trucks\"
\"plow-trucks\"
\"sweeper-trucks\"
\"dry-cargo-trucks\"
\"moving-trucks\"
\"reefer-trucks\"
\"pickup-trucks\"
\"cargo-vans\"
\"service-utility-vans\"
\"reefer-vans\"
\"double-drop-trailers\"
\"drop-deck-trailers\"
\"drop-frame-van-trailers\"
\"dry-van-trailers\"
\"dump-trailers\"
\"flatbed-trailers\"
\"grain-trailers\"
\"log-trailers\"
\"lowboy-trailers\"
\"oilfied-trailers\"
\"reefer-trailers\"
\"roll-off-trailers\"
\"crude-oil-trailers\"
\"fuel-tank-trailers\"
\"vacuum-tank-trailers\"
\"water-tank-trailers\"
\"utility-trailers\"
\"light-towers\"
\"bucket-trucks\"
\"all-terrain-cranes\"
\"carry-deck-cranes\"
\"crawler-cranes\"
\"overhead-cranes\"
\"rough-terrain-cranes\"
\"tower-cranes\"
\"telescopic-cranes\"

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"2af4d60b-d96d-4356-bf7c-f6d2268706aa","id":"2af4d60b-d96d-4356-bf7c-f6d2268706aa","name":"Boom and Bucket - Integration API","type":"collection"}},"urlObject":{"protocol":"https","path":["valuationservice","valuation","iron-insight","summarized"],"host":["api","boomandbucket","com"],"query":[{"description":{"content":"

The make or manufacturer of the equipment.

\n","type":"text/plain"},"key":"make","value":"Caterpillar"},{"description":{"content":"

The model of the equipment, ensure that special characters that are not URL friendly are encoded correctly.

\n","type":"text/plain"},"key":"model","value":"259D"},{"description":{"content":"

The year the equipment was manufactured.

\n","type":"text/plain"},"key":"year","value":"2019"},{"description":{"content":"

The hours or miles the equipment has on its primary meter, some equipment may have several meters, use the primary meter for that model.

\n","type":"text/plain"},"key":"meter","value":"4000"},{"description":{"content":"

If provided, this will enable precision search to refine the comparables to determine the estimation.

\n","type":"text/plain"},"key":"taxonomizedSubCategorySlug","value":"skid-steer-loaders"},{"description":{"content":"

If true, will download a Excel file with the comparables and detailed analytics. If false, will return a summary of the estimation.

\n","type":"text/plain"},"key":"downloadReport","value":"false"}],"variable":[]}},"response":[{"id":"4a33be7a-7804-49e4-8f63-4c1e7511cf22","name":"2019 Caterpillar 259D","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.boomandbucket.com/valuationservice/valuation/iron-insight/summarized?make=Caterpillar&model=259D&year=2019&meter=5000&downloadReport=false","protocol":"https","host":["api","boomandbucket","com"],"path":["valuationservice","valuation","iron-insight","summarized"],"query":[{"key":"make","value":"Caterpillar"},{"key":"model","value":"259D"},{"key":"year","value":"2019"},{"key":"meter","value":"5000"},{"key":"downloadReport","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 07 Feb 2024 19:13:26 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Request-Context","value":"appId=cid-v1:3695f997-cc2f-45f0-8294-f170c1613f5c"}],"cookie":[],"responseTime":null,"body":"{\n \"retailConfidenceIntervalHighPriceInCents\": 5678600,\n \"retailConfidenceIntervalLowPriceInCents\": 3311600,\n \"auctionConfidenceIntervalHighPriceInCents\": 3307000,\n \"auctionConfidenceIntervalLowPriceInCents\": 2949400,\n \"retailConfidencePercentage\": 54.58318920788654,\n \"auctionConfidencePercentage\": 11.450161698312574,\n \"retailComparableCount\": 90,\n \"auctionComparableCount\": 90,\n \"retailConfidenceScore\": \"Low\",\n \"auctionConfidenceScore\": \"Medium\"\n}"},{"id":"41db9734-6c2b-4024-93ee-c4d5953fae8a","name":"2019 Caterpillar 259D (Precision Search)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.boomandbucket.com/valuationservice/valuation/iron-insight/summarized?make=Caterpillar&model=259D&year=2019&meter=5000&taxonomizedSubCategorySlug=skid-steer-loaders&downloadReport=false","protocol":"https","host":["api","boomandbucket","com"],"path":["valuationservice","valuation","iron-insight","summarized"],"query":[{"key":"make","value":"Caterpillar"},{"key":"model","value":"259D"},{"key":"year","value":"2019"},{"key":"meter","value":"5000"},{"key":"taxonomizedSubCategorySlug","value":"skid-steer-loaders"},{"key":"downloadReport","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 07 Feb 2024 19:13:26 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Request-Context","value":"appId=cid-v1:3695f997-cc2f-45f0-8294-f170c1613f5c"}],"cookie":[],"responseTime":null,"body":"{\n \"retailConfidenceIntervalHighPriceInCents\": 5017800,\n \"retailConfidenceIntervalLowPriceInCents\": 4329300,\n \"auctionConfidenceIntervalHighPriceInCents\": 2596400,\n \"auctionConfidenceIntervalLowPriceInCents\": 2538300,\n \"retailConfidencePercentage\": 14.772142121524201,\n \"auctionConfidencePercentage\": 2.263166095356809,\n \"retailComparableCount\": 9,\n \"auctionComparableCount\": 5,\n \"retailConfidenceScore\": \"Medium\",\n \"auctionConfidenceScore\": \"High\"\n}"},{"id":"ef7d7f37-c021-4c5f-a923-0cfb17d750bc","name":"2022 Bobcat E26","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.boomandbucket.com/valuationservice/valuation/iron-insight/summarized?make=Bobcat&model=E-26&year=2019&meter=1324&downloadReport=false","protocol":"https","host":["api","boomandbucket","com"],"path":["valuationservice","valuation","iron-insight","summarized"],"query":[{"key":"make","value":"Bobcat"},{"key":"model","value":"E-26"},{"key":"year","value":"2019"},{"key":"meter","value":"1324"},{"key":"taxonomizedSubCategorySlug","value":"mini-excavator","disabled":true},{"key":"downloadReport","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 07 Feb 2024 19:13:26 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Request-Context","value":"appId=cid-v1:3695f997-cc2f-45f0-8294-f170c1613f5c"}],"cookie":[],"responseTime":null,"body":"{\n \"retailConfidenceIntervalHighPriceInCents\": 3327200,\n \"retailConfidenceIntervalLowPriceInCents\": 3065100,\n \"auctionConfidenceIntervalHighPriceInCents\": 2526900,\n \"auctionConfidenceIntervalLowPriceInCents\": 2005300,\n \"retailConfidencePercentage\": 8.207553078223837,\n \"auctionConfidencePercentage\": 23.17192358951577,\n \"retailComparableCount\": 90,\n \"auctionComparableCount\": 90,\n \"retailConfidenceScore\": \"High\",\n \"auctionConfidenceScore\": \"Medium\"\n}"},{"id":"728bd5bc-eca5-454c-aa14-3995cc38a3cc","name":"2019 Ford F750 Flatbed Truck","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.boomandbucket.com/valuationservice/valuation/iron-insight/summarized?make=Ford&model=F750&year=2019&meter=75000&taxonomizedSubCategorySlug=flatbed-trucks&downloadReport=false","protocol":"https","host":["api","boomandbucket","com"],"path":["valuationservice","valuation","iron-insight","summarized"],"query":[{"key":"make","value":"Ford"},{"key":"model","value":"F750"},{"key":"year","value":"2019"},{"key":"meter","value":"75000"},{"key":"taxonomizedSubCategorySlug","value":"flatbed-trucks"},{"key":"downloadReport","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 07 Feb 2024 19:13:26 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Request-Context","value":"appId=cid-v1:3695f997-cc2f-45f0-8294-f170c1613f5c"}],"cookie":[],"responseTime":null,"body":"{\n \"retailConfidenceIntervalHighPriceInCents\": 3167700,\n \"retailConfidenceIntervalLowPriceInCents\": 2199700,\n \"auctionConfidenceIntervalHighPriceInCents\": 3028500,\n \"auctionConfidenceIntervalLowPriceInCents\": 1323400,\n \"retailConfidencePercentage\": 36.670833806872,\n \"auctionConfidencePercentage\": 85.16983016983018,\n \"retailComparableCount\": 46,\n \"auctionComparableCount\": 13,\n \"retailConfidenceScore\": \"Low\",\n \"auctionConfidenceScore\": \"Low\"\n}"},{"id":"0a616e28-05b1-442c-8c71-b4e1ae063793","name":"2018 KOMATSU PC210 LC-11","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.boomandbucket.com/valuationservice/valuation/iron-insight/summarized?make=KOMATSU&model=PC210 LC-11&year=2018&meter=5000&taxonomizedSubCategorySlug=excavators&downloadReport=true","protocol":"https","host":["api","boomandbucket","com"],"path":["valuationservice","valuation","iron-insight","summarized"],"query":[{"key":"make","value":"KOMATSU"},{"key":"model","value":"PC210 LC-11"},{"key":"year","value":"2018"},{"key":"meter","value":"5000"},{"key":"taxonomizedSubCategorySlug","value":"excavators"},{"key":"downloadReport","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 07 Feb 2024 19:13:26 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Request-Context","value":"appId=cid-v1:3695f997-cc2f-45f0-8294-f170c1613f5c"}],"cookie":[],"responseTime":null,"body":"{\n \"retailConfidenceIntervalHighPriceInCents\": 13501200,\n \"retailConfidenceIntervalLowPriceInCents\": 12056100,\n \"auctionConfidenceIntervalHighPriceInCents\": 9839400,\n \"auctionConfidenceIntervalLowPriceInCents\": 8414000,\n \"retailConfidencePercentage\": 11.32683293881582,\n \"auctionConfidencePercentage\": 15.66580208379127,\n \"retailComparableCount\": 90,\n \"auctionComparableCount\": 45,\n \"retailConfidenceScore\": \"Medium\",\n \"auctionConfidenceScore\": \"Medium\"\n}"},{"id":"71b074d4-b4d2-462f-9e57-3949a23d40a5","name":"2012 John Deere 672G","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.boomandbucket.com/valuationservice/valuation/iron-insight/summarized?make=John DEERE&model=672G&year=2012&meter=15000&downloadReport=false","protocol":"https","host":["api","boomandbucket","com"],"path":["valuationservice","valuation","iron-insight","summarized"],"query":[{"key":"make","value":"John DEERE"},{"key":"model","value":"672G"},{"key":"year","value":"2012"},{"key":"meter","value":"15000"},{"key":"downloadReport","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 07 Feb 2024 19:13:26 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Request-Context","value":"appId=cid-v1:3695f997-cc2f-45f0-8294-f170c1613f5c"}],"cookie":[],"responseTime":null,"body":"{\n \"retailConfidenceIntervalHighPriceInCents\": 10775700,\n \"retailConfidenceIntervalLowPriceInCents\": 9270900,\n \"auctionConfidenceIntervalHighPriceInCents\": 7196900,\n \"auctionConfidenceIntervalLowPriceInCents\": 5034400,\n \"retailConfidencePercentage\": 15.05552776388194,\n \"auctionConfidencePercentage\": 35.92610436429485,\n \"retailComparableCount\": 87,\n \"auctionComparableCount\": 26,\n \"retailConfidenceScore\": \"Medium\",\n \"auctionConfidenceScore\": \"Low\"\n}"}],"_postman_id":"5da52789-f1ea-4699-920d-5d5624fd6207"},{"name":"Add Digital Asset","id":"786ffe81-f40e-4c24-b721-70b7bf12bbc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"url":"http://api.boomandbucket.com/inspectionservice/inspection/{inspectionId}/digitalasset/external","description":"

This endpoint allows you to upload a digital asset (image) externally for an inspection.

The inspectionId for an equipment can be retrieved using the Get Equipment endpoint. The response includes the inspectionId of the inspection tied to that equipment.

Request Body

the url of digital assest as a JSON string in the body of the request (please make sure the url is wrapped in double quotes)

Response:

Successful response: HTTP Status 200 OK with the id of the digital asset that was posted.
Error response: HTTP Status 400 Bad Request with details in the response body.

This endpoint allows you to add one feature to a specific equipment.

Request Body

feature (array): An array with one item as follows:
- text (string): The name of the feature
- description (string) (optional): A description of the feature
\n

Response:

Successful response: HTTP Status 200 OK with the id of the feature that was posted.
Error response: HTTP Status 400 Bad Request with details in the response body.

This endpoint allows you to modify a feature associated with a particular equipment.

Request Body

text (string): The modified name of the feature
description (string) (optional): The modified description of the feature

Response:

Successful response: HTTP Status 200 OK.
Error response: HTTP Status 400 Bad Request with details in the response body.

This endpoint removes a feature associated with a particular equipment.

Response:

Successful response: HTTP Status 200 OK.

This endpoint allows you to add one specification to a specific equipment.

Request Body

technicalSpecification (array): An array with one item as follows:
- text (string): The specification text
- description (string) (optional): A description of the specification
\n

Response:

Successful response: HTTP Status 200 OK with the id of the specification that was posted.
\n
Error response: HTTP Status 400 Bad Request with details in the response body.
\n

This endpoint allows you to modify a specification associated with a particular equipment.

Request Body

text (string): The modified name of the specification
\n
description (string) (optional): The modified description of the specification
\n

Response:

Successful response: HTTP Status 200 OK.
\n
Error response: HTTP Status 400 Bad Request with details in the response body.
\n

This endpoint removes a specification associated with a particular equipment.

Response:

Successful response: HTTP Status 200 OK.