get method

Future<CollectionStatus> get(
  1. String merchantId,
  2. String collectionId, {
  3. String? $fields,
})

Gets the status of a collection from your Merchant Center account.

Request parameters:

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

collectionId - Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection.

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

Completes with a CollectionStatus.

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<CollectionStatus> get(
  core.String merchantId,
  core.String collectionId, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

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

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