create

POST /api/trailer

Headers

X-Gatego-oid

Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)

application/json

Body

carrier_id integer(int64) Required
custom_fields object
Hide custom_fields attributes Show custom_fields attributes object
- Additional properties
- key string
number string Required
type string

Responses

201 */*

Created
Hide response attributes Show response attributes object
- carrier object
  
  Hide carrier attributes Show carrier attributes object
  
  address string
  
  address_additional_info string
  
  authorized boolean
  
  created_at string(date-time)
  
  created_by string
  
  email string
  
  fleet_id string
  
  id integer(int64)
  
  last_modified_at string(date-time)
  
  last_modified_by string
  
  name string
  
  rfc string
  
  scac string
  
  usdot string
  
  yards array[object]
  
  Hide yards attributes Show yards attributes object
  
  authorized boolean
  
  carrier_capacity integer(int64)
  
  yard_id integer(int64)
- custom_fields object
  
  Hide custom_fields attributes Show custom_fields attributes object
  
  Additional properties
  
  key string
- id integer(int64)
- number string
- tags array[object]
  
  Hide tags attributes Show tags attributes object
  
  associated_at string(date-time)
  
  color string
  
  created_at string(date-time)
  
  id integer(int64)
  
  last_modified_at string(date-time)
  
  name string
- type string
401

Unauthorized
403

Forbidden
404

Not Found

POST /api/trailer

curl \
 -X POST http://127.0.0.1:8080/api/trailer \
 -H "Content-Type: application/json" \
 -d '{"carrier_id":42,"custom_fields":{"key":"string"},"number":"string","type":"string"}'

Request examples

# Headers

# Payload
{
  "carrier_id": 42,
  "custom_fields": {
    "key": "string"
  },
  "number": "string",
  "type": "string"
}

Response examples (201)

{
  "carrier": {
    "address": "string",
    "address_additional_info": "string",
    "authorized": true,
    "created_at": "2024-05-04T09:42:00+00:00",
    "created_by": "string",
    "email": "string",
    "fleet_id": "string",
    "id": 42,
    "last_modified_at": "2024-05-04T09:42:00+00:00",
    "last_modified_by": "string",
    "name": "string",
    "rfc": "string",
    "scac": "string",
    "usdot": "string",
    "yards": [
      {
        "authorized": true,
        "carrier_capacity": 42,
        "yard_id": 42
      }
    ]
  },
  "custom_fields": {
    "key": "string"
  },
  "id": 42,
  "number": "string",
  "tags": [
    {
      "associated_at": "2024-05-04T09:42:00+00:00",
      "color": "string",
      "created_at": "2024-05-04T09:42:00+00:00",
      "id": 42,
      "last_modified_at": "2024-05-04T09:42:00+00:00",
      "name": "string"
    }
  ],
  "type": "string"
}