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