gatego logo
API Changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Gatego Developers Documentation
main
  • main default
  • settings-multilevel

Topics

  • Introduction
  • Authentication

Endpoints

  • Billing Config
    • Get all yards configs GET
    • Get all yards configs including carrier configs GET
    • Get all yards configs including carrierIds GET
    • Get the config for the requested yard GET
    • Create or updates yard config PUT
    • Create new yard config POST
    • Delete a yard config DELETE
    • Get requested carrier within yard GET
    • Create or updates a carrier config within a yard PUT
    • Create new carrier config within a yard POST
    • Delete a carrier config within a yard DELETE
    • Update an existing billing carrier config within a yard PATCH
    • Get the config for the requested yard including carrier configs GET
    • Get requested yard GET
    • Get requested carrier within yard by unique id GET
    • Delete a carrier within a yard by its unique id DELETE
    • Update an existing carrier config within a yard by its unique id PATCH
  • Billing Dashboard
    • Generate All Billing summaries for ongoing period POST
    • Billing summary aggregated for a list of yard and carriers GET
    • To Be Completed GET
    • Generate Billing summary for ongoing period POST
    • Generate Billing summary information for past period POST
  • Billing Invoice
    • Get Invoices GET
    • Generate all invoices for previous period POST
    • Get detailed overage info GET
    • Get Invoice Summaries GET
    • Get specific Invoice GET
    • Generate/Replace Invoice PUT
    • Generate Invoice POST
    • Delete specific invoice DELETE
    • Delete invoice by id DELETE
  • Billing Invoice Adjustment
    • Retrieves all generated invoice adjustments matching the specified parameters GET
    • Creates a new invoice adjustment for the given yard and carrier POST
    • Deletes an existing invoice adjustment DELETE
    • Updates an existing invoice adjustment PATCH
  • Camera
    • Get all available integration cameras GET
    • Get snapshot from camera provider integration GET
    • Get all Yard Cameras GET
    • Register Yard Camera POST
    • Get Yard Camera GET
    • De-register Yard Camera DELETE
    • Modify a Yard Camera PATCH
  • Hardware
    • Actuate a gate POST
  • Integration
    • Get Integrations GET
    • Add Integration POST
    • Get Camera Providers GET
    • Get Camera Providers GET
    • Get Cameras from Provider GET
    • Get Integration GET
    • Delete Integration DELETE
    • Update Integration PATCH
  • Yard Tasking
    • Endpoint for Creating Tasks POST
    • Endpoint for Drivers to Cancel a Task POST
    • Endpoint for Drivers to Mark Tasks as Completed POST
    • Endpoint for Retrieving a Detailed View of Yard Tasks. Optional yard ID can be specified. If no yard ID is specified, the detailed view of all yards is retrieved. GET
    • Endpoint for Retrieving a Detailed View of Tasks by Status. Optional yard ID can be specified. If no yard ID is specified, the detailed view of all yards is retrieved. GET
    • Endpoint for Retrieving a Detailed View of Tasks by Status. Optional yard ID can be specified. If no yard ID is specified, the detailed view of all yards is retrieved. GET
    • POST /api/yard-task/driver/last-check POST
    • Fetches a list of drivers within an organization, including their session status and availability. GET
    • Endpoint for Drivers to Retrieve a List of Assigned Tasks GET
    • Endpoint for Saving FCM Token POST
    • Endpoint for Drivers to End a Session POST
    • Endpoint for Drivers to Add Session Locations POST
    • Endpoint for Drivers to Start a Session POST
    • Endpoint for Drivers to Mark Tasks as Started POST
    • Endpoint for Retrieving a Summary of Yard Tasks for all Yards GET
    • Endpoint for Retrieving a Yard Summary GET
    • Endpoint for Updating a Task PUT
    • Endpoint for Deleting a Task (Queue Only) DELETE
    • Endpoint for Updating a Task PATCH
  • Attachment Controller
    • POST /api/attachment POST
    • GET /api/attachment/{id} GET
    • DELETE /api/attachment/{id} DELETE
  • Carrier Controller
    • GET /api/carrier GET
  • Dashboard Controller
    • GET /api/dashboard/movement GET
    • GET /api/dashboard/yard/error4xx GET
    • GET /api/dashboard/yard/error5xx GET
    • GET /api/dashboard/yard/trailer GET
    • GET /api/dashboard/yard/truck GET
  • Driver Controller
    • GET /api/driver GET
    • GET /api/driver/check GET
    • GET /api/driver/search GET
    • GET /api/driver/{id} GET
  • Settings Controller
    • GET /api/settings GET
    • PUT /api/settings PUT
    • GET /api/settings/{name} GET
  • Trailer Controller
    • GET /api/trailer GET
  • Truck Controller
    • GET /api/truck GET
    • GET /api/truck/{id} GET
    • GET /api/truck/{truckId}/inspections GET
    • GET /api/truck/{truckId}/last-inspection GET
  • UI Assets Controller
    • GET /api/ui/assets/binary/{fullPath} GET
  • Yard Controller
    • GET /api/yard GET
Powered by Bump.sh