Filter Construction for the Order Change Requests API for Buyers

Use filters to refine the change request information the API retrieves.

The filter list comprises a list of name/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 Ariba Network ID (ANID).

Parameter

Description

$filter
Specifies record search criteria and how to organize the returned records. If used, you must specify at least one $filter attribute:
supplierANID
The supplier's Ariba Network ID.
orderNumber
The identifier for this order. Analogous to the purchase order number.
itemNumber
The purchase order line number.
scheduleLineNumber
The purchase order schedule-line number.
plantID
A buyer plant location code.
customerPartNumber
The identifier for an item in the buyer system. This identifier is specified by the buyer.
startDate

The earliest date in a date range during which SAP Business Network received a change request. The maximum date range is 31 days.

If startDate and endDate are not specified, the date range is 31 days before today. Otherwise, both values must be specified. The dates can be in the past, but with a maximum date range of 31 days.

endDate

The latest date of a date range during which SAP Business Network received a change request. The maximum date range is 31 days

If startDate and endDate are not specified, the date range is 31 days before today. Otherwise, both values must be provided. The specified dates can both be in the past, but with a maximum date range of 31 days.

supplierResponseStatus
The status of the supplier response. The valid values are case sensitive.

  • For the /changeRequests endpoint, the possible values are Accepted, Rejected, Proposed, or Pending.

  • For the /changeRequestResponses endpoint, the possible values are Accepted, Rejected, or Proposed.

customerResponseStatus
The status of the buyer response. The valid values are case sensitive.

  • For the /changeRequests endpoint, the possible values are Accepted, Rejected, or Pending.

  • For the /changeRequestResponses endpoint, the possible values are Accepted, Rejected, or Proposed.

$orderby

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

The value of propertyName is the column name to sort by. The only valid value is 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.

$top

The maximum number of items to display per page. Default is 10. Maximum is 1000. If set to a number greater than 1000, pages display no more than 1000 items.

$skip

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

$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 parameter syntax:

                   header_parameter eq value

  • $filter syntax – The and operator separates multiple parameter attributes:

    $filter=attribute eq 'value' and attribute eq 'value'

  • Query-parameter syntax – An ampersand (&) separates query parameters from the $filter and other query parameters:

    $filter=filter_attribute eq 'value'&query_parameter=value&query_parameter=value