Download OpenAPI specification:Download
This endpoint returns information about individual terminals including terminal name/code/ID, supported move types(pickup, drop off, etc.), and appointment type(time slot appointments vs pre-advice). This information is required to query specific terminal appointment availability or dwell statistics.
terminals retrieved
Bad request
Unauthorized
Forbidden
Server error occured
{- "terminals": [
- {
- "terminal_name": "HUSKY",
- "terminal_cd": "string",
- "terminal_id": "string",
- "move_type": "string",
- "appointment_type": "slot"
}
]
}
This API endpoint returns appointment availability statistics for time slotted appointments. This API returns data only for the time slotted appointment move types and does not include pre-advice information as it is not applicable as an appointment availability statistic. The response will contain appointment availability data starting with the current date and 7 days into the future and contain a listing of available and booked appointments by move time and time slot for a specific terminal.
appointments by specific terminal ID retrieved
Bad request
Unauthorized
Forbidden
Server error occured
{- "appointments": [
- {
- "date_aggregated_dttm": "2019-08-24T14:15:22Z",
- "date": "string",
- "move_type": [
- "string"
], - "move_type_desc": [
- "string"
], - "slot_desc": "string",
- "slot_start_dttm": "2019-08-24T14:15:22Z",
- "slot_end_dttm": "2019-08-24T14:15:22Z",
- "total_appointments": 0,
- "allocated_appointments": 0,
- "blocked_flag": "string"
}
]
}
This API endpoint provides information about container dwell time in a specific terminal. The dwelling time is calculated as an average dwell within the specified date range. Dwell time is calculated in hours from the container vessel discharge date to the terminal gate out event or from discharge to current dwell time on terminal.
Information about terminal dwell statistics retrieved
Bad request
Unauthorized
Forbidden
Server error occured
{- "start_dttm": "2019-08-24T14:15:22Z",
- "end_dttm": "2019-08-24T14:15:22Z",
- "container_count": 0,
- "avg_dwell_time": 0,
- "teu": 0,
- "date_aggregated_dttm": "2019-08-24T14:15:22Z"
}