returnrefundlineitem method

Future<OrdersReturnRefundLineItemResponse> returnrefundlineitem(OrdersReturnRefundLineItemRequest request, String merchantId, String orderId, { String? $fields, })

Returns and refunds a line item.

Note that this method can only be called on fully shipped orders. The Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a 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.

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

Completes with a OrdersReturnRefundLineItemResponse.

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<OrdersReturnRefundLineItemResponse> returnrefundlineitem(
  OrdersReturnRefundLineItemRequest 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') +
      '/returnRefundLineItem';

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