Method: orders.cancel

Stay organized with collections Save and categorize content based on your preferences.

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

HTTP request

POST https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/orders/{orderId}/cancel

Path parameters

Parameters
merchantId

string

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.

Request body

The request body contains an instance of OrdersCancelRequest.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "executionStatus": string,
  "kind": string
}
Fields
executionStatus

string

The status of the execution.

Acceptable values are:

  • "duplicate"
  • "executed"
kind

string

Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse".

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

OrdersCancelRequest

JSON representation 
{
  "operationId": string,
  "reason": string,
  "reasonText": string
}
Fields
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"
  • "invalidCoupon"
  • "malformedShippingAddress"
  • "noInventory"
  • "other"
  • "priceError"
  • "shippingPriceError"
  • "taxError"
  • "undeliverableShippingAddress"
  • "unsupportedPoBoxAddress"
  • "failedToCaptureFunds"
reasonText

string

The explanation of the reason.