Construction of a Filter List for the Purchase Orders Supplier API

Describes the header and query parameters for the /orders and /items endpoints.

The filter list comprises a list of key/value pairs separated by logical operators. The supported logical operator is and, which is case-sensitive.

Header Parameters

Description

X-ARIBA-NETWORK-ID

Required. Your SAP Business Network ID (ANID).

Query Parameters

Parameter Attributes

Description

$filter

 

Specifies record search criteria and how to organize the returned records. If used, you must specify at least one $filter attribute.

buyerANID

The buyer's SAP Business Network ID (ANID).

documentNumber

The identifier for this order. It is the same value as orderID and similar to the purchase order number.

orderStatus

Indicates what state of processing the order has reached.

routingStatus

Indicates whether a purchase order or service order is queued, sent, acknowledged, or if routing failed.

startDate

The starting date of the period in which SAP Business Network received the order. The date format is YYYY-MM-DDThh:mm:ss . The maximum date range is 31 days. If an endDate is not also specified, the API retrieves 31 days of data, starting from the startDate.

endDate

The ending date of the period in which SAP Business Network received the order. The date format is YYYY-MM-DDThh:mm:ss . The maximum date range is 31 days. If not specified, the default is the current date and time when the API query is issued. If a startDate is not also specified, the API retrieves 31 days of data, ending with the endDate.

$orderby

 

Specifies the sort order of results. The syntax is $orderby= propertyName asc.

The value of propertyName is the column name to sort by. Valid values are:
  • BUYERORGID

  • SUPPLIERORGID

The sort order can be either ascending (asc) or descending:(desc). When $orderby is not specified, results are sorted in ascending order by default.

$skip

 

Specifies the number of items to skip (offset). Default is 0, which returns page 1.

$top

 

The maximum number of items to display per page. Default is 10. Maximum is 100. Any setting greater than 100 displays 100 items per page.

$count

 

Returns inline the number of elements in a collection. The syntax is $count=true. Valid values are true, which returns the number of elements, or false, which returns a value of 0.

API requests can pass multiple parameters in the request URL.

  • Header parameters use the following syntax:

                   header_parameter eq value
                
  • The $filter query parameter uses the following syntax, with the operator and between multiple parameter attributes:

    $filter=attribute eq value and attribute eq value
                
  • Other query parameters use the following syntax, which is separated from $filter and other query parameters by an ampersand (&).

    $filter=filter_attributeeqvalue&query_parameter=value&query_parameter=value