Endpoint Reference
Complete API endpoint reference organized by resource type.
Available Resources
Resource |
Description |
|---|---|
Manage and validate physical addresses used for shipping origins, destinations, and company locations. |
|
Access calendar events and scheduling information for jobs, deliveries, and appointments. |
|
Manage company records including customers, vendors, carriers, and franchisees. Companies are the core entities in the system that can place orders, provide services, or act as shipping partners. |
|
Manage contact information for individuals associated with companies. Contacts can have various roles such as primary contact, billing contact, or operations contact. |
|
Access dashboard widgets and analytics data for business intelligence and reporting. |
|
Manage documents and files associated with jobs, companies, or contacts. Includes invoices, bills of lading, photos, and other supporting documentation. |
|
Send and manage email communications related to jobs, quotes, and customer notifications. |
|
Manage shipping and logistics jobs. Jobs represent the movement of goods from origin to destination and include quotes, bookings, tracking, and completion. |
|
Process and track payments for jobs including credit cards, ACH, and other payment methods. |
|
Manage shipment details within jobs including tracking, carrier assignments, and delivery confirmation. |
|
Track real-time status and location of shipments throughout the delivery process. |
|
Access system reference data and configuration values. Lookups provide standardized lists of values used throughout the system such as company types, job statuses, and service types. |
|
Manage system notifications and alerts for users including email and SMS preferences. |
|
Generate and access various business reports including financial summaries, operational metrics, and custom reports. |
|
Manage user accounts and authentication. Users are individuals who can log into the system and perform various operations based on their permissions. |
|