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