Get in Touch

SAP OData Node Documentation

Complete guide to installing, configuring, and using the avanai SAP Connect OData node for n8n.

Installation

Method 1: Install via n8n Community Nodes (Recommended)

  1. Open your n8n instance
  2. Go to Settings → Community Nodes
  3. Click "Install Community Node"
  4. Enter the package name: n8n-nodes-sap-odata
  5. Click Install
Note: Community nodes require n8n version 0.187.0 or higher. Self-hosted instances only.

Method 2: Install via npm (Self-hosted)

npm install n8n-nodes-sap-odata

Method 3: Install from Source

git clone https://github.com/avanaihq/n8n-nodes-sap-odata.git
cd n8n-nodes-sap-odata
npm install
npm run build
npm link
View on npm →

Configuration

After installation, you'll see two new nodes available in n8n:

  • SAP OData - Main node for CRUD operations
  • SAP OData Trigger - Webhook trigger for real-time events

Basic Setup

  1. Drag the SAP OData node into your workflow
  2. Click on the node to open configuration
  3. Create new credentials or select existing ones
  4. Configure your operation and entity settings

Authentication

Supported Authentication Methods

Basic Authentication

For on-premise SAP systems (ECC, S/4HANA):

  • Host: Your SAP server URL (e.g., https://your-sap-server:8000)
  • Username: Your SAP username
  • Password: Your SAP password

OAuth 2.0 Client Credentials

For SAP Cloud and BTP environments:

  • Token URL: OAuth token endpoint
  • Client ID: OAuth client ID
  • Client Secret: OAuth client secret
  • Scope: Required OAuth scopes (optional)

No Authentication

For public APIs and sandbox environments that don't require authentication.

Security Note: Always use HTTPS in production environments. The node handles CSRF tokens, session management, and secure credential storage automatically.

Operations

Available Operations

Get

Retrieve a single entity by its key.

Entity Set: A_BusinessPartner
Key: BusinessPartner='1000000'

Get All

Retrieve multiple entities with optional filtering and pagination.

Entity Set: A_BusinessPartner
$filter: Country eq 'DE'
$select: BusinessPartner,BusinessPartnerName
$top: 100

Create

Create a new entity in SAP.

Update

Update an existing entity (PATCH operation).

Delete

Delete an entity from SAP.

Get Metadata

Retrieve service metadata or service document.

Function Import

Execute SAP business logic:

  • OData V2: Function Imports
  • OData V4: Actions and Functions

Query Options

All standard OData query options are supported:

  • $filter - Filter results
  • $select - Select specific fields
  • $expand - Expand navigation properties
  • $orderby - Sort results
  • $top - Limit number of results
  • $skip - Skip results (pagination)
  • $count - Include total count
  • $search - Full-text search (OData V4)

Examples

Example 1: Get Business Partners from Germany

Operation: Get All
Entity Set: A_BusinessPartner
$filter: Country eq 'DE'
$select: BusinessPartner,BusinessPartnerName,Country
$top: 50

Example 2: Create a New Business Partner

Operation: Create
Entity Set: A_BusinessPartner
Body: {
  "BusinessPartnerCategory": "2",
  "BusinessPartnerGrouping": "BP02",
  "FirstName": "John",
  "LastName": "Doe"
}

Example 3: Automated Order-to-Cash Workflow

  1. Trigger: SAP OData Trigger for new Sales Orders
  2. Get Customer: Retrieve Business Partner details
  3. Check Credit: Execute credit limit Function Import
  4. Send Email: Notify sales team
  5. Update CRM: Sync order data to external system

Troubleshooting

Common Issues

CSRF Token Errors

The node handles CSRF tokens automatically. If you encounter issues:

  • Ensure you're using HTTPS
  • Check your credentials are valid
  • Verify the OData service supports CSRF protection

Authentication Failures

  • Verify credentials are correct
  • Check user has proper SAP authorizations
  • For OAuth, ensure token endpoint and scopes are correct

Service Discovery Issues

  • Ensure SAP Gateway is running
  • Check service is activated in SICF
  • Verify user has access to Gateway Catalog

Performance Issues

  • Use $select to limit returned fields
  • Use $top for pagination
  • Add appropriate $filter conditions
  • Monitor SAP system performance

Debug Tips

  • Enable debug mode in n8n for detailed logs
  • Check SAP system logs for errors
  • Use SAP Gateway Error Log (transaction /IWFND/ERROR_LOG)
  • Test OData URLs directly in browser first

Getting Help