Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / content_v2.shippingsettings.html
blob: a9c29c8f89700c8b1f8b7d1f9898b8b77b110edd [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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]82<p class="firstline">Retrieves the shipping settings of the 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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]87 <code><a href="#getsupportedholidays">getsupportedholidays(merchantId)</a></code></p>
88<p class="firstline">Retrieves supported holidays for an account.</p>
89<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]90 <code><a href="#list">list(merchantId, pageToken=None, maxResults=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]91<p class="firstline">Lists the shipping settings of the sub-accounts in your Merchant Center account.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#patch">patch(merchantId, accountId, body, dryRun=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]97<p class="firstline">Updates the shipping settings of the account. This method supports patch semantics.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]98<p class="toc_element">
99 <code><a href="#update">update(merchantId, accountId, body, dryRun=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]100<p class="firstline">Updates the shipping settings of the account.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="custombatch">custombatch(body, dryRun=None)</code>
104 <pre>Retrieves and updates the shipping settings of multiple accounts in a single request.
105
106Args:
107 body: object, The request body. (required)
108 The object takes the form of:
109
110{
111 "entries": [ # The request entries to be processed in the batch.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]112 { # A batch entry encoding a single non-batch shippingsettings request.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]113 "batchId": 42, # An entry ID, unique within the batch request.
114 "method": "A String",
115 "merchantId": "A String", # The ID of the managing account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]116 "shippingSettings": { # The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role. # The account shipping settings to update. Only defined if the method is update.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]117 "services": [ # The target account's list of services. Optional.
118 {
119 "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
120 "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]121 "maxHandlingTimeInDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to minHandlingTimeInDays.
122 "transitTimeTable": { # Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}transitTimeInDays or transitTimeTable can be set, but not both.
123 "rows": [
124 {
125 "values": [
126 {
127 "maxTransitTimeInDays": 42, # Must be greater than or equal to minTransitTimeInDays.
128 "minTransitTimeInDays": 42, # Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.
129 },
130 ],
131 },
132 ],
133 "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.
134 "A String",
135 ],
136 "transitTimeLabels": [ # A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"].
137 "A String",
138 ],
139 },
140 "minHandlingTimeInDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
141 "cutoffTime": { # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
142 "timezone": "A String", # Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
143 "minute": 42, # Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.
144 "hour": 42, # Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.
145 },
146 "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.
147 "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}transitTimeInDays or transitTimeTable must be set, but not both.
148 "holidayCutoffs": [ # Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
149 {
150 "visibleFromDate": "A String", # Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.
151 "deadlineHour": 42, # Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.
152 "holidayId": "A String", # Unique identifier for the holiday. Required.
153 "deadlineDate": "A String", # Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.
154 "deadlineTimezone": "A String", # Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
155 },
156 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]157 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]158 "eligibility": "A String", # Eligibility for this service.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]159 "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
160 "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.
161 {
162 "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.
163 "A String",
164 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]165 "name": "A String", # Name of the rate group. Optional. If set has to be unique within shipping service.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]166 "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
167 {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]168 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's rows. Required.
169 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]170 {
171 "currency": "A String", # The currency of the price.
172 "value": "A String", # The price represented as a number.
173 },
174 ],
175 "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.
176 "A String",
177 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]178 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]179 {
180 "value": "A String", # The weight represented as a number.
181 "unit": "A String", # The weight unit.
182 },
183 ],
184 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
185 {
186 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
187 "A String",
188 ],
189 },
190 ],
191 "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.
192 "A String",
193 ],
194 },
195 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
196 {
197 "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.
198 { # 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.
199 "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.
200 "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.
201 "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.
202 "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.
203 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
204 "currency": "A String", # The currency of the price.
205 "value": "A String", # The price represented as a number.
206 },
207 },
208 ],
209 },
210 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]211 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
212 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]213 {
214 "currency": "A String", # The currency of the price.
215 "value": "A String", # The price represented as a number.
216 },
217 ],
218 "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.
219 "A String",
220 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]221 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]222 {
223 "value": "A String", # The weight represented as a number.
224 "unit": "A String", # The weight unit.
225 },
226 ],
227 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
228 {
229 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
230 "A String",
231 ],
232 },
233 ],
234 "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.
235 "A String",
236 ],
237 },
238 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
239 },
240 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]241 "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
242 {
243 "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
244 "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
245 "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.
246 "currency": "A String", # The currency of the price.
247 "value": "A String", # The price represented as a number.
248 },
249 "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.
250 "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
251 "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.
252 },
253 ],
254 "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
255 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's rows. Required.
256 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
257 {
258 "currency": "A String", # The currency of the price.
259 "value": "A String", # The price represented as a number.
260 },
261 ],
262 "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.
263 "A String",
264 ],
265 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
266 {
267 "value": "A String", # The weight represented as a number.
268 "unit": "A String", # The weight unit.
269 },
270 ],
271 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
272 {
273 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
274 "A String",
275 ],
276 },
277 ],
278 "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.
279 "A String",
280 ],
281 },
282 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
283 {
284 "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.
285 { # 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.
286 "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.
287 "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.
288 "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.
289 "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.
290 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
291 "currency": "A String", # The currency of the price.
292 "value": "A String", # The price represented as a number.
293 },
294 },
295 ],
296 },
297 ],
298 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
299 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
300 {
301 "currency": "A String", # The currency of the price.
302 "value": "A String", # The price represented as a number.
303 },
304 ],
305 "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.
306 "A String",
307 ],
308 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
309 {
310 "value": "A String", # The weight represented as a number.
311 "unit": "A String", # The weight unit.
312 },
313 ],
314 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
315 {
316 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
317 "A String",
318 ],
319 },
320 ],
321 "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.
322 "A String",
323 ],
324 },
325 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
326 },
327 "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.
328 "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.
329 "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.
330 "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.
331 "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.
332 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
333 "currency": "A String", # The currency of the price.
334 "value": "A String", # The price represented as a number.
335 },
336 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]337 },
338 ],
339 "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
340 "active": True or False, # A boolean exposing the active status of the shipping service. Required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]341 "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency.
342 "currency": "A String", # The currency of the price.
343 "value": "A String", # The price represented as a number.
344 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]345 },
346 ],
347 "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
348 {
349 "postalCodeRanges": [ # A range of postal codes. Required.
350 {
351 "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.
352 "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.
353 },
354 ],
355 "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
356 "name": "A String", # The name of the postal code group, referred to in headers. Required.
357 },
358 ],
359 "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
360 },
361 "accountId": "A String", # The ID of the account for which to get/update account shipping settings.
362 },
363 ],
364 }
365
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]366 dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]367
368Returns:
369 An object of the form:
370
371 {
372 "kind": "content#shippingsettingsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponse".
373 "entries": [ # The result of the execution of the batch requests.
374 { # A batch entry encoding a single non-batch shipping settings response.
375 "batchId": 42, # The ID of the request entry to which this entry responds.
376 "kind": "content#shippingsettingsCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponseEntry".
377 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if, and only if, the request failed.
378 "message": "A String", # The message of the first error in errors.
379 "code": 42, # The HTTP status of the first error in errors.
380 "errors": [ # A list of errors.
381 { # An error returned by the API.
382 "reason": "A String", # The error code.
383 "domain": "A String", # The domain of the error.
384 "message": "A String", # A description of the error.
385 },
386 ],
387 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]388 "shippingSettings": { # The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role. # The retrieved or updated account shipping settings.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]389 "services": [ # The target account's list of services. Optional.
390 {
391 "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
392 "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]393 "maxHandlingTimeInDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to minHandlingTimeInDays.
394 "transitTimeTable": { # Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}transitTimeInDays or transitTimeTable can be set, but not both.
395 "rows": [
396 {
397 "values": [
398 {
399 "maxTransitTimeInDays": 42, # Must be greater than or equal to minTransitTimeInDays.
400 "minTransitTimeInDays": 42, # Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.
401 },
402 ],
403 },
404 ],
405 "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.
406 "A String",
407 ],
408 "transitTimeLabels": [ # A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"].
409 "A String",
410 ],
411 },
412 "minHandlingTimeInDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
413 "cutoffTime": { # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
414 "timezone": "A String", # Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
415 "minute": 42, # Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.
416 "hour": 42, # Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.
417 },
418 "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.
419 "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}transitTimeInDays or transitTimeTable must be set, but not both.
420 "holidayCutoffs": [ # Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
421 {
422 "visibleFromDate": "A String", # Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.
423 "deadlineHour": 42, # Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.
424 "holidayId": "A String", # Unique identifier for the holiday. Required.
425 "deadlineDate": "A String", # Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.
426 "deadlineTimezone": "A String", # Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
427 },
428 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]429 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]430 "eligibility": "A String", # Eligibility for this service.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]431 "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
432 "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.
433 {
434 "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.
435 "A String",
436 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]437 "name": "A String", # Name of the rate group. Optional. If set has to be unique within shipping service.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]438 "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
439 {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]440 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's rows. Required.
441 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]442 {
443 "currency": "A String", # The currency of the price.
444 "value": "A String", # The price represented as a number.
445 },
446 ],
447 "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.
448 "A String",
449 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]450 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]451 {
452 "value": "A String", # The weight represented as a number.
453 "unit": "A String", # The weight unit.
454 },
455 ],
456 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
457 {
458 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
459 "A String",
460 ],
461 },
462 ],
463 "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.
464 "A String",
465 ],
466 },
467 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
468 {
469 "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.
470 { # 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.
471 "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.
472 "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.
473 "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.
474 "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.
475 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
476 "currency": "A String", # The currency of the price.
477 "value": "A String", # The price represented as a number.
478 },
479 },
480 ],
481 },
482 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]483 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
484 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]485 {
486 "currency": "A String", # The currency of the price.
487 "value": "A String", # The price represented as a number.
488 },
489 ],
490 "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.
491 "A String",
492 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]493 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]494 {
495 "value": "A String", # The weight represented as a number.
496 "unit": "A String", # The weight unit.
497 },
498 ],
499 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
500 {
501 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
502 "A String",
503 ],
504 },
505 ],
506 "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.
507 "A String",
508 ],
509 },
510 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
511 },
512 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]513 "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
514 {
515 "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
516 "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
517 "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.
518 "currency": "A String", # The currency of the price.
519 "value": "A String", # The price represented as a number.
520 },
521 "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.
522 "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
523 "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.
524 },
525 ],
526 "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
527 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's rows. Required.
528 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
529 {
530 "currency": "A String", # The currency of the price.
531 "value": "A String", # The price represented as a number.
532 },
533 ],
534 "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.
535 "A String",
536 ],
537 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
538 {
539 "value": "A String", # The weight represented as a number.
540 "unit": "A String", # The weight unit.
541 },
542 ],
543 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
544 {
545 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
546 "A String",
547 ],
548 },
549 ],
550 "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.
551 "A String",
552 ],
553 },
554 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
555 {
556 "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.
557 { # 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.
558 "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.
559 "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.
560 "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.
561 "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.
562 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
563 "currency": "A String", # The currency of the price.
564 "value": "A String", # The price represented as a number.
565 },
566 },
567 ],
568 },
569 ],
570 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
571 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
572 {
573 "currency": "A String", # The currency of the price.
574 "value": "A String", # The price represented as a number.
575 },
576 ],
577 "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.
578 "A String",
579 ],
580 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
581 {
582 "value": "A String", # The weight represented as a number.
583 "unit": "A String", # The weight unit.
584 },
585 ],
586 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
587 {
588 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
589 "A String",
590 ],
591 },
592 ],
593 "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.
594 "A String",
595 ],
596 },
597 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
598 },
599 "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.
600 "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.
601 "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.
602 "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.
603 "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.
604 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
605 "currency": "A String", # The currency of the price.
606 "value": "A String", # The price represented as a number.
607 },
608 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]609 },
610 ],
611 "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
612 "active": True or False, # A boolean exposing the active status of the shipping service. Required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]613 "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency.
614 "currency": "A String", # The currency of the price.
615 "value": "A String", # The price represented as a number.
616 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]617 },
618 ],
619 "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
620 {
621 "postalCodeRanges": [ # A range of postal codes. Required.
622 {
623 "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.
624 "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.
625 },
626 ],
627 "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
628 "name": "A String", # The name of the postal code group, referred to in headers. Required.
629 },
630 ],
631 "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
632 },
633 },
634 ],
635 }</pre>
636</div>
637
638<div class="method">
639 <code class="details" id="get">get(merchantId, accountId)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]640 <pre>Retrieves the shipping settings of the account.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]641
642Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]643 merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]644 accountId: string, The ID of the account for which to get/update shipping settings. (required)
645
646Returns:
647 An object of the form:
648
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]649 { # The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]650 "services": [ # The target account's list of services. Optional.
651 {
652 "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
653 "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]654 "maxHandlingTimeInDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to minHandlingTimeInDays.
655 "transitTimeTable": { # Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}transitTimeInDays or transitTimeTable can be set, but not both.
656 "rows": [
657 {
658 "values": [
659 {
660 "maxTransitTimeInDays": 42, # Must be greater than or equal to minTransitTimeInDays.
661 "minTransitTimeInDays": 42, # Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.
662 },
663 ],
664 },
665 ],
666 "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.
667 "A String",
668 ],
669 "transitTimeLabels": [ # A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"].
670 "A String",
671 ],
672 },
673 "minHandlingTimeInDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
674 "cutoffTime": { # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
675 "timezone": "A String", # Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
676 "minute": 42, # Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.
677 "hour": 42, # Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.
678 },
679 "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.
680 "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}transitTimeInDays or transitTimeTable must be set, but not both.
681 "holidayCutoffs": [ # Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
682 {
683 "visibleFromDate": "A String", # Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.
684 "deadlineHour": 42, # Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.
685 "holidayId": "A String", # Unique identifier for the holiday. Required.
686 "deadlineDate": "A String", # Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.
687 "deadlineTimezone": "A String", # Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
688 },
689 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]690 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]691 "eligibility": "A String", # Eligibility for this service.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]692 "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
693 "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.
694 {
695 "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.
696 "A String",
697 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]698 "name": "A String", # Name of the rate group. Optional. If set has to be unique within shipping service.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]699 "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
700 {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]701 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's rows. Required.
702 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]703 {
704 "currency": "A String", # The currency of the price.
705 "value": "A String", # The price represented as a number.
706 },
707 ],
708 "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.
709 "A String",
710 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]711 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]712 {
713 "value": "A String", # The weight represented as a number.
714 "unit": "A String", # The weight unit.
715 },
716 ],
717 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
718 {
719 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
720 "A String",
721 ],
722 },
723 ],
724 "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.
725 "A String",
726 ],
727 },
728 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
729 {
730 "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.
731 { # 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.
732 "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.
733 "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.
734 "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.
735 "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.
736 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
737 "currency": "A String", # The currency of the price.
738 "value": "A String", # The price represented as a number.
739 },
740 },
741 ],
742 },
743 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]744 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
745 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]746 {
747 "currency": "A String", # The currency of the price.
748 "value": "A String", # The price represented as a number.
749 },
750 ],
751 "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.
752 "A String",
753 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]754 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]755 {
756 "value": "A String", # The weight represented as a number.
757 "unit": "A String", # The weight unit.
758 },
759 ],
760 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
761 {
762 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
763 "A String",
764 ],
765 },
766 ],
767 "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.
768 "A String",
769 ],
770 },
771 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
772 },
773 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]774 "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
775 {
776 "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
777 "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
778 "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.
779 "currency": "A String", # The currency of the price.
780 "value": "A String", # The price represented as a number.
781 },
782 "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.
783 "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
784 "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.
785 },
786 ],
787 "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
788 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's rows. Required.
789 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
790 {
791 "currency": "A String", # The currency of the price.
792 "value": "A String", # The price represented as a number.
793 },
794 ],
795 "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.
796 "A String",
797 ],
798 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
799 {
800 "value": "A String", # The weight represented as a number.
801 "unit": "A String", # The weight unit.
802 },
803 ],
804 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
805 {
806 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
807 "A String",
808 ],
809 },
810 ],
811 "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.
812 "A String",
813 ],
814 },
815 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
816 {
817 "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.
818 { # 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.
819 "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.
820 "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.
821 "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.
822 "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.
823 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
824 "currency": "A String", # The currency of the price.
825 "value": "A String", # The price represented as a number.
826 },
827 },
828 ],
829 },
830 ],
831 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
832 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
833 {
834 "currency": "A String", # The currency of the price.
835 "value": "A String", # The price represented as a number.
836 },
837 ],
838 "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.
839 "A String",
840 ],
841 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
842 {
843 "value": "A String", # The weight represented as a number.
844 "unit": "A String", # The weight unit.
845 },
846 ],
847 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
848 {
849 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
850 "A String",
851 ],
852 },
853 ],
854 "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.
855 "A String",
856 ],
857 },
858 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
859 },
860 "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.
861 "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.
862 "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.
863 "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.
864 "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.
865 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
866 "currency": "A String", # The currency of the price.
867 "value": "A String", # The price represented as a number.
868 },
869 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]870 },
871 ],
872 "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
873 "active": True or False, # A boolean exposing the active status of the shipping service. Required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]874 "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency.
875 "currency": "A String", # The currency of the price.
876 "value": "A String", # The price represented as a number.
877 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]878 },
879 ],
880 "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
881 {
882 "postalCodeRanges": [ # A range of postal codes. Required.
883 {
884 "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.
885 "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.
886 },
887 ],
888 "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
889 "name": "A String", # The name of the postal code group, referred to in headers. Required.
890 },
891 ],
892 "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
893 }</pre>
894</div>
895
896<div class="method">
897 <code class="details" id="getsupportedcarriers">getsupportedcarriers(merchantId)</code>
898 <pre>Retrieves supported carriers and carrier services for an account.
899
900Args:
901 merchantId: string, The ID of the account for which to retrieve the supported carriers. (required)
902
903Returns:
904 An object of the form:
905
906 {
907 "kind": "content#shippingsettingsGetSupportedCarriersResponse", # Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedCarriersResponse".
908 "carriers": [ # A list of supported carriers. May be empty.
909 {
910 "services": [ # A list of supported services (e.g., "ground") for that carrier. Contains at least one service.
911 "A String",
912 ],
913 "country": "A String", # The CLDR country code of the carrier (e.g., "US"). Always present.
914 "name": "A String", # The name of the carrier (e.g., "UPS"). Always present.
915 },
916 ],
917 }</pre>
918</div>
919
920<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]921 <code class="details" id="getsupportedholidays">getsupportedholidays(merchantId)</code>
922 <pre>Retrieves supported holidays for an account.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]923
924Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]925 merchantId: string, The ID of the account for which to retrieve the supported holidays. (required)
926
927Returns:
928 An object of the form:
929
930 {
931 "kind": "content#shippingsettingsGetSupportedHolidaysResponse", # Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedHolidaysResponse".
932 "holidays": [ # A list of holidays applicable for delivery guarantees. May be empty.
933 {
934 "countryCode": "A String", # The CLDR territory code of the country in which the holiday is available. E.g. "US", "DE", "GB". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present.
935 "deliveryGuaranteeHour": "A String", # Hour of the day in the delivery location's timezone on the guaranteed delivery date by which the order has to arrive at the customer's. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always present.
936 "deliveryGuaranteeDate": "A String", # Date on which the order has to arrive at the customer's, in ISO 8601 format. E.g. "2016-12-24" for 24th December 2016. Always present.
937 "date": "A String", # Date of the holiday, in ISO 8601 format. E.g. "2016-12-25" for Christmas 2016. Always present.
938 "type": "A String", # The holiday type. Always present.
939 "id": "A String", # Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present.
940 },
941 ],
942 }</pre>
943</div>
944
945<div class="method">
946 <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None)</code>
947 <pre>Lists the shipping settings of the sub-accounts in your Merchant Center account.
948
949Args:
950 merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]951 pageToken: string, The token returned by the previous request.
952 maxResults: integer, The maximum number of shipping settings to return in the response, used for paging.
953
954Returns:
955 An object of the form:
956
957 {
958 "nextPageToken": "A String", # The token for the retrieval of the next page of shipping settings.
959 "kind": "content#shippingsettingsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsListResponse".
960 "resources": [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]961 { # The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]962 "services": [ # The target account's list of services. Optional.
963 {
964 "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
965 "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]966 "maxHandlingTimeInDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to minHandlingTimeInDays.
967 "transitTimeTable": { # Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}transitTimeInDays or transitTimeTable can be set, but not both.
968 "rows": [
969 {
970 "values": [
971 {
972 "maxTransitTimeInDays": 42, # Must be greater than or equal to minTransitTimeInDays.
973 "minTransitTimeInDays": 42, # Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.
974 },
975 ],
976 },
977 ],
978 "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.
979 "A String",
980 ],
981 "transitTimeLabels": [ # A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"].
982 "A String",
983 ],
984 },
985 "minHandlingTimeInDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
986 "cutoffTime": { # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
987 "timezone": "A String", # Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
988 "minute": 42, # Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.
989 "hour": 42, # Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.
990 },
991 "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.
992 "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}transitTimeInDays or transitTimeTable must be set, but not both.
993 "holidayCutoffs": [ # Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
994 {
995 "visibleFromDate": "A String", # Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.
996 "deadlineHour": 42, # Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.
997 "holidayId": "A String", # Unique identifier for the holiday. Required.
998 "deadlineDate": "A String", # Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.
999 "deadlineTimezone": "A String", # Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
1000 },
1001 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1002 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1003 "eligibility": "A String", # Eligibility for this service.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1004 "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
1005 "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.
1006 {
1007 "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.
1008 "A String",
1009 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1010 "name": "A String", # Name of the rate group. Optional. If set has to be unique within shipping service.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1011 "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
1012 {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1013 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's rows. Required.
1014 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1015 {
1016 "currency": "A String", # The currency of the price.
1017 "value": "A String", # The price represented as a number.
1018 },
1019 ],
1020 "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.
1021 "A String",
1022 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1023 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1024 {
1025 "value": "A String", # The weight represented as a number.
1026 "unit": "A String", # The weight unit.
1027 },
1028 ],
1029 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1030 {
1031 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1032 "A String",
1033 ],
1034 },
1035 ],
1036 "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.
1037 "A String",
1038 ],
1039 },
1040 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
1041 {
1042 "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.
1043 { # 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.
1044 "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.
1045 "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.
1046 "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.
1047 "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.
1048 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1049 "currency": "A String", # The currency of the price.
1050 "value": "A String", # The price represented as a number.
1051 },
1052 },
1053 ],
1054 },
1055 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1056 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
1057 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1058 {
1059 "currency": "A String", # The currency of the price.
1060 "value": "A String", # The price represented as a number.
1061 },
1062 ],
1063 "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.
1064 "A String",
1065 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1066 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1067 {
1068 "value": "A String", # The weight represented as a number.
1069 "unit": "A String", # The weight unit.
1070 },
1071 ],
1072 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1073 {
1074 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1075 "A String",
1076 ],
1077 },
1078 ],
1079 "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.
1080 "A String",
1081 ],
1082 },
1083 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
1084 },
1085 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1086 "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
1087 {
1088 "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
1089 "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
1090 "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.
1091 "currency": "A String", # The currency of the price.
1092 "value": "A String", # The price represented as a number.
1093 },
1094 "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.
1095 "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
1096 "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.
1097 },
1098 ],
1099 "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
1100 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's rows. Required.
1101 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
1102 {
1103 "currency": "A String", # The currency of the price.
1104 "value": "A String", # The price represented as a number.
1105 },
1106 ],
1107 "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.
1108 "A String",
1109 ],
1110 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
1111 {
1112 "value": "A String", # The weight represented as a number.
1113 "unit": "A String", # The weight unit.
1114 },
1115 ],
1116 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1117 {
1118 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1119 "A String",
1120 ],
1121 },
1122 ],
1123 "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.
1124 "A String",
1125 ],
1126 },
1127 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
1128 {
1129 "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.
1130 { # 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.
1131 "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.
1132 "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.
1133 "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.
1134 "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.
1135 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1136 "currency": "A String", # The currency of the price.
1137 "value": "A String", # The price represented as a number.
1138 },
1139 },
1140 ],
1141 },
1142 ],
1143 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
1144 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
1145 {
1146 "currency": "A String", # The currency of the price.
1147 "value": "A String", # The price represented as a number.
1148 },
1149 ],
1150 "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.
1151 "A String",
1152 ],
1153 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
1154 {
1155 "value": "A String", # The weight represented as a number.
1156 "unit": "A String", # The weight unit.
1157 },
1158 ],
1159 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1160 {
1161 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1162 "A String",
1163 ],
1164 },
1165 ],
1166 "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.
1167 "A String",
1168 ],
1169 },
1170 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
1171 },
1172 "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.
1173 "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.
1174 "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.
1175 "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.
1176 "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.
1177 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1178 "currency": "A String", # The currency of the price.
1179 "value": "A String", # The price represented as a number.
1180 },
1181 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1182 },
1183 ],
1184 "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
1185 "active": True or False, # A boolean exposing the active status of the shipping service. Required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1186 "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency.
1187 "currency": "A String", # The currency of the price.
1188 "value": "A String", # The price represented as a number.
1189 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1190 },
1191 ],
1192 "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
1193 {
1194 "postalCodeRanges": [ # A range of postal codes. Required.
1195 {
1196 "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.
1197 "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.
1198 },
1199 ],
1200 "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
1201 "name": "A String", # The name of the postal code group, referred to in headers. Required.
1202 },
1203 ],
1204 "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
1205 },
1206 ],
1207 }</pre>
1208</div>
1209
1210<div class="method">
1211 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1212 <pre>Retrieves the next page of results.
1213
1214Args:
1215 previous_request: The request for the previous page. (required)
1216 previous_response: The response from the request for the previous page. (required)
1217
1218Returns:
1219 A request object that you can call 'execute()' on to request the next
1220 page. Returns None if there are no more items in the collection.
1221 </pre>
1222</div>
1223
1224<div class="method">
1225 <code class="details" id="patch">patch(merchantId, accountId, body, dryRun=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1226 <pre>Updates the shipping settings of the account. This method supports patch semantics.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1227
1228Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1229 merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1230 accountId: string, The ID of the account for which to get/update shipping settings. (required)
1231 body: object, The request body. (required)
1232 The object takes the form of:
1233
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1234{ # The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1235 "services": [ # The target account's list of services. Optional.
1236 {
1237 "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
1238 "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1239 "maxHandlingTimeInDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to minHandlingTimeInDays.
1240 "transitTimeTable": { # Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}transitTimeInDays or transitTimeTable can be set, but not both.
1241 "rows": [
1242 {
1243 "values": [
1244 {
1245 "maxTransitTimeInDays": 42, # Must be greater than or equal to minTransitTimeInDays.
1246 "minTransitTimeInDays": 42, # Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.
1247 },
1248 ],
1249 },
1250 ],
1251 "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.
1252 "A String",
1253 ],
1254 "transitTimeLabels": [ # A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"].
1255 "A String",
1256 ],
1257 },
1258 "minHandlingTimeInDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
1259 "cutoffTime": { # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
1260 "timezone": "A String", # Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
1261 "minute": 42, # Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.
1262 "hour": 42, # Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.
1263 },
1264 "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.
1265 "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}transitTimeInDays or transitTimeTable must be set, but not both.
1266 "holidayCutoffs": [ # Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
1267 {
1268 "visibleFromDate": "A String", # Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.
1269 "deadlineHour": 42, # Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.
1270 "holidayId": "A String", # Unique identifier for the holiday. Required.
1271 "deadlineDate": "A String", # Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.
1272 "deadlineTimezone": "A String", # Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
1273 },
1274 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1275 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1276 "eligibility": "A String", # Eligibility for this service.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1277 "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
1278 "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.
1279 {
1280 "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.
1281 "A String",
1282 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1283 "name": "A String", # Name of the rate group. Optional. If set has to be unique within shipping service.
1284 "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
1285 {
1286 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's rows. Required.
1287 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
1288 {
1289 "currency": "A String", # The currency of the price.
1290 "value": "A String", # The price represented as a number.
1291 },
1292 ],
1293 "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.
1294 "A String",
1295 ],
1296 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
1297 {
1298 "value": "A String", # The weight represented as a number.
1299 "unit": "A String", # The weight unit.
1300 },
1301 ],
1302 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1303 {
1304 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1305 "A String",
1306 ],
1307 },
1308 ],
1309 "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.
1310 "A String",
1311 ],
1312 },
1313 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
1314 {
1315 "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.
1316 { # 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.
1317 "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.
1318 "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.
1319 "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.
1320 "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.
1321 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1322 "currency": "A String", # The currency of the price.
1323 "value": "A String", # The price represented as a number.
1324 },
1325 },
1326 ],
1327 },
1328 ],
1329 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
1330 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
1331 {
1332 "currency": "A String", # The currency of the price.
1333 "value": "A String", # The price represented as a number.
1334 },
1335 ],
1336 "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.
1337 "A String",
1338 ],
1339 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
1340 {
1341 "value": "A String", # The weight represented as a number.
1342 "unit": "A String", # The weight unit.
1343 },
1344 ],
1345 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1346 {
1347 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1348 "A String",
1349 ],
1350 },
1351 ],
1352 "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.
1353 "A String",
1354 ],
1355 },
1356 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
1357 },
1358 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1359 "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
1360 {
1361 "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
1362 "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
1363 "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.
1364 "currency": "A String", # The currency of the price.
1365 "value": "A String", # The price represented as a number.
1366 },
1367 "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.
1368 "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
1369 "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.
1370 },
1371 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1372 "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1373 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's rows. Required.
1374 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1375 {
1376 "currency": "A String", # The currency of the price.
1377 "value": "A String", # The price represented as a number.
1378 },
1379 ],
1380 "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.
1381 "A String",
1382 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1383 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1384 {
1385 "value": "A String", # The weight represented as a number.
1386 "unit": "A String", # The weight unit.
1387 },
1388 ],
1389 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1390 {
1391 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1392 "A String",
1393 ],
1394 },
1395 ],
1396 "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.
1397 "A String",
1398 ],
1399 },
1400 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
1401 {
1402 "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.
1403 { # 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.
1404 "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.
1405 "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.
1406 "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.
1407 "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.
1408 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1409 "currency": "A String", # The currency of the price.
1410 "value": "A String", # The price represented as a number.
1411 },
1412 },
1413 ],
1414 },
1415 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1416 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
1417 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1418 {
1419 "currency": "A String", # The currency of the price.
1420 "value": "A String", # The price represented as a number.
1421 },
1422 ],
1423 "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.
1424 "A String",
1425 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1426 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1427 {
1428 "value": "A String", # The weight represented as a number.
1429 "unit": "A String", # The weight unit.
1430 },
1431 ],
1432 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1433 {
1434 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1435 "A String",
1436 ],
1437 },
1438 ],
1439 "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.
1440 "A String",
1441 ],
1442 },
1443 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
1444 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1445 "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.
1446 "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.
1447 "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.
1448 "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.
1449 "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.
1450 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1451 "currency": "A String", # The currency of the price.
1452 "value": "A String", # The price represented as a number.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1453 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1454 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1455 },
1456 ],
1457 "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
1458 "active": True or False, # A boolean exposing the active status of the shipping service. Required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1459 "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency.
1460 "currency": "A String", # The currency of the price.
1461 "value": "A String", # The price represented as a number.
1462 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1463 },
1464 ],
1465 "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
1466 {
1467 "postalCodeRanges": [ # A range of postal codes. Required.
1468 {
1469 "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.
1470 "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.
1471 },
1472 ],
1473 "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
1474 "name": "A String", # The name of the postal code group, referred to in headers. Required.
1475 },
1476 ],
1477 "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
1478}
1479
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1480 dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1481
1482Returns:
1483 An object of the form:
1484
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1485 { # The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1486 "services": [ # The target account's list of services. Optional.
1487 {
1488 "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
1489 "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1490 "maxHandlingTimeInDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to minHandlingTimeInDays.
1491 "transitTimeTable": { # Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}transitTimeInDays or transitTimeTable can be set, but not both.
1492 "rows": [
1493 {
1494 "values": [
1495 {
1496 "maxTransitTimeInDays": 42, # Must be greater than or equal to minTransitTimeInDays.
1497 "minTransitTimeInDays": 42, # Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.
1498 },
1499 ],
1500 },
1501 ],
1502 "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.
1503 "A String",
1504 ],
1505 "transitTimeLabels": [ # A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"].
1506 "A String",
1507 ],
1508 },
1509 "minHandlingTimeInDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
1510 "cutoffTime": { # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
1511 "timezone": "A String", # Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
1512 "minute": 42, # Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.
1513 "hour": 42, # Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.
1514 },
1515 "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.
1516 "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}transitTimeInDays or transitTimeTable must be set, but not both.
1517 "holidayCutoffs": [ # Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
1518 {
1519 "visibleFromDate": "A String", # Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.
1520 "deadlineHour": 42, # Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.
1521 "holidayId": "A String", # Unique identifier for the holiday. Required.
1522 "deadlineDate": "A String", # Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.
1523 "deadlineTimezone": "A String", # Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
1524 },
1525 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1526 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1527 "eligibility": "A String", # Eligibility for this service.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1528 "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
1529 "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.
1530 {
1531 "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.
1532 "A String",
1533 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1534 "name": "A String", # Name of the rate group. Optional. If set has to be unique within shipping service.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1535 "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
1536 {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1537 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's rows. Required.
1538 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1539 {
1540 "currency": "A String", # The currency of the price.
1541 "value": "A String", # The price represented as a number.
1542 },
1543 ],
1544 "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.
1545 "A String",
1546 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1547 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1548 {
1549 "value": "A String", # The weight represented as a number.
1550 "unit": "A String", # The weight unit.
1551 },
1552 ],
1553 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1554 {
1555 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1556 "A String",
1557 ],
1558 },
1559 ],
1560 "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.
1561 "A String",
1562 ],
1563 },
1564 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
1565 {
1566 "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.
1567 { # 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.
1568 "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.
1569 "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.
1570 "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.
1571 "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.
1572 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1573 "currency": "A String", # The currency of the price.
1574 "value": "A String", # The price represented as a number.
1575 },
1576 },
1577 ],
1578 },
1579 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1580 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
1581 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1582 {
1583 "currency": "A String", # The currency of the price.
1584 "value": "A String", # The price represented as a number.
1585 },
1586 ],
1587 "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.
1588 "A String",
1589 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1590 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1591 {
1592 "value": "A String", # The weight represented as a number.
1593 "unit": "A String", # The weight unit.
1594 },
1595 ],
1596 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1597 {
1598 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1599 "A String",
1600 ],
1601 },
1602 ],
1603 "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.
1604 "A String",
1605 ],
1606 },
1607 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
1608 },
1609 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1610 "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
1611 {
1612 "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
1613 "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
1614 "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.
1615 "currency": "A String", # The currency of the price.
1616 "value": "A String", # The price represented as a number.
1617 },
1618 "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.
1619 "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
1620 "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.
1621 },
1622 ],
1623 "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
1624 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's rows. Required.
1625 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
1626 {
1627 "currency": "A String", # The currency of the price.
1628 "value": "A String", # The price represented as a number.
1629 },
1630 ],
1631 "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.
1632 "A String",
1633 ],
1634 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
1635 {
1636 "value": "A String", # The weight represented as a number.
1637 "unit": "A String", # The weight unit.
1638 },
1639 ],
1640 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1641 {
1642 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1643 "A String",
1644 ],
1645 },
1646 ],
1647 "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.
1648 "A String",
1649 ],
1650 },
1651 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
1652 {
1653 "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.
1654 { # 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.
1655 "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.
1656 "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.
1657 "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.
1658 "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.
1659 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1660 "currency": "A String", # The currency of the price.
1661 "value": "A String", # The price represented as a number.
1662 },
1663 },
1664 ],
1665 },
1666 ],
1667 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
1668 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
1669 {
1670 "currency": "A String", # The currency of the price.
1671 "value": "A String", # The price represented as a number.
1672 },
1673 ],
1674 "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.
1675 "A String",
1676 ],
1677 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
1678 {
1679 "value": "A String", # The weight represented as a number.
1680 "unit": "A String", # The weight unit.
1681 },
1682 ],
1683 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1684 {
1685 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1686 "A String",
1687 ],
1688 },
1689 ],
1690 "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.
1691 "A String",
1692 ],
1693 },
1694 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
1695 },
1696 "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.
1697 "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.
1698 "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.
1699 "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.
1700 "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.
1701 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1702 "currency": "A String", # The currency of the price.
1703 "value": "A String", # The price represented as a number.
1704 },
1705 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1706 },
1707 ],
1708 "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
1709 "active": True or False, # A boolean exposing the active status of the shipping service. Required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1710 "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency.
1711 "currency": "A String", # The currency of the price.
1712 "value": "A String", # The price represented as a number.
1713 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1714 },
1715 ],
1716 "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
1717 {
1718 "postalCodeRanges": [ # A range of postal codes. Required.
1719 {
1720 "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.
1721 "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.
1722 },
1723 ],
1724 "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
1725 "name": "A String", # The name of the postal code group, referred to in headers. Required.
1726 },
1727 ],
1728 "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
1729 }</pre>
1730</div>
1731
1732<div class="method">
1733 <code class="details" id="update">update(merchantId, accountId, body, dryRun=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1734 <pre>Updates the shipping settings of the account.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1735
1736Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1737 merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1738 accountId: string, The ID of the account for which to get/update shipping settings. (required)
1739 body: object, The request body. (required)
1740 The object takes the form of:
1741
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1742{ # The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1743 "services": [ # The target account's list of services. Optional.
1744 {
1745 "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
1746 "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1747 "maxHandlingTimeInDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to minHandlingTimeInDays.
1748 "transitTimeTable": { # Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}transitTimeInDays or transitTimeTable can be set, but not both.
1749 "rows": [
1750 {
1751 "values": [
1752 {
1753 "maxTransitTimeInDays": 42, # Must be greater than or equal to minTransitTimeInDays.
1754 "minTransitTimeInDays": 42, # Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.
1755 },
1756 ],
1757 },
1758 ],
1759 "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.
1760 "A String",
1761 ],
1762 "transitTimeLabels": [ # A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"].
1763 "A String",
1764 ],
1765 },
1766 "minHandlingTimeInDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
1767 "cutoffTime": { # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
1768 "timezone": "A String", # Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
1769 "minute": 42, # Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.
1770 "hour": 42, # Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.
1771 },
1772 "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.
1773 "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}transitTimeInDays or transitTimeTable must be set, but not both.
1774 "holidayCutoffs": [ # Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
1775 {
1776 "visibleFromDate": "A String", # Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.
1777 "deadlineHour": 42, # Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.
1778 "holidayId": "A String", # Unique identifier for the holiday. Required.
1779 "deadlineDate": "A String", # Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.
1780 "deadlineTimezone": "A String", # Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
1781 },
1782 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1783 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1784 "eligibility": "A String", # Eligibility for this service.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1785 "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
1786 "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.
1787 {
1788 "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.
1789 "A String",
1790 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1791 "name": "A String", # Name of the rate group. Optional. If set has to be unique within shipping service.
1792 "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
1793 {
1794 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's rows. Required.
1795 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
1796 {
1797 "currency": "A String", # The currency of the price.
1798 "value": "A String", # The price represented as a number.
1799 },
1800 ],
1801 "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.
1802 "A String",
1803 ],
1804 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
1805 {
1806 "value": "A String", # The weight represented as a number.
1807 "unit": "A String", # The weight unit.
1808 },
1809 ],
1810 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1811 {
1812 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1813 "A String",
1814 ],
1815 },
1816 ],
1817 "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.
1818 "A String",
1819 ],
1820 },
1821 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
1822 {
1823 "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.
1824 { # 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.
1825 "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.
1826 "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.
1827 "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.
1828 "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.
1829 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1830 "currency": "A String", # The currency of the price.
1831 "value": "A String", # The price represented as a number.
1832 },
1833 },
1834 ],
1835 },
1836 ],
1837 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
1838 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
1839 {
1840 "currency": "A String", # The currency of the price.
1841 "value": "A String", # The price represented as a number.
1842 },
1843 ],
1844 "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.
1845 "A String",
1846 ],
1847 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
1848 {
1849 "value": "A String", # The weight represented as a number.
1850 "unit": "A String", # The weight unit.
1851 },
1852 ],
1853 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1854 {
1855 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1856 "A String",
1857 ],
1858 },
1859 ],
1860 "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.
1861 "A String",
1862 ],
1863 },
1864 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
1865 },
1866 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1867 "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
1868 {
1869 "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
1870 "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
1871 "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.
1872 "currency": "A String", # The currency of the price.
1873 "value": "A String", # The price represented as a number.
1874 },
1875 "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.
1876 "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
1877 "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.
1878 },
1879 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1880 "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1881 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's rows. Required.
1882 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1883 {
1884 "currency": "A String", # The currency of the price.
1885 "value": "A String", # The price represented as a number.
1886 },
1887 ],
1888 "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.
1889 "A String",
1890 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1891 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1892 {
1893 "value": "A String", # The weight represented as a number.
1894 "unit": "A String", # The weight unit.
1895 },
1896 ],
1897 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1898 {
1899 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1900 "A String",
1901 ],
1902 },
1903 ],
1904 "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.
1905 "A String",
1906 ],
1907 },
1908 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
1909 {
1910 "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.
1911 { # 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.
1912 "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.
1913 "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.
1914 "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.
1915 "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.
1916 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1917 "currency": "A String", # The currency of the price.
1918 "value": "A String", # The price represented as a number.
1919 },
1920 },
1921 ],
1922 },
1923 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1924 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
1925 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1926 {
1927 "currency": "A String", # The currency of the price.
1928 "value": "A String", # The price represented as a number.
1929 },
1930 ],
1931 "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.
1932 "A String",
1933 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1934 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1935 {
1936 "value": "A String", # The weight represented as a number.
1937 "unit": "A String", # The weight unit.
1938 },
1939 ],
1940 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
1941 {
1942 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
1943 "A String",
1944 ],
1945 },
1946 ],
1947 "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.
1948 "A String",
1949 ],
1950 },
1951 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
1952 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1953 "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.
1954 "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.
1955 "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.
1956 "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.
1957 "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.
1958 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
1959 "currency": "A String", # The currency of the price.
1960 "value": "A String", # The price represented as a number.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1961 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1962 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1963 },
1964 ],
1965 "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
1966 "active": True or False, # A boolean exposing the active status of the shipping service. Required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1967 "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency.
1968 "currency": "A String", # The currency of the price.
1969 "value": "A String", # The price represented as a number.
1970 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1971 },
1972 ],
1973 "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
1974 {
1975 "postalCodeRanges": [ # A range of postal codes. Required.
1976 {
1977 "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.
1978 "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.
1979 },
1980 ],
1981 "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
1982 "name": "A String", # The name of the postal code group, referred to in headers. Required.
1983 },
1984 ],
1985 "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
1986}
1987
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1988 dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1989
1990Returns:
1991 An object of the form:
1992
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1993 { # The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1994 "services": [ # The target account's list of services. Optional.
1995 {
1996 "name": "A String", # Free-form name of the service. Must be unique within target account. Required.
1997 "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1998 "maxHandlingTimeInDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to minHandlingTimeInDays.
1999 "transitTimeTable": { # Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}transitTimeInDays or transitTimeTable can be set, but not both.
2000 "rows": [
2001 {
2002 "values": [
2003 {
2004 "maxTransitTimeInDays": 42, # Must be greater than or equal to minTransitTimeInDays.
2005 "minTransitTimeInDays": 42, # Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.
2006 },
2007 ],
2008 },
2009 ],
2010 "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.
2011 "A String",
2012 ],
2013 "transitTimeLabels": [ # A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"].
2014 "A String",
2015 ],
2016 },
2017 "minHandlingTimeInDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
2018 "cutoffTime": { # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
2019 "timezone": "A String", # Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
2020 "minute": 42, # Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.
2021 "hour": 42, # Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.
2022 },
2023 "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.
2024 "minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}transitTimeInDays or transitTimeTable must be set, but not both.
2025 "holidayCutoffs": [ # Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
2026 {
2027 "visibleFromDate": "A String", # Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.
2028 "deadlineHour": 42, # Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.
2029 "holidayId": "A String", # Unique identifier for the holiday. Required.
2030 "deadlineDate": "A String", # Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.
2031 "deadlineTimezone": "A String", # Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
2032 },
2033 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2034 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2035 "eligibility": "A String", # Eligibility for this service.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2036 "deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
2037 "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.
2038 {
2039 "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.
2040 "A String",
2041 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2042 "name": "A String", # Name of the rate group. Optional. If set has to be unique within shipping service.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2043 "subtables": [ # A list of subtables referred to by mainTable. Can only be set if mainTable is set.
2044 {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2045 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's rows. Required.
2046 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2047 {
2048 "currency": "A String", # The currency of the price.
2049 "value": "A String", # The price represented as a number.
2050 },
2051 ],
2052 "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.
2053 "A String",
2054 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2055 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2056 {
2057 "value": "A String", # The weight represented as a number.
2058 "unit": "A String", # The weight unit.
2059 },
2060 ],
2061 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
2062 {
2063 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
2064 "A String",
2065 ],
2066 },
2067 ],
2068 "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.
2069 "A String",
2070 ],
2071 },
2072 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
2073 {
2074 "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.
2075 { # 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.
2076 "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.
2077 "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.
2078 "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.
2079 "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.
2080 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
2081 "currency": "A String", # The currency of the price.
2082 "value": "A String", # The price represented as a number.
2083 },
2084 },
2085 ],
2086 },
2087 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2088 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
2089 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2090 {
2091 "currency": "A String", # The currency of the price.
2092 "value": "A String", # The price represented as a number.
2093 },
2094 ],
2095 "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.
2096 "A String",
2097 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2098 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2099 {
2100 "value": "A String", # The weight represented as a number.
2101 "unit": "A String", # The weight unit.
2102 },
2103 ],
2104 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
2105 {
2106 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
2107 "A String",
2108 ],
2109 },
2110 ],
2111 "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.
2112 "A String",
2113 ],
2114 },
2115 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
2116 },
2117 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2118 "carrierRates": [ # A list of carrier rates that can be referred to by mainTable or singleValue.
2119 {
2120 "name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
2121 "originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
2122 "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.
2123 "currency": "A String", # The currency of the price.
2124 "value": "A String", # The price represented as a number.
2125 },
2126 "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.
2127 "carrierName": "A String", # Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
2128 "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.
2129 },
2130 ],
2131 "mainTable": { # A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
2132 "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's rows. Required.
2133 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
2134 {
2135 "currency": "A String", # The currency of the price.
2136 "value": "A String", # The price represented as a number.
2137 },
2138 ],
2139 "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.
2140 "A String",
2141 ],
2142 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
2143 {
2144 "value": "A String", # The weight represented as a number.
2145 "unit": "A String", # The weight unit.
2146 },
2147 ],
2148 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
2149 {
2150 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
2151 "A String",
2152 ],
2153 },
2154 ],
2155 "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.
2156 "A String",
2157 ],
2158 },
2159 "rows": [ # The list of rows that constitute the table. Must have the same length as rowHeaders. Required.
2160 {
2161 "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.
2162 { # 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.
2163 "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.
2164 "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.
2165 "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.
2166 "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.
2167 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
2168 "currency": "A String", # The currency of the price.
2169 "value": "A String", # The price represented as a number.
2170 },
2171 },
2172 ],
2173 },
2174 ],
2175 "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
2176 "prices": [ # A list of inclusive order price upper bounds. The last price's value can 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.
2177 {
2178 "currency": "A String", # The currency of the price.
2179 "value": "A String", # The price represented as a number.
2180 },
2181 ],
2182 "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.
2183 "A String",
2184 ],
2185 "weights": [ # A list of inclusive order weight upper bounds. The last weight's value can 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.
2186 {
2187 "value": "A String", # The weight represented as a number.
2188 "unit": "A String", # The weight unit.
2189 },
2190 ],
2191 "locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
2192 {
2193 "locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
2194 "A String",
2195 ],
2196 },
2197 ],
2198 "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.
2199 "A String",
2200 ],
2201 },
2202 "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
2203 },
2204 "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.
2205 "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.
2206 "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.
2207 "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.
2208 "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.
2209 "flatRate": { # A flat rate. Can only be set if all other fields are not set.
2210 "currency": "A String", # The currency of the price.
2211 "value": "A String", # The price represented as a number.
2212 },
2213 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2214 },
2215 ],
2216 "currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
2217 "active": True or False, # A boolean exposing the active status of the shipping service. Required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2218 "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency.
2219 "currency": "A String", # The currency of the price.
2220 "value": "A String", # The price represented as a number.
2221 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2222 },
2223 ],
2224 "postalCodeGroups": [ # A list of postal code groups that can be referred to in services. Optional.
2225 {
2226 "postalCodeRanges": [ # A range of postal codes. Required.
2227 {
2228 "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.
2229 "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.
2230 },
2231 ],
2232 "country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
2233 "name": "A String", # The name of the postal code group, referred to in headers. Required.
2234 },
2235 ],
2236 "accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
2237 }</pre>
2238</div>
2239
2240</body></html>