Retrieving Order Information Using the Purchase Orders Supplier API

Use this procedure to gather order information sent by your buyers.

Context

You can retrieve purchase order or line item information for your buyers from SAP Business Network.

Procedure

  1. Identify which type of purchase order information is desired: orders or line items.
  2. Construct a filter list to specify what information to retrieve.
  3. Request a count of the desired purchase order information.
    • For order information, use GET {{runtime_url}}/orders?$filter=filter_list&$count=true&$orderby=value&$top=value&$skip=value

    • For line-item information, use GET {{runtime_url}}/items?$filter=filter_list&$count=true&$orderby=value&$top=value&$skip=value

    filter_list
    Specifies a list of query filter attributes that identify the information to retrieve.
    $count=true
    Results return only the number of records that match the query criteria.

    See Construction of a Filter List for the Purchase Orders Supplier API for details about query parameters.

    A successful query returns the number of records that match the specified filter criteria.
  4. If the count indicates the need for a more detailed inquiry, request the desired information.
    • For order information, use GET {{runtime_url}}/orders?$filter=buyerANID eq buyer_ID [and attribute eq value…]&$orderby=value&$top=value&$skip=value

    • For line-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 buyerSAP Business Network ID
      [and attribute eq value…]
      Represents additional attribute name/value pairs specified to the $filter parameter
    A successful query returns detailed records that match the specified criteria.