Content API for Shopping . orderreports

Instance Methods

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

Retrieves a report for disbursements from your Merchant Center account.

listdisbursements_next(previous_request=*, previous_response=*)

Retrieves the next page of results.

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

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

listtransactions_next(previous_request=*, previous_response=*)

Retrieves the next page of results.

Method Details

listdisbursements(merchantId=*, disbursementStartDate=*, disbursementEndDate=None, pageToken=None, maxResults=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)
  disbursementStartDate: string, The first date which disbursements occurred. In ISO 8601 format. (required)
  disbursementEndDate: string, The last date which disbursements occurred. In ISO 8601 format. Default: current date.
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of disbursements to return in the response, used for paging.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The token for the retrieval of the next page of disbursements.
    "kind": "content#orderreportsListDisbursementsResponse", # Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListDisbursementsResponse".
    "disbursements": [ # The list of disbursements.
      { # Order disbursement. All methods require the payment analyst role.
        "disbursementCreationDate": "A String", # The disbursement date, in ISO 8601 format.
        "disbursementAmount": { # The disbursement amount.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "disbursementDate": "A String", # The date the disbursement was initiated, in ISO 8601 format.
        "merchantId": "A String", # The ID of the managing account.
        "disbursementId": "A String", # The ID of the disbursement.
      },
    ],
  }
listdisbursements_next(previous_request=*, previous_response=*)
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=*, transactionStartDate=*, pageToken=None, maxResults=None, transactionEndDate=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)
  transactionStartDate: string, The first date in which transaction occurred. In ISO 8601 format. (required)
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of disbursements to return in the response, used for paging.
  transactionEndDate: string, The last date in which transaction occurred. In ISO 8601 format. Default: current date.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The token for the retrieval of the next page of transactions.
    "kind": "content#orderreportsListTransactionsResponse", # Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListTransactionsResponse".
    "transactions": [ # The list of transactions.
      {
        "orderId": "A String", # The ID of the order.
        "merchantOrderId": "A String", # Merchant-provided ID of the order.
        "productAmountWithRemittedTax": { # Total amount with remitted tax 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.
          },
        },
        "productAmount": { # Total amount for the items.
          "tax": { # [required] Tax value.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
          "pretax": { # [required] Value before taxes.
            "currency": "A String", # The currency of the price.
            "value": "A String", # The price represented as a number.
          },
        },
        "disbursementId": "A String", # The ID of the disbursement.
        "transactionDate": "A String", # The date of the transaction, in ISO 8601 format.
        "disbursementCreationDate": "A String", # The date the disbursement was created, in ISO 8601 format.
        "disbursementAmount": { # The disbursement amount.
          "currency": "A String", # The currency of the price.
          "value": "A String", # The price represented as a number.
        },
        "disbursementDate": "A String", # The date the disbursement was initiated, in ISO 8601 format.
        "merchantId": "A String", # The ID of the managing account.
      },
    ],
  }
listtransactions_next(previous_request=*, previous_response=*)
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.