create

POST /api/carrier

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

address string
address_additional_info string
email string
fleet_id string
name string Required
rfc string
scac string
usdot string
yards array[object]
Hide yards attributes Show yards attributes object
- authorized boolean
- carrier_capacity integer(int32)
- yard_id integer(int64)

Responses

201 */*

Created
Hide response attributes Show response 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)
401

Unauthorized
403

Forbidden
404

Not Found

POST /api/carrier

curl \
 -X POST http://127.0.0.1:8080/api/carrier \
 -H "Content-Type: application/json" \
 -d '{"address":"string","address_additional_info":"string","email":"string","fleet_id":"string","name":"string","rfc":"string","scac":"string","usdot":"string","yards":[{"authorized":true,"carrier_capacity":42,"yard_id":42}]}'

Request examples

# Headers

# Payload
{
  "address": "string",
  "address_additional_info": "string",
  "email": "string",
  "fleet_id": "string",
  "name": "string",
  "rfc": "string",
  "scac": "string",
  "usdot": "string",
  "yards": [
    {
      "authorized": true,
      "carrier_capacity": 42,
      "yard_id": 42
    }
  ]
}

Response examples (201)

{"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}]}