Returns and refunds a line item. Note that this method can only be called on fully shipped orders. Try it now.
Request
HTTP request
POST https://www.googleapis.com/content/v2.1/merchantId/orders/orderId/returnRefundLineItem
Parameters
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
merchantId |
unsigned long |
The ID of the account that manages the order. This cannot be a multi-client account. |
orderId |
string |
The ID of the order. |
Authorization
This request requires authorization with the following scope:
Scope |
---|
https://www.googleapis.com/auth/content |
Request body
In the request body, supply data with the following structure:
{ "operationId": string, "lineItemId": string, "productId": string, "quantity": unsigned integer, "reason": string, "reasonText": string, "priceAmount": { "value": string, "currency": string }, "taxAmount": { "value": string, "currency": string } }
Property name | Value | Description | Notes |
---|---|---|---|
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 |
unsigned integer |
The quantity to return and refund. | |
reason |
string |
The reason for the return.
Acceptable values are:
|
|
reasonText |
string |
The explanation of the reason. | |
priceAmount |
nested object |
The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. If omitted, refundless return is assumed. | |
priceAmount.value |
string |
The price represented as a number. | writable |
priceAmount.currency |
string |
The currency of the price. | writable |
taxAmount |
nested object |
The amount of tax to be refunded. Optional, but if filled, then priceAmount must be set. Calculated automatically if not provided. | |
taxAmount.value |
string |
The price represented as a number. | writable |
taxAmount.currency |
string |
The currency of the price. | writable |
Response
If successful, this method returns a response body with the following structure:
{ "kind": "content#ordersReturnRefundLineItemResponse", "executionStatus": string }
Property name | Value | Description | Notes |
---|---|---|---|
kind |
string |
Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnRefundLineItemResponse" . |
|
executionStatus |
string |
The status of the execution.
Acceptable values are:
|