fulfillment APIv1.15.0

FilterField

This type contains the criteria for narrowing down the collection of orders that will be returned by the getOrders call.

Note: The FilterField type provides the underlying data structure for the filter parameter for orders returned by a search, which combines the field, range, set, and value fields in a single string. However, this type is not used directly in the call.

Types that use FilterField

Not used by any types

Calls that use FilterField

Not used by any calls

Fields

Field
Type
Description
field
The name of a field to be used in the filter. Currently, three fields can be used: creationdate, lastmodifieddate, and orderfulfillmentstatus.
range
Contains the criteria for specifying a range of values of the specified field.
set
array of string
An enumerated set of values of the specified field that apply simultaneously to the filter.
value
A single value of the specified field that applies to the filter.