Method: accounts.onlineReturnPolicies.list

Lists all existing return policies.

HTTP request

GET https://merchantapi.googleapis.com/accounts/v1beta/{parent=accounts/*}/onlineReturnPolicies

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The merchant account for which to list return policies. Format: accounts/{account}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of OnlineReturnPolicy resources to return. The service returns fewer than this value if the number of return policies for the given merchant is less that than the pageSize. The default value is 10. The maximum value is 100; If a value higher than the maximum is specified, then the pageSize will default to the maximum
pageToken

string

Optional. A page token, received from a previous onlineReturnPolicies.list call. Provide the page token to retrieve the subsequent page.

When paginating, all other parameters provided to onlineReturnPolicies.list must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

Request body

The request body must be empty.

Response body

Response message for the onlineReturnPolicies.list method.

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

JSON representation 
{
  "onlineReturnPolicies": [
    {
      object (OnlineReturnPolicy)
    }
  ],
  "nextPageToken": string
}
Fields
onlineReturnPolicies[]

object (OnlineReturnPolicy)

The retrieved return policies.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.