gatego API documentation

AssociateToYard

POST /api/yard/{yardId}/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)

Path parameters

yardId integer(int64) Required

yardId

application/json

Body

authorized boolean
carrier_capacity integer(int32)
carrier_id integer(int64)

Responses

• 200

OK
Hide response attributes Show response attributes object
- authorized boolean
- capacity integer(int64)
- carrier_id integer(int64)
• 201

Created
• 401

Unauthorized
• 403

Forbidden
• 404

Not Found

POST /api/yard/{yardId}/carrier

curl \
 -X POST https://api-dev.gatego.io:443/api/yard/{yardId}/carrier \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"authorized":true,"carrier_capacity":42,"carrier_id":42}'

Request example

# Headers

# Payload
{
  "authorized": true,
  "carrier_capacity": 42,
  "carrier_id": 42
}

Response examples (200)

{
  "authorized": true,
  "capacity": 42,
  "carrier_id": 42
}