Send vendor-specific data
POST/chargers/:id/actions/data-transfer
Sends an OCPP DataTransfer command to exchange vendor-specific data with the charger for custom features not covered by standard OCPP.
Use Cases:
- Access vendor-specific charger features
- Retrieve proprietary diagnostic information
- Configure vendor-specific settings
- Trigger custom charger functionality
- Exchange telemetry not defined in OCPP standard
DataTransfer Parameters:
- Vendor ID: Unique vendor identifier (e.g., "com.manufacturer")
- Message ID (optional): Specific command or feature identifier
- Data (optional): Vendor-specific payload (string format)
Vendor-Specific Nature:
- Format and content defined by charger manufacturer
- Not standardized across different vendors
- Requires vendor documentation to use correctly
- May not be supported by all chargers
- Vendor handles request processing and response
Common Use Cases by Vendor:
- Retrieve extended diagnostics (ABB, Wallbox, etc.)
- Control display messages or LED colors
- Access proprietary metering data
- Configure advanced hardware features
- Trigger vendor-specific maintenance modes
Important Notes:
- Consult charger manufacturer documentation for supported commands
- Data format and structure vary by vendor
- Charger returns vendor-specific response data
- May return "NotSupported" if vendor ID/message ID unknown
- Not guaranteed to work across different charger models
Best Practices:
- Verify charger vendor supports the command
- Document vendor-specific integrations clearly
- Test on development chargers before production
- Handle "NotSupported" or error responses gracefully
- Maintain vendor-specific logic separate from standard OCPP
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 500
Standard success response for actions
Standard error response format
Standard error response format
Standard error response format
Standard error response format
Standard error response format