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