Method: orderreports.listdisbursements

Retrieves a report for disbursements from your Merchant Center account.

HTTP request

GET https://www.googleapis.com/content/v2/{merchantId}/orderreports/disbursements

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 disbursements to return in the response, used for paging.

pageToken

string

The token returned by the previous request.

disbursementStartDate

string

The first date which disbursements occurred. In ISO 8601 format.

disbursementEndDate

string

The last date which disbursements occurred. In ISO 8601 format. Default: current date.

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,
  "disbursements": [
    {
      object (OrderReportDisbursement)
    }
  ],
  "kind": string
}
Fields
nextPageToken

string

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

disbursements[]

object (OrderReportDisbursement)

The list of disbursements.

kind

string

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

"content#orderreportsListDisbursementsResponse"

.

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!