If you're still using v2 of the Content API for Shopping, please migrate to v2.1 immediately to avoid disruptions with your integration.

For more information, see Migrating to v2.1 and this blog post.

Method: orders.refund

Deprecated, please use returnRefundLineItem instead.

HTTP request

POST https://shoppingcontent.googleapis.com/content/v2/{merchantId}/orders/{orderId}/refund

Path parameters

Parameters
merchantId

string

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

string

The ID of the order to refund.

Request body

The request body contains an instance of OrdersRefundRequest.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "executionStatus": string,
  "kind": string
}
Fields
executionStatus

string

The status of the execution.

Acceptable values are:

  • "duplicate"
  • "executed"
kind

string

Identifies what kind of resource this is. Value: the fixed string

"content#ordersRefundResponse"

.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

OrdersRefundRequest

JSON representation 
{
  "operationId": string,
  "amount": {
    object (Price)
  },
  "reason": string,
  "reasonText": string,
  "amountPretax": {
    object (Price)
  },
  "amountTax": {
    object (Price)
  }
}
Fields
operationId

string

The ID of the operation. Unique across all operations for a given order.
amount

object (Price)

Deprecated. Please use amountPretax and amountTax instead.
reason

string

The reason for the refund.

Acceptable values are:

  • "adjustment"
  • "courtesyAdjustment"
  • "customerCanceled"
  • "customerDiscretionaryReturn"
  • "deliveredLateByCarrier"
  • "feeAdjustment"
  • "lateShipmentCredit"
  • "noInventory"
  • "other"
  • "priceError"
  • "productArrivedDamaged"
  • "productNotAsDescribed"
  • "shippingCostAdjustment"
  • "taxAdjustment"
  • "undeliverableShippingAddress"
  • "wrongProductShipped"
reasonText

string

The explanation of the reason.
amountPretax

object (Price)

The amount that is refunded. Either amount or amountPretax should be filled.
amountTax

object (Price)

Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, amountPretax must be set. Calculated automatically if not provided.