Qodex.ai

Onboard Equipment

POST https://api.boomandbucket.com/marketplaceservice/marketplace/fleet-management-integration/onboard-equipment

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:

  1. Get the onboarded equipment using the Get Equipment endpoint. The response includes the listingId of the listing tied to that equipment.
  2. 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}

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

Request Body

{"serialNumber"=>"value", "taxonomizedSubCategoryId"=>"00000000-0000-0000-0000-000000000000", "year"=>2024, "make"=>"Caterpillar", "model"=>"D4", "hours"=>142, "mileage"=>0, "highwayType"=>0, "fleetIdentifierCompanyId"=>"00000000-0000-0000-0000-000000000000", "fleetIdentifierValue"=>"string", "sellerCompanyName"=>"string", "sellerOfficeAddressLineOne"=>"string", "sellerOfficeAddressLineTwo"=>"string", "sellerOfficeCity"=>"string", "sellerOfficeState"=>"string", "sellerOfficeZipCode"=>"string", "sellerContactFirstName"=>"string", "sellerContactLastName"=>"string", "sellerContactEmail"=>"string", "sellerContactPhone"=>"string"}

RESPONSES

status: OK

"ebba8be0-cba6-4d9f-b119-e66708a1f1d6"