Content API for Shopping . settlementreports

Instance Methods

close()

Close httplib2 connections.

get(merchantId, settlementId, x__xgafv=None)

Retrieves a settlement report from your Merchant Center account.

list(merchantId, maxResults=None, pageToken=None, transferEndDate=None, transferStartDate=None, x__xgafv=None)

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

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(merchantId, settlementId, x__xgafv=None)
Retrieves a settlement report from your Merchant Center account.

Args:
  merchantId: string, The Merchant Center account of the settlement report. (required)
  settlementId: string, The Google-provided ID of the settlement. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { #  Settlement reports detail order-level and item-level credits and debits between you and Google.
  "endDate": "A String", # The end date on which all transactions are included in the report, in ISO 8601 format.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#settlementReport`"
  "previousBalance": { # The residual amount from the previous invoice. This is set only if the previous invoices are not paid because of negative balance.
    "currency": "A String", # The currency of the price.
    "value": "A String", # The price represented as a number.
  },
  "settlementId": "A String", # The ID of the settlement report.
  "startDate": "A String", # The start date on which all transactions are included in the report, in ISO 8601 format.
  "transferAmount": { # The money due to the merchant.
    "currency": "A String", # The currency of the price.
    "value": "A String", # The price represented as a number.
  },
  "transferDate": "A String", # Date on which transfer for this payment was initiated by Google, in ISO 8601 format.
  "transferIds": [ # The list of bank identifiers used for the transfer. For example, Trace ID for Federal Automated Clearing House (ACH). This may also be known as the Wire ID.
    "A String",
  ],
}
list(merchantId, maxResults=None, pageToken=None, transferEndDate=None, transferStartDate=None, x__xgafv=None)
Retrieves a list of settlement reports from your Merchant Center account.

Args:
  merchantId: string, The Merchant Center account to list settlements for. (required)
  maxResults: integer, 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.
  transferEndDate: string, Obtains settlements which have transactions before this date (inclusively), in ISO 8601 format.
  transferStartDate: string, Obtains settlements which have transactions after this date (inclusively), in ISO 8601 format.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#settlementreportsListResponse`".
  "nextPageToken": "A String", # The token for the retrieval of the next page of returns.
  "resources": [
    { #  Settlement reports detail order-level and item-level credits and debits between you and Google.
      "endDate": "A String", # The end date on which all transactions are included in the report, in ISO 8601 format.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#settlementReport`"
      "previousBalance": { # The residual amount from the previous invoice. This is set only if the previous invoices are not paid because of negative balance.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "settlementId": "A String", # The ID of the settlement report.
      "startDate": "A String", # The start date on which all transactions are included in the report, in ISO 8601 format.
      "transferAmount": { # The money due to the merchant.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "transferDate": "A String", # Date on which transfer for this payment was initiated by Google, in ISO 8601 format.
      "transferIds": [ # The list of bank identifiers used for the transfer. For example, Trace ID for Federal Automated Clearing House (ACH). This may also be known as the Wire ID.
        "A String",
      ],
    },
  ],
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.