Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 42818cfca63bf2d3d257ff8859939dcf6839456e / . / docs / dyn / content_v2.shippingsettings.html
blob: bf4e978bd47bbcd01b09a1f8c8a3ea272d598c07 [file] [log] [blame]
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[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.shippingsettings.html">shippingsettings</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#custombatch">custombatch(body, dryRun=None)</a></code></p>
79<p class="firstline">Retrieves and updates the shipping settings of multiple accounts in a single request.</p>
80<p class="toc_element">
81 <code><a href="#get">get(merchantId, accountId)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]82<p class="firstline">Retrieves the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#getsupportedcarriers">getsupportedcarriers(merchantId)</a></code></p>
85<p class="firstline">Retrieves supported carriers and carrier services for an account.</p>
86<p class="toc_element">
87 <code><a href="#list">list(merchantId, pageToken=None, maxResults=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]88<p class="firstline">Lists the shipping settings of the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#patch">patch(merchantId, accountId, body, dryRun=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]94<p class="firstline">Updates the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account. This method supports patch semantics.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]95<p class="toc_element">
96 <code><a href="#update">update(merchantId, accountId, body, dryRun=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]97<p class="firstline">Updates the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="custombatch">custombatch(body, dryRun=None)</code>
101 <pre>Retrieves and updates the shipping settings of multiple accounts in a single request.
102
103Args:
104 body: object, The request body. (required)
105 The object takes the form of:
106
107{
108 "entries": [ # The request entries to be processed in the batch.
109 { # A batch entry encoding a single non-batch accountshipping request.
110 "batchId": 42, # An entry ID, unique within the batch request.
111 "method": "A String",
112 "merchantId": "A String", # The ID of the managing account.
113 "shippingSettings": { # The merchant account's shipping settings. # The account shipping settings to update. Only defined if the method is update.
114 "services": [ # The target account's list of services. Optional.
115 {
116 "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
117 "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
118 "maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. Required.
119 "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Required.
120 },
121 "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
122 "rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
123 {
124 "applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
125 "A String",
126 ],
127 "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
128 {
129 "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
130 "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
131 "flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
132 "currency": "A String", # The currency of the price.
133 "value": "A String", # The price represented as a number.
134 },
135 "percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.
136 "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
137 "carrierService": "A String", # Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
138 },
139 ],
140 "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
141 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
142 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
143 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
144 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
145 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
146 "currency": "A String", # The currency of the price.
147 "value": "A String", # The price represented as a number.
148 },
149 },
150 "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
151 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
152 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
153 {
154 "currency": "A String", # The currency of the price.
155 "value": "A String", # The price represented as a number.
156 },
157 ],
158 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
159 "A String",
160 ],
161 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
162 {
163 "value": "A String", # The weight represented as a number.
164 "unit": "A String", # The weight unit.
165 },
166 ],
167 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
168 {
169 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
170 "A String",
171 ],
172 },
173 ],
174 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
175 "A String",
176 ],
177 },
178 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
179 {
180 "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
181 { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
182 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
183 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
184 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
185 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
186 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
187 "currency": "A String", # The currency of the price.
188 "value": "A String", # The price represented as a number.
189 },
190 },
191 ],
192 },
193 ],
194 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
195 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
196 {
197 "currency": "A String", # The currency of the price.
198 "value": "A String", # The price represented as a number.
199 },
200 ],
201 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
202 "A String",
203 ],
204 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
205 {
206 "value": "A String", # The weight represented as a number.
207 "unit": "A String", # The weight unit.
208 },
209 ],
210 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
211 {
212 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
213 "A String",
214 ],
215 },
216 ],
217 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
218 "A String",
219 ],
220 },
221 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
222 },
223 "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
224 {
225 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
226 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
227 {
228 "currency": "A String", # The currency of the price.
229 "value": "A String", # The price represented as a number.
230 },
231 ],
232 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
233 "A String",
234 ],
235 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
236 {
237 "value": "A String", # The weight represented as a number.
238 "unit": "A String", # The weight unit.
239 },
240 ],
241 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
242 {
243 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
244 "A String",
245 ],
246 },
247 ],
248 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
249 "A String",
250 ],
251 },
252 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
253 {
254 "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
255 { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
256 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
257 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
258 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
259 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
260 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
261 "currency": "A String", # The currency of the price.
262 "value": "A String", # The price represented as a number.
263 },
264 },
265 ],
266 },
267 ],
268 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
269 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
270 {
271 "currency": "A String", # The currency of the price.
272 "value": "A String", # The price represented as a number.
273 },
274 ],
275 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
276 "A String",
277 ],
278 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
279 {
280 "value": "A String", # The weight represented as a number.
281 "unit": "A String", # The weight unit.
282 },
283 ],
284 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
285 {
286 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
287 "A String",
288 ],
289 },
290 ],
291 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
292 "A String",
293 ],
294 },
295 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
296 },
297 ],
298 },
299 ],
300 "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
301 "active": True or False, # A boolean exposing the active status of the shipping service. Required.
302 },
303 ],
304 "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
305 {
306 "postalCodeRanges": [ # A range of postal codes. Required.
307 {
308 "postalCodeRangeBegin": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
309 "postalCodeRangeEnd": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.
310 },
311 ],
312 "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
313 "name": "A String", # The name of the postal code group, referred to in headers. Required.
314 },
315 ],
316 "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
317 },
318 "accountId": "A String", # The ID of the account for which to get/update account shipping settings.
319 },
320 ],
321 }
322
323 dryRun: boolean, Flag to run the request in dry-run mode.
324
325Returns:
326 An object of the form:
327
328 {
329 "kind": "content#shippingsettingsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponse".
330 "entries": [ # The result of the execution of the batch requests.
331 { # A batch entry encoding a single non-batch shipping settings response.
332 "batchId": 42, # The ID of the request entry to which this entry responds.
333 "kind": "content#shippingsettingsCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponseEntry".
334 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if, and only if, the request failed.
335 "message": "A String", # The message of the first error in errors.
336 "code": 42, # The HTTP status of the first error in errors.
337 "errors": [ # A list of errors.
338 { # An error returned by the API.
339 "reason": "A String", # The error code.
340 "domain": "A String", # The domain of the error.
341 "message": "A String", # A description of the error.
342 },
343 ],
344 },
345 "shippingSettings": { # The merchant account's shipping settings. # The retrieved or updated account shipping settings.
346 "services": [ # The target account's list of services. Optional.
347 {
348 "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
349 "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
350 "maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. Required.
351 "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Required.
352 },
353 "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
354 "rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
355 {
356 "applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
357 "A String",
358 ],
359 "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
360 {
361 "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
362 "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
363 "flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
364 "currency": "A String", # The currency of the price.
365 "value": "A String", # The price represented as a number.
366 },
367 "percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.
368 "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
369 "carrierService": "A String", # Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
370 },
371 ],
372 "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
373 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
374 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
375 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
376 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
377 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
378 "currency": "A String", # The currency of the price.
379 "value": "A String", # The price represented as a number.
380 },
381 },
382 "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
383 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
384 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
385 {
386 "currency": "A String", # The currency of the price.
387 "value": "A String", # The price represented as a number.
388 },
389 ],
390 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
391 "A String",
392 ],
393 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
394 {
395 "value": "A String", # The weight represented as a number.
396 "unit": "A String", # The weight unit.
397 },
398 ],
399 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
400 {
401 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
402 "A String",
403 ],
404 },
405 ],
406 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
407 "A String",
408 ],
409 },
410 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
411 {
412 "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
413 { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
414 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
415 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
416 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
417 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
418 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
419 "currency": "A String", # The currency of the price.
420 "value": "A String", # The price represented as a number.
421 },
422 },
423 ],
424 },
425 ],
426 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
427 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
428 {
429 "currency": "A String", # The currency of the price.
430 "value": "A String", # The price represented as a number.
431 },
432 ],
433 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
434 "A String",
435 ],
436 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
437 {
438 "value": "A String", # The weight represented as a number.
439 "unit": "A String", # The weight unit.
440 },
441 ],
442 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
443 {
444 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
445 "A String",
446 ],
447 },
448 ],
449 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
450 "A String",
451 ],
452 },
453 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
454 },
455 "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
456 {
457 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
458 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
459 {
460 "currency": "A String", # The currency of the price.
461 "value": "A String", # The price represented as a number.
462 },
463 ],
464 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
465 "A String",
466 ],
467 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
468 {
469 "value": "A String", # The weight represented as a number.
470 "unit": "A String", # The weight unit.
471 },
472 ],
473 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
474 {
475 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
476 "A String",
477 ],
478 },
479 ],
480 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
481 "A String",
482 ],
483 },
484 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
485 {
486 "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
487 { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
488 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
489 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
490 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
491 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
492 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
493 "currency": "A String", # The currency of the price.
494 "value": "A String", # The price represented as a number.
495 },
496 },
497 ],
498 },
499 ],
500 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
501 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
502 {
503 "currency": "A String", # The currency of the price.
504 "value": "A String", # The price represented as a number.
505 },
506 ],
507 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
508 "A String",
509 ],
510 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
511 {
512 "value": "A String", # The weight represented as a number.
513 "unit": "A String", # The weight unit.
514 },
515 ],
516 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
517 {
518 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
519 "A String",
520 ],
521 },
522 ],
523 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
524 "A String",
525 ],
526 },
527 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
528 },
529 ],
530 },
531 ],
532 "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
533 "active": True or False, # A boolean exposing the active status of the shipping service. Required.
534 },
535 ],
536 "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
537 {
538 "postalCodeRanges": [ # A range of postal codes. Required.
539 {
540 "postalCodeRangeBegin": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
541 "postalCodeRangeEnd": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.
542 },
543 ],
544 "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
545 "name": "A String", # The name of the postal code group, referred to in headers. Required.
546 },
547 ],
548 "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
549 },
550 },
551 ],
552 }</pre>
553</div>
554
555<div class="method">
556 <code class="details" id="get">get(merchantId, accountId)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]557 <pre>Retrieves the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]558
559Args:
560 merchantId: string, The ID of the managing account. (required)
561 accountId: string, The ID of the account for which to get/update shipping settings. (required)
562
563Returns:
564 An object of the form:
565
566 { # The merchant account's shipping settings.
567 "services": [ # The target account's list of services. Optional.
568 {
569 "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
570 "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
571 "maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. Required.
572 "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Required.
573 },
574 "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
575 "rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
576 {
577 "applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
578 "A String",
579 ],
580 "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
581 {
582 "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
583 "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
584 "flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
585 "currency": "A String", # The currency of the price.
586 "value": "A String", # The price represented as a number.
587 },
588 "percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.
589 "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
590 "carrierService": "A String", # Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
591 },
592 ],
593 "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
594 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
595 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
596 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
597 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
598 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
599 "currency": "A String", # The currency of the price.
600 "value": "A String", # The price represented as a number.
601 },
602 },
603 "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
604 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
605 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
606 {
607 "currency": "A String", # The currency of the price.
608 "value": "A String", # The price represented as a number.
609 },
610 ],
611 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
612 "A String",
613 ],
614 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
615 {
616 "value": "A String", # The weight represented as a number.
617 "unit": "A String", # The weight unit.
618 },
619 ],
620 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
621 {
622 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
623 "A String",
624 ],
625 },
626 ],
627 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
628 "A String",
629 ],
630 },
631 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
632 {
633 "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
634 { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
635 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
636 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
637 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
638 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
639 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
640 "currency": "A String", # The currency of the price.
641 "value": "A String", # The price represented as a number.
642 },
643 },
644 ],
645 },
646 ],
647 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
648 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
649 {
650 "currency": "A String", # The currency of the price.
651 "value": "A String", # The price represented as a number.
652 },
653 ],
654 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
655 "A String",
656 ],
657 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
658 {
659 "value": "A String", # The weight represented as a number.
660 "unit": "A String", # The weight unit.
661 },
662 ],
663 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
664 {
665 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
666 "A String",
667 ],
668 },
669 ],
670 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
671 "A String",
672 ],
673 },
674 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
675 },
676 "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
677 {
678 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
679 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
680 {
681 "currency": "A String", # The currency of the price.
682 "value": "A String", # The price represented as a number.
683 },
684 ],
685 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
686 "A String",
687 ],
688 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
689 {
690 "value": "A String", # The weight represented as a number.
691 "unit": "A String", # The weight unit.
692 },
693 ],
694 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
695 {
696 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
697 "A String",
698 ],
699 },
700 ],
701 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
702 "A String",
703 ],
704 },
705 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
706 {
707 "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
708 { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
709 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
710 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
711 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
712 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
713 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
714 "currency": "A String", # The currency of the price.
715 "value": "A String", # The price represented as a number.
716 },
717 },
718 ],
719 },
720 ],
721 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
722 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
723 {
724 "currency": "A String", # The currency of the price.
725 "value": "A String", # The price represented as a number.
726 },
727 ],
728 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
729 "A String",
730 ],
731 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
732 {
733 "value": "A String", # The weight represented as a number.
734 "unit": "A String", # The weight unit.
735 },
736 ],
737 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
738 {
739 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
740 "A String",
741 ],
742 },
743 ],
744 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
745 "A String",
746 ],
747 },
748 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
749 },
750 ],
751 },
752 ],
753 "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
754 "active": True or False, # A boolean exposing the active status of the shipping service. Required.
755 },
756 ],
757 "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
758 {
759 "postalCodeRanges": [ # A range of postal codes. Required.
760 {
761 "postalCodeRangeBegin": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
762 "postalCodeRangeEnd": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.
763 },
764 ],
765 "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
766 "name": "A String", # The name of the postal code group, referred to in headers. Required.
767 },
768 ],
769 "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
770 }</pre>
771</div>
772
773<div class="method">
774 <code class="details" id="getsupportedcarriers">getsupportedcarriers(merchantId)</code>
775 <pre>Retrieves supported carriers and carrier services for an account.
776
777Args:
778 merchantId: string, The ID of the account for which to retrieve the supported carriers. (required)
779
780Returns:
781 An object of the form:
782
783 {
784 "kind": "content#shippingsettingsGetSupportedCarriersResponse", # Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedCarriersResponse".
785 "carriers": [ # A list of supported carriers. May be empty.
786 {
787 "services": [ # A list of supported services (e.g., "ground") for that carrier. Contains at least one service.
788 "A String",
789 ],
790 "country": "A String", # The CLDR country code of the carrier (e.g., "US"). Always present.
791 "name": "A String", # The name of the carrier (e.g., "UPS"). Always present.
792 },
793 ],
794 }</pre>
795</div>
796
797<div class="method">
798 <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]799 <pre>Lists the shipping settings of the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]800
801Args:
802 merchantId: string, The ID of the managing account. (required)
803 pageToken: string, The token returned by the previous request.
804 maxResults: integer, The maximum number of shipping settings to return in the response, used for paging.
805
806Returns:
807 An object of the form:
808
809 {
810 "nextPageToken": "A String", # The token for the retrieval of the next page of shipping settings.
811 "kind": "content#shippingsettingsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsListResponse".
812 "resources": [
813 { # The merchant account's shipping settings.
814 "services": [ # The target account's list of services. Optional.
815 {
816 "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
817 "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
818 "maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. Required.
819 "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Required.
820 },
821 "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
822 "rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
823 {
824 "applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
825 "A String",
826 ],
827 "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
828 {
829 "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
830 "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
831 "flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
832 "currency": "A String", # The currency of the price.
833 "value": "A String", # The price represented as a number.
834 },
835 "percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.
836 "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
837 "carrierService": "A String", # Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
838 },
839 ],
840 "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
841 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
842 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
843 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
844 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
845 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
846 "currency": "A String", # The currency of the price.
847 "value": "A String", # The price represented as a number.
848 },
849 },
850 "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
851 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
852 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
853 {
854 "currency": "A String", # The currency of the price.
855 "value": "A String", # The price represented as a number.
856 },
857 ],
858 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
859 "A String",
860 ],
861 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
862 {
863 "value": "A String", # The weight represented as a number.
864 "unit": "A String", # The weight unit.
865 },
866 ],
867 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
868 {
869 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
870 "A String",
871 ],
872 },
873 ],
874 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
875 "A String",
876 ],
877 },
878 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
879 {
880 "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
881 { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
882 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
883 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
884 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
885 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
886 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
887 "currency": "A String", # The currency of the price.
888 "value": "A String", # The price represented as a number.
889 },
890 },
891 ],
892 },
893 ],
894 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
895 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
896 {
897 "currency": "A String", # The currency of the price.
898 "value": "A String", # The price represented as a number.
899 },
900 ],
901 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
902 "A String",
903 ],
904 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
905 {
906 "value": "A String", # The weight represented as a number.
907 "unit": "A String", # The weight unit.
908 },
909 ],
910 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
911 {
912 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
913 "A String",
914 ],
915 },
916 ],
917 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
918 "A String",
919 ],
920 },
921 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
922 },
923 "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
924 {
925 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
926 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
927 {
928 "currency": "A String", # The currency of the price.
929 "value": "A String", # The price represented as a number.
930 },
931 ],
932 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
933 "A String",
934 ],
935 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
936 {
937 "value": "A String", # The weight represented as a number.
938 "unit": "A String", # The weight unit.
939 },
940 ],
941 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
942 {
943 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
944 "A String",
945 ],
946 },
947 ],
948 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
949 "A String",
950 ],
951 },
952 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
953 {
954 "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
955 { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
956 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
957 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
958 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
959 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
960 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
961 "currency": "A String", # The currency of the price.
962 "value": "A String", # The price represented as a number.
963 },
964 },
965 ],
966 },
967 ],
968 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
969 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
970 {
971 "currency": "A String", # The currency of the price.
972 "value": "A String", # The price represented as a number.
973 },
974 ],
975 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
976 "A String",
977 ],
978 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
979 {
980 "value": "A String", # The weight represented as a number.
981 "unit": "A String", # The weight unit.
982 },
983 ],
984 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
985 {
986 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
987 "A String",
988 ],
989 },
990 ],
991 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
992 "A String",
993 ],
994 },
995 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
996 },
997 ],
998 },
999 ],
1000 "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
1001 "active": True or False, # A boolean exposing the active status of the shipping service. Required.
1002 },
1003 ],
1004 "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
1005 {
1006 "postalCodeRanges": [ # A range of postal codes. Required.
1007 {
1008 "postalCodeRangeBegin": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
1009 "postalCodeRangeEnd": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.
1010 },
1011 ],
1012 "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
1013 "name": "A String", # The name of the postal code group, referred to in headers. Required.
1014 },
1015 ],
1016 "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
1017 },
1018 ],
1019 }</pre>
1020</div>
1021
1022<div class="method">
1023 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1024 <pre>Retrieves the next page of results.
1025
1026Args:
1027 previous_request: The request for the previous page. (required)
1028 previous_response: The response from the request for the previous page. (required)
1029
1030Returns:
1031 A request object that you can call 'execute()' on to request the next
1032 page. Returns None if there are no more items in the collection.
1033 </pre>
1034</div>
1035
1036<div class="method">
1037 <code class="details" id="patch">patch(merchantId, accountId, body, dryRun=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1038 <pre>Updates the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account. This method supports patch semantics.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1039
1040Args:
1041 merchantId: string, The ID of the managing account. (required)
1042 accountId: string, The ID of the account for which to get/update shipping settings. (required)
1043 body: object, The request body. (required)
1044 The object takes the form of:
1045
1046{ # The merchant account's shipping settings.
1047 "services": [ # The target account's list of services. Optional.
1048 {
1049 "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
1050 "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
1051 "maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. Required.
1052 "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Required.
1053 },
1054 "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
1055 "rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
1056 {
1057 "applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
1058 "A String",
1059 ],
1060 "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
1061 {
1062 "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
1063 "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
1064 "flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
1065 "currency": "A String", # The currency of the price.
1066 "value": "A String", # The price represented as a number.
1067 },
1068 "percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.
1069 "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
1070 "carrierService": "A String", # Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
1071 },
1072 ],
1073 "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
1074 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
1075 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
1076 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
1077 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
1078 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1079 "currency": "A String", # The currency of the price.
1080 "value": "A String", # The price represented as a number.
1081 },
1082 },
1083 "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
1084 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
1085 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
1086 {
1087 "currency": "A String", # The currency of the price.
1088 "value": "A String", # The price represented as a number.
1089 },
1090 ],
1091 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
1092 "A String",
1093 ],
1094 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
1095 {
1096 "value": "A String", # The weight represented as a number.
1097 "unit": "A String", # The weight unit.
1098 },
1099 ],
1100 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1101 {
1102 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1103 "A String",
1104 ],
1105 },
1106 ],
1107 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
1108 "A String",
1109 ],
1110 },
1111 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
1112 {
1113 "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
1114 { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
1115 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
1116 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
1117 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
1118 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
1119 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1120 "currency": "A String", # The currency of the price.
1121 "value": "A String", # The price represented as a number.
1122 },
1123 },
1124 ],
1125 },
1126 ],
1127 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
1128 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
1129 {
1130 "currency": "A String", # The currency of the price.
1131 "value": "A String", # The price represented as a number.
1132 },
1133 ],
1134 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
1135 "A String",
1136 ],
1137 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
1138 {
1139 "value": "A String", # The weight represented as a number.
1140 "unit": "A String", # The weight unit.
1141 },
1142 ],
1143 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1144 {
1145 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1146 "A String",
1147 ],
1148 },
1149 ],
1150 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
1151 "A String",
1152 ],
1153 },
1154 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
1155 },
1156 "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
1157 {
1158 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
1159 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
1160 {
1161 "currency": "A String", # The currency of the price.
1162 "value": "A String", # The price represented as a number.
1163 },
1164 ],
1165 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
1166 "A String",
1167 ],
1168 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
1169 {
1170 "value": "A String", # The weight represented as a number.
1171 "unit": "A String", # The weight unit.
1172 },
1173 ],
1174 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1175 {
1176 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1177 "A String",
1178 ],
1179 },
1180 ],
1181 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
1182 "A String",
1183 ],
1184 },
1185 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
1186 {
1187 "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
1188 { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
1189 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
1190 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
1191 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
1192 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
1193 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1194 "currency": "A String", # The currency of the price.
1195 "value": "A String", # The price represented as a number.
1196 },
1197 },
1198 ],
1199 },
1200 ],
1201 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
1202 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
1203 {
1204 "currency": "A String", # The currency of the price.
1205 "value": "A String", # The price represented as a number.
1206 },
1207 ],
1208 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
1209 "A String",
1210 ],
1211 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
1212 {
1213 "value": "A String", # The weight represented as a number.
1214 "unit": "A String", # The weight unit.
1215 },
1216 ],
1217 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1218 {
1219 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1220 "A String",
1221 ],
1222 },
1223 ],
1224 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
1225 "A String",
1226 ],
1227 },
1228 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
1229 },
1230 ],
1231 },
1232 ],
1233 "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
1234 "active": True or False, # A boolean exposing the active status of the shipping service. Required.
1235 },
1236 ],
1237 "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
1238 {
1239 "postalCodeRanges": [ # A range of postal codes. Required.
1240 {
1241 "postalCodeRangeBegin": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
1242 "postalCodeRangeEnd": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.
1243 },
1244 ],
1245 "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
1246 "name": "A String", # The name of the postal code group, referred to in headers. Required.
1247 },
1248 ],
1249 "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
1250}
1251
1252 dryRun: boolean, Flag to run the request in dry-run mode.
1253
1254Returns:
1255 An object of the form:
1256
1257 { # The merchant account's shipping settings.
1258 "services": [ # The target account's list of services. Optional.
1259 {
1260 "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
1261 "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
1262 "maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. Required.
1263 "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Required.
1264 },
1265 "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
1266 "rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
1267 {
1268 "applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
1269 "A String",
1270 ],
1271 "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
1272 {
1273 "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
1274 "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
1275 "flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
1276 "currency": "A String", # The currency of the price.
1277 "value": "A String", # The price represented as a number.
1278 },
1279 "percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.
1280 "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
1281 "carrierService": "A String", # Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
1282 },
1283 ],
1284 "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
1285 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
1286 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
1287 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
1288 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
1289 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1290 "currency": "A String", # The currency of the price.
1291 "value": "A String", # The price represented as a number.
1292 },
1293 },
1294 "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
1295 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
1296 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
1297 {
1298 "currency": "A String", # The currency of the price.
1299 "value": "A String", # The price represented as a number.
1300 },
1301 ],
1302 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
1303 "A String",
1304 ],
1305 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
1306 {
1307 "value": "A String", # The weight represented as a number.
1308 "unit": "A String", # The weight unit.
1309 },
1310 ],
1311 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1312 {
1313 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1314 "A String",
1315 ],
1316 },
1317 ],
1318 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
1319 "A String",
1320 ],
1321 },
1322 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
1323 {
1324 "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
1325 { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
1326 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
1327 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
1328 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
1329 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
1330 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1331 "currency": "A String", # The currency of the price.
1332 "value": "A String", # The price represented as a number.
1333 },
1334 },
1335 ],
1336 },
1337 ],
1338 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
1339 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
1340 {
1341 "currency": "A String", # The currency of the price.
1342 "value": "A String", # The price represented as a number.
1343 },
1344 ],
1345 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
1346 "A String",
1347 ],
1348 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
1349 {
1350 "value": "A String", # The weight represented as a number.
1351 "unit": "A String", # The weight unit.
1352 },
1353 ],
1354 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1355 {
1356 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1357 "A String",
1358 ],
1359 },
1360 ],
1361 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
1362 "A String",
1363 ],
1364 },
1365 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
1366 },
1367 "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
1368 {
1369 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
1370 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
1371 {
1372 "currency": "A String", # The currency of the price.
1373 "value": "A String", # The price represented as a number.
1374 },
1375 ],
1376 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
1377 "A String",
1378 ],
1379 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
1380 {
1381 "value": "A String", # The weight represented as a number.
1382 "unit": "A String", # The weight unit.
1383 },
1384 ],
1385 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1386 {
1387 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1388 "A String",
1389 ],
1390 },
1391 ],
1392 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
1393 "A String",
1394 ],
1395 },
1396 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
1397 {
1398 "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
1399 { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
1400 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
1401 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
1402 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
1403 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
1404 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1405 "currency": "A String", # The currency of the price.
1406 "value": "A String", # The price represented as a number.
1407 },
1408 },
1409 ],
1410 },
1411 ],
1412 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
1413 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
1414 {
1415 "currency": "A String", # The currency of the price.
1416 "value": "A String", # The price represented as a number.
1417 },
1418 ],
1419 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
1420 "A String",
1421 ],
1422 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
1423 {
1424 "value": "A String", # The weight represented as a number.
1425 "unit": "A String", # The weight unit.
1426 },
1427 ],
1428 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1429 {
1430 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1431 "A String",
1432 ],
1433 },
1434 ],
1435 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
1436 "A String",
1437 ],
1438 },
1439 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
1440 },
1441 ],
1442 },
1443 ],
1444 "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
1445 "active": True or False, # A boolean exposing the active status of the shipping service. Required.
1446 },
1447 ],
1448 "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
1449 {
1450 "postalCodeRanges": [ # A range of postal codes. Required.
1451 {
1452 "postalCodeRangeBegin": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
1453 "postalCodeRangeEnd": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.
1454 },
1455 ],
1456 "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
1457 "name": "A String", # The name of the postal code group, referred to in headers. Required.
1458 },
1459 ],
1460 "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
1461 }</pre>
1462</div>
1463
1464<div class="method">
1465 <code class="details" id="update">update(merchantId, accountId, body, dryRun=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1466 <pre>Updates the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1467
1468Args:
1469 merchantId: string, The ID of the managing account. (required)
1470 accountId: string, The ID of the account for which to get/update shipping settings. (required)
1471 body: object, The request body. (required)
1472 The object takes the form of:
1473
1474{ # The merchant account's shipping settings.
1475 "services": [ # The target account's list of services. Optional.
1476 {
1477 "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
1478 "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
1479 "maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. Required.
1480 "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Required.
1481 },
1482 "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
1483 "rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
1484 {
1485 "applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
1486 "A String",
1487 ],
1488 "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
1489 {
1490 "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
1491 "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
1492 "flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
1493 "currency": "A String", # The currency of the price.
1494 "value": "A String", # The price represented as a number.
1495 },
1496 "percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.
1497 "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
1498 "carrierService": "A String", # Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
1499 },
1500 ],
1501 "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
1502 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
1503 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
1504 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
1505 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
1506 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1507 "currency": "A String", # The currency of the price.
1508 "value": "A String", # The price represented as a number.
1509 },
1510 },
1511 "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
1512 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
1513 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
1514 {
1515 "currency": "A String", # The currency of the price.
1516 "value": "A String", # The price represented as a number.
1517 },
1518 ],
1519 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
1520 "A String",
1521 ],
1522 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
1523 {
1524 "value": "A String", # The weight represented as a number.
1525 "unit": "A String", # The weight unit.
1526 },
1527 ],
1528 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1529 {
1530 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1531 "A String",
1532 ],
1533 },
1534 ],
1535 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
1536 "A String",
1537 ],
1538 },
1539 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
1540 {
1541 "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
1542 { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
1543 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
1544 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
1545 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
1546 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
1547 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1548 "currency": "A String", # The currency of the price.
1549 "value": "A String", # The price represented as a number.
1550 },
1551 },
1552 ],
1553 },
1554 ],
1555 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
1556 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
1557 {
1558 "currency": "A String", # The currency of the price.
1559 "value": "A String", # The price represented as a number.
1560 },
1561 ],
1562 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
1563 "A String",
1564 ],
1565 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
1566 {
1567 "value": "A String", # The weight represented as a number.
1568 "unit": "A String", # The weight unit.
1569 },
1570 ],
1571 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1572 {
1573 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1574 "A String",
1575 ],
1576 },
1577 ],
1578 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
1579 "A String",
1580 ],
1581 },
1582 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
1583 },
1584 "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
1585 {
1586 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
1587 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
1588 {
1589 "currency": "A String", # The currency of the price.
1590 "value": "A String", # The price represented as a number.
1591 },
1592 ],
1593 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
1594 "A String",
1595 ],
1596 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
1597 {
1598 "value": "A String", # The weight represented as a number.
1599 "unit": "A String", # The weight unit.
1600 },
1601 ],
1602 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1603 {
1604 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1605 "A String",
1606 ],
1607 },
1608 ],
1609 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
1610 "A String",
1611 ],
1612 },
1613 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
1614 {
1615 "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
1616 { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
1617 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
1618 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
1619 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
1620 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
1621 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1622 "currency": "A String", # The currency of the price.
1623 "value": "A String", # The price represented as a number.
1624 },
1625 },
1626 ],
1627 },
1628 ],
1629 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
1630 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
1631 {
1632 "currency": "A String", # The currency of the price.
1633 "value": "A String", # The price represented as a number.
1634 },
1635 ],
1636 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
1637 "A String",
1638 ],
1639 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
1640 {
1641 "value": "A String", # The weight represented as a number.
1642 "unit": "A String", # The weight unit.
1643 },
1644 ],
1645 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1646 {
1647 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1648 "A String",
1649 ],
1650 },
1651 ],
1652 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
1653 "A String",
1654 ],
1655 },
1656 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
1657 },
1658 ],
1659 },
1660 ],
1661 "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
1662 "active": True or False, # A boolean exposing the active status of the shipping service. Required.
1663 },
1664 ],
1665 "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
1666 {
1667 "postalCodeRanges": [ # A range of postal codes. Required.
1668 {
1669 "postalCodeRangeBegin": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
1670 "postalCodeRangeEnd": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.
1671 },
1672 ],
1673 "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
1674 "name": "A String", # The name of the postal code group, referred to in headers. Required.
1675 },
1676 ],
1677 "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
1678}
1679
1680 dryRun: boolean, Flag to run the request in dry-run mode.
1681
1682Returns:
1683 An object of the form:
1684
1685 { # The merchant account's shipping settings.
1686 "services": [ # The target account's list of services. Optional.
1687 {
1688 "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
1689 "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
1690 "maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. Required.
1691 "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Required.
1692 },
1693 "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
1694 "rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
1695 {
1696 "applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
1697 "A String",
1698 ],
1699 "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
1700 {
1701 "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
1702 "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
1703 "flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
1704 "currency": "A String", # The currency of the price.
1705 "value": "A String", # The price represented as a number.
1706 },
1707 "percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.
1708 "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
1709 "carrierService": "A String", # Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
1710 },
1711 ],
1712 "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
1713 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
1714 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
1715 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
1716 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
1717 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1718 "currency": "A String", # The currency of the price.
1719 "value": "A String", # The price represented as a number.
1720 },
1721 },
1722 "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
1723 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
1724 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
1725 {
1726 "currency": "A String", # The currency of the price.
1727 "value": "A String", # The price represented as a number.
1728 },
1729 ],
1730 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
1731 "A String",
1732 ],
1733 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
1734 {
1735 "value": "A String", # The weight represented as a number.
1736 "unit": "A String", # The weight unit.
1737 },
1738 ],
1739 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1740 {
1741 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1742 "A String",
1743 ],
1744 },
1745 ],
1746 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
1747 "A String",
1748 ],
1749 },
1750 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
1751 {
1752 "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
1753 { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
1754 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
1755 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
1756 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
1757 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
1758 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1759 "currency": "A String", # The currency of the price.
1760 "value": "A String", # The price represented as a number.
1761 },
1762 },
1763 ],
1764 },
1765 ],
1766 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
1767 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
1768 {
1769 "currency": "A String", # The currency of the price.
1770 "value": "A String", # The price represented as a number.
1771 },
1772 ],
1773 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
1774 "A String",
1775 ],
1776 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
1777 {
1778 "value": "A String", # The weight represented as a number.
1779 "unit": "A String", # The weight unit.
1780 },
1781 ],
1782 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1783 {
1784 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1785 "A String",
1786 ],
1787 },
1788 ],
1789 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
1790 "A String",
1791 ],
1792 },
1793 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
1794 },
1795 "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
1796 {
1797 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's rows. Required.
1798 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
1799 {
1800 "currency": "A String", # The currency of the price.
1801 "value": "A String", # The price represented as a number.
1802 },
1803 ],
1804 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
1805 "A String",
1806 ],
1807 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
1808 {
1809 "value": "A String", # The weight represented as a number.
1810 "unit": "A String", # The weight unit.
1811 },
1812 ],
1813 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1814 {
1815 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1816 "A String",
1817 ],
1818 },
1819 ],
1820 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
1821 "A String",
1822 ],
1823 },
1824 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
1825 {
1826 "cells": [ # The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
1827 { # The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.
1828 "carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
1829 "noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
1830 "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set.
1831 "subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
1832 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1833 "currency": "A String", # The currency of the price.
1834 "value": "A String", # The price represented as a number.
1835 },
1836 },
1837 ],
1838 },
1839 ],
1840 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or locations must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
1841 "prices": [ # be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
1842 {
1843 "currency": "A String", # The currency of the price.
1844 "value": "A String", # The price represented as a number.
1845 },
1846 ],
1847 "postalCodeGroupNames": [ # A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
1848 "A String",
1849 ],
1850 "weights": [ # be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
1851 {
1852 "value": "A String", # The weight represented as a number.
1853 "unit": "A String", # The weight unit.
1854 },
1855 ],
1856 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1857 {
1858 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1859 "A String",
1860 ],
1861 },
1862 ],
1863 "numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set.
1864 "A String",
1865 ],
1866 },
1867 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
1868 },
1869 ],
1870 },
1871 ],
1872 "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
1873 "active": True or False, # A boolean exposing the active status of the shipping service. Required.
1874 },
1875 ],
1876 "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
1877 {
1878 "postalCodeRanges": [ # A range of postal codes. Required.
1879 {
1880 "postalCodeRangeBegin": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
1881 "postalCodeRangeEnd": "A String", # A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.
1882 },
1883 ],
1884 "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
1885 "name": "A String", # The name of the postal code group, referred to in headers. Required.
1886 },
1887 ],
1888 "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
1889 }</pre>
1890</div>
1891
1892</body></html>