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