Orders: cancel

Requires authorization

Cancels all line items in an order, making a full refund. Try it now.

Request

HTTP request

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

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 to cancel.

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,
  "reason": string,
  "reasonText": string
}
Property name Value Description Notes
operationId string The ID of the operation. Unique across all operations for a given order.
reason string The reason for the cancellation.

Acceptable values are:
  • "customerInitiatedCancel"
  • "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#ordersCancelResponse",
  "executionStatus": string
}
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse".
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.

Send feedback about...

Content API for Shopping