cancel method

Future<OrdersCancelResponse> cancel(
  1. OrdersCancelRequest request,
  2. String merchantId,
  3. String orderId, {
  4. String? $fields,
})

Cancels all line items in an order, making a full refund.

request - The metadata request object.

Request parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

orderId - The ID of the order to cancel.

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

Completes with a OrdersCancelResponse.

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<OrdersCancelResponse> cancel(
  OrdersCancelRequest request,
  core.String merchantId,
  core.String orderId, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = commons.escapeVariable('$merchantId') +
      '/orders/' +
      commons.escapeVariable('$orderId') +
      '/cancel';

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