Method: orders.instorerefundlineitem

Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store).
Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return.

HTTP request

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

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.

Request body

The request body contains an instance of OrdersInStoreRefundLineItemRequest.

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#ordersInStoreRefundLineItemResponse"

.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the OAuth 2.0 Overview.

OrdersInStoreRefundLineItemRequest

JSON representation
{
  "operationId": string,
  "lineItemId": string,
  "productId": string,
  "quantity": integer,
  "reason": string,
  "reasonText": string,
  "priceAmount": {
    object (Price)
  },
  "taxAmount": {
    object (Price)
  }
}
Fields
operationId

string

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

lineItemId

string

The ID of the line item to return. Either lineItemId or productId is required.

productId

string

The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.

quantity

integer (uint32 format)

The quantity to return and refund.

reason

string

The reason for the return.

Acceptable values are:

  • "customerDiscretionaryReturn"
  • "customerInitiatedMerchantCancel"
  • "deliveredTooLate"
  • "expiredItem"
  • "invalidCoupon"
  • "malformedShippingAddress"
  • "other"
  • "productArrivedDamaged"
  • "productNotAsDescribed"
  • "qualityNotAsExpected"
  • "undeliverableShippingAddress"
  • "unsupportedPoBoxAddress"
  • "wrongProductShipped"

reasonText

string

The explanation of the reason.

priceAmount

object (Price)

The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. Required.

taxAmount

object (Price)

The amount of tax to be refunded. Required.