We will sunset v2 of the Content API on March 29th, 2021. To avoid disruptions with your integration, please migrate to v2.1 as soon as possible. For more information, see Migrating to v2.1.

Method: returnaddress.list

Lists the return addresses of the Merchant Center account.

HTTP request

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

Path parameters

Parameters
merchantId

string

The Merchant Center account to list return addresses for.

Query parameters

Parameters
maxResults

integer (uint32 format)

The maximum number of addresses in the response, used for paging.

pageToken

string

The token returned by the previous request.

country

string

accounts.list only return addresses applicable to the given country of sale. When omitted, all return addresses are listed.

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 (ReturnAddress)
    }
  ]
}
Fields
nextPageToken

string

The token for the retrieval of the next page of addresses.

kind

string

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

"content#returnaddressListResponse"

.

resources[]

object (ReturnAddress)

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the OAuth 2.0 Overview.