100% found this document useful (1 vote)
618 views38 pages

SAP Ariba API Inventory List

The document provides information about 190 APIs supported by SAP Ariba, including the API name, description, and supported formats. The APIs cover a range of areas including procurement, sourcing, supplier management, catalogs, and analytics. The majority (122) support the web service format while others (68) support the REST format.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as XLSX, PDF, TXT or read online on Scribd
100% found this document useful (1 vote)
618 views38 pages

SAP Ariba API Inventory List

The document provides information about 190 APIs supported by SAP Ariba, including the API name, description, and supported formats. The APIs cover a range of areas including procurement, sourcing, supplier management, catalogs, and analytics. The majority (122) support the web service format while others (68) support the REST format.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as XLSX, PDF, TXT or read online on Scribd
You are on page 1/ 38

Count of API # Supported Formats

Solution Area REST Web Service Total Result


Ariba Network 5 5
Operational Procurement 8 82 90
Strategic Procurement 5 39 44
(empty) 17 17
Strategic Procurement ONLY Not applicable if Operat 1 1
Total Result 35 122 157

Variant Specific? Count of API #


vSAP only 9
(empty) 181
Total Result 190
API Name
API #

Export Organizations
115

117 Export Simplified Supplier Profiles

Export Supplier Profiles


118

Export user supplier profiles for


consolidated supplier information export
119

143 Supplier Data API with pagination

External Approval API for Sourcing and


144 Supplier Management
Operational Reporting API for Strategic
145 Sourcing

Analytical Reporting API for Strategic


146 Procurement

147 Integration Monitoring API for Sourcing

148 Document Approval API


149 Catalog Content API

150 Catalog Lookup API

151 Custom Forms API


Operational Reporting API for
152 Procurement

Analytical Reporting API for


153 Procurement
Integration Monitoring API for
154 Procurement

Master Data Integration Job Status API


155 for Operational Procurement

156 Flow Extension API

Discovery RFX Publication to External


157 Marketplace API
Discovery RFX Publication from External
158 Marketplace API

159 Transaction Monitoring API v2

160 Planning Collaboration API

161 Ariba Network Purchase Orders API

162 Ariba Network Supplier Profile API

163 Asset Management API


164 Contract Compliance API
Ariba Network Invoice Header Data
165 Extraction API (Buyer)
Ariba Network Invoice Header Data
165 Extraction API (Supplier)

166 Proof of Service APIs for Buyers

167 Proof of Service APIs (Supplier)

Configuration Parameter Review API for


168 Procurement
169 Contract Workspace Modification API

170 Contract Workspace Retrieval API

171 Event Management API

172 Surrogate Bidding API

Configuration Parameter Review API for


173 Sourcing

174 Product Hierarchy Management API

175 Sourcing Project Management API


Tag Management API for Materials and
176 Bills of Materials
177
178
179
180
181
182
183
184
185
186
187
188
189
Description Supported Formats

The Export Organizations web service is an inbound service that enables you to export
information about the organizations configured for your site. This web service receives
OrganizationExportWSRequest messages and responds with
OrganizationExportWSReply messages. Web Service

Export Simplified Supplier Profile and Questionnaire's answers. Web Service

Use the Export Supplier Profiles web service to export supplier profiles. This web
service responds with a base64- encoded CSV file that contains all supplier profiles. The
profiles include responses to the Supplier Profile Questionnaire (SPQ), except responses
to questions with the Answer Type set to Attachment. Web Service

Export supplier user profiles for consolidated supplier information export Web Service

Using this API, you can create a client application to extract Supplier data from your
SAP Ariba Supplier Lifecycle and Performance or SAP Ariba Supplier Information and
Performance Management (new architecture) solution to report on suppliers, including
registration, qualification, and preferred statuses and details about their questionnaires
and certificates, using pagination to limit the amount of data you extract at one time. REST

The External approval API for sourcing and supplier management processes external
approvals for sourcing, contract workspaces, and supplier management tasks. REST
The Operational reporting API for strategic sourcing enables you to extract and report
on the transactional
sourcing data that you need to make operational decisions, such as events scheduled to
close in the next day, tasks
due to be completed, documents awaiting approval, etc.
Your client application filters the particular type of data you wish to extract by
specifying transaction type, timespan, transaction status, and other considerations.
These filters are included in reporting view templates. A
particular view template is created only once, and persists in the system. The client
application must specify the
view by name with each API call. REST

The SAP Ariba Analytical Reporting API enables you to create a client application that
extracts reportable data from
reporting facts and dimensions such as you would select in the user interface when
creating an analytical report.
For example, you could use this API to extract and report on the analytical data that
you need to import to a
customer's warehouse or create dashboards for trend assessment. REST

The data integration options available in SAP Ariba allows customers to import or
export master and transaction data, to and from their ERP system. Data can be
imported or exported by running individual or batch data import or export tasks from
the user interface, or by scheduling the import or export using the SAP Ariba
Integration Toolkit (ITK). The Integration monitoring API for Strategic Sourcing allows
customers to develop client applications that call the Integration monitoring API URL,
which will return the status of a particular integration event (a data import or export
task). This is useful for customers to automate their batch import or export jobs to or
from their SAP Ariba solution. Buyer organizations can use the Integration monitoring
API to monitor the status of import and export integration events. The API returns the
current running status of the specified event, or, if the event is not currently running,
the system returns details of the last run status of the specific event. It can also be
configured to return the execution history of the integration event. REST

The Document Approvals API allows you to create a client application to approve or
deny requisitions and invoices generated in an SAP Ariba procurement solution. The
client application can process a requisition or invoice either manually, by presenting the
decision to an authorized user, or programmatically by providing the ID of a specific
user authorized to approve, deny, or comment on the requisition or invoice. REST
This API set enables your application to fetch catalog data from the SAP Ariba solution.
The following APIs enable
you to fetch specLfic catalog related information:
Catalog subscription API fetches catalog subscriptions that have been activated after a
specLfied date and time
Catalog facet API fetches attribute-based faceted catalog data
Catalog item API fetches all or a filtered subset of items in a catalog REST

This API set enables your application to update existing catalog-related lookups in SAP
Ariba solutions by
uploading new lookup files. It also enables you to fetch the status of lookups from SAP
Ariba solutions.
This set contains the following APIs:
Lookup upload API uploads lookup files to the content management system (CMS) in
SAP Ariba solutions to
update existing lookups
Lookup status API fetches the status of lookups from the content management system
(CMS) in SAP Ariba
solutions REST

This API set enables your application to get:


- Information about form designs created in the forms builder
- Data from submitted form documents REST
The Operational reporting API for procurement enables you to extract and report on
the transactional procurement
data that you need to make operational decisions, such as invoices to pay or purchase
requisitions that need
approval.
You can use this API to create a client application that extracts reportable data from the
following types of
transactions:
● Requisitions
● Purchase Orders of the following types
○ Direct Orders
○ Copy Orders
○ ERP Orders
● Receipts
● Invoices
● Invoice Reconciliation
● Contract Compliance Documents
Your client application filters the particular type of data you wish to extract by
specifying transaction type, timespan, transaction status, and other considerations.
These filters are included in reporting view templates. You can
create a custom view template using specLfic API calls, or you can use one of the pre-
defined system view
templates. A particular view template is created only once, and persists in the system.
The client application must
specify the view template by name with each API call. REST

The SAP Ariba Analytical Reporting API enables you to create a client application that
extracts reportable data from
reporting facts and dimensions such as you would select in the user interface when
creating an analytical report.
For example, you could use this API to extract and report on the analytical data that
you need to import to a
customer's warehouse or create dashboards for trend assessment. REST
The data integration options available in SAP Ariba allows customers to import or
export master and transaction data, to and from their ERP system. Data can be
imported or exported by running individual or batch data import or export tasks from
the user interface, or by scheduling the import or export using the SAP Ariba
Integration Toolkit (ITK). The Integration monitoring API for Procurement allows
customers to develop client applications that call the Integration monitoring API URL,
which will return the status of a particular integration event (a data import or export
task). This is useful for customers to automate their batch import or export jobs to or
from their SAP Ariba solution. Buyer organizations can use the Integration monitoring
API to monitor the status of import and export integration events. The API returns the
current running status of the specified event, or, if the event is not currently running,
the system returns details of the last run status of the specific event. It can also be
configured to return the execution history of the integration event.

The Integration monitoring API is applicable to:

SAP, PeopleSoft, and generic ERP systems


Individual import and export file channel integration events
Batch import integration events
Transaction and master data. REST

The Master Data Integration Job Status API for Operational Procurement allows the
external ERP system that posts master data to the Master Data Integration Service to
query for the status of master data integration jobs. You can configure the API request
to query on the jobId returned by the uploadXMLData API, or on an object name. The
response is in JSON format. If the master data integration job successfully posted the
data to the buying solution from SAP Ariba, then the response includes the following
details, among others: the number of records inserted, the number of records updated,
and the number of records deleted. If there are any errors when the data is posted to
the buying solution, the error details are included in the response. REST

This API allows you to intercept a document at specific points within its normal flow.
You can also temporarily suspend the flow of a document if desired. During this
interception, you can:

Access data associated with the document


Post attachments to the document
Resume or halt the workflow entirely REST

This API set makes it possible to post SAP Ariba Sourcing RFx events on portals and web
sites outside the usual discovery area, increasing the number of potential bidders by
exposing events to new audiences in new venues. REST
This API set allows a customer organization in an external marketplace to publish an
RFx event on SAP Ariba Discovery and use Single Sign On to view supplier responses
and grant awards. This enables event bidding from both partner suppliers and SAP
Ariba Discovery suppliers, greatly increasing the number of suppliers who can bid. REST

The SAP Ariba Transaction Monitoring APIs for tracking Supply Chain Collaboration
gives Ariba Network a fast and reliable mechanism to monitor Supply Chain
Collaboration transactions across the network. This allows a high degree of visibility and
traceability into business processes and documents associated with these transactions.
This API allows you to trace the lineage of a transaction and perform searches based on
time and searchable fields. REST

Retrieve supplier inventory data, supplier-managed inventory data, and forecast and
commitment data about your suppliers, directly from Ariba Network. REST

The Purchase Order API enables you to retrieve purchase order header and item details
from the Ariba Network.
REST

Retrieve Ariba Network supplier profile information based on supplier ANID.

A customer with an Ariba Network Buyer Account can use the Ariba Network supplier
profile API to retrieve profile information about Ariba Network registered public
suppliers by passing the supplier's ANID. Retrieving a supplier profile could facilitate
enrichment of supplier records in non-SAP Ariba applications, for example. REST

The Asset Management API enables you to assign unique values to asset line items on
requisitions before purchase orders are generated. You use this API to create a client
application to do the following:

Get the count of requisitions consisting of asset items.


Get requisitions consisting of line items configured as assets in the SAP Ariba
Procurement solution.
Assign unique values to asset items on requisitions fetched from the SAP Ariba
Procurement solution. REST
The Contract Compliance API set allows your client application to get information about
contract requests and contracts created in SAP Ariba Procurement solutions. It also
enables you to update the contract accumulators in SAP Ariba Procurement solutions
with data from documents created in your client application.

This set contains the following APIs:

Contract request API: exports contract request header details to the client application.
Contract request line item API: exports specified contract request line items to the
client application.
Contract API: exports contract header details to the client application.
Contract line item API: exports specified contract line items to the client application.
Contract accumulation requests API: Updates and validates contract accumulators
based on the documents from the client application REST
This API retrieves the header information of one or more invoices in Ariba Network so
that users can optimize work and speed up the end-to-end invoice processing cycle. REST
This API retrieves the header information of one or more invoices in Ariba Network so
that users can optimize work and speed up the end-to-end invoice processing cycle. REST

This API allows you to create and manage proof of service (PoS) in Ariba Network. The
PoS is a digital document that acts as a proof of completion of a service line item in the
service order. The ability to create and manage proof of service is important for
organizations to have a digital record as the proof of a completed service, which allows
them to increase efficiency and save time required to process hard copies of receipts as
proof of service. With this API, you can create, update, and view PoS. You can also use it
to retrieve a list of all users of an organization with the specified role, and add an
attachment to a PoS or download a specified attachment from a PoS. REST

This API allows you to create and manage proof of service (PoS) in Ariba Network. The
PoS is a digital document that acts as a proof of completion of a service line item in the
service order. The ability to create and manage proof of service is important for
organizations to have a digital record as the proof of a completed service, which allows
them to increase efficiency and save time required to process hard copies of receipts as
proof of service. With this API, you can create, update, and view PoS. You can also use it
to retrieve a list of all users of an organization with the specified role, and add an
attachment to a PoS or download a specified attachment from a PoS. REST

Review the current and default values of SAP Ariba Buying and configuration
parameters. The behavior of SAP Ariba Buying can be configured in various ways using
configuration parameters. This API enables the customer to review the current and
default values of these configuration parameters. You can specify which parameters to
review by name or description or by using search filters. REST
The Contract Workspace modification API contains endpoints to create a contract
workspace by using an existing template and update the Single Contract Workspace
Metadata (header fields) details. REST

The Contract Workspace retrieval API, GET API, gets the single contract workspace
metadata (header fields) details. The Contact Workspace retrieval API, Search API,
searches for contract workspaces using attributes such as the title and the Last
Modified date. REST

Use the Event Management API to publish sourcing events.

You can also use the Event Management API to republish previously published events
and specify how previous participant responses are handled (kept or discarded), and if
participants receive notifications for the modifications. REST

Use this API to submit surrogate bids on behalf of participants (supplier users) in SAP
Ariba Sourcing events. REST

Review the current and default values of SAP Ariba Sourcing and configuration
parameters.

The behavior of SAP Ariba Sourcing can be configured in various ways using
configuration parameters. This API enables the customer to review the current and
default values of these configuration parameters. You can specify which parameters to
review by name or description or by using search filters. REST

You can use the Product Hierarchy Management API to get all product questionnaires
responded to by a supplier (identified by supplierID) along with associated sourcing
events and line items. REST

SAP Ariba Sourcing Project Management API enables buyers using SAP Ariba Sourcing
or SAP Ariba Contracts to add or delete users in a project group that is part of a
sourcing project or a contract workspace. Buyers can also retrieve lists of project
groups and members of the groups from a sourcing project or contract workspace.

You can also add users to an ad-hoc event. To specify the ad-hoc event to which you
want to add users, specify the workspace ID instead of the project ID. REST
Product sourcing users of SAP Ariba Strategic Sourcing Suite can use this API to add tags
to the bills of materials (BOMs) and materials. They can also use this API to view or
delete tags associated with materials or BOMs. Product sourcing users can use the tags
for searching and filtering BOMs and materials from the product sourcing UI.
REST
Product Line Solution Area2 Category Documentation Documented rate limits

SAP Ariba Buying


and Invoicing, SAP
Ariba Strategic
Sourcing Suite, SAP Suppliers/Supplier
Ariba Sourcing Administration Users Documentation

SAP Ariba Supplier Supplier profile


Information Supplier questionnaire
Management Profiles (SPQ)

SAP Ariba Supplier Supplier profile


Information Supplier questionnaire
Management Profiles (SPQ) Documentation

SAP Ariba Supplier Supplier profile


Information Supplier questionnaire
Management Profiles (SPQ)

SAP Ariba Supplier


Lifecycle &
Performance Reports Analytical Report Documentation

Supplier
SAP Ariba Supplier Lifecycle and
Lifecycle & Performance,
Performance, SAP Contract
Ariba Sourcing, SAP workspaces/re
Ariba Contract quests,
Management, SAP Sourcing Project Tasks,
Ariba Strategic Events/Projects Approvals, Event
Sourcing Suite /Requests Status, Awards Documentation
Ariba Analysis, SAP
Ariba Strategic
Sourcing Suite, SAP
Ariba Contract
Management, SAP Analytical Reports
Ariba Sourcing Reports (Operational) Documentation API rate limits - See Limitations

Ariba Analysis, SAP


Ariba Strategic
Sourcing Suite, SAP
Ariba Contract
Management, SAP
Ariba Sourcing Reports Analytical Reports Documentation API rate limits - See Limitations

SAP Ariba
Sourcing, SAP Ariba
Contract
Management, SAP
Ariba Strategic Integration/ Error/Warning
Sourcing Suite platform Messages Documentation API rate limits - See Limitations

SAP Ariba Buying,


SAP Ariba Buying
and Invoicing, SAP
Ariba Invoice Integration/ Approval
Management platform processes/rules Documentation
SAP Ariba Catalog Catalogs Catalog search Documentation

SAP Ariba Catalog Catalogs Catalog search Documentation

SAP Ariba Buying Extension


and Invoicing Studio Forms Reports Documentation
SAP Ariba Buying
and Invoicing, SAP
Ariba Buying, SAP
Ariba Invoice Analytical Report
Management Reports (operational) Documentation API rate limits - See Limitations

SAP Ariba Buying


and Invoicing, SAP
Ariba Buying, SAP
Ariba Invoice
Management Reports Analytical Report Documentation API rate limits - See Limitations
SAP Ariba Buying
and Invoicing, SAP
Ariba Buying, SAP
Ariba Invoice Integration/ Error/Warning
Management platform Messages Documentation API rate limits - See Limitations

SAP Ariba Buying


and Invoicing, SAP
Ariba Buying, SAP
Ariba Invoice Integration/ Error/Warning
Management platform Messages Documentation

Invoice, Purchase
Orders, Service
Sheets, Ship
Transaction Notices, Order
Ariba Network Documents Confirmations Documentation

Ariba Discovery Discovery Discovery postings Documentation


Ariba Discovery Discovery Discovery postings Documentation

Ariba Network,
Ariba Network
Collaborative
Supply Chain Infrastructure Monitoring Documentation

Ariba Network, Planning


Ariba Network Collaboration,
Collaborative Inventory
Supply Chain Collaboration Forecast, Planning Documentation

Transaction
Ariba Network Documents Purchase Orders Documentation

Ariba Network
Supplier Organization
Ariba Network Profiles Profile Documentation

SAP Ariba Buying


and Invoicing, SAP
Ariba Buying, SAP
Ariba Invoice Receiving,
Management Purchasing Receipts Documentation
SAP Ariba Buying
and Invoicing, SAP Contract Pricing
Ariba Contracts Contracts Terms Documentation
No specific API limits in place for
this API but dynamic run time
Ariba Network Invoices Search Documentation throttling is in effect
No specific API limits in place for
this API but dynamic run time
Ariba Network Invoices Search Documentation throttling is in effect

No specific API limits in place for


Proof of this API but dynamic run time
Ariba Network Service Create/Update Documentation throttling is in effect

No specific API limits in place for


Proof of this API but dynamic run time
Ariba Network Service Create/Update Documentation throttling is in effect

SAP Ariba Buying


and Invoicing, SAP
Ariba Buying, SAP No specific API limits in place for
Ariba Invoice this API but dynamic run time
Management Parameters Audit Documentation throttling is in effect
SAP Ariba Contract Contract 1/second, 2/minute, 10/hour,
Management Workspace Create/Update Documentation 240/day

SAP Ariba Contract Contract 1/second, 3/minute, 180/hour,


Management Workspace Search Documentation 4320/day

No specific API limits in place for


Team this API but dynamic run time
SAP Ariba Sourcing Projects Management Documentation throttling is in effect
No specific API limits in place for
Sourcing this API but dynamic run time
SAP Ariba Sourcing Events Bidding Documentation throttling is in effect

SAP Ariba
Sourcing, SAP Ariba
Contract
Management, SAP
Ariba Strategic
Sourcing Suite, SAP
Ariba Supplier
Lifecycle and No specific API limits in place for
Performance this API but dynamic run time
Management Parameters Audit Documentation throttling is in effect

No specific API limits in place for


Sourcing this API but dynamic run time
SAP Ariba Sourcing Events Search Documentation throttling is in effect

SAP Ariba
Sourcing, SAP Ariba
Contract Sourcing
Management, SAP Events,
Ariba Strategic Contract 1/second, 30/minute,
Sourcing Suite Workspaces Create/Update Documentation 35000/hour
Product
SAP Ariba Sourcing Sourcing Create/Update Documentation 500/second
Release
Date

###

1805
1805

1805

1808

1712
1801

1905

###
1712

1805
1808

1807

??

1810
1810

1712

1908

1911

1911

1911
2002

2005

2005

2005

2005

2005
2005

2005

2005

2005

2005

2005

2005
2005
Supplier Data API with pagination
External Approval API for Sourcing and Supplier Management
Operational Reporting API for Strategic Sourcing
Analytical Reporting API for Strategic Procurement
Integration Monitoring API for Sourcing
Document Approval API
Catalog Content API
Catalog Lookup API
Custom Forms API
Operational Reporting API for Procurement
Analytical Reporting API for Procurement
Integration Monitoring API for Procurement
Master Data Integration Job Status API for Operational Procurement
Flow Extension API
Discovery RFX Publication to External Marketplace API
Discovery RFX Publication from External Marketplace API
Transaction Monitoring API v2
Planning Collaboration Buyer API
Ariba Network Purchase Orders API
Ariba Network Supplier Profile API
Asset Management API

You might also like