listPurchaseOptions method

Future<ListPurchaseOptionsOutput> listPurchaseOptions({
  1. List<PurchaseOptionFilter>? filters,
  2. int? maxResults,
  3. String? nextToken,
})

Returns the purchase options (offers and offer sets) available to the buyer. You can filter results by product, seller, purchase option type, visibility scope, and availability status.

Parameter filters : Filters to narrow the results. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.

Parameter maxResults : The maximum number of results that are returned per call. You can use nextToken to get more results.

Parameter nextToken : If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

Implementation

Future<ListPurchaseOptionsOutput> listPurchaseOptions({
  List<PurchaseOptionFilter>? filters,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final $payload = <String, dynamic>{
    if (filters != null) 'filters': filters,
    if (maxResults != null) 'maxResults': maxResults,
    if (nextToken != null) 'nextToken': nextToken,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/2026-02-05/listPurchaseOptions',
    exceptionFnMap: _exceptionFns,
  );
  return ListPurchaseOptionsOutput.fromJson(response);
}