Retrieving Ship-Notice Information Using the Ship Notice API for Buyers

Use this procedure to gather information from ship notices your suppliers send.

Prerequisites

To create an application and request access to use this API, 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 configure the API client ID in SAP Business Network for buyers. For more details see, Configuring the API Client ID in SAP Business Network for Buyers.

You can retrieve header or item information from ship notices in SAP Business Network for your suppliers.

Identify which type of ship-notice information is desired: header information or items.
Construct a filter list to specify what information to retrieve.

See Parameters of a Filter List for the Ship Notice API for Buyers for details.
Request the desired ship-notice information.
- For ship-notice header information, use GET {{runtime_url}}/shipNotices?$filter=supplierANID eq supplier_ID [and attribute eq value…]&$orderby=value&$top=value&$skip=value
- For ship-notice item information, use GET {{runtime_url}}/items?$filter=supplierANID eq supplier_ID [and attribute eq value…]&$orderby=value&$top=value&$skip=value
supplier_ID

Represents the specified supplier's SAP Business Network ID.

[and attribute eq value…]

Represents additional attribute key/value pairs specified to the $filter parameter.

See Parameters of a Filter List for the Ship Notice API for Buyers for details about query parameters.

A successful query returns detailed records that match the specified filter criteria.