1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
<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="#listdisbursements">listdisbursements(merchantId, disbursementStartDate, disbursementEndDate=None, pageToken=None, maxResults=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, transactionStartDate, pageToken=None, maxResults=None, transactionEndDate=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="listdisbursements">listdisbursements(merchantId, disbursementStartDate, disbursementEndDate=None, pageToken=None, maxResults=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)
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.
},
],
}</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 'execute()' 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, transactionStartDate, pageToken=None, maxResults=None, transactionEndDate=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)
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.
"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.
},
},
"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.
},
],
}</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 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
