Planning Collaboration Supplier API Overview

Describes the API endpoints, prerequisites, setup, and restrictions.

This API includes the following endpoints:
GET /forecast
This endpoint retrieves forecast data the buyer has shared and forecast commitment data the supplier has changed.
GET /supplierInventory
This endpoint enables suppliers to make commitments to deliver quantities of goods, to supply upcoming demands forecast by buyers. As a part of this process, suppliers share their inventory data with buyers.
GET /supplierManagedInventory
This endpoint retrieves inventory data about supplier-managed goods that are in their customers' warehouses, matched to buyer demand on each date.

Prerequisites

  • To create an application and request access to use the SAP Ariba APIs relevant to this feature, you must have access to the SAP Ariba Developer Portal. For details refer to Steps to Start Using the SAP Ariba APIs in Help for the SAP Ariba Developer Portal.

  • You must be enabled for SAP Business Network for Supply Chain.

  • You must be enabled for the applicable collaboration component:

    • The /forecast and /supplierIinventory API endpoints require that:

      • You are enabled for the forecast collaboration component.

      • Transaction rule Allow suppliers to view forecast data is enabled.

    • The /supplierManagedInventory API endpoint requires that you are enabled for the inventory collaboration component.

  • All queries made to this API must be authenticated using OAuth authentication. For details refer to SAP Ariba Developer Portal Authentication in Help for the SAP Ariba Developer Portal.

For additional information for suppliers, see "Topics about API management" in the Seller account settings and profile configuration guide.

Restrictions

Use of SAP Ariba APIs for suppliers using the SAP Ariba Developer Portal is restricted to SAP Business Network suppliers with Enterprise accounts. Access to the SAP Ariba Developer Portal is restricted for all other SAP Business Network supplier account types. For example, Standard Account suppliers cannot access the SAP Ariba Developer Portal.

Related Information