- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- OrdersRefundRequest
- Try it!
Deprecated, please use returnRefundLineItem instead.
HTTP request
POST https://shoppingcontent.googleapis.com/content/v2/{merchantId}/orders/{orderId}/refund
Path parameters
Parameters | |
---|---|
merchantId |
The ID of the account that manages the order. This cannot be a multi-client account. |
orderId |
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 |
The status of the execution.
|
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.
OrdersRefundRequest
JSON representation | |
---|---|
{ "operationId": string, "amount": { object ( |
Fields | |
---|---|
operationId |
The ID of the operation. Unique across all operations for a given order. |
amount |
Deprecated. Please use amountPretax and amountTax instead. |
reason |
The reason for the refund.
|
reasonText |
The explanation of the reason. |
amountPretax |
The amount that is refunded. Either amount or amountPretax should be filled. |
amountTax |
Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, amountPretax must be set. Calculated automatically if not provided. |