Method: settlementtransactions.list

Retrieves a list of transactions for the settlement.

HTTP request

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

Path parameters

Parameters
merchantId

string

The Merchant Center account to list transactions for.

settlementId

string

The Google-provided ID of the settlement.

Query parameters

Parameters
maxResults

integer (uint32 format)

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

pageToken

string

The token returned by the previous request.

transactionIds

string

The list of transactions to return. If not set, all transactions will be returned.

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 (SettlementTransaction)
    }
  ]
}
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#settlementtransactionsListResponse"

.

resources[]

object (SettlementTransaction)

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!