Sign in

v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

Create a new asset

post/v1/assets

Headers

X-Time-Zonestring

Specify the timezone for formatting the timestamps.

X-User-Idinteger

Specify the ID of the Fleet Admin or the Fleet Manager who is accessing this endpoint.

Request body

namestring required

Denotes the name of the asset that you are creating.

typestring required

Denotes the type of the asset that you are creating. Allowed values are ["dry_box", "reefer", "flatbed", "step_deck", "tanker", "low_boy", "intermodal_chassis", "auto_hauler", "livestock", "dump_tipper", "curtain_side", "stake", "construction", "other"]

custom_typestring

Specify the custom type of the asset. If not available, mention it as "Other".

makestring required

Denotes make of the asset that you are creating.

modelstring required

Denotes the model of the asset that you are creating.

yearstring required

Denotes the year of manufacturing of the asset.

subtypestring

Specify the sub type of the asset. Allowed values are: ["backhoe", "boom_truck", "bulldozer", "crane", "dump_truck", "excavator", "forklift", "front_loader", "grader", "trencher", "other"]

vinstring

Specify the VIN number of the asset.

lengthnumber float

Specify the length of the asset.

axleinteger

Provide the axle information of the asset.

gvwrinteger

Gross Vehicle Weight Rating (GVWR) of the asset.

gawrinteger

Gross Axle Weight Rating (GAWR) of the asset.

length_metric_unitsboolean

Specify if length is in metric units.

weight_metric_unitsboolean

Specify if the weight is in metric units.

license_plate_statestring

Mention the state where the license place was installed.

license_plate_numberstring

Mention the number of license plate.

leasedboolean

Mention if the asset is leased or not.

notesstring

Specify any notes for the asset.

asset_gateway_idstring

Mention the ID of the asset gateway with which the asset with linked.

group_idsinteger[]

Specify the group IDs for the assets.

Response

200

Example response

{
  "assets": [
    {
      "asset": {
        "id": 635,
        "name": "def",
        "status": "active",
        "type": "low_boy",
        "make": "HYUNDAI MOTOR CO LTD",
        "model": "ZAKLAD BUDOWY I REMONTOW NACZEP WIE",
        "year": "2013",
        "asset_gateway": {
          "id": 698,
          "identifier": "ATE-3NG-DDQ",
          "active": true
        },
        "availability_details": {
          "availability_status": "out_of_service",
          "out_of_service_reason": "Asset Maintenance",
          "updated_at": "2024-07-31T05:30:53Z",
          "additional_note": "This asset sheduled for maintenance",
          "custom_driver_app_warning_prompt": "This asset is scheduled for maintenance, please don't operate",
          "updated_by_user": {
            "id": 123,
            "first_name": "First",
            "last_name": "Last",
            "user_name": "demo_dispatcher",
            "email": "demo.dispatcher@gmail.com",
            "company_reference_id": 1234,
            "status": "active",
            "role": "dispatcher"
          }
        }
      }
    }
  ],
  "pagination": {
    "per_page": 25,
    "page_no": 1,
    "total": 2
  }
}