DIY Developer Guide: Building Custom Integrations for SAP Business ByDesign

A technical guide for developers building custom integrations with SAP Business ByDesign. Covers authentication, OData APIs, common patterns, and when to use a managed platform instead.

Overview

SAP Business ByDesign is a cloud ERP designed for mid-market companies. Its integration capabilities center around OData services, SOAP web services, and a built-in integration framework. This guide covers the practical steps for building custom integrations.

Authentication & Access

SAP Business ByDesign uses:

• Basic authentication for OData and SOAP services
• OAuth 2.0 for newer API endpoints
• Communication arrangements for B2B integration scenarios

Set up a communication system and communication arrangement in your ByDesign tenant before making API calls.

Working with OData APIs

ByDesign exposes business objects through OData v2 services:

• Sales Orders: Access via the /sap/byd/odata/v1/khsalesorder endpoint
• Customers: /sap/byd/odata/v1/khcustomer
• Products: /sap/byd/odata/v1/khproduct
• Invoices: /sap/byd/odata/v1/khcustomerinvoice

Use $filter, $select, $expand, and $top query parameters to optimize your requests.

Common Integration Patterns

Order Sync

1. Poll the ecommerce platform for new orders
2. Transform order data to ByDesign sales order format
3. POST to the sales order OData service
4. Handle validation errors and retry logic

Inventory Sync

1. Query ByDesign material stock data
2. Transform to the target system's inventory format
3. Push inventory levels to ecommerce channels
4. Schedule at regular intervals to maintain accuracy

Error Handling

• Implement exponential backoff for rate-limited requests
• Log all API responses for debugging
• Set up alerts for failed transactions
• Build idempotent operations to handle duplicates

When to Use a Managed Platform

Building custom integrations with SAP ByDesign requires deep knowledge of SAP's data model, OData quirks, and error handling patterns. For businesses that need reliable, production-grade integrations without dedicated developer resources, a managed platform like APIWORX handles the complexity — from field mapping to error resolution to monitoring.

Don't want to build it yourself? We'll do it for you.

This guide shows how to build it manually. APIWORX automates all of this in 2–4 weeks with zero developer time required.

Talk to an expert