Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e633be11dbb412e5030b5afca31111fa4074dff1 / . / docs / dyn / content_v2.accounttax.html
blob: 80181cb8cf0e84703591af33172dd180c49978f7 [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="content_v2.html">Content API for Shopping</a> . <a href="content_v2.accounttax.html">accounttax</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#custombatch">custombatch(body)</a></code></p>
79<p class="firstline">Retrieves and updates tax settings of multiple accounts in a single request.</p>
80<p class="toc_element">
81 <code><a href="#get">get(merchantId, accountId)</a></code></p>
82<p class="firstline">Retrieves the tax settings of the account.</p>
83<p class="toc_element">
84 <code><a href="#list">list(merchantId, pageToken=None, maxResults=None)</a></code></p>
85<p class="firstline">Lists the tax settings of the sub-accounts in your Merchant Center account.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
90 <code><a href="#patch">patch(merchantId, accountId, body)</a></code></p>
91<p class="firstline">Updates the tax settings of the account. This method supports patch semantics.</p>
92<p class="toc_element">
93 <code><a href="#update">update(merchantId, accountId, body)</a></code></p>
94<p class="firstline">Updates the tax settings of the account.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="custombatch">custombatch(body)</code>
98 <pre>Retrieves and updates tax settings of multiple accounts in a single request.
99
100Args:
101 body: object, The request body. (required)
102 The object takes the form of:
103
104{
105 "entries": [ # The request entries to be processed in the batch.
106 { # A batch entry encoding a single non-batch accounttax request.
107 "batchId": 42, # An entry ID, unique within the batch request.
108 "method": "A String",
109 "accountTax": { # The tax settings of a merchant account. # The account tax settings to update. Only defined if the method is update.
110 "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
111 { # Tax calculation rule to apply in a state or province (USA only).
112 "country": "A String", # Country code in which tax is applicable.
113 "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
114 "shippingTaxed": True or False, # If true, shipping charges are also taxed.
115 "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
116 "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
117 },
118 ],
119 "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
120 "accountId": "A String", # The ID of the account to which these account tax settings belong.
121 },
122 "merchantId": "A String", # The ID of the managing account.
123 "accountId": "A String", # The ID of the account for which to get/update account tax settings.
124 },
125 ],
126 }
127
128
129Returns:
130 An object of the form:
131
132 {
133 "kind": "content#accounttaxCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponse".
134 "entries": [ # The result of the execution of the batch requests.
135 { # A batch entry encoding a single non-batch accounttax response.
136 "batchId": 42, # The ID of the request entry this entry responds to.
137 "accountTax": { # The tax settings of a merchant account. # The retrieved or updated account tax settings.
138 "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
139 { # Tax calculation rule to apply in a state or province (USA only).
140 "country": "A String", # Country code in which tax is applicable.
141 "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
142 "shippingTaxed": True or False, # If true, shipping charges are also taxed.
143 "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
144 "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
145 },
146 ],
147 "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
148 "accountId": "A String", # The ID of the account to which these account tax settings belong.
149 },
150 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
151 "message": "A String", # The message of the first error in errors.
152 "code": 42, # The HTTP status of the first error in errors.
153 "errors": [ # A list of errors.
154 { # An error returned by the API.
155 "reason": "A String", # The error code.
156 "domain": "A String", # The domain of the error.
157 "message": "A String", # A description of the error.
158 },
159 ],
160 },
161 "kind": "content#accounttaxCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponseEntry".
162 },
163 ],
164 }</pre>
165</div>
166
167<div class="method">
168 <code class="details" id="get">get(merchantId, accountId)</code>
169 <pre>Retrieves the tax settings of the account.
170
171Args:
172 merchantId: string, The ID of the managing account. (required)
173 accountId: string, The ID of the account for which to get/update account tax settings. (required)
174
175Returns:
176 An object of the form:
177
178 { # The tax settings of a merchant account.
179 "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
180 { # Tax calculation rule to apply in a state or province (USA only).
181 "country": "A String", # Country code in which tax is applicable.
182 "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
183 "shippingTaxed": True or False, # If true, shipping charges are also taxed.
184 "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
185 "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
186 },
187 ],
188 "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
189 "accountId": "A String", # The ID of the account to which these account tax settings belong.
190 }</pre>
191</div>
192
193<div class="method">
194 <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None)</code>
195 <pre>Lists the tax settings of the sub-accounts in your Merchant Center account.
196
197Args:
198 merchantId: string, The ID of the managing account. (required)
199 pageToken: string, The token returned by the previous request.
200 maxResults: integer, The maximum number of tax settings to return in the response, used for paging.
201
202Returns:
203 An object of the form:
204
205 {
206 "nextPageToken": "A String", # The token for the retrieval of the next page of account tax settings.
207 "kind": "content#accounttaxListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxListResponse".
208 "resources": [
209 { # The tax settings of a merchant account.
210 "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
211 { # Tax calculation rule to apply in a state or province (USA only).
212 "country": "A String", # Country code in which tax is applicable.
213 "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
214 "shippingTaxed": True or False, # If true, shipping charges are also taxed.
215 "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
216 "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
217 },
218 ],
219 "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
220 "accountId": "A String", # The ID of the account to which these account tax settings belong.
221 },
222 ],
223 }</pre>
224</div>
225
226<div class="method">
227 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
228 <pre>Retrieves the next page of results.
229
230Args:
231 previous_request: The request for the previous page. (required)
232 previous_response: The response from the request for the previous page. (required)
233
234Returns:
235 A request object that you can call 'execute()' on to request the next
236 page. Returns None if there are no more items in the collection.
237 </pre>
238</div>
239
240<div class="method">
241 <code class="details" id="patch">patch(merchantId, accountId, body)</code>
242 <pre>Updates the tax settings of the account. This method supports patch semantics.
243
244Args:
245 merchantId: string, The ID of the managing account. (required)
246 accountId: string, The ID of the account for which to get/update account tax settings. (required)
247 body: object, The request body. (required)
248 The object takes the form of:
249
250{ # The tax settings of a merchant account.
251 "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
252 { # Tax calculation rule to apply in a state or province (USA only).
253 "country": "A String", # Country code in which tax is applicable.
254 "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
255 "shippingTaxed": True or False, # If true, shipping charges are also taxed.
256 "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
257 "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
258 },
259 ],
260 "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
261 "accountId": "A String", # The ID of the account to which these account tax settings belong.
262}
263
264
265Returns:
266 An object of the form:
267
268 { # The tax settings of a merchant account.
269 "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
270 { # Tax calculation rule to apply in a state or province (USA only).
271 "country": "A String", # Country code in which tax is applicable.
272 "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
273 "shippingTaxed": True or False, # If true, shipping charges are also taxed.
274 "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
275 "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
276 },
277 ],
278 "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
279 "accountId": "A String", # The ID of the account to which these account tax settings belong.
280 }</pre>
281</div>
282
283<div class="method">
284 <code class="details" id="update">update(merchantId, accountId, body)</code>
285 <pre>Updates the tax settings of the account.
286
287Args:
288 merchantId: string, The ID of the managing account. (required)
289 accountId: string, The ID of the account for which to get/update account tax settings. (required)
290 body: object, The request body. (required)
291 The object takes the form of:
292
293{ # The tax settings of a merchant account.
294 "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
295 { # Tax calculation rule to apply in a state or province (USA only).
296 "country": "A String", # Country code in which tax is applicable.
297 "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
298 "shippingTaxed": True or False, # If true, shipping charges are also taxed.
299 "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
300 "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
301 },
302 ],
303 "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
304 "accountId": "A String", # The ID of the account to which these account tax settings belong.
305}
306
307
308Returns:
309 An object of the form:
310
311 { # The tax settings of a merchant account.
312 "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
313 { # Tax calculation rule to apply in a state or province (USA only).
314 "country": "A String", # Country code in which tax is applicable.
315 "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
316 "shippingTaxed": True or False, # If true, shipping charges are also taxed.
317 "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
318 "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
319 },
320 ],
321 "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
322 "accountId": "A String", # The ID of the account to which these account tax settings belong.
323 }</pre>
324</div>
325
326</body></html>