SAP Ariba

SAP Ariba is available in the Finance hub.

Element Information Details
Authentication Hybrid - OAuth 2.0 and cXML
Events NOT supported
Bulk NOT Supported
Virtual Data Resources and Transformations Supported

SAP Ariba Element


SAP Ariba is a hybrid element using an authentication workflow using both OAuth2.0 and cXML services. The list of resources supported by either types of authentication are discussed further down below.

Using OAuth 2

One of the two types of authentication utilized by the SAP Ariba element is OAuth2.0, which uses an API key and Base64 encoded Client ID and Client Secret. Unlike other elements, SAP Ariba provides you with a different set of auth credentials for each API module. Currently, we support the following objects:

  • contract-workspaces
  • document-changes
  • invoices
  • pending-approvables
  • purchase orders

SAP Ariba’s API modules are broadly classified into these categories:

  1. Analytics
  2. Ariba Network
  3. Catalog
  4. Procurement
  5. Strategic Resourcing
  6. Supplier Management

Each module itself has different API sub-categories under it; accordingly, you will need a different set of authentication credentials to access different objects. In our element, we use the following API sub-categories to access each object:

ObjectAPI Sub CategoryCategory
  1. Contract Workspaces Retrieval API
  2. Contract Workspaces Modification API
Strategic Resourcing
InvoicesAriba Network Invoice Header Data Extraction APIAriba Network
DocumentChangesDocument Approval APIProcurement
PendingApprovablesDocument Approval APIProcurement
PurchaseOrdersAriba Network Purchase Order APIAriba Network

To access each object in the element, user will have to register an application for each of the above mentioned APIs. To register an application: 

  1. Login to your registered Ariba developer account.
  2. Access the ‘Manage’ tab on the left of the screen.
  3. Click on  ‘+’ to add a new application.
  4. A screen pops up asking for the ‘application name’ and ‘description’. Enter them.
  5. An application will be created.

Once an application is created, you now need access to the APIs.

  1. From the ‘Actions’ button, click on ‘Request API access’.
  2. On the new screen, select an API from the list. This API is nothing but the sub-category item we talked about in the table above.  You can fill in other optional fields which includes realm name, AN-ID and realm type which are the details of your account. You can also include some comments describing why you need API access.  Fill in appropriate details on the screen and click ‘Submit’.
  3. Your application will now be sent to review and will be approved by the Ariba team.
  4. Once the app is approved, you will now have access to the data from the API calls.
  5. Now, to generate the auth credentials click Generate OAuth Secret.
    This will give you an ‘API key’ and ‘Base64 encoded Client ID and Client Secret’ which is what you require for creating an instance.
Note: To access Ariba REST APIs, you need to have different instances corresponding to different objects. However, using the element on our platform, you can make a call to any object with one single instance. While provisioning an instance, under the optional fields, enter all the valid credentials corresponding to the object you want to access and then click 'Create Instance'. As long as the credentials being used are valid, you will be able to make a call to any object with just one instance.

Using cXML

On certain resources, SAP Ariba supports only GET calls but the SAP Ariba element on our platform leverages the cXML services of the Ariba system and implements POST/PATCH/DELETE calls on the 'purchaseOrders' and POST/DELETE on the 'invoices' objects, respectively. These calls do not have any dependency on the OAuth2.0 authentication used while provisioning an instance. The above mentioned cXML calls require you to pass the credentials in the header section of the request payload. Below is a sample header that is required to pass in the request payload:































            <Credential domain="AribaNetworkUserId">




            <UserAgent>Buyer xxxx</UserAgent>



Authentication Parameters

You can authenticate an element instance using the UI or via API calls. For detailed information on how to authenticate an instance, see our related documentation:

To authenticate an instance of the SAP Ariba element, you may need any of the following parameters:

Parameter NameAPI ValueDescription
contractWorkspaces.apiKeyContract Workspaces API key.
Document Approval API KeydocumentApproval.apiKeyDocument Approval API Key.
Document Approval Base64 Client Id and SecretdocumentApproval.base64clientidandsecretDocument Approval Base64 Client Id and Secret.
DomaindomainDomain for SAP Ariba.
Invoices API Keyinvoices.apiKeyInvoices API Key.
Invoices Base64 Client Id and Secretinvoices.base64ClientIdAndSecretInvoices Base64 Client Id and Secret.
Purchase Orders API KeypurchaseOrders.apiKeyPurchase Orders API Key.
Purchase Orders Base64 Client Id and SecretpurchaseOrders.base64ClientIdAndSecretPurchase Orders Base64 Client Id and Secret.
Shared SecretsharedSecretSAP Ariba Shared Secret.
Default Select map used to specify default fields for bulk download and GET /all requests. Each key should be the canonical objectName and values may be specified as a comma-delimited string or a list of strings.
Instance Variablesinstance.variablesStates what the instance variables are.
Synchronous Bulk Notificationsynchronous.bulk.notificationEnables synchronous bulk callback notification.
Filter null values from the responsefilter.response.nullsUsed to enable/disable filtering of null values from the responses.

Sample Configuration JSON

"configuration": {
    "filter.response.nulls": "true",
    "domain": "NetworkId",
    "synchronous.bulk.notification": "true",
    "contractWorkspaces.apiKey": "<MyContractWorkspaceApiKey>",
    "sharedSecret": "******",
    "purchaseOrders.base64ClientIdAndSecret": "xxxxxxxxxxxx",
    "purchaseOrders.apiKey": "<MyPurchaseOrdersApiKey>",
    "invoices.base64ClientIdAndSecret": "xxxxxxxxx",
    "invoices.apiKey": "<MyInvoicesApiKey>",
    "documentApproval.base64clientidandsecret": "xxxxxxxxxxx",
    "documentApproval.apiKey": "<MyDocumentApproval>",
    "contractWorkspaces.base64ClientIdAndSecret": "xxxxxxxxxxxx"

Element Fact Sheet and Reference

Authentication and Configuration Parameters

To see all authentication parameters for the SAP Ariba element, follow these steps:

  1. Sign in to Cloud Elements and navigate to Elements.
  2. Hover over the card for an element, and then click My Resources. 
  3. In the top navigation toolbar, click Setup.
  4. From the 'Setup' page, you can view a complete list of the element's authentication and configuration parameters.

Element Resources

In order to provide users with normalized APIs across Hubs, Cloud Elements resources were mapped to the following Vendor resources:

CE PlaceholderCE MethodCE ResourceVendor MethodVendor Resource
Purchase OrdersGET/purchase-ordersGET/purchase-orders
POST /purchase-ordersPOST<cXML of PO>
PATCH/purchase-orders/{id}POST<cXML of PO>
DELETE/purchase-orders/{id}POST<cXML of PO>
POST/invoicesPOST<cXML of invoices>

PATCH/invoices/{id}POST<cXML of invoices>

DELETE/invoices/{id}POST<cXML of invoices>
Contract WorkspacesGET /contract-workspacesGET/contract-workspaces
Document ApprovalsGET/approvals
Note: POST and PATCH methods for /contractworkspaces currently only works with minimum payload and does not support maximum payload. Request payloads for these methods containing custom fields or department array fields will fail with a 400 error. 

Events and Supported Resources

The SAP Ariba Element does not support any events.


Bulk provides an option to upload a large number of resources, such as contacts, to a service provider all at once. You can use bulk to download a csv or json file from a large number of records or upload a csv or json file to add multiple records. 

Bulk InformationDetails
Bulk TypeCloud Elements bulk service and not native bulk endpoints. Rate limits come into play when using the Cloud Elements bulk service, so review the limitations in the API provider's documentation.
Objects that Support Bulk/purchase-orders, /invoices
Field Selection SupportNo. To limit the fields returned by the query, you must use a transformation. For example, you can use only select * for this element.
Order By SupportNo.


The Cloud Elements Query Language ( CEQL ) provides a standard way to search across all of our elements. Rather than having users research how to query each resource at a provider, we've normalized your search experience. Cloud Elements translates your queries to the API provider's search syntax. CEQL represents the "where" portion of a typical query that can include many other components like field selection, sorting, and pagination. For more details on Querying, see Querying with CEQL.

To determine whether where clause is supported for an object, you can make an API call to object/{objectName}/metadata while providing the Element version and check for "filterable"="true".

SAP Ariba Element supports querying for the following objects:

  • GET/contract-workspaces
  • GET/invoices
  • GET/purchase-orders

Element Extension

Element Builder gives you the integration tools to extend the current feature set of any of our elements by adding a resource or method. If your use case requires a resource our element doesn’t currently support, you can easily add it in yourself using Element Builder.

SAP Ariba is an extendable element, meaning you can customize it according to your needs; for more information, see Extending Elements.

Discovery APIs

Discovery APIs  are usually used in conjunction with a specific authenticated element instance to:

  • Identify data objects in an element
  • Identify data objects and their source (the vendor, a VDR, or Cloud Elements library)
  • Find metadata, including custom fields, related to an object
  • Retrieve the Open API specifications (API docs) of an object

However, Discovery APIs are not supported by Cloud Elements for the SAP Ariba element, as there is no support by the vendor for the same.

Element API Documentation

The base URL for all API requests is

Provider Documentation

To get access the vendor documentation, the users have to login into

The API documentation for SAP Ariba is private, where the users have to reach out to SAP support to register and get access to it. Please follow the link to register for the developer portal

However, as an alternate, users can read the content from to get more information on the Ariba APIs.