Method: settlementreports.list

Retrieves a list of settlement reports from your Merchant Center account.

HTTP request

GET https://www.googleapis.com/content/v2.1/{merchantId}/settlementreports

Path parameters

Parameters
merchantId

string

The Merchant Center account to list settlements for.

Query parameters

Parameters
maxResults

integer (uint32 format)

The maximum number of settlements to return in the response, used for paging. The default value is 200 returns per page, and the maximum allowed value is 5000 returns per page.

pageToken

string

The token returned by the previous request.

transferStartDate

string

Obtains settlements which have transactions after this date (inclusively), in ISO 8601 format.

transferEndDate

string

Obtains settlements which have transactions before this date (inclusively), in ISO 8601 format.

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 (SettlementReport)
    }
  ]
}
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#settlementreportsListResponse"

.

resources[]

object (SettlementReport)

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.

Try it!