- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- OrdersCancelLineItemRequest
- Try it!
Cancels a line item, making a full refund.
HTTP request
POST https://shoppingcontent.googleapis.com/content/v2/{merchantId}/orders/{orderId}/cancelLineItem
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. |
Request body
The request body contains an instance of OrdersCancelLineItemRequest
.
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.
OrdersCancelLineItemRequest
JSON representation | |
---|---|
{ "operationId": string, "lineItemId": string, "quantity": integer, "reason": string, "reasonText": string, "amount": { object ( |
Fields | |
---|---|
operationId |
The ID of the operation. Unique across all operations for a given order. |
lineItemId |
The ID of the line item to cancel. Either lineItemId or productId is required. |
quantity |
The quantity to cancel. |
reason |
The reason for the cancellation.
|
reasonText |
The explanation of the reason. |
amount |
Deprecated. Please use amountPretax and amountTax instead. |
productId |
The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required. |
amountPretax |
Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order. |
amountTax |
Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided. |