Method: orders.createtestreturn

Sandbox only. Creates a test return.

HTTP request

POST https://www.googleapis.com/content/v2.1/{merchantId}/orders/{orderId}/testreturn

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.

Request body

The request body contains an instance of OrdersCreateTestReturnRequest.

Response body

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

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

string

The ID of the newly created test order return.

kind

string

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

"content#ordersCreateTestReturnResponse"

.

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.

OrdersCreateTestReturnRequest

JSON representation
{
  "items": [
    {
      object (OrdersCustomBatchRequestEntryCreateTestReturnReturnItem)
    }
  ]
}
Fields
items[]

object (OrdersCustomBatchRequestEntryCreateTestReturnReturnItem)

Returned items.

OrdersCustomBatchRequestEntryCreateTestReturnReturnItem

JSON representation
{
  "lineItemId": string,
  "quantity": integer
}
Fields
lineItemId

string

The ID of the line item to return.

quantity

integer (uint32 format)

Quantity that is returned.