Version v2 of the Content API is scheduled for sunset on September 30th, 2021. Onboarding to v2 will stop on April 30, 2021. To avoid disruptions with your integration, please migrate to v2.1 as soon as possible.

For more information, see Migrating to v2.1 and this blog post.

Method: orderreturns.list

Lists order returns in your Merchant Center account.

HTTP request

GET https://shoppingcontent.googleapis.com/content/v2/{merchantId}/orderreturns

Path parameters

Parameters
merchantId

string

The ID of the account that manages the order. This cannot be a multi-client account.

Query parameters

Parameters
maxResults

integer (uint32 format)

The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page.
orderBy

enum (OrderBy)

Return the results in the specified order.
createdStartDate

string

Obtains order returns created after this date (inclusively), in ISO 8601 format.
createdEndDate

string

Obtains order returns created before this date (inclusively), in ISO 8601 format.
pageToken

string

The token returned by the previous request.

Request body

The request body must be empty.

Response body

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

JSON representation 
{
  "nextPageToken": string,
  "kind": string,
  "resources": [
    {
      object (MerchantOrderReturn)
    }
  ]
}
Fields
nextPageToken

string

The token for the retrieval of the next page of returns.
kind

string

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

"content#orderreturnsListResponse"

.
resources[]

object (MerchantOrderReturn)

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the OAuth 2.0 Overview.

OrderBy

Enums
RETURN_CREATION_TIME_DESC
RETURN_CREATION_TIME_ASC