Returns one or more offers, optionally filtered and sorted by specified parameters.
= Required Parameter
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NetworkId | Url | Network ID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_key | String | Network token | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Target | String | This calls action target | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method | String | This calls action method | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fields | Array | List of fields to return; defaults to all fieldsShow Supported Values Any of the following values from the Offer model are supported.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
filters | Filter | Array of field values to filter results byShow Filterable Fields The following fields from the model can be filtered on.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sort | Sort | Array of fields and directions to sort results byShow Sortable Fields The following fields from the model can be sorted in either ascending (ASC) or descending (DESC) order.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit | Integer | Objects per page to return; defaults to returning all found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
page | Integer | Result page to return, based on limit value; defaults to 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contain | Contain | List of related objects to return with each resultShow Supported Values Any of the following supported values can be passed.
|
GET Response Notes
Returns an array of matching Offer model objects
API Call Builder
Javascript is required to use the API Call Builder.