Method: orders.canceltestorderbycustomer

Sandbox only. Cancels a test order for customer-initiated cancellation.

HTTP request

POST https://www.googleapis.com/content/v2sandbox/{merchantId}/testorders/{orderId}/cancelByCustomer

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

Request body

The request body contains an instance of OrdersCancelTestOrderByCustomerRequest.

Response body

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

JSON representation
{
  "kind": string
}
Fields
kind

string

Identifies what kind of resource this is. Value: the fixed string

"content#ordersCancelTestOrderByCustomerResponse"

.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the OAuth 2.0 Overview.

OrdersCancelTestOrderByCustomerRequest

JSON representation
{
  "reason": string
}
Fields
reason

string

The reason for the cancellation.

Acceptable values are:

  • "changedMind"
  • "orderedWrongItem"
  • "other"