Skip to main content

SAP S/4HANA Cloud Component

Manage business partners, sales orders, materials, and other enterprise resources in SAP S/4HANA Public Cloud.

Component key: sapS4Hana

Changelog ↓

Description​

SAP S/4HANA Cloud is an enterprise resource planning (ERP) system. This component allows you to manage business partners, sales orders, materials, and other enterprise resources within SAP S/4HANA Cloud Public Edition.

API Documentation​

This component was built using the SAP API Business Hub for SAP S/4HANA Cloud.

Connections​

API Key (Sandbox)​

key: apiKey

This connection authenticates with SAP S/4HANA Cloud APIs via the SAP API Business Hub sandbox environment. It is designed for testing and development purposes only and provides read-only access to sample data.

Sandbox Environment Only

This connection is intended for testing and development using the SAP API Business Hub sandbox. For production access to real SAP S/4HANA Cloud data, use the Basic Auth connection instead.

Prerequisites​

Setup Steps​

To create an API key for the sandbox:

  1. Navigate to SAP API Business Hub and log in with SAP credentials.
  2. Click on the user profile icon in the top right corner.
  3. Select Settings or API Keys from the menu.
  4. Click Show API Key to reveal the existing key, or generate a new one if needed.
  5. Copy the API key and store it securely.

Configure the Connection​

  • SAP API Key: Enter the API key obtained from SAP API Business Hub.
  • Base URL: Use the default sandbox URL: https://sandbox.api.sap.com/s4hanacloud
InputNotesExample
SAP API Key

API key from SAP API Business Hub. Log in at https://api.sap.com and access your API key from your account settings.

AbCdEf123456...
Base URL

SAP API Business Hub sandbox URL. Use the default sandbox URL for testing. This connection is intended for sandbox environments only.

https://sandbox.api.sap.com/s4hanacloud

Basic Auth​

key: sapBasicAuth

This connection authenticates directly with an SAP S/4HANA Cloud Public Edition tenant using Basic Authentication.

Production Access

This connection is for direct tenant access to SAP S/4HANA Cloud Public Edition. It requires a Communication Arrangement configured by an SAP administrator.

Prerequisites​

  • SAP S/4HANA Cloud Public Edition tenant
  • Administrator access to configure Communication Arrangements
  • A Communication Scenario enabled for the required APIs (e.g., SAP_COM_0008 for Business Partner API)

Setup Steps in SAP S/4HANA Cloud​

To configure Basic Authentication access, an SAP administrator must complete these steps:

  1. Create a Communication User

    • Navigate to the Maintain Communication Users app
    • Create a new user for API access
    • Set a secure password and note the credentials

  2. Create a Communication System

    • Navigate to the Communication Systems app
    • Create a new system representing the external integration
    • Under Users for Inbound Communication, add the Communication User created above
    • Ensure User ID and Password (Basic Authentication) is enabled

  3. Create a Communication Arrangement

    • Navigate to the Communication Arrangements app
    • Create a new arrangement based on the required Communication Scenario
    • Select the Communication System created above
    • Verify the inbound services are enabled

Configure the Connection​

  • Tenant URL: The SAP S/4HANA Cloud tenant URL

    • Example: https://my123456-api.s4hana.cloud.sap

  • Communication User: The Communication User name created in SAP S/4HANA Cloud

    • Example: Username

  • Password: The Communication User password

InputNotesExample
Password

Communication User password.

Tenant URL

SAP S/4HANA Cloud API tenant URL (include -api in the hostname).

https://my123456-api.s4hana.cloud.sap
Communication User

Communication User name from the Communication Arrangement in SAP S/4HANA Cloud.

COMM_USER_001

OAuth 2.0 Authorization Code​

key: sapOAuth

This connection authenticates with an SAP S/4HANA Cloud Public Edition tenant using OAuth 2.0 Authorization Code flow. It provides full read/write access to business data and is recommended for production integrations.

Production Access

This connection is for direct tenant access to SAP S/4HANA Cloud Public Edition. It requires a Communication Arrangement configured by an SAP administrator with OAuth 2.0 enabled.

Prerequisites​

  • SAP S/4HANA Cloud Public Edition tenant
  • Administrator access to configure Communication Arrangements
  • A Communication Scenario enabled for the required APIs (e.g., SAP_COM_0008 for Business Partner API)
  • An SAP user account with permissions to access the required APIs

Setup Steps in SAP S/4HANA Cloud​

To configure OAuth 2.0 access, an SAP administrator must complete these steps:

  1. Create a Communication System

    • Navigate to Communication Systems app
    • Create a new system representing the external integration (e.g., PRISMATIC)
    • Under Users for Inbound Communication, configure OAuth 2.0:
      • Authentication Method: OAuth 2.0
      • OAuth 2.0 Client ID: Enter a client identifier (e.g., PRISMATIC)
      • Client Type: Public Client (recommended) or Confidential Client

  2. Create a Communication Arrangement

    • Navigate to Communication Arrangements app
    • Create a new arrangement based on the required Communication Scenario
    • Select the Communication System created above
    • Note the OAuth 2.0 Details from Inbound Communication:
      • Client ID

Configure the Connection​

Only two fields are required to configure this connection:

  • Tenant ID: The SAP S/4HANA Cloud tenant identifier

    • This is the prefix in your SAP URL (e.g., my123456 from my123456.s4hana.cloud.sap)
    • Find this in your browser address bar when logged into SAP

  • Client ID: The OAuth 2.0 Client ID from the Communication Arrangement

    • Navigate to Inbound Communication and click OAuth 2.0 Details to view the Client ID

  • Scopes (optional): Space-separated OAuth scopes

    • Leave empty to use default scopes
    • Specify API-specific scopes if required by your Communication Arrangement
Finding OAuth 2.0 Details

In the Communication Arrangement, navigate to Inbound Communication and click OAuth 2.0 Details to view the Client ID.

Authorization Flow​

When you connect using this method:

  1. Enter your Tenant ID and Client ID in the connection form
  2. Click Connect - you will be redirected to SAP's login page
  3. Log in with your SAP user credentials (your personal SAP username and password)
  4. Grant authorization for the integration to access SAP on your behalf
  5. You will be redirected back to complete the connection setup
SAP Login Credentials

During the OAuth flow, you log in with your SAP user account credentials - not the Communication System credentials. Your SAP user must have the appropriate authorizations to access the APIs defined in the Communication Arrangement.

For detailed setup instructions, refer to:

InputNotesExample
Authorize URL

The OAuth 2.0 authorization endpoint for SAP S/4HANA.

https://my410414.s4hana.cloud.sap/sap/bc/sec/oauth2/authorize
Client ID

The OAuth Client ID from the Communication Arrangement. Navigate to Inbound Communication and click OAuth 2.0 Details to view the Client ID. Learn more

TEST
Client Secret

Leave empty for Public Client configurations.

Scopes

Space-separated OAuth scopes. Leave empty to use default scopes, or specify API scopes from your Communication Arrangement.

API_PURCHASEORDER_PROCESS_SRV_0001
Tenant ID

The SAP S/4HANA Cloud tenant identifier. This is the prefix in your SAP URL (e.g., 'my123456' from my123456.s4hana.cloud.sap). Learn more

my123456
Token URL

The OAuth 2.0 token endpoint for SAP S/4HANA.

https://my123456-api.s4hana.cloud.sap/sap/public/bc/sec/oauth2/token?client_id=TEST

Actions​

Add Attachment​

Uploads an attachment to a business object using the file name, mime type of the attachment, business object type, and business object instance key. | key: addAttachment

InputNotesExample
Connection
Request Body

Request Body

Add Item To Purchase Requisition​

Adds an item to a purchase requisition using the purchase requisition number provided. | key: addItemToPurchaseRequisition

InputNotesExample
Connection
Purchase Requisition Number

Purchase Requisition Number

Body

Request Body

Create Change Record​

Creates a change record. | key: createChangeRecord

InputNotesExample
Connection
Project ID

Project ID

Body

Request Body

Create Project​

Creates a customer or internal project based on the level of information you provide. | key: createProject

InputNotesExample
Connection
Body

Request Body

Create Purchase Requisition​

Creates a purchase requisition with one or more items. | key: createPurchaseRequisition

InputNotesExample
Connection
Body

Request Body

Create Record​

Creates a new record in SAP S/4HANA OData V2. For OData V4 APIs, use Raw Request. | key: createRecord

InputNotesExample
Connection
Record Type

Type of SAP S/4HANA Record, e.g: WorkItemSet

WorkItemSet
Body

Request Body

Create Subscription​

Creates business event subscriptions. | key: createSubscription

InputNotesExample
Connection
Body

Request Body

Delete Attachment​

Deletes the attachment associated with the business object using the document type, document number, document version, document part, logical document ID, archive document ID, business object type, and business object instance key. | key: deleteAttachment

InputNotesExample
Archive Document ID

Archive Document ID

Business Object Type Name

Business Object Type Name

Connection
Document Info Record Document Number

Document Info Record Document Number

Document Info Record Document Part

Document Info Record Document Part

Document Info Record Document Type

Document Info Record Document Type

Document Info Record Document Version

Document Info Record Document Version

Linked SAP Object Key

Linked SAP Object Key

Logical Document

Logical Document

Delete Record​

Deletes an existing record in SAP S/4HANA OData V2. For OData V4 APIs, use Raw Request. | key: deleteRecord

InputNotesExample
Connection
Record ID

ID number tied to the record

12312313
Record Type

Type of SAP S/4HANA Record, e.g: WorkItemSet

WorkItemSet

Get Attachment​

Reads the attachments associated with a document info record. | key: getAttachment

InputNotesExample
Order By

Order items by property value

Select

Select property to be returned

Connection
Document Info Record Document Number

Document Info Record Document Number

Document Info Record Document Part

Document Info Record Document Part

Document Info Record Document Type

Document Info Record Document Type

Document Info Record Document Version

Document Info Record Document Version

Filter

Filter items by property values

Inline Count

Get Change Records​

Reads data of a specific change record based on its universally unique identifier (UUID). | key: getChangerecord

InputNotesExample
Expand

Expand property to be returned

Select

Select property to be returned

Change Record UUID

NodeID

Connection

Get Project​

Returns details about a customer or internal project. | key: getProject

InputNotesExample
Connection
Expand

Expand to include related entities

Project ID

Project ID

Select

Select property to be returned

Get Purchase Requisition​

Gets the header details of a purchase requisition using the purchase requisition number provided. | key: getPurchaseRequisition

InputNotesExample
Connection
Expand

Expand property to be returned

Purchase Requisition Number

Purchase Requisition Number

Select

Select property to be returned

Get Purchase Requisition Item Details​

Gets the item details of all the items in a purchase requisition | key: getPurchaseRequisitionItemDetails

InputNotesExample
Connection
Expand

Expand property to be returned

Filter

Filter items by property values

Inline Count
Order By

Order items by property value

Purchase Requisition Number

Purchase Requisition Number

Select

Select property to be returned

Skip

Skip the first n items

Top

Show only the first n items

Get Record​

Retrieve a single record from SAP S/4HANA OData V2. For OData V4 APIs, use Raw Request. | key: getRecord

InputNotesExample
Connection
Expand

Expand related entities

Filter

Filter items by property values

Inline Count
Order By

Order items by property value

Record ID

ID number tied to the record

12312313
Record Type

Type of SAP S/4HANA Record, e.g: WorkItemSet

WorkItemSet
Select

Select property to be returned

Skip

Skip the first n items

Top

Show only the first n items

List Change Records​

Retrieves the list of change records in the system. | key: listChangeRecords

InputNotesExample
Expand

Expand property to be returned

Order By

Order items by property value

Select

Select property to be returned

Connection
Filter

Filter items by property values

Inline Count
Skip

Skip the first n items

Top

Show only the first n items

List Files​

Retrieves list of prepared files, based on specific filter conditions. | key: listFiles

InputNotesExample
Connection
Filter

Filter items by property values

Inline Count
Select

Select property to be returned

List Projects​

Returns details about all customer and internal projects in the system. | key: listProjects

InputNotesExample
Connection
Expand

Expand property to be returned

Filter

Filter items by property values

Inline Count
Order By

Order by property

Select

Select property to be returned

List Purchase Requisitions​

Gets the header details of all the purchase requisitions in the system. | key: listPurchaseRequisitions

InputNotesExample
Connection
Expand

Expand property to be returned

Filter

Filter items by property values

Inline Count
Order By

Order items by property value

Select

Select property to be returned

Skip

Skip the first n items

Top

Show only the first n items

List Records​

Retrieve a list of records from SAP S/4HANA OData V2. For OData V4 APIs, use Raw Request. | key: listRecords

InputNotesExample
Connection
Expand

Expand related entities

Available values (use one): ProjectRoleSet, WorkPackageSet
Filter

Filter items by property values

Inline Count
Order By

Order items by property value

Available values (use one): FileSize, FileSize desc, FileName, FileName desc, MimeType, MimeType desc, CreatedByUser, CreatedByUser desc, CreationDateTime, CreationDateTime desc, LastChangedByUser, LastChangedByUser desc, ChangedDateTime, ChangedDateTime desc
Record Type

Type of SAP S/4HANA Record, e.g: WorkItemSet

WorkItemSet
Select

Select property to be returned

Available values (use one): DocumentInfoRecordDocType, DocumentInfoRecordDocNumber, DocumentInfoRecordDocVersion, DocumentInfoRecordDocPart, LogicalDocument, ArchiveDocumentID, LinkedSAPObjectKey, BusinessObjectTypeName, SemanticObject, WorkstationApplication, FileSize, FileName, DocumentURL, MimeType, Content, CreatedByUser, CreatedByUserFullName, CreationDateTime, BusinessObjectType, LastChangedByUser, LastChangedByUserFullName, ChangedDateTime, StorageCategory, ArchiveLinkRepository, SAPObjectType, SAPObjectNodeType, HarmonizedDocumentType, AttachmentDeletionIsAllowed, AttachmentRenameIsAllowed, Source, AttachmentContentHash
Skip

Skip the first n items

Top

Show only the first n items

List Subscriptions​

Reads subscription information for business events. | key: listSubscriptions

InputNotesExample
Connection
Filter

Filter items by property values

Inline Count
Order By

Order by property

Search

Search items by search phrases

Select

Select property to be returned

Skip

Skip the first n items

Top

Show only the first n items

List Timesheet Entry Collection​

Reads data for all workforce’s timesheet entries. It retrieves information about the time recording made by each workforce’s on a particular task and on a particular day. | key: listTimesheetEntryCollection

InputNotesExample
Connection
Filter

Filter items by property values

Inline Count
Order By

Order by property

Select

Select property to be returned

Skip

Skip the first n items

Top

Show only the first n items

Raw Request​

Send raw HTTP request to SAP S/4HANA | key: rawRequest

InputNotesExample
Connection
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only. The base URL from your connection is automatically prepended. For example: /sap/opu/odata4/sap/api_purchaseorder_2/srvd_a2x/sap/purchaseorder/0001/PurchaseOrder

/sap/opu/odata4/sap/api_purchaseorder_2/srvd_a2x/sap/purchaseorder/0001/PurchaseOrder
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Raw Request - OData​

Send an OData GET request to SAP S/4HANA with query parameters | key: rawRequestOdata

InputNotesExample
Connection
Expand

Expand property to be returned

Filter

Filter items by property values

Inline Count
Order By

Order by property

Search

Search items by search phrases

Select

Select property to be returned

Skip

Skip the first n items

Top

Show only the first n items

URL Path

Input the path only. The base URL from your connection is automatically prepended. Example: /sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHeader

/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHeader

Update Change Record​

Updates header attributes of the change record specified in the request. | key: updateChangeRecord

InputNotesExample
Change Record UUID

NodeID

Connection
Body

Request Body

Update Project​

Updates the basic information for a customer or internal project. | key: updateProject

InputNotesExample
Connection
Project ID

Project ID

Body

Request Body

Update Purchase Requisition​

Updates the header details of a purchase requisition. | key: updatePurchaseRequisition

InputNotesExample
Connection
Purchase Requisition Number

Purchase Requisition Number

Body

Request Body

Update Record​

Updates an existing record in SAP S/4HANA. | key: updateRecord

InputNotesExample
Connection
Record ID

ID number tied to the record

12312313
Record Type

Type of SAP S/4HANA Record, e.g: WorkItemSet

WorkItemSet
Body

Request Body

Update Subscription​

Updates business events subscription status using the business event subscriber code, SAP object type, SAP object task code, and business event subscription state code. | key: updateSubscription

InputNotesExample
Bus Event Subscriber Code

Subscriber ID

Connection
Body

Request Body

SAP Object Task Code

SAP Object Task Code

SAP Object Type

SAP Object Type

Update Timesheet Entry Collection​

Creates, updates, or deletes workforce timesheet entry based on the data provided in payload. | key: updateTimesheetEntryCollection

InputNotesExample
Connection
Body

Request Body

Changelog​

2026-01-22​

Enhanced Raw Request and Raw Request - OData actions header return structure.

2026-01-14​

Added OAuth 2.0 Authorization Code connection for direct access to SAP S/4HANA Cloud Public Edition. This connection uses OAuth 2.0 Authorization Code flow for authentication and is recommended for production integrations. Supports both Public Client and Confidential Client configurations.

2026-01-08​

Added Basic Auth connection for direct access to SAP S/4HANA Cloud Public Edition. Users can now authenticate to their production SAP S/4HANA Cloud tenants.