Skip to main content

The result set for the deal item search.

Types that use DealItemSearchResponse

Not used by any types.

Call that uses DealItemSearchResponse

GET
/deal_item

Fields

Field
Type
Description
dealItems
array of DealItem
A list of deal items that match the search criteria.
href
string
The relative path to the current set of results.
limit
integer
The maximum number of items, from the current result set, returned on a single page.

Default: 20
next
string
The relative path to the next set of results.
offset
integer
The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output.

For example, if the offset is set to 0 and the limit is set to 10, the method will retrieve items 1 through 10 from the list of items returned. If the offset is set to 10 and the limit is set to 10, the method will retrieve items 11 through 20 from the list of items returned.

Default: 0
prev
string
The relative path to the previous set of results.
total
integer
The total number of matches for the search criteria.