contextstring
Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view.
One ofvieweditDefault "view"
pageinteger
Current page of the collection. Default is 1.
Default 1
per_pageinteger
Maximum number of items to be returned in result set. Default is 10.
Default 10
searchstring
Limit results to those matching a string.
afterstring (date-time)
Limit response to resources published after a given ISO8601 compliant date.
beforestring (date-time)
Limit response to resources published before a given ISO8601 compliant date.
modified_afterstring (date-time)
Limit response to resources modified after a given ISO8601 compliant date.
modified_beforestring (date-time)
Limit response to resources modified before a given ISO8601 compliant date.
dates_are_gmtboolean
Whether to consider GMT post dates when limiting response by published or modified date.
excludearray<integer>
Ensure result set excludes specific IDs.
includearray<integer>
Limit result set to specific ids.
offsetinteger
Offset the result set by a specific number of items.
orderstring
Order sort attribute ascending or descending. Options: asc and desc. Default is desc.
One ofascdescDefault "desc"
orderbystring
Sort collection by object attribute. Options: date, modified, id, include, title and slug. Default is date.
One ofdatemodifiedidincludetitleslugDefault "date"
parentarray<integer>
Limit result set to those of particular parent IDs.
parent_excludearray<integer>
Limit result set to all items except those of a particular parent ID.
statusarray<string>
Limit result set to orders assigned a specific status. Options: any, pending, processing, on-hold, completed, cancelled, refunded, failed and trash. Default is any.
customerinteger
Limit result set to orders assigned a specific customer.
productinteger
Limit result set to orders assigned a specific product.
dpinteger
Number of decimal points to use in each resource. Default is 2.
Default 2
