Show Menu
Search…
Ctrl+K
ESC
Example searches: “id”, “Carrier”, “getAll”, “summaryEquipment”, “downloadFrame”
Toggle dark mode
API Changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Topics
Introduction
Authentication
Endpoints
Account
GetAll
GET
Create
POST
Invite
POST
Me
GET
GetByUsername
GET
GetById
GET
Delete
DELETE
Update
PATCH
GetPending
GET
Account Public
ForgotPassword
POST
GetInvite
GET
CreateInvitedAccount
POST
ResendConfirmationEmail
POST
ResetPassword
POST
Validate
POST
Attachment
Upload attachment
POST
ImageSizesGenerate
POST
ImageSizesStopGeneration
POST
Download
GET
DownloadInfo
GET
Auth
Authenticates a user providing an access_token (JWT) for subsequent calls
POST
Returns a new `access_token` and `refresh_token` pair
POST
Billing Dashboard
Billing dashboard
GET
Camera
GetAll
GET
Register
POST
GetById
GET
Patch
PATCH
Capture
POST
DownloadFrame
GET
Carrier
Returns the list of carriers associated to current visible yards in the organization
GET
Creates or updates a carrier
PUT
Create
POST
Returns the carrier or carriers that match all the parameters conditions
GET
GetById
GET
Delete
DELETE
Update
PATCH
Dashboard
Movement
GET
WaireCalculations
GET
YardTrailer
GET
YardTruck
GET
Movement
GET
WaireCalculations
GET
YardTrailer
GET
YardTruck
GET
Driver
GetAll
GET
Creates or updates a driver
PUT
Create
POST
Check
GET
SearchByTerm
GET
GetById
GET
Delete
DELETE
Update
PATCH
Inspection
Returns all inspections ordered by timestamp, newer first
GET
CreateInspection
POST
GetById
GET
DeleteInspection
DELETE
Update
PATCH
Report
POST
Movement (ReadOnly)
GetById
GET
Organization
GetAll
GET
Create
POST
GetById
GET
Delete
DELETE
Update
PATCH
De-associates the given carrier from all the yards in this organization. Also, if the carrier is *not* a Global Carrier, then it will be also be deleted from the system
DELETE
Organization Group
GetAll
GET
Create
POST
GetById
GET
Delete
DELETE
Update
PATCH
Organization Group PaymentMethod
GetPaymentMethod
GET
Attach a new Payment Method to the organization
POST
Organization Group Subscription
GetSubscriptions
GET
PostSubscription
POST
Organization PaymentMethod
GetPaymentMethod
GET
Attach a new Payment Method to the organization
POST
Organization Subscription
GetSubscriptions
GET
PostSubscription
POST
Payment Intent
Attach a new Payment Method to the organization
POST
Settings
Returns all settings, including the not configured ones, with their organization/yard/account values if any
GET
Saves a list of settings (it can be all for the org, all for a yard, or a subset or just one property in the list). If the account is not a YardAdmin any attempt to store a value with level ORGANIZATION/YARD will produce an unauthorized error
PUT
Returns the effective value for a particular setting
GET
Share
Publish the specified movement
POST
Public endpoint to retrieve a previously shared attachment
GET
Public endpoint to retrieve a previously shared movement
GET
SignUp
Checks if an account exists
POST
Checks if an account exists
POST
Summary
Trailers Aging Summary
GET
SummaryDamaged
GET
SummaryEquipment
GET
SummaryMovement
GET
SummaryTrailer
GET
SummaryYard
GET
YardActivity
GET
Tag
GetAll
GET
Create or update a tag
PUT
Create
POST
GetById
GET
Delete
DELETE
Update
PATCH
Trailer
GetAll
GET
Create or update a trailer
PUT
Create
POST
GetByCarrierIdAndNumber
GET
Search
GET
GetById
GET
Delete
DELETE
Update
PATCH
GetInspections
GET
GetLastInspection
GET
GetTags
GET
Associates a tag to a trailer
POST
DeassociateTag
DELETE
Truck
GetAll
GET
Create or update a truck
PUT
Create
POST
Search a (unique) truck by number and carrierId
GET
Search
GET
GetById
GET
Delete
DELETE
Update
PATCH
GetInspections
GET
GetLastInspection
GET
User Event
Find
GET
Create
POST
Count
GET
UserInterface - App Info
GetAppInfo
GET
Yard
GetAll
GET
Create
POST
GetById
GET
Delete
DELETE
Update
PATCH
GetYardCarriers
GET
AssociateToYard
POST
DeleteYardCarrierAssociation
DELETE
ModifyYardCarrierAssociation
PATCH
OpenGateIn
POST
OpenGateOut
POST
TrailersInYard
GET
TrucksInYard
GET
Yard Movement
Registers a new yard movement
POST
Quick check to know if there has been new movements or new editions after the given date
GET
GetById
GET
Delete
DELETE
Update
PATCH
GetInspections
GET
InvalidateTrailer
PATCH
InvalidateTruck
PATCH
Yard Movement Precheck
Retrieve the list of current active Prechecks
GET
Registers a new yard movement precheck
POST
Retrieve the unique active non-checked Precheck with the given Gatepass Code
GET
GetByTrailerOrTruckNumberInfix
GET
Retrieve a Precheck by identifier
GET
Deletes the requested Precheck
DELETE
Modified an existing movement precheck
PATCH
Retrieve just the Gatepass code of a Precheck by identifier
GET
Generates a new gatepass for the given precheck (only if it does not exist already)
POST
Send the generated gatepass to the preferred notification channel of the driver associated to the given precheck
POST
Dismiss highlight
Show more
Yard
Yard Controller