We will sunset v2 of the Content API on March 29th, 2021. To avoid disruptions with your integration, please migrate to v2.1 as soon as possible. For more information, see Migrating to v2.1.

Method: orderreturns.process

Processes return in your Merchant Center account.

HTTP request

POST https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/orderreturns/{returnId}/process

Path parameters

Parameters
merchantId

string

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

returnId

string

The ID of the return.

Request body

The request body contains an instance of OrderreturnsProcessRequest.

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

.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the OAuth 2.0 Overview.

OrderreturnsProcessRequest

JSON representation
{
  "operationId": string,
  "returnItems": [
    {
      object (OrderreturnsReturnItem)
    }
  ],
  "fullChargeReturnShippingCost": boolean,
  "refundShippingFee": {
    object (OrderreturnsRefundOperation)
  }
}
Fields
operationId

string

[required] The ID of the operation, unique across all operations for a given order return.

returnItems[]

object (OrderreturnsReturnItem)

The list of items to return.

fullChargeReturnShippingCost

boolean

Option to charge the customer return shipping cost.

refundShippingFee

object (OrderreturnsRefundOperation)

Refunds for original shipping fee.

OrderreturnsReturnItem

JSON representation
{
  "returnItemId": string,
  "refund": {
    object (OrderreturnsRefundOperation)
  },
  "reject": {
    object (OrderreturnsRejectOperation)
  }
}
Fields
returnItemId

string

Unit level ID for the return item. Different units of the same product will have different IDs.

refund

object (OrderreturnsRefundOperation)

Refunds the item.

reject

object (OrderreturnsRejectOperation)

Rejects the item.

OrderreturnsRefundOperation

JSON representation
{
  "returnRefundReason": string,
  "fullRefund": boolean,
  "partialRefund": {
    object (OrderreturnsPartialRefund)
  },
  "reasonText": string,
  "paymentType": string
}
Fields
returnRefundReason

string

Code of the refund reason.

fullRefund

boolean

If true, the item will be fully refunded. Allowed only when paymentType is FOP. Merchant can choose this refund option to indicate the full remaining amount of corresponding object to be refunded to the customer via FOP.

partialRefund

object (OrderreturnsPartialRefund)

If this is set, the item will be partially refunded. Merchant can choose this refund option to specify the customized amount that to be refunded to the customer.

reasonText

string

The explanation of the reason.

paymentType

string

The payment way of issuing refund. Default value is ORIGINAL_FOP if not set.

OrderreturnsPartialRefund

JSON representation
{
  "priceAmount": {
    object (Price)
  },
  "taxAmount": {
    object (Price)
  }
}
Fields
priceAmount

object (Price)

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

taxAmount

object (Price)

Tax amount to be refunded. Note: This has different meaning depending on the location of the order.

OrderreturnsRejectOperation

JSON representation
{
  "reason": string,
  "reasonText": string
}
Fields
reason

string

The reason for the return.

reasonText

string

The explanation of the reason.