blob: c96a9648cc7bd4ad3ff389dd2766144d1ad9d7a1 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.orderreports.html">orderreports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#listdisbursements">listdisbursements(merchantId, disbursementEndDate=None, disbursementStartDate=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a report for disbursements from your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#listdisbursements_next">listdisbursements_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#listtransactions">listtransactions(merchantId, disbursementId, maxResults=None, pageToken=None, transactionEndDate=None, transactionStartDate=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of transactions for a disbursement from your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#listtransactions_next">listtransactions_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="listdisbursements">listdisbursements(merchantId, disbursementEndDate=None, disbursementStartDate=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>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:
{
&quot;disbursements&quot;: [ # The list of disbursements.
{ # Order disbursement. All methods require the payment analyst role.
&quot;disbursementAmount&quot;: { # The disbursement amount.
&quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
&quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
},
&quot;disbursementCreationDate&quot;: &quot;A String&quot;, # The disbursement date, in ISO 8601 format.
&quot;disbursementDate&quot;: &quot;A String&quot;, # The date the disbursement was initiated, in ISO 8601 format.
&quot;disbursementId&quot;: &quot;A String&quot;, # The ID of the disbursement.
&quot;merchantId&quot;: &quot;A String&quot;, # The ID of the managing account.
},
],
&quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#orderreportsListDisbursementsResponse`&quot;.
&quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the retrieval of the next page of disbursements.
}</pre>
</div>
<div class="method">
<code class="details" id="listdisbursements_next">listdisbursements_next(previous_request, previous_response)</code>
<pre>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 &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="listtransactions">listtransactions(merchantId, disbursementId, maxResults=None, pageToken=None, transactionEndDate=None, transactionStartDate=None, x__xgafv=None)</code>
<pre>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:
{
&quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#orderreportsListTransactionsResponse`&quot;.
&quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the retrieval of the next page of transactions.
&quot;transactions&quot;: [ # The list of transactions.
{
&quot;disbursementAmount&quot;: { # The disbursement amount.
&quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
&quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
},
&quot;disbursementCreationDate&quot;: &quot;A String&quot;, # The date the disbursement was created, in ISO 8601 format.
&quot;disbursementDate&quot;: &quot;A String&quot;, # The date the disbursement was initiated, in ISO 8601 format.
&quot;disbursementId&quot;: &quot;A String&quot;, # The ID of the disbursement.
&quot;merchantId&quot;: &quot;A String&quot;, # The ID of the managing account.
&quot;merchantOrderId&quot;: &quot;A String&quot;, # Merchant-provided ID of the order.
&quot;orderId&quot;: &quot;A String&quot;, # The ID of the order.
&quot;productAmount&quot;: { # Total amount for the items.
&quot;priceAmount&quot;: { # The pre-tax or post-tax price depending on the location of the order.
&quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
&quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
},
&quot;remittedTaxAmount&quot;: { # Remitted tax value.
&quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
&quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
},
&quot;taxAmount&quot;: { # Tax value.
&quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
&quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
},
},
&quot;transactionDate&quot;: &quot;A String&quot;, # The date of the transaction, in ISO 8601 format.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="listtransactions_next">listtransactions_next(previous_request, previous_response)</code>
<pre>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 &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>