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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
|
<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.html">Content API for Shopping</a> . <a href="content_v2.accounttax.html">accounttax</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#custombatch">custombatch(body, dryRun=None)</a></code></p>
<p class="firstline">Retrieves and updates tax settings of multiple accounts in a single request.</p>
<p class="toc_element">
<code><a href="#get">get(merchantId, accountId)</a></code></p>
<p class="firstline">Retrieves the tax settings of the account.</p>
<p class="toc_element">
<code><a href="#list">list(merchantId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">Lists the tax settings of the sub-accounts in your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#list_next">list_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="#patch">patch(merchantId, accountId, body, dryRun=None)</a></code></p>
<p class="firstline">Updates the tax settings of the account. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(merchantId, accountId, body, dryRun=None)</a></code></p>
<p class="firstline">Updates the tax settings of the account.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="custombatch">custombatch(body, dryRun=None)</code>
<pre>Retrieves and updates tax settings of multiple accounts in a single request.
Args:
body: object, The request body. (required)
The object takes the form of:
{
"entries": [ # The request entries to be processed in the batch.
{ # A batch entry encoding a single non-batch accounttax request.
"batchId": 42, # An entry ID, unique within the batch request.
"method": "A String",
"accountTax": { # The tax settings of a merchant account. # The account tax settings to update. Only defined if the method is update.
"rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
{ # Tax calculation rule to apply in a state or province (USA only).
"country": "A String", # Country code in which tax is applicable.
"ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
"shippingTaxed": True or False, # If true, shipping charges are also taxed.
"locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
"useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
},
],
"kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
"accountId": "A String", # The ID of the account to which these account tax settings belong.
},
"merchantId": "A String", # The ID of the managing account.
"accountId": "A String", # The ID of the account for which to get/update account tax settings.
},
],
}
dryRun: boolean, Flag to run the request in dry-run mode.
Returns:
An object of the form:
{
"kind": "content#accounttaxCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponse".
"entries": [ # The result of the execution of the batch requests.
{ # A batch entry encoding a single non-batch accounttax response.
"batchId": 42, # The ID of the request entry this entry responds to.
"accountTax": { # The tax settings of a merchant account. # The retrieved or updated account tax settings.
"rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
{ # Tax calculation rule to apply in a state or province (USA only).
"country": "A String", # Country code in which tax is applicable.
"ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
"shippingTaxed": True or False, # If true, shipping charges are also taxed.
"locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
"useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
},
],
"kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
"accountId": "A String", # The ID of the account to which these account tax settings belong.
},
"errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
"message": "A String", # The message of the first error in errors.
"code": 42, # The HTTP status of the first error in errors.
"errors": [ # A list of errors.
{ # An error returned by the API.
"reason": "A String", # The error code.
"domain": "A String", # The domain of the error.
"message": "A String", # A description of the error.
},
],
},
"kind": "content#accounttaxCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponseEntry".
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(merchantId, accountId)</code>
<pre>Retrieves the tax settings of the account.
Args:
merchantId: string, The ID of the managing account. (required)
accountId: string, The ID of the account for which to get/update account tax settings. (required)
Returns:
An object of the form:
{ # The tax settings of a merchant account.
"rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
{ # Tax calculation rule to apply in a state or province (USA only).
"country": "A String", # Country code in which tax is applicable.
"ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
"shippingTaxed": True or False, # If true, shipping charges are also taxed.
"locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
"useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
},
],
"kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
"accountId": "A String", # The ID of the account to which these account tax settings belong.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(merchantId, pageToken=None, maxResults=None)</code>
<pre>Lists the tax settings of the sub-accounts in your Merchant Center account.
Args:
merchantId: string, The ID of the managing account. (required)
pageToken: string, The token returned by the previous request.
maxResults: integer, The maximum number of tax settings 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 account tax settings.
"kind": "content#accounttaxListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxListResponse".
"resources": [
{ # The tax settings of a merchant account.
"rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
{ # Tax calculation rule to apply in a state or province (USA only).
"country": "A String", # Country code in which tax is applicable.
"ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
"shippingTaxed": True or False, # If true, shipping charges are also taxed.
"locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
"useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
},
],
"kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
"accountId": "A String", # The ID of the account to which these account tax settings belong.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_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="patch">patch(merchantId, accountId, body, dryRun=None)</code>
<pre>Updates the tax settings of the account. This method supports patch semantics.
Args:
merchantId: string, The ID of the managing account. (required)
accountId: string, The ID of the account for which to get/update account tax settings. (required)
body: object, The request body. (required)
The object takes the form of:
{ # The tax settings of a merchant account.
"rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
{ # Tax calculation rule to apply in a state or province (USA only).
"country": "A String", # Country code in which tax is applicable.
"ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
"shippingTaxed": True or False, # If true, shipping charges are also taxed.
"locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
"useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
},
],
"kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
"accountId": "A String", # The ID of the account to which these account tax settings belong.
}
dryRun: boolean, Flag to run the request in dry-run mode.
Returns:
An object of the form:
{ # The tax settings of a merchant account.
"rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
{ # Tax calculation rule to apply in a state or province (USA only).
"country": "A String", # Country code in which tax is applicable.
"ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
"shippingTaxed": True or False, # If true, shipping charges are also taxed.
"locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
"useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
},
],
"kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
"accountId": "A String", # The ID of the account to which these account tax settings belong.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(merchantId, accountId, body, dryRun=None)</code>
<pre>Updates the tax settings of the account.
Args:
merchantId: string, The ID of the managing account. (required)
accountId: string, The ID of the account for which to get/update account tax settings. (required)
body: object, The request body. (required)
The object takes the form of:
{ # The tax settings of a merchant account.
"rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
{ # Tax calculation rule to apply in a state or province (USA only).
"country": "A String", # Country code in which tax is applicable.
"ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
"shippingTaxed": True or False, # If true, shipping charges are also taxed.
"locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
"useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
},
],
"kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
"accountId": "A String", # The ID of the account to which these account tax settings belong.
}
dryRun: boolean, Flag to run the request in dry-run mode.
Returns:
An object of the form:
{ # The tax settings of a merchant account.
"rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
{ # Tax calculation rule to apply in a state or province (USA only).
"country": "A String", # Country code in which tax is applicable.
"ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
"shippingTaxed": True or False, # If true, shipping charges are also taxed.
"locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
"useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
},
],
"kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
"accountId": "A String", # The ID of the account to which these account tax settings belong.
}</pre>
</div>
</body></html>
|
