Skip to main content
Version: 1.0.0

Address Module API

API for company address management

API for company API key management

API for managing transport auctions

API for company user authentication, registration and account management

Provides endpoints to search and manage cargo auctions.

Cargoffer billing module for transport companies. Allows management and consultation of all information related to:

  • Monthly and accumulated billing
  • Applied rates
  • Consumption by users, vehicles, and carriers
  • eCMR generation

Main features:

  • Real-time current billing consultation
  • Complete history with detailed breakdown
  • Integration with JWT authentication system
  • Support for multiple billing periods

Usage examples:

  • Billing dashboard in web application
  • Monthly report generation
  • Reconciliation with accounting systems
  • Operational cost analysis

API for HS Code classification system (sections, chapters, headings, subheadings)

API for managing CMR (Consignment Note) documents

Provides endpoints for:

  • Creating contact/support tickets with different categories

Typical use cases:

  • Reporting technical problems
  • Requesting information about functionalities
  • Reporting delivery incidents
  • General service inquiries

Requires JWT authentication for registered companies or can be used anonymously.

This API provides endpoints for managing transportation contracts between companies and carriers. Includes functionality for:

  • Retrieving contract lists - Generating PDF contracts - Sending contracts via email All endpoints require authentication via JWT token.

Provides endpoints for: - Get country information (public and admin) - Get regex for country code validation - Create, update, and delete countries (admin only) Note: - Endpoints that modify data require administrator authentication.

API for company dashboard statistics

API for managing company profile data and signatures

API for transport delivery management

API for company document management. Allows uploading, listing, updating, and deleting documents associated with a company, with version control and status management.

API for managing company invoices and payments

API for managing transport issues and support tickets

API for minimum route calculations (costs, CO2, route information)

API for managing company carriers and their drivers

API for the comprehensive management of notifications within the CargOffer platform.

Provides endpoints for:

  • Consulting dashboard notifications
  • Marking notifications as read
  • Deleting notifications

Audience:

  • CargOffer client applications
  • Business integrations

Security:

  • Authentication via JWT Bearer tokens or API Keys
  • JWT tokens: Include in Authorization header as Bearer <token>
  • API Keys: Include in X-API-Key header or apikey query parameter
  • Access restricted to authorized users

API for company payment and payment method management

This module allows managing the complete delivery cycle via QR tokens:

  • Delivery information consultation

API for comprehensive management of associated truckers

Collaborative Trucker Management System

Provides endpoints to manage truckers working with the company:

Main features:

  • Individual and bulk (CSV) trucker registration
  • Complete driver profile management
  • Default vehicle assignment
  • Access and permission control
  • Filtering by DNI/NIE/CIF
  • Contact information retrieval

Business use cases:

  • Onboarding new truckers
  • Driver data updates
  • Bulk import from external systems
  • Quick lookup by tax ID
  • Collaborative fleet management

Advanced features:

  • Automatic credential sending via email
  • Tax data validation (taxid)
  • Email address verification
  • CSV templates for import
  • Multilingual help notes

Security:

  • Mandatory JWT authentication
  • Company membership verification
  • Multitenant permission control
  • Limits according to subscription plan

Authentication​

JWT Bearer authentication

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer

Bearer format:

JWT

License