Orders: cancellineitem

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

Request

HTTP request

POST https://www.googleapis.com/content/v2/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`

For more information, see the authentication and authorization page.

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,
  "amount": {
    "value": string,
    "currency": 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 cancel. 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.
`amount`	`nested object`	Deprecated. Please use amountPretax and amountTax instead.
`amount.value`	`string`	The price represented as a number.	writable
`amount.currency`	`string`	The currency of the price.	writable
`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.
`amountPretax`	`nested object`	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.
`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 corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided.
`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#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`"