- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- OrderreturnsProcessRequest
- OrderreturnsReturnItem
- OrderreturnsRefundOperation
- OrderreturnsPartialRefund
- OrderreturnsRejectOperation
- Try it!
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 |
The ID of the account that manages the order. This cannot be a multi-client account. |
returnId |
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 |
The status of the execution. Acceptable values are:
|
kind |
Identifies what kind of resource this is. Value: the fixed string " |
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 ( |
Fields | |
---|---|
operationId |
[required] The ID of the operation, unique across all operations for a given order return. |
returnItems[] |
The list of items to return. |
fullChargeReturnShippingCost |
Option to charge the customer return shipping cost. |
refundShippingFee |
Refunds for original shipping fee. |
OrderreturnsReturnItem
JSON representation |
---|
{ "returnItemId": string, "refund": { object ( |
Fields | |
---|---|
returnItemId |
Unit level ID for the return item. Different units of the same product will have different IDs. |
refund |
Refunds the item. |
reject |
Rejects the item. |
OrderreturnsRefundOperation
JSON representation |
---|
{
"returnRefundReason": string,
"fullRefund": boolean,
"partialRefund": {
object ( |
Fields | |
---|---|
returnRefundReason |
Code of the refund reason. |
fullRefund |
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 through FOP. |
partialRefund |
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 |
The explanation of the reason. |
paymentType |
The payment way of issuing refund. Default value is ORIGINAL_FOP if not set. |
OrderreturnsPartialRefund
JSON representation |
---|
{ "priceAmount": { object ( |
Fields | |
---|---|
priceAmount |
The pre-tax or post-tax amount to be refunded, depending on the location of the order. |
taxAmount |
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 |
The reason for the return. |
reasonText |
The explanation of the reason. |