Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4f877e562986034f25ea4246ad1256eabd339526 / . / docs / dyn / content_v2.accountshipping.html
blob: 57861698027afe218d52e25ee6cbc6e288fa3ca1 [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.accountshipping.html">accountshipping</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]78 <code><a href="#custombatch">custombatch(body, dryRun=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]79<p class="firstline">Retrieves and updates the shipping 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 shipping 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 shipping 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">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]90 <code><a href="#patch">patch(merchantId, accountId, body, dryRun=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]91<p class="firstline">Updates the shipping settings of the account. This method supports patch semantics.</p>
92<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]93 <code><a href="#update">update(merchantId, accountId, body, dryRun=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]94<p class="firstline">Updates the shipping settings of the account.</p>
95<h3>Method Details</h3>
96<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]97 <code class="details" id="custombatch">custombatch(body, dryRun=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]98 <pre>Retrieves and updates the shipping 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 accountshipping request.
107 "batchId": 42, # An entry ID, unique within the batch request.
108 "method": "A String",
109 "accountShipping": { # The shipping settings of a merchant account. # The account shipping settings to update. Only defined if the method is update.
110 "kind": "content#accountShipping", # Identifies what kind of resource this is. Value: the fixed string "content#accountShipping".
111 "carrierRates": [ # Carrier-based shipping calculations.
112 { # A carrier-calculated shipping rate.
113 "shippingOrigin": "A String", # Shipping origin represented as a postal code.
114 "name": "A String", # The name of the carrier rate.
115 "saleCountry": "A String", # Sale country for which this carrier rate is valid, represented as an ISO 3166-1 Alpha-2 code.
116 "modifierPercent": "A String", # Multiplicative shipping rate modifier in percent. Represented as a floating point number without the percentage character.
117 "carrier": "A String", # The carrier that is responsible for the shipping, such as "UPS", "FedEx", or "USPS".
118 "carrierService": "A String", # The carrier service, such as "Ground" or "2Day".
119 "modifierFlatRate": { # Additive shipping rate modifier.
120 "currency": "A String", # The currency of the price.
121 "value": "A String", # The price represented as a number.
122 },
123 },
124 ],
125 "locationGroups": [ # Location groups for shipping.
126 { # A user-defined locations group in a given country. All the locations of the group must be of the same type.
127 "postalCodeRanges": [ # A postal code range representing a city or a set of cities.
128 { # A postal code range, that can be either:
129 # - A range of postal codes (e.g., start=12340, end=12359)
130 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
131 "start": "A String", # The first (inclusive) postal code or prefix of the range.
132 "end": "A String", # The last (inclusive) postal code or prefix of the range.
133 },
134 ],
135 "country": "A String", # The country in which this location group is, represented as ISO 3166-1 Alpha-2 code.
136 "locationIds": [ # A location ID (also called criteria ID) representing administrative areas, smaller country subdivisions (counties), or cities.
137 "A String",
138 ],
139 "name": "A String", # The name of the location group.
140 "postalCodes": [ # A postal code representing a city or a set of cities.
141 # - A single postal code (e.g., 12345)
142 # - A postal code prefix followed by a star (e.g., 1234*)
143 "A String",
144 ],
145 },
146 ],
147 "services": [ # Shipping services describing shipping fees calculation.
148 { # Shipping services provided in a country.
149 "active": True or False, # Whether the shipping service is available.
150 "costRuleTree": { # Building block of the cost calculation decision tree. # Decision tree for "complicated" shipping cost calculation.
151 # - The tree root should have no condition and no calculation method.
152 # - All the children must have a condition on the same dimension. The first child matching a condition is entered, therefore, price and weight conditions form contiguous intervals.
153 # - The last child of an element must have no condition and matches all elements not previously matched.
154 # - Children and calculation method are mutually exclusive, and exactly one of them must be defined; the root must only have children.
155 "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Final calculation method to be used only in leaf nodes.
156 "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
157 "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
158 "rateTable": "A String", # Name of the rate table to use for the calculation.
159 "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
160 "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
161 "currency": "A String", # The currency of the price.
162 "value": "A String", # The price represented as a number.
163 },
164 },
165 "condition": { # Condition for this rule to be applicable. If no condition is specified, the rule acts as a catch-all.
166 "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
167 "value": "A String", # The weight represented as a number.
168 "unit": "A String", # The weight unit.
169 },
170 "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
171 "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
172 "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
173 # - A range of postal codes (e.g., start=12340, end=12359)
174 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
175 "start": "A String", # The first (inclusive) postal code or prefix of the range.
176 "end": "A String", # The last (inclusive) postal code or prefix of the range.
177 },
178 "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
179 "currency": "A String", # The currency of the price.
180 "value": "A String", # The price represented as a number.
181 },
182 "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
183 "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
184 },
185 "children": [ # Subsequent rules to be applied, only for inner nodes. The last child must not specify a condition and acts as a catch-all.
186 # Object with schema name: AccountShippingShippingServiceCostRule
187 ],
188 },
189 "saleCountry": "A String", # Sale country for which this service can be used, represented as an ISO 3166-1 Alpha-2 code.
190 "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Calculation method for the "simple" case that needs no rules.
191 "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
192 "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
193 "rateTable": "A String", # Name of the rate table to use for the calculation.
194 "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
195 "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
196 "currency": "A String", # The currency of the price.
197 "value": "A String", # The price represented as a number.
198 },
199 },
200 "name": "A String", # The name of this shipping service.
201 },
202 ],
203 "accountId": "A String", # The ID of the account to which these account shipping settings belong.
204 "rateTables": [ # Rate tables definitions.
205 { # A single or bi-dimensional table of shipping rates. Each dimension is defined in terms of consecutive price/weight ranges, delivery locations, or shipping labels.
206 "content": [ # One-dimensional table cells define one condition along the same dimension. Bi-dimensional table cells use two dimensions with respectively M and N distinct values and must contain exactly M * N cells with distinct conditions (for each possible value pairs).
207 {
208 "rate": { # The rate applicable if the cell conditions are matched.
209 "currency": "A String", # The currency of the price.
210 "value": "A String", # The price represented as a number.
211 },
212 "condition": { # Conditions for which the cell is valid. All cells in a table must use the same dimension or pair of dimensions among price, weight, shipping label or delivery location. If no condition is specified, the cell acts as a catch-all and matches all the elements that are not matched by other cells in this dimension.
213 "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
214 "value": "A String", # The weight represented as a number.
215 "unit": "A String", # The weight unit.
216 },
217 "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
218 "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
219 "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
220 # - A range of postal codes (e.g., start=12340, end=12359)
221 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
222 "start": "A String", # The first (inclusive) postal code or prefix of the range.
223 "end": "A String", # The last (inclusive) postal code or prefix of the range.
224 },
225 "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
226 "currency": "A String", # The currency of the price.
227 "value": "A String", # The price represented as a number.
228 },
229 "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
230 "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
231 },
232 },
233 ],
234 "saleCountry": "A String", # Sale country for which this table is valid, represented as an ISO 3166-1 Alpha-2 code.
235 "name": "A String", # The name of the rate table.
236 },
237 ],
238 },
239 "merchantId": "A String", # The ID of the managing account.
240 "accountId": "A String", # The ID of the account for which to get/update account shipping settings.
241 },
242 ],
243 }
244
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]245 dryRun: boolean, Flag to run the request in dry-run mode.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]246
247Returns:
248 An object of the form:
249
250 {
251 "kind": "content#accountshippingCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountshippingCustomBatchResponse".
252 "entries": [ # The result of the execution of the batch requests.
253 { # A batch entry encoding a single non-batch accountshipping response.
254 "batchId": 42, # The ID of the request entry this entry responds to.
255 "kind": "content#accountshippingCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#accountshippingCustomBatchResponseEntry".
256 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
257 "message": "A String", # The message of the first error in errors.
258 "code": 42, # The HTTP status of the first error in errors.
259 "errors": [ # A list of errors.
260 { # An error returned by the API.
261 "reason": "A String", # The error code.
262 "domain": "A String", # The domain of the error.
263 "message": "A String", # A description of the error.
264 },
265 ],
266 },
267 "accountShipping": { # The shipping settings of a merchant account. # The retrieved or updated account shipping settings.
268 "kind": "content#accountShipping", # Identifies what kind of resource this is. Value: the fixed string "content#accountShipping".
269 "carrierRates": [ # Carrier-based shipping calculations.
270 { # A carrier-calculated shipping rate.
271 "shippingOrigin": "A String", # Shipping origin represented as a postal code.
272 "name": "A String", # The name of the carrier rate.
273 "saleCountry": "A String", # Sale country for which this carrier rate is valid, represented as an ISO 3166-1 Alpha-2 code.
274 "modifierPercent": "A String", # Multiplicative shipping rate modifier in percent. Represented as a floating point number without the percentage character.
275 "carrier": "A String", # The carrier that is responsible for the shipping, such as "UPS", "FedEx", or "USPS".
276 "carrierService": "A String", # The carrier service, such as "Ground" or "2Day".
277 "modifierFlatRate": { # Additive shipping rate modifier.
278 "currency": "A String", # The currency of the price.
279 "value": "A String", # The price represented as a number.
280 },
281 },
282 ],
283 "locationGroups": [ # Location groups for shipping.
284 { # A user-defined locations group in a given country. All the locations of the group must be of the same type.
285 "postalCodeRanges": [ # A postal code range representing a city or a set of cities.
286 { # A postal code range, that can be either:
287 # - A range of postal codes (e.g., start=12340, end=12359)
288 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
289 "start": "A String", # The first (inclusive) postal code or prefix of the range.
290 "end": "A String", # The last (inclusive) postal code or prefix of the range.
291 },
292 ],
293 "country": "A String", # The country in which this location group is, represented as ISO 3166-1 Alpha-2 code.
294 "locationIds": [ # A location ID (also called criteria ID) representing administrative areas, smaller country subdivisions (counties), or cities.
295 "A String",
296 ],
297 "name": "A String", # The name of the location group.
298 "postalCodes": [ # A postal code representing a city or a set of cities.
299 # - A single postal code (e.g., 12345)
300 # - A postal code prefix followed by a star (e.g., 1234*)
301 "A String",
302 ],
303 },
304 ],
305 "services": [ # Shipping services describing shipping fees calculation.
306 { # Shipping services provided in a country.
307 "active": True or False, # Whether the shipping service is available.
308 "costRuleTree": { # Building block of the cost calculation decision tree. # Decision tree for "complicated" shipping cost calculation.
309 # - The tree root should have no condition and no calculation method.
310 # - All the children must have a condition on the same dimension. The first child matching a condition is entered, therefore, price and weight conditions form contiguous intervals.
311 # - The last child of an element must have no condition and matches all elements not previously matched.
312 # - Children and calculation method are mutually exclusive, and exactly one of them must be defined; the root must only have children.
313 "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Final calculation method to be used only in leaf nodes.
314 "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
315 "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
316 "rateTable": "A String", # Name of the rate table to use for the calculation.
317 "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
318 "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
319 "currency": "A String", # The currency of the price.
320 "value": "A String", # The price represented as a number.
321 },
322 },
323 "condition": { # Condition for this rule to be applicable. If no condition is specified, the rule acts as a catch-all.
324 "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
325 "value": "A String", # The weight represented as a number.
326 "unit": "A String", # The weight unit.
327 },
328 "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
329 "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
330 "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
331 # - A range of postal codes (e.g., start=12340, end=12359)
332 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
333 "start": "A String", # The first (inclusive) postal code or prefix of the range.
334 "end": "A String", # The last (inclusive) postal code or prefix of the range.
335 },
336 "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
337 "currency": "A String", # The currency of the price.
338 "value": "A String", # The price represented as a number.
339 },
340 "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
341 "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
342 },
343 "children": [ # Subsequent rules to be applied, only for inner nodes. The last child must not specify a condition and acts as a catch-all.
344 # Object with schema name: AccountShippingShippingServiceCostRule
345 ],
346 },
347 "saleCountry": "A String", # Sale country for which this service can be used, represented as an ISO 3166-1 Alpha-2 code.
348 "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Calculation method for the "simple" case that needs no rules.
349 "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
350 "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
351 "rateTable": "A String", # Name of the rate table to use for the calculation.
352 "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
353 "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
354 "currency": "A String", # The currency of the price.
355 "value": "A String", # The price represented as a number.
356 },
357 },
358 "name": "A String", # The name of this shipping service.
359 },
360 ],
361 "accountId": "A String", # The ID of the account to which these account shipping settings belong.
362 "rateTables": [ # Rate tables definitions.
363 { # A single or bi-dimensional table of shipping rates. Each dimension is defined in terms of consecutive price/weight ranges, delivery locations, or shipping labels.
364 "content": [ # One-dimensional table cells define one condition along the same dimension. Bi-dimensional table cells use two dimensions with respectively M and N distinct values and must contain exactly M * N cells with distinct conditions (for each possible value pairs).
365 {
366 "rate": { # The rate applicable if the cell conditions are matched.
367 "currency": "A String", # The currency of the price.
368 "value": "A String", # The price represented as a number.
369 },
370 "condition": { # Conditions for which the cell is valid. All cells in a table must use the same dimension or pair of dimensions among price, weight, shipping label or delivery location. If no condition is specified, the cell acts as a catch-all and matches all the elements that are not matched by other cells in this dimension.
371 "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
372 "value": "A String", # The weight represented as a number.
373 "unit": "A String", # The weight unit.
374 },
375 "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
376 "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
377 "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
378 # - A range of postal codes (e.g., start=12340, end=12359)
379 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
380 "start": "A String", # The first (inclusive) postal code or prefix of the range.
381 "end": "A String", # The last (inclusive) postal code or prefix of the range.
382 },
383 "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
384 "currency": "A String", # The currency of the price.
385 "value": "A String", # The price represented as a number.
386 },
387 "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
388 "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
389 },
390 },
391 ],
392 "saleCountry": "A String", # Sale country for which this table is valid, represented as an ISO 3166-1 Alpha-2 code.
393 "name": "A String", # The name of the rate table.
394 },
395 ],
396 },
397 },
398 ],
399 }</pre>
400</div>
401
402<div class="method">
403 <code class="details" id="get">get(merchantId, accountId)</code>
404 <pre>Retrieves the shipping settings of the account.
405
406Args:
407 merchantId: string, The ID of the managing account. (required)
408 accountId: string, The ID of the account for which to get/update account shipping settings. (required)
409
410Returns:
411 An object of the form:
412
413 { # The shipping settings of a merchant account.
414 "kind": "content#accountShipping", # Identifies what kind of resource this is. Value: the fixed string "content#accountShipping".
415 "carrierRates": [ # Carrier-based shipping calculations.
416 { # A carrier-calculated shipping rate.
417 "shippingOrigin": "A String", # Shipping origin represented as a postal code.
418 "name": "A String", # The name of the carrier rate.
419 "saleCountry": "A String", # Sale country for which this carrier rate is valid, represented as an ISO 3166-1 Alpha-2 code.
420 "modifierPercent": "A String", # Multiplicative shipping rate modifier in percent. Represented as a floating point number without the percentage character.
421 "carrier": "A String", # The carrier that is responsible for the shipping, such as "UPS", "FedEx", or "USPS".
422 "carrierService": "A String", # The carrier service, such as "Ground" or "2Day".
423 "modifierFlatRate": { # Additive shipping rate modifier.
424 "currency": "A String", # The currency of the price.
425 "value": "A String", # The price represented as a number.
426 },
427 },
428 ],
429 "locationGroups": [ # Location groups for shipping.
430 { # A user-defined locations group in a given country. All the locations of the group must be of the same type.
431 "postalCodeRanges": [ # A postal code range representing a city or a set of cities.
432 { # A postal code range, that can be either:
433 # - A range of postal codes (e.g., start=12340, end=12359)
434 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
435 "start": "A String", # The first (inclusive) postal code or prefix of the range.
436 "end": "A String", # The last (inclusive) postal code or prefix of the range.
437 },
438 ],
439 "country": "A String", # The country in which this location group is, represented as ISO 3166-1 Alpha-2 code.
440 "locationIds": [ # A location ID (also called criteria ID) representing administrative areas, smaller country subdivisions (counties), or cities.
441 "A String",
442 ],
443 "name": "A String", # The name of the location group.
444 "postalCodes": [ # A postal code representing a city or a set of cities.
445 # - A single postal code (e.g., 12345)
446 # - A postal code prefix followed by a star (e.g., 1234*)
447 "A String",
448 ],
449 },
450 ],
451 "services": [ # Shipping services describing shipping fees calculation.
452 { # Shipping services provided in a country.
453 "active": True or False, # Whether the shipping service is available.
454 "costRuleTree": { # Building block of the cost calculation decision tree. # Decision tree for "complicated" shipping cost calculation.
455 # - The tree root should have no condition and no calculation method.
456 # - All the children must have a condition on the same dimension. The first child matching a condition is entered, therefore, price and weight conditions form contiguous intervals.
457 # - The last child of an element must have no condition and matches all elements not previously matched.
458 # - Children and calculation method are mutually exclusive, and exactly one of them must be defined; the root must only have children.
459 "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Final calculation method to be used only in leaf nodes.
460 "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
461 "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
462 "rateTable": "A String", # Name of the rate table to use for the calculation.
463 "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
464 "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
465 "currency": "A String", # The currency of the price.
466 "value": "A String", # The price represented as a number.
467 },
468 },
469 "condition": { # Condition for this rule to be applicable. If no condition is specified, the rule acts as a catch-all.
470 "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
471 "value": "A String", # The weight represented as a number.
472 "unit": "A String", # The weight unit.
473 },
474 "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
475 "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
476 "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
477 # - A range of postal codes (e.g., start=12340, end=12359)
478 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
479 "start": "A String", # The first (inclusive) postal code or prefix of the range.
480 "end": "A String", # The last (inclusive) postal code or prefix of the range.
481 },
482 "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
483 "currency": "A String", # The currency of the price.
484 "value": "A String", # The price represented as a number.
485 },
486 "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
487 "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
488 },
489 "children": [ # Subsequent rules to be applied, only for inner nodes. The last child must not specify a condition and acts as a catch-all.
490 # Object with schema name: AccountShippingShippingServiceCostRule
491 ],
492 },
493 "saleCountry": "A String", # Sale country for which this service can be used, represented as an ISO 3166-1 Alpha-2 code.
494 "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Calculation method for the "simple" case that needs no rules.
495 "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
496 "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
497 "rateTable": "A String", # Name of the rate table to use for the calculation.
498 "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
499 "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
500 "currency": "A String", # The currency of the price.
501 "value": "A String", # The price represented as a number.
502 },
503 },
504 "name": "A String", # The name of this shipping service.
505 },
506 ],
507 "accountId": "A String", # The ID of the account to which these account shipping settings belong.
508 "rateTables": [ # Rate tables definitions.
509 { # A single or bi-dimensional table of shipping rates. Each dimension is defined in terms of consecutive price/weight ranges, delivery locations, or shipping labels.
510 "content": [ # One-dimensional table cells define one condition along the same dimension. Bi-dimensional table cells use two dimensions with respectively M and N distinct values and must contain exactly M * N cells with distinct conditions (for each possible value pairs).
511 {
512 "rate": { # The rate applicable if the cell conditions are matched.
513 "currency": "A String", # The currency of the price.
514 "value": "A String", # The price represented as a number.
515 },
516 "condition": { # Conditions for which the cell is valid. All cells in a table must use the same dimension or pair of dimensions among price, weight, shipping label or delivery location. If no condition is specified, the cell acts as a catch-all and matches all the elements that are not matched by other cells in this dimension.
517 "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
518 "value": "A String", # The weight represented as a number.
519 "unit": "A String", # The weight unit.
520 },
521 "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
522 "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
523 "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
524 # - A range of postal codes (e.g., start=12340, end=12359)
525 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
526 "start": "A String", # The first (inclusive) postal code or prefix of the range.
527 "end": "A String", # The last (inclusive) postal code or prefix of the range.
528 },
529 "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
530 "currency": "A String", # The currency of the price.
531 "value": "A String", # The price represented as a number.
532 },
533 "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
534 "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
535 },
536 },
537 ],
538 "saleCountry": "A String", # Sale country for which this table is valid, represented as an ISO 3166-1 Alpha-2 code.
539 "name": "A String", # The name of the rate table.
540 },
541 ],
542 }</pre>
543</div>
544
545<div class="method">
546 <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None)</code>
547 <pre>Lists the shipping settings of the sub-accounts in your Merchant Center account.
548
549Args:
550 merchantId: string, The ID of the managing account. (required)
551 pageToken: string, The token returned by the previous request.
552 maxResults: integer, The maximum number of shipping settings to return in the response, used for paging.
553
554Returns:
555 An object of the form:
556
557 {
558 "nextPageToken": "A String", # The token for the retrieval of the next page of account shipping settings.
559 "kind": "content#accountshippingListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountshippingListResponse".
560 "resources": [
561 { # The shipping settings of a merchant account.
562 "kind": "content#accountShipping", # Identifies what kind of resource this is. Value: the fixed string "content#accountShipping".
563 "carrierRates": [ # Carrier-based shipping calculations.
564 { # A carrier-calculated shipping rate.
565 "shippingOrigin": "A String", # Shipping origin represented as a postal code.
566 "name": "A String", # The name of the carrier rate.
567 "saleCountry": "A String", # Sale country for which this carrier rate is valid, represented as an ISO 3166-1 Alpha-2 code.
568 "modifierPercent": "A String", # Multiplicative shipping rate modifier in percent. Represented as a floating point number without the percentage character.
569 "carrier": "A String", # The carrier that is responsible for the shipping, such as "UPS", "FedEx", or "USPS".
570 "carrierService": "A String", # The carrier service, such as "Ground" or "2Day".
571 "modifierFlatRate": { # Additive shipping rate modifier.
572 "currency": "A String", # The currency of the price.
573 "value": "A String", # The price represented as a number.
574 },
575 },
576 ],
577 "locationGroups": [ # Location groups for shipping.
578 { # A user-defined locations group in a given country. All the locations of the group must be of the same type.
579 "postalCodeRanges": [ # A postal code range representing a city or a set of cities.
580 { # A postal code range, that can be either:
581 # - A range of postal codes (e.g., start=12340, end=12359)
582 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
583 "start": "A String", # The first (inclusive) postal code or prefix of the range.
584 "end": "A String", # The last (inclusive) postal code or prefix of the range.
585 },
586 ],
587 "country": "A String", # The country in which this location group is, represented as ISO 3166-1 Alpha-2 code.
588 "locationIds": [ # A location ID (also called criteria ID) representing administrative areas, smaller country subdivisions (counties), or cities.
589 "A String",
590 ],
591 "name": "A String", # The name of the location group.
592 "postalCodes": [ # A postal code representing a city or a set of cities.
593 # - A single postal code (e.g., 12345)
594 # - A postal code prefix followed by a star (e.g., 1234*)
595 "A String",
596 ],
597 },
598 ],
599 "services": [ # Shipping services describing shipping fees calculation.
600 { # Shipping services provided in a country.
601 "active": True or False, # Whether the shipping service is available.
602 "costRuleTree": { # Building block of the cost calculation decision tree. # Decision tree for "complicated" shipping cost calculation.
603 # - The tree root should have no condition and no calculation method.
604 # - All the children must have a condition on the same dimension. The first child matching a condition is entered, therefore, price and weight conditions form contiguous intervals.
605 # - The last child of an element must have no condition and matches all elements not previously matched.
606 # - Children and calculation method are mutually exclusive, and exactly one of them must be defined; the root must only have children.
607 "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Final calculation method to be used only in leaf nodes.
608 "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
609 "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
610 "rateTable": "A String", # Name of the rate table to use for the calculation.
611 "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
612 "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
613 "currency": "A String", # The currency of the price.
614 "value": "A String", # The price represented as a number.
615 },
616 },
617 "condition": { # Condition for this rule to be applicable. If no condition is specified, the rule acts as a catch-all.
618 "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
619 "value": "A String", # The weight represented as a number.
620 "unit": "A String", # The weight unit.
621 },
622 "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
623 "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
624 "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
625 # - A range of postal codes (e.g., start=12340, end=12359)
626 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
627 "start": "A String", # The first (inclusive) postal code or prefix of the range.
628 "end": "A String", # The last (inclusive) postal code or prefix of the range.
629 },
630 "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
631 "currency": "A String", # The currency of the price.
632 "value": "A String", # The price represented as a number.
633 },
634 "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
635 "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
636 },
637 "children": [ # Subsequent rules to be applied, only for inner nodes. The last child must not specify a condition and acts as a catch-all.
638 # Object with schema name: AccountShippingShippingServiceCostRule
639 ],
640 },
641 "saleCountry": "A String", # Sale country for which this service can be used, represented as an ISO 3166-1 Alpha-2 code.
642 "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Calculation method for the "simple" case that needs no rules.
643 "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
644 "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
645 "rateTable": "A String", # Name of the rate table to use for the calculation.
646 "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
647 "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
648 "currency": "A String", # The currency of the price.
649 "value": "A String", # The price represented as a number.
650 },
651 },
652 "name": "A String", # The name of this shipping service.
653 },
654 ],
655 "accountId": "A String", # The ID of the account to which these account shipping settings belong.
656 "rateTables": [ # Rate tables definitions.
657 { # A single or bi-dimensional table of shipping rates. Each dimension is defined in terms of consecutive price/weight ranges, delivery locations, or shipping labels.
658 "content": [ # One-dimensional table cells define one condition along the same dimension. Bi-dimensional table cells use two dimensions with respectively M and N distinct values and must contain exactly M * N cells with distinct conditions (for each possible value pairs).
659 {
660 "rate": { # The rate applicable if the cell conditions are matched.
661 "currency": "A String", # The currency of the price.
662 "value": "A String", # The price represented as a number.
663 },
664 "condition": { # Conditions for which the cell is valid. All cells in a table must use the same dimension or pair of dimensions among price, weight, shipping label or delivery location. If no condition is specified, the cell acts as a catch-all and matches all the elements that are not matched by other cells in this dimension.
665 "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
666 "value": "A String", # The weight represented as a number.
667 "unit": "A String", # The weight unit.
668 },
669 "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
670 "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
671 "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
672 # - A range of postal codes (e.g., start=12340, end=12359)
673 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
674 "start": "A String", # The first (inclusive) postal code or prefix of the range.
675 "end": "A String", # The last (inclusive) postal code or prefix of the range.
676 },
677 "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
678 "currency": "A String", # The currency of the price.
679 "value": "A String", # The price represented as a number.
680 },
681 "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
682 "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
683 },
684 },
685 ],
686 "saleCountry": "A String", # Sale country for which this table is valid, represented as an ISO 3166-1 Alpha-2 code.
687 "name": "A String", # The name of the rate table.
688 },
689 ],
690 },
691 ],
692 }</pre>
693</div>
694
695<div class="method">
696 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
697 <pre>Retrieves the next page of results.
698
699Args:
700 previous_request: The request for the previous page. (required)
701 previous_response: The response from the request for the previous page. (required)
702
703Returns:
704 A request object that you can call 'execute()' on to request the next
705 page. Returns None if there are no more items in the collection.
706 </pre>
707</div>
708
709<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]710 <code class="details" id="patch">patch(merchantId, accountId, body, dryRun=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]711 <pre>Updates the shipping settings of the account. This method supports patch semantics.
712
713Args:
714 merchantId: string, The ID of the managing account. (required)
715 accountId: string, The ID of the account for which to get/update account shipping settings. (required)
716 body: object, The request body. (required)
717 The object takes the form of:
718
719{ # The shipping settings of a merchant account.
720 "kind": "content#accountShipping", # Identifies what kind of resource this is. Value: the fixed string "content#accountShipping".
721 "carrierRates": [ # Carrier-based shipping calculations.
722 { # A carrier-calculated shipping rate.
723 "shippingOrigin": "A String", # Shipping origin represented as a postal code.
724 "name": "A String", # The name of the carrier rate.
725 "saleCountry": "A String", # Sale country for which this carrier rate is valid, represented as an ISO 3166-1 Alpha-2 code.
726 "modifierPercent": "A String", # Multiplicative shipping rate modifier in percent. Represented as a floating point number without the percentage character.
727 "carrier": "A String", # The carrier that is responsible for the shipping, such as "UPS", "FedEx", or "USPS".
728 "carrierService": "A String", # The carrier service, such as "Ground" or "2Day".
729 "modifierFlatRate": { # Additive shipping rate modifier.
730 "currency": "A String", # The currency of the price.
731 "value": "A String", # The price represented as a number.
732 },
733 },
734 ],
735 "locationGroups": [ # Location groups for shipping.
736 { # A user-defined locations group in a given country. All the locations of the group must be of the same type.
737 "postalCodeRanges": [ # A postal code range representing a city or a set of cities.
738 { # A postal code range, that can be either:
739 # - A range of postal codes (e.g., start=12340, end=12359)
740 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
741 "start": "A String", # The first (inclusive) postal code or prefix of the range.
742 "end": "A String", # The last (inclusive) postal code or prefix of the range.
743 },
744 ],
745 "country": "A String", # The country in which this location group is, represented as ISO 3166-1 Alpha-2 code.
746 "locationIds": [ # A location ID (also called criteria ID) representing administrative areas, smaller country subdivisions (counties), or cities.
747 "A String",
748 ],
749 "name": "A String", # The name of the location group.
750 "postalCodes": [ # A postal code representing a city or a set of cities.
751 # - A single postal code (e.g., 12345)
752 # - A postal code prefix followed by a star (e.g., 1234*)
753 "A String",
754 ],
755 },
756 ],
757 "services": [ # Shipping services describing shipping fees calculation.
758 { # Shipping services provided in a country.
759 "active": True or False, # Whether the shipping service is available.
760 "costRuleTree": { # Building block of the cost calculation decision tree. # Decision tree for "complicated" shipping cost calculation.
761 # - The tree root should have no condition and no calculation method.
762 # - All the children must have a condition on the same dimension. The first child matching a condition is entered, therefore, price and weight conditions form contiguous intervals.
763 # - The last child of an element must have no condition and matches all elements not previously matched.
764 # - Children and calculation method are mutually exclusive, and exactly one of them must be defined; the root must only have children.
765 "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Final calculation method to be used only in leaf nodes.
766 "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
767 "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
768 "rateTable": "A String", # Name of the rate table to use for the calculation.
769 "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
770 "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
771 "currency": "A String", # The currency of the price.
772 "value": "A String", # The price represented as a number.
773 },
774 },
775 "condition": { # Condition for this rule to be applicable. If no condition is specified, the rule acts as a catch-all.
776 "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
777 "value": "A String", # The weight represented as a number.
778 "unit": "A String", # The weight unit.
779 },
780 "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
781 "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
782 "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
783 # - A range of postal codes (e.g., start=12340, end=12359)
784 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
785 "start": "A String", # The first (inclusive) postal code or prefix of the range.
786 "end": "A String", # The last (inclusive) postal code or prefix of the range.
787 },
788 "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
789 "currency": "A String", # The currency of the price.
790 "value": "A String", # The price represented as a number.
791 },
792 "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
793 "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
794 },
795 "children": [ # Subsequent rules to be applied, only for inner nodes. The last child must not specify a condition and acts as a catch-all.
796 # Object with schema name: AccountShippingShippingServiceCostRule
797 ],
798 },
799 "saleCountry": "A String", # Sale country for which this service can be used, represented as an ISO 3166-1 Alpha-2 code.
800 "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Calculation method for the "simple" case that needs no rules.
801 "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
802 "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
803 "rateTable": "A String", # Name of the rate table to use for the calculation.
804 "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
805 "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
806 "currency": "A String", # The currency of the price.
807 "value": "A String", # The price represented as a number.
808 },
809 },
810 "name": "A String", # The name of this shipping service.
811 },
812 ],
813 "accountId": "A String", # The ID of the account to which these account shipping settings belong.
814 "rateTables": [ # Rate tables definitions.
815 { # A single or bi-dimensional table of shipping rates. Each dimension is defined in terms of consecutive price/weight ranges, delivery locations, or shipping labels.
816 "content": [ # One-dimensional table cells define one condition along the same dimension. Bi-dimensional table cells use two dimensions with respectively M and N distinct values and must contain exactly M * N cells with distinct conditions (for each possible value pairs).
817 {
818 "rate": { # The rate applicable if the cell conditions are matched.
819 "currency": "A String", # The currency of the price.
820 "value": "A String", # The price represented as a number.
821 },
822 "condition": { # Conditions for which the cell is valid. All cells in a table must use the same dimension or pair of dimensions among price, weight, shipping label or delivery location. If no condition is specified, the cell acts as a catch-all and matches all the elements that are not matched by other cells in this dimension.
823 "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
824 "value": "A String", # The weight represented as a number.
825 "unit": "A String", # The weight unit.
826 },
827 "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
828 "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
829 "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
830 # - A range of postal codes (e.g., start=12340, end=12359)
831 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
832 "start": "A String", # The first (inclusive) postal code or prefix of the range.
833 "end": "A String", # The last (inclusive) postal code or prefix of the range.
834 },
835 "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
836 "currency": "A String", # The currency of the price.
837 "value": "A String", # The price represented as a number.
838 },
839 "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
840 "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
841 },
842 },
843 ],
844 "saleCountry": "A String", # Sale country for which this table is valid, represented as an ISO 3166-1 Alpha-2 code.
845 "name": "A String", # The name of the rate table.
846 },
847 ],
848}
849
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]850 dryRun: boolean, Flag to run the request in dry-run mode.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]851
852Returns:
853 An object of the form:
854
855 { # The shipping settings of a merchant account.
856 "kind": "content#accountShipping", # Identifies what kind of resource this is. Value: the fixed string "content#accountShipping".
857 "carrierRates": [ # Carrier-based shipping calculations.
858 { # A carrier-calculated shipping rate.
859 "shippingOrigin": "A String", # Shipping origin represented as a postal code.
860 "name": "A String", # The name of the carrier rate.
861 "saleCountry": "A String", # Sale country for which this carrier rate is valid, represented as an ISO 3166-1 Alpha-2 code.
862 "modifierPercent": "A String", # Multiplicative shipping rate modifier in percent. Represented as a floating point number without the percentage character.
863 "carrier": "A String", # The carrier that is responsible for the shipping, such as "UPS", "FedEx", or "USPS".
864 "carrierService": "A String", # The carrier service, such as "Ground" or "2Day".
865 "modifierFlatRate": { # Additive shipping rate modifier.
866 "currency": "A String", # The currency of the price.
867 "value": "A String", # The price represented as a number.
868 },
869 },
870 ],
871 "locationGroups": [ # Location groups for shipping.
872 { # A user-defined locations group in a given country. All the locations of the group must be of the same type.
873 "postalCodeRanges": [ # A postal code range representing a city or a set of cities.
874 { # A postal code range, that can be either:
875 # - A range of postal codes (e.g., start=12340, end=12359)
876 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
877 "start": "A String", # The first (inclusive) postal code or prefix of the range.
878 "end": "A String", # The last (inclusive) postal code or prefix of the range.
879 },
880 ],
881 "country": "A String", # The country in which this location group is, represented as ISO 3166-1 Alpha-2 code.
882 "locationIds": [ # A location ID (also called criteria ID) representing administrative areas, smaller country subdivisions (counties), or cities.
883 "A String",
884 ],
885 "name": "A String", # The name of the location group.
886 "postalCodes": [ # A postal code representing a city or a set of cities.
887 # - A single postal code (e.g., 12345)
888 # - A postal code prefix followed by a star (e.g., 1234*)
889 "A String",
890 ],
891 },
892 ],
893 "services": [ # Shipping services describing shipping fees calculation.
894 { # Shipping services provided in a country.
895 "active": True or False, # Whether the shipping service is available.
896 "costRuleTree": { # Building block of the cost calculation decision tree. # Decision tree for "complicated" shipping cost calculation.
897 # - The tree root should have no condition and no calculation method.
898 # - All the children must have a condition on the same dimension. The first child matching a condition is entered, therefore, price and weight conditions form contiguous intervals.
899 # - The last child of an element must have no condition and matches all elements not previously matched.
900 # - Children and calculation method are mutually exclusive, and exactly one of them must be defined; the root must only have children.
901 "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Final calculation method to be used only in leaf nodes.
902 "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
903 "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
904 "rateTable": "A String", # Name of the rate table to use for the calculation.
905 "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
906 "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
907 "currency": "A String", # The currency of the price.
908 "value": "A String", # The price represented as a number.
909 },
910 },
911 "condition": { # Condition for this rule to be applicable. If no condition is specified, the rule acts as a catch-all.
912 "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
913 "value": "A String", # The weight represented as a number.
914 "unit": "A String", # The weight unit.
915 },
916 "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
917 "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
918 "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
919 # - A range of postal codes (e.g., start=12340, end=12359)
920 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
921 "start": "A String", # The first (inclusive) postal code or prefix of the range.
922 "end": "A String", # The last (inclusive) postal code or prefix of the range.
923 },
924 "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
925 "currency": "A String", # The currency of the price.
926 "value": "A String", # The price represented as a number.
927 },
928 "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
929 "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
930 },
931 "children": [ # Subsequent rules to be applied, only for inner nodes. The last child must not specify a condition and acts as a catch-all.
932 # Object with schema name: AccountShippingShippingServiceCostRule
933 ],
934 },
935 "saleCountry": "A String", # Sale country for which this service can be used, represented as an ISO 3166-1 Alpha-2 code.
936 "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Calculation method for the "simple" case that needs no rules.
937 "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
938 "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
939 "rateTable": "A String", # Name of the rate table to use for the calculation.
940 "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
941 "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
942 "currency": "A String", # The currency of the price.
943 "value": "A String", # The price represented as a number.
944 },
945 },
946 "name": "A String", # The name of this shipping service.
947 },
948 ],
949 "accountId": "A String", # The ID of the account to which these account shipping settings belong.
950 "rateTables": [ # Rate tables definitions.
951 { # A single or bi-dimensional table of shipping rates. Each dimension is defined in terms of consecutive price/weight ranges, delivery locations, or shipping labels.
952 "content": [ # One-dimensional table cells define one condition along the same dimension. Bi-dimensional table cells use two dimensions with respectively M and N distinct values and must contain exactly M * N cells with distinct conditions (for each possible value pairs).
953 {
954 "rate": { # The rate applicable if the cell conditions are matched.
955 "currency": "A String", # The currency of the price.
956 "value": "A String", # The price represented as a number.
957 },
958 "condition": { # Conditions for which the cell is valid. All cells in a table must use the same dimension or pair of dimensions among price, weight, shipping label or delivery location. If no condition is specified, the cell acts as a catch-all and matches all the elements that are not matched by other cells in this dimension.
959 "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
960 "value": "A String", # The weight represented as a number.
961 "unit": "A String", # The weight unit.
962 },
963 "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
964 "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
965 "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
966 # - A range of postal codes (e.g., start=12340, end=12359)
967 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
968 "start": "A String", # The first (inclusive) postal code or prefix of the range.
969 "end": "A String", # The last (inclusive) postal code or prefix of the range.
970 },
971 "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
972 "currency": "A String", # The currency of the price.
973 "value": "A String", # The price represented as a number.
974 },
975 "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
976 "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
977 },
978 },
979 ],
980 "saleCountry": "A String", # Sale country for which this table is valid, represented as an ISO 3166-1 Alpha-2 code.
981 "name": "A String", # The name of the rate table.
982 },
983 ],
984 }</pre>
985</div>
986
987<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]988 <code class="details" id="update">update(merchantId, accountId, body, dryRun=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]989 <pre>Updates the shipping settings of the account.
990
991Args:
992 merchantId: string, The ID of the managing account. (required)
993 accountId: string, The ID of the account for which to get/update account shipping settings. (required)
994 body: object, The request body. (required)
995 The object takes the form of:
996
997{ # The shipping settings of a merchant account.
998 "kind": "content#accountShipping", # Identifies what kind of resource this is. Value: the fixed string "content#accountShipping".
999 "carrierRates": [ # Carrier-based shipping calculations.
1000 { # A carrier-calculated shipping rate.
1001 "shippingOrigin": "A String", # Shipping origin represented as a postal code.
1002 "name": "A String", # The name of the carrier rate.
1003 "saleCountry": "A String", # Sale country for which this carrier rate is valid, represented as an ISO 3166-1 Alpha-2 code.
1004 "modifierPercent": "A String", # Multiplicative shipping rate modifier in percent. Represented as a floating point number without the percentage character.
1005 "carrier": "A String", # The carrier that is responsible for the shipping, such as "UPS", "FedEx", or "USPS".
1006 "carrierService": "A String", # The carrier service, such as "Ground" or "2Day".
1007 "modifierFlatRate": { # Additive shipping rate modifier.
1008 "currency": "A String", # The currency of the price.
1009 "value": "A String", # The price represented as a number.
1010 },
1011 },
1012 ],
1013 "locationGroups": [ # Location groups for shipping.
1014 { # A user-defined locations group in a given country. All the locations of the group must be of the same type.
1015 "postalCodeRanges": [ # A postal code range representing a city or a set of cities.
1016 { # A postal code range, that can be either:
1017 # - A range of postal codes (e.g., start=12340, end=12359)
1018 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
1019 "start": "A String", # The first (inclusive) postal code or prefix of the range.
1020 "end": "A String", # The last (inclusive) postal code or prefix of the range.
1021 },
1022 ],
1023 "country": "A String", # The country in which this location group is, represented as ISO 3166-1 Alpha-2 code.
1024 "locationIds": [ # A location ID (also called criteria ID) representing administrative areas, smaller country subdivisions (counties), or cities.
1025 "A String",
1026 ],
1027 "name": "A String", # The name of the location group.
1028 "postalCodes": [ # A postal code representing a city or a set of cities.
1029 # - A single postal code (e.g., 12345)
1030 # - A postal code prefix followed by a star (e.g., 1234*)
1031 "A String",
1032 ],
1033 },
1034 ],
1035 "services": [ # Shipping services describing shipping fees calculation.
1036 { # Shipping services provided in a country.
1037 "active": True or False, # Whether the shipping service is available.
1038 "costRuleTree": { # Building block of the cost calculation decision tree. # Decision tree for "complicated" shipping cost calculation.
1039 # - The tree root should have no condition and no calculation method.
1040 # - All the children must have a condition on the same dimension. The first child matching a condition is entered, therefore, price and weight conditions form contiguous intervals.
1041 # - The last child of an element must have no condition and matches all elements not previously matched.
1042 # - Children and calculation method are mutually exclusive, and exactly one of them must be defined; the root must only have children.
1043 "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Final calculation method to be used only in leaf nodes.
1044 "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
1045 "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
1046 "rateTable": "A String", # Name of the rate table to use for the calculation.
1047 "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
1048 "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
1049 "currency": "A String", # The currency of the price.
1050 "value": "A String", # The price represented as a number.
1051 },
1052 },
1053 "condition": { # Condition for this rule to be applicable. If no condition is specified, the rule acts as a catch-all.
1054 "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
1055 "value": "A String", # The weight represented as a number.
1056 "unit": "A String", # The weight unit.
1057 },
1058 "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
1059 "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
1060 "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
1061 # - A range of postal codes (e.g., start=12340, end=12359)
1062 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
1063 "start": "A String", # The first (inclusive) postal code or prefix of the range.
1064 "end": "A String", # The last (inclusive) postal code or prefix of the range.
1065 },
1066 "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
1067 "currency": "A String", # The currency of the price.
1068 "value": "A String", # The price represented as a number.
1069 },
1070 "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
1071 "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
1072 },
1073 "children": [ # Subsequent rules to be applied, only for inner nodes. The last child must not specify a condition and acts as a catch-all.
1074 # Object with schema name: AccountShippingShippingServiceCostRule
1075 ],
1076 },
1077 "saleCountry": "A String", # Sale country for which this service can be used, represented as an ISO 3166-1 Alpha-2 code.
1078 "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Calculation method for the "simple" case that needs no rules.
1079 "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
1080 "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
1081 "rateTable": "A String", # Name of the rate table to use for the calculation.
1082 "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
1083 "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
1084 "currency": "A String", # The currency of the price.
1085 "value": "A String", # The price represented as a number.
1086 },
1087 },
1088 "name": "A String", # The name of this shipping service.
1089 },
1090 ],
1091 "accountId": "A String", # The ID of the account to which these account shipping settings belong.
1092 "rateTables": [ # Rate tables definitions.
1093 { # A single or bi-dimensional table of shipping rates. Each dimension is defined in terms of consecutive price/weight ranges, delivery locations, or shipping labels.
1094 "content": [ # One-dimensional table cells define one condition along the same dimension. Bi-dimensional table cells use two dimensions with respectively M and N distinct values and must contain exactly M * N cells with distinct conditions (for each possible value pairs).
1095 {
1096 "rate": { # The rate applicable if the cell conditions are matched.
1097 "currency": "A String", # The currency of the price.
1098 "value": "A String", # The price represented as a number.
1099 },
1100 "condition": { # Conditions for which the cell is valid. All cells in a table must use the same dimension or pair of dimensions among price, weight, shipping label or delivery location. If no condition is specified, the cell acts as a catch-all and matches all the elements that are not matched by other cells in this dimension.
1101 "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
1102 "value": "A String", # The weight represented as a number.
1103 "unit": "A String", # The weight unit.
1104 },
1105 "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
1106 "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
1107 "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
1108 # - A range of postal codes (e.g., start=12340, end=12359)
1109 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
1110 "start": "A String", # The first (inclusive) postal code or prefix of the range.
1111 "end": "A String", # The last (inclusive) postal code or prefix of the range.
1112 },
1113 "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
1114 "currency": "A String", # The currency of the price.
1115 "value": "A String", # The price represented as a number.
1116 },
1117 "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
1118 "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
1119 },
1120 },
1121 ],
1122 "saleCountry": "A String", # Sale country for which this table is valid, represented as an ISO 3166-1 Alpha-2 code.
1123 "name": "A String", # The name of the rate table.
1124 },
1125 ],
1126}
1127
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]1128 dryRun: boolean, Flag to run the request in dry-run mode.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1129
1130Returns:
1131 An object of the form:
1132
1133 { # The shipping settings of a merchant account.
1134 "kind": "content#accountShipping", # Identifies what kind of resource this is. Value: the fixed string "content#accountShipping".
1135 "carrierRates": [ # Carrier-based shipping calculations.
1136 { # A carrier-calculated shipping rate.
1137 "shippingOrigin": "A String", # Shipping origin represented as a postal code.
1138 "name": "A String", # The name of the carrier rate.
1139 "saleCountry": "A String", # Sale country for which this carrier rate is valid, represented as an ISO 3166-1 Alpha-2 code.
1140 "modifierPercent": "A String", # Multiplicative shipping rate modifier in percent. Represented as a floating point number without the percentage character.
1141 "carrier": "A String", # The carrier that is responsible for the shipping, such as "UPS", "FedEx", or "USPS".
1142 "carrierService": "A String", # The carrier service, such as "Ground" or "2Day".
1143 "modifierFlatRate": { # Additive shipping rate modifier.
1144 "currency": "A String", # The currency of the price.
1145 "value": "A String", # The price represented as a number.
1146 },
1147 },
1148 ],
1149 "locationGroups": [ # Location groups for shipping.
1150 { # A user-defined locations group in a given country. All the locations of the group must be of the same type.
1151 "postalCodeRanges": [ # A postal code range representing a city or a set of cities.
1152 { # A postal code range, that can be either:
1153 # - A range of postal codes (e.g., start=12340, end=12359)
1154 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
1155 "start": "A String", # The first (inclusive) postal code or prefix of the range.
1156 "end": "A String", # The last (inclusive) postal code or prefix of the range.
1157 },
1158 ],
1159 "country": "A String", # The country in which this location group is, represented as ISO 3166-1 Alpha-2 code.
1160 "locationIds": [ # A location ID (also called criteria ID) representing administrative areas, smaller country subdivisions (counties), or cities.
1161 "A String",
1162 ],
1163 "name": "A String", # The name of the location group.
1164 "postalCodes": [ # A postal code representing a city or a set of cities.
1165 # - A single postal code (e.g., 12345)
1166 # - A postal code prefix followed by a star (e.g., 1234*)
1167 "A String",
1168 ],
1169 },
1170 ],
1171 "services": [ # Shipping services describing shipping fees calculation.
1172 { # Shipping services provided in a country.
1173 "active": True or False, # Whether the shipping service is available.
1174 "costRuleTree": { # Building block of the cost calculation decision tree. # Decision tree for "complicated" shipping cost calculation.
1175 # - The tree root should have no condition and no calculation method.
1176 # - All the children must have a condition on the same dimension. The first child matching a condition is entered, therefore, price and weight conditions form contiguous intervals.
1177 # - The last child of an element must have no condition and matches all elements not previously matched.
1178 # - Children and calculation method are mutually exclusive, and exactly one of them must be defined; the root must only have children.
1179 "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Final calculation method to be used only in leaf nodes.
1180 "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
1181 "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
1182 "rateTable": "A String", # Name of the rate table to use for the calculation.
1183 "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
1184 "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
1185 "currency": "A String", # The currency of the price.
1186 "value": "A String", # The price represented as a number.
1187 },
1188 },
1189 "condition": { # Condition for this rule to be applicable. If no condition is specified, the rule acts as a catch-all.
1190 "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
1191 "value": "A String", # The weight represented as a number.
1192 "unit": "A String", # The weight unit.
1193 },
1194 "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
1195 "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
1196 "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
1197 # - A range of postal codes (e.g., start=12340, end=12359)
1198 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
1199 "start": "A String", # The first (inclusive) postal code or prefix of the range.
1200 "end": "A String", # The last (inclusive) postal code or prefix of the range.
1201 },
1202 "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
1203 "currency": "A String", # The currency of the price.
1204 "value": "A String", # The price represented as a number.
1205 },
1206 "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
1207 "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
1208 },
1209 "children": [ # Subsequent rules to be applied, only for inner nodes. The last child must not specify a condition and acts as a catch-all.
1210 # Object with schema name: AccountShippingShippingServiceCostRule
1211 ],
1212 },
1213 "saleCountry": "A String", # Sale country for which this service can be used, represented as an ISO 3166-1 Alpha-2 code.
1214 "calculationMethod": { # Shipping cost calculation method. Exactly one of the field is set. # Calculation method for the "simple" case that needs no rules.
1215 "percentageRate": "A String", # Percentage of the price, represented as a floating point number without the percentage character.
1216 "carrierRate": "A String", # Name of the carrier rate to use for the calculation.
1217 "rateTable": "A String", # Name of the rate table to use for the calculation.
1218 "excluded": True or False, # Delivery is excluded. Valid only within cost rules tree.
1219 "flatRate": { # Fixed price shipping, represented as a floating point number associated with a currency.
1220 "currency": "A String", # The currency of the price.
1221 "value": "A String", # The price represented as a number.
1222 },
1223 },
1224 "name": "A String", # The name of this shipping service.
1225 },
1226 ],
1227 "accountId": "A String", # The ID of the account to which these account shipping settings belong.
1228 "rateTables": [ # Rate tables definitions.
1229 { # A single or bi-dimensional table of shipping rates. Each dimension is defined in terms of consecutive price/weight ranges, delivery locations, or shipping labels.
1230 "content": [ # One-dimensional table cells define one condition along the same dimension. Bi-dimensional table cells use two dimensions with respectively M and N distinct values and must contain exactly M * N cells with distinct conditions (for each possible value pairs).
1231 {
1232 "rate": { # The rate applicable if the cell conditions are matched.
1233 "currency": "A String", # The currency of the price.
1234 "value": "A String", # The price represented as a number.
1235 },
1236 "condition": { # Conditions for which the cell is valid. All cells in a table must use the same dimension or pair of dimensions among price, weight, shipping label or delivery location. If no condition is specified, the cell acts as a catch-all and matches all the elements that are not matched by other cells in this dimension.
1237 "weightMax": { # Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive).
1238 "value": "A String", # The weight represented as a number.
1239 "unit": "A String", # The weight unit.
1240 },
1241 "deliveryLocationId": "A String", # Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.
1242 "deliveryPostalCode": "A String", # Delivery location in terms of a postal code.
1243 "deliveryPostalCodeRange": { # A postal code range, that can be either: # Delivery location in terms of a postal code range.
1244 # - A range of postal codes (e.g., start=12340, end=12359)
1245 # - A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).
1246 "start": "A String", # The first (inclusive) postal code or prefix of the range.
1247 "end": "A String", # The last (inclusive) postal code or prefix of the range.
1248 },
1249 "priceMax": { # Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive).
1250 "currency": "A String", # The currency of the price.
1251 "value": "A String", # The price represented as a number.
1252 },
1253 "shippingLabel": "A String", # Shipping label of the product. The products with the label are matched.
1254 "deliveryLocationGroup": "A String", # Delivery location in terms of a location group name. A location group with this name must be specified among location groups.
1255 },
1256 },
1257 ],
1258 "saleCountry": "A String", # Sale country for which this table is valid, represented as an ISO 3166-1 Alpha-2 code.
1259 "name": "A String", # The name of the rate table.
1260 },
1261 ],
1262 }</pre>
1263</div>
1264
1265</body></html>