Sap S4hana Sales

SAP S/4HANA Sales APIs

Source: SAP Help Portal — APIs for Sales Version: SAP S/4HANA 2025 FPS01 (Feb 2026)

Protocol Quick Reference

Communication Types

OData V2 vs V4

Only 3 APIs have V4 versions: Sales Order, Sales Contract, Customer Return. Prefer V4 when available.

API Selection Guide

By Task

By Protocol Choice

• Real-time CRUD on single documents → OData (V4 preferred if available)
• Bulk/batch processing → SOAP A2A
• Cross-company B2B → SOAP B2B
• Simulation (no save) → OData Simulation APIs
• Read-only master data → OData A2X (Read)

Authentication

Common Authorization Objects

Common Implementation Patterns

Service Activation

OData APIs: Activate via transaction for maintaining services on SAP Gateway hub system.

SOAP A2A APIs: ICF service is inactive by default. Activate via SICF: Select service → Menu Service/Host → Activate.

Deep Insert (Required by Most Sales APIs)

POST /sap/opu/odata/SAP/<SERVICE>/<HeaderEntity>
Content-Type: application/json

{
  "HeaderField1": "value",
  "to_Item": [
    {
      "ItemField1": "value",
      "to_Partner": [...]
    }
  ],
  "to_Partner": [...],
  "to_PricingElement": [...],
  "to_Text": [...]
}

$batch Request Pattern

POST /sap/opu/odata/SAP/<SERVICE>/$batch
Content-Type: multipart/mixed; boundary=batch

--batch
Content-Type: multipart/mixed; boundary=changeset

--changeset
Content-Type: application/http
Content-Transfer-Encoding: binary

<individual request>
--changeset--
--batch--

Universal constraint: No multiple documents in a single changeset.

ETag Handling (Optimistic Concurrency)

OData V4 (Sales Order, Sales Contract): If-Match header required for all change operations. ETag = LastChangeDateTime.

OData V2 (Customer Return): GET → retrieve LastChangeDateTime → $batch changeset with MERGE (If-Match) as first op, then payload.

Pricing APIs: ETag in every entity; retrieve via GET, include in If-Match.

Async Mode (OData V4 Only)

Set prefer: respond-async header. Response returns 202 Accepted with location header containing a polling URL.

Error Monitoring

BAdI Integration Points

Available for Sales Orders, Customer Returns, Scheduling Agreements, Credit/Debit Memos:

• Sales Document Check Before Save BAdI — Cancel without saving on error
• Sales Header Check BAdI — Continue and save
• Sales Item Check BAdI — Continue and save

Reference Files

Read the relevant reference file when working with a specific API domain: