marketing APIv1.10.1

ItemsPagedCollection

This type defines the fields for a paginated result set of promotions. The response consists of 0 or more sequenced pages that are returned from the complete result set, where each page consists of 0 or more items.

Types that use ItemsPagedCollection

Not used by any types

Call that uses ItemsPagedCollection

Fields

Field
Type
Description
href
The URI of the current page of results from the result set.
limit
The number of items returned on a single page from the result set. This value can be set in the request with the limit query parameter.
listings
array of ListingDetail
An array of the listings associated with a promotion.
next
The URI for the following page of results. This value is returned only if there is an additional page of results to display from the result set.

Max length: 2048
offset
The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter.

Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.

prev
The URI for the preceding page of results. This value is returned only if there is a previous page of results to display from the result set.

Max length: 2048
total
The total number of items retrieved in the result set.

If no items are found, this field is returned with a value of 0.
warnings
array of ErrorDetailV3
A list of warnings that were generated by the request. Warning do not stop processing, but should be checked to ensure that the response contains the correct information.