Content API for Shopping . orderreports

Instance Methods

close()

Close httplib2 connections.

listdisbursements(merchantId, disbursementEndDate=None, disbursementStartDate=None, maxResults=None, pageToken=None, x__xgafv=None)

Retrieves a report for disbursements from your Merchant Center account.

listdisbursements_next()

Retrieves the next page of results.

listtransactions(merchantId, disbursementId, maxResults=None, pageToken=None, transactionEndDate=None, transactionStartDate=None, x__xgafv=None)

Retrieves a list of transactions for a disbursement from your Merchant Center account.

listtransactions_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
listdisbursements(merchantId, disbursementEndDate=None, disbursementStartDate=None, maxResults=None, pageToken=None, x__xgafv=None)
Retrieves a report for disbursements from your Merchant Center account.

Args:
  merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
  disbursementEndDate: string, The last date which disbursements occurred. In ISO 8601 format. Default: current date.
  disbursementStartDate: string, The first date which disbursements occurred. In ISO 8601 format.
  maxResults: integer, The maximum number of disbursements to return in the response, used for paging.
  pageToken: string, The token returned by the previous request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "disbursements": [ # The list of disbursements.
    { # Order disbursement. All methods require the payment analyst role.
      "disbursementAmount": { # The disbursement amount.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "disbursementCreationDate": "A String", # The disbursement date, in ISO 8601 format.
      "disbursementDate": "A String", # The date the disbursement was initiated, in ISO 8601 format.
      "disbursementId": "A String", # The ID of the disbursement.
      "merchantId": "A String", # The ID of the managing account.
    },
  ],
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#orderreportsListDisbursementsResponse`".
  "nextPageToken": "A String", # The token for the retrieval of the next page of disbursements.
}
listdisbursements_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.
        
listtransactions(merchantId, disbursementId, maxResults=None, pageToken=None, transactionEndDate=None, transactionStartDate=None, x__xgafv=None)
Retrieves a list of transactions for a disbursement from your Merchant Center account.

Args:
  merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
  disbursementId: string, The Google-provided ID of the disbursement (found in Wallet). (required)
  maxResults: integer, The maximum number of disbursements to return in the response, used for paging.
  pageToken: string, The token returned by the previous request.
  transactionEndDate: string, The last date in which transaction occurred. In ISO 8601 format. Default: current date.
  transactionStartDate: string, The first date in which transaction occurred. 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#orderreportsListTransactionsResponse`".
  "nextPageToken": "A String", # The token for the retrieval of the next page of transactions.
  "transactions": [ # The list of transactions.
    {
      "disbursementAmount": { # The disbursement amount.
        "currency": "A String", # The currency of the price.
        "value": "A String", # The price represented as a number.
      },
      "disbursementCreationDate": "A String", # The date the disbursement was created, in ISO 8601 format.
      "disbursementDate": "A String", # The date the disbursement was initiated, in ISO 8601 format.
      "disbursementId": "A String", # The ID of the disbursement.
      "merchantId": "A String", # The ID of the managing account.
      "merchantOrderId": "A String", # Merchant-provided ID of the order.
      "orderId": "A String", # The ID of the order.
      "productAmount": { # Total amount for the items.
        "priceAmount": { # The pre-tax or post-tax price depending on the location of the order.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "remittedTaxAmount": { # Remitted tax value.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "taxAmount": { # Tax value.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
      },
      "transactionDate": "A String", # The date of the transaction, in ISO 8601 format.
    },
  ],
}
listtransactions_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.