list method

Future<ProductstatusesListResponse> list(
  1. String merchantId, {
  2. List<String>? destinations,
  3. int? maxResults,
  4. String? pageToken,
  5. String? $fields,
})

Lists the statuses of the products in your Merchant Center account.

Request parameters:

merchantId - The ID of the account that contains the products. This account cannot be a multi-client account.

destinations - If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.

maxResults - The maximum number of product statuses to return in the response, used for paging. The default value is 25. The maximum value is 250.

pageToken - The token returned by the previous request.

$fields - Selector specifying which fields to include in a partial response.

Completes with a ProductstatusesListResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<ProductstatusesListResponse> list(
  core.String merchantId, {
  core.List<core.String>? destinations,
  core.int? maxResults,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (destinations != null) 'destinations': destinations,
    if (maxResults != null) 'maxResults': ['${maxResults}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = commons.escapeVariable('$merchantId') + '/productstatuses';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return ProductstatusesListResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}