Orders: returnrefundlineitem

Requires authorization

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/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 (read more about authentication and authorization).

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,
  "amountPretax": {
    "value": string,
    "currency": string
  },
  "amountTax": {
    "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: "customerDiscretionaryReturn" "customerInitiatedMerchantCancel" "invalidCoupon" "malformedShippingAddress" "other" "productArrivedDamaged" "undeliverableShippingAddress" "unsupportedPoBoxAddress" "wrongProductShipped"
reasonText	string	The explanation of the reason.
amountPretax	nested object	The amount that is refunded. If omitted, refundless return is assumed (same as calling returnLineItem method). Optional, but if filled then both amountPretax and amountTax must be set.
amountPretax.value	string	The price represented as a number.	writable
amountPretax.currency	string	The currency of the price.	writable
amountTax	nested object	Tax amount that correspond to refund amount in amountPretax.
amountTax.value	string	The price represented as a number.	writable
amountTax.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: "duplicate" "executed"

Try it!

Use the APIs Explorer below to call this method on the Sandbox environment and see the response.
Alternatively, test this on live data.