Construction of a Filter List for the Planning Collaboration Supplier API

Use filters to refine the planning collaboration information the API retrieves.

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.

plantId

The plant's ID.

vendorId

The supplier's vendor ID.

buyerPartNumber

The buyer's identifier for an item in the buyer system..

supplierPartNumber

The supplier's identifier for an item in the supplier system.

startDate

(supplierManagedInventory and forecast endpoints only)

The starting date and optional time of the buyer demand period, in the form YYYY-MM-DDThh:mm . The derived period is limited to 1 year from the ending date. If time information is added, it is not considered for filtering.

endDate

(supplierManagedInventory and forecast endpoints only)

The ending date and optional time of the buyer demand period, in the form YYYY-MM-DDThh:mm . The derived period is limited to 1 year from the starting date. If time information is added, it is not considered for filtering.

$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:
  • BUYERPARTNO

  • BUYERLASTUPDATE

  • LEADTIME

  • LOCATIONID

  • LOCATIONAME

  • PLANTID

  • PROCESSTYPE

  • STOCKONHAND

  • SUPPLIERLASTUPDATE

  • SUPPLIERPARTNO

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_attribute eq value&query_parameter=value&query_parameter=value