Skip to main content
POST
/
v1
/
companies
/
{company-id}
/
managed_companies
/
{managed-company-id}
/
equipment
Create Equipment for a Managed Company
curl --request POST \
  --url https://api.tread-horizon.com/v1/companies/{company-id}/managed_companies/{managed-company-id}/equipment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "equipment_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "license_number": "<string>",
  "external_id": "<string>",
  "ownership": "internal",
  "state": "active",
  "zone": "<string>",
  "accounting_id": "<string>",
  "home_base_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "equipment_type": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "system": true,
      "external_id": "<string>",
      "accounting_id": "<string>"
    },
    "external_id": "<string>",
    "equipment_id": "<string>",
    "license_number": "<string>",
    "zone": "<string>",
    "accounting_id": "<string>",
    "company": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tread_id": "ABC123",
      "legal_name": "<string>",
      "company_type": "hauler"
    },
    "ownership": "internal",
    "state": "active",
    "labels": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "color": "<string>"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "company_share": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "<string>",
      "ticket_match_id": "<string>",
      "sender_company": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tread_id": "ABC123",
        "legal_name": "<string>",
        "company_type": "hauler"
      },
      "dispatchable": true,
      "schedule_on": true,
      "rate_override": true,
      "expires_at": "2023-11-07T05:31:56Z"
    },
    "home_base": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "lat": "<string>",
      "lon": "<string>",
      "full_address": "<string>",
      "routable": true,
      "discarded_at": "2023-11-07T05:31:56Z",
      "address": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "thoroughfare": "<string>",
        "premise": "<string>",
        "locality": "<string>",
        "administrative_area": "<string>",
        "postal_code": "<string>",
        "country": "US",
        "lat": "<string>",
        "lon": "<string>",
        "place_id": "<string>"
      },
      "next_billion_geofence": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "geofence": {
          "name": "<string>",
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "geojson": {
            "type": "<string>",
            "coordinates": [
              [
                [
                  "<unknown>"
                ]
              ]
            ]
          },
          "circle_center": {
            "lat": 123,
            "lon": 123
          },
          "circle_radius": 123
        },
        "moving_geofence": false
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Accept-Language
string
default:en

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

Example:

"en"

Path Parameters

​
company-id
string
required

Managing Company ID

​
managed-company-id
string
required

Managed Company ID

Body

application/json
​
name
string
required
​
equipment_type_id
string<uuid>
required
​
license_number
string | null
​
external_id
string | null
​
ownership
enum<string>
default:internal
Available options:
internal,
external
Example:

"internal"

​
state
enum<string>
default:active
Available options:
active,
inactive
Example:

"active"

​
zone
string | null
​
accounting_id
string | null
​
home_base_id
string<uuid> | null
​
label_ids
string<uuid>[]

Array of Label IDs to assign to this equipment.

Response

Created

​
data
Equipment-Read · object
required