Planning Collaboration Buyer API Overview and Setup
Describes the API business uses, endpoints, prerequisites, setup, and restrictions.
Business uses
-
A supplier manages certain goods for you at one of their warehouses. You can use this API to get supplier inventory data levels at that location.
-
You have inventory you want to maintain at a certain level. Your supplier agrees to ship goods to maintain the stock on hand within a certain range. You can use this API to get supplier-managed inventory data with the quantity of goods the supplier is planning to ship during a certain time period.
-
You might need to place a rush order of a certain material. You can use this API to learn which suppliers made commitments for the desired material in the required timeframe. You can then determine whether your suppliers can individually or collectively provide the needed quantity of the material, by the date you need it.
Use cases
This API supports the following usages:
|
Use case |
Description |
|---|---|
|
Supplier-managed inventory data export |
You can use the /supplierManagedInventory endpoint to retrieve planning information from SAP Business Network. This data might include supplier commitments, planned replenishment by suppliers, and projected stock at a certain location. This data is expressed as key f igure time series. You provide to the API the parameters to filter the data you want. |
|
Supplier inventory data export |
You can use the /supplierInventory endpoint to retrieve from SAP Business Network total stock on hand data and a breakdown across the different stock types it contains. You provide to the API the parameters to filter the data you want. |
|
Forecast data export |
You can use the /forecast endpoint to retrieve supplier forecast and commitment data from SAP Business Network. You provide to the API the parameters to filter the data you want. |
Prerequisites
Before you can use the Planning Collaboration API for SAP Business Network for Supply Chain, you must:
-
Complete the onboarding process on the SAP Ariba developer portal. See the SAP Ariba developer portal guide for more information.
-
Ensure that your application conforms to expected OAuth authentication. Only applications approved by the SAP Ariba APIs administration can execute OAuth authentication.
-
As a buyer administrator, add your OAuth Client ID to your profile.
-
In the SAP Business Network buyer dashboard, click your account name in the upper right corner.
-
Click .
-
In the Client ID field, type your OAuth Client ID and click Save.
-
-
Be enabled for SAP Business Network for Supply Chain and the applicable collaboration component:
-
For the supplier inventory and supplier-managed inventory API endpoints, enable the inventory collaboration component.
-
For the forecast API endpoint, enable the forecast collaboration component.
-
-
Also for the forecast API endpoint, enable the forecast collaboration transaction rules:
-
Allow suppliers to view forecast data
-
Allow suppliers to commit to forecast data
-

