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