Orders: cancellineitem

Cancels a line item, making a full refund. Try it now.

Request

HTTP request

POST https://www.googleapis.com/content/v2.1/merchantId/orders/orderId/cancelLineItem

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
}
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 cancel. Either lineItemId or productId is required.
productId string The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.
quantity unsigned integer The quantity to cancel.
reason string The reason for the cancellation.

Acceptable values are:
  • "customerInitiatedCancel"
  • "invalidCoupon"
  • "malformedShippingAddress"
  • "noInventory"
  • "other"
  • "priceError"
  • "shippingPriceError"
  • "taxError"
  • "undeliverableShippingAddress"
  • "unsupportedPoBoxAddress"
reasonText string The explanation of the reason.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "content#ordersCancelLineItemResponse",
  "executionStatus": string
}
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelLineItemResponse".
executionStatus string The status of the execution.

Acceptable values are:
  • "duplicate"
  • "executed"

Send feedback about...

Content API for Shopping