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

Use this procedure to gather ship notice information.

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 suppliers. For more details see, Configuring API Client ID in SAP Business Network for Suppliers.

Context

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

Procedure

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

    See Parameters of a Filter List for the Ship Notice API for Suppliers for details.

  3. Request the desired ship-notice information.

    • For ship-notice header information, use GET {{runtime_url}}/shipNotices?$filter=buyerANID eq buyer_ID [and attribute eq value…]&$orderby=value&$top=value&$skip=value

    • For ship-notice item information, use GET {{runtime_url}}/items?$filter=buyerANID eq buyer_ID [and attribute eq value…]&$orderby=value&$top=value&$skip=value

    buyer_ID
    Represents the specified buyer'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 Suppliers for details about query parameters.

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