gatego API documentation

GetById

GET /api/yard/{yardId}

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

Responses

• 200

OK
Hide response attributes Show response attributes object
- address string
- carriers array[object]
  
  Hide carriers attributes Show carriers attributes
  
  authorized boolean
  
  capacity integer(int64)
  
  carrier_id integer(int64)
- created_at string(date-time)
- id integer(int64)
- last_modified_at string(date-time)
- max_capacity integer(int32)
- name string
- organization_id integer(int64)
- place_id string
• 401

Unauthorized
• 403

Forbidden
• 404

Not Found

GET /api/yard/{yardId}

curl \
 -X GET https://api-dev.gatego.io:443/api/yard/{yardId} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "address": "string",
  "carriers": [
    {
      "authorized": true,
      "capacity": 42,
      "carrier_id": 42
    }
  ],
  "created_at": "2023-05-04T09:42:00+00:00",
  "id": 42,
  "last_modified_at": "2023-05-04T09:42:00+00:00",
  "max_capacity": 42,
  "name": "string",
  "organization_id": 42,
  "place_id": "string"
}