1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="merchantapi_accounts_v1.html">Merchant API</a> . <a href="merchantapi_accounts_v1.accounts.html">accounts</a> . <a href="merchantapi_accounts_v1.accounts.shippingSettings.html">shippingSettings</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#getShippingSettings">getShippingSettings(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieve shipping setting information.</p>
<p class="toc_element">
<code><a href="#insert">insert(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Replace the shipping setting of a business with the request shipping setting. Executing this method requires admin access.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="getShippingSettings">getShippingSettings(name, x__xgafv=None)</code>
<pre>Retrieve shipping setting information.
Args:
name: string, Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsettings` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The Merchant Center account's [shipping settings](https://support.google.com/merchants/answer/6069284). The `ShippingSettings` resource lets you retrieve and update the shipping settings of your advanced account and all its associated sub-accounts.
"etag": "A String", # Required. This field helps avoid async issues. It ensures that the shipping setting data doesn't change between the `get` call and the `insert` call. The user should follow these steps: 1. Set the etag field as an empty string for the initial shipping setting creation. 2. After the initial creation, call the `get` method to obtain an etag and the current shipping setting data before calling `insert`. 3. Modify the shipping setting information. 4. Call the `insert` method with the shipping setting information and the etag obtained in step 2. 5. If the shipping setting data changes between step 2 and step 4, the insert request will fail because the etag changes every time the shipping setting data changes. In this case, the user should repeat steps 2-4 with the new etag.
"name": "A String", # Identifier. The resource name of the shipping settings. Format: `accounts/{account}/shippingSettings`. For example, `accounts/123456/shippingSettings`.
"services": [ # Optional. The target account's list of services.
{ # Shipping service.
"active": True or False, # Required. A boolean exposing the active status of the shipping service.
"currencyCode": "A String", # Required. The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
"deliveryCountries": [ # Required. The CLDR territory code of the countries to which the service applies.
"A String",
],
"deliveryTime": { # Time spent in various aspects from order to the delivery of the product. # Required. Time spent in various aspects from order to the delivery of the product.
"cutoffTime": { # Business days cutoff time definition. # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
"hour": 42, # Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day.
"minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day.
"timeZone": "A String", # Required. [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example "Europe/Zurich".
},
"handlingBusinessDayConfig": { # Business days of the warehouse. # The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
"businessDays": [ # Required. Regular business days. May not be empty.
"A String",
],
},
"maxHandlingDays": 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 `min_handling_days`. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time.
"maxTransitDays": 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 `min_transit_days`.
"minHandlingDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time.
"minTransitDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `min_transit_days`, `max_transit_days` or `transit_time_table` must be set, but not both.
"transitBusinessDayConfig": { # Business days of the warehouse. # The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.
"businessDays": [ # Required. Regular business days. May not be empty.
"A String",
],
},
"transitTimeTable": { # Transit time table, number of business days spent in transit based on row and column dimensions. Either `min_transit_days`, `max_transit_days` or `transit_time_table` can be set, but not both. # Transit time table, number of business days spent in transit based on row and column dimensions. Either `min_transit_days`, `max_transit_days` or `transit_time_table` can be set, but not both.
"postalCodeGroupNames": [ # Required. A list of region names Region.name . 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.
"A String",
],
"rows": [ # Required. If there's only one dimension set of `postal_code_group_names` or `transit_time_labels`, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a `postal_code_group_names`, and columns (values) to a `transit_time_labels`.
{ # If there's only one dimension set of `postal_code_group_names` or `transit_time_labels`, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a `postal_code_group_names`, and columns (values) to a `transit_time_labels`.
"values": [ # Required. Transit time range (min-max) in business days.
{ # Transit time range (min-max) in business days.
"maxTransitDays": 42, # Must be greater than or equal to `min_transit_days`.
"minTransitDays": 42, # Minimum transit time range in business days. 0 means same day delivery, 1 means next day delivery.
},
],
},
],
"transitTimeLabels": [ # Required. A list of transit time labels. The last value can be `"all other labels"`. Example: `["food", "electronics", "all other labels"]`.
"A String",
],
},
"warehouseBasedDeliveryTimes": [ # Optional. Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in delivery time should be set.
{ # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in `delivery_time` should be set.
"carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. [supported carriers](https://support.google.com/merchants/answer/7050921#zippy=%2Ccarrier-rates-au-de-uk-and-us-only)
"carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The name of the service must be in the eddSupportedServices list.
"warehouse": "A String", # Required. Warehouse name. This should match warehouse.
},
],
},
"loyaltyPrograms": [ # Optional. Loyalty programs that this shipping service is limited to.
{ # [Loyalty program](https://support.google.com/merchants/answer/12922446) provided by a business.
"loyaltyProgramTiers": [ # Optional. Loyalty program tier of this shipping service.
{ # Subset of a business's loyalty program.
"tierLabel": "A String", # The tier label [tier_label] sub-attribute differentiates offer level benefits between each tier. This value is also set in your program settings in Merchant Center, and is required for data source changes even if your loyalty program only has 1 tier.
},
],
"programLabel": "A String", # This is the loyalty program label set in your loyalty program settings in Merchant Center. This sub-attribute allows Google to map your loyalty program to eligible offers.
},
],
"minimumOrderValue": { # The price represented as a number and currency. # Optional. 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`.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"minimumOrderValueTable": { # Table of per store minimum order values for the pickup fulfillment type. # Optional. Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with `minimum_order_value`.
"storeCodeSetWithMovs": [ # Required. A list of store code sets sharing the same minimum order value (MOV). 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.
{ # 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.
"storeCodes": [ # Optional. A list of unique store codes or empty for the catch all.
"A String",
],
"value": { # The price represented as a number and currency. # The minimum order value for the given stores.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
},
],
},
"rateGroups": [ # Optional. Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap.
{ # Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap.
"applicableShippingLabels": [ # Required. A list of [shipping labels](https://support.google.com/merchants/answer/6324504) 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.
"A String",
],
"carrierRates": [ # Optional. A list of carrier rates that can be referred to by `main_table` or `single_value`.
{ # A list of carrier rates that can be referred to by `main_table` or `single_value`. Supported carrier services are defined in https://support.google.com/merchants/answer/12577710?ref_topic=12570808&sjid=10662598224319463032-NC#zippy=%2Cdelivery-cost-rate-type%2Ccarrier-rate-au-de-uk-and-us-only.
"carrier": "A String", # Required. Carrier service, such as `"UPS"` or `"Fedex"`.
"carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`.
"flatAdjustment": { # The price represented as a number and currency. # Optional. Additive shipping rate modifier. Can be negative. For example `{ "amount_micros": 1, "currency_code" : "USD" }` adds $1 to the rate, `{ "amount_micros": -3, "currency_code" : "USD" }` removes $3 from the rate.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"name": "A String", # Required. Name of the carrier rate. Must be unique per rate group.
"originPostalCode": "A String", # Required. Shipping origin for this carrier rate.
"percentageAdjustment": "A String", # Optional. 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%.
},
],
"mainTable": { # A table defining the rate group, when `single_value` is not expressive enough. # A table defining the rate group, when `single_value` is not expressive enough. Can only be set if `single_value` is not set.
"columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
"locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
"locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
"A String",
],
},
],
"numberOfItems": [ # Required. 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", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # Required. 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.
"A String",
],
"prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The price represented as a number and currency.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
],
"weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The weight represented as the value in string and the unit.
"amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
"unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
},
],
},
"name": "A String", # Name of the table. Required for subtables, ignored for the main table.
"rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Required. Headers of the table's rows.
"locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
"locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
"A String",
],
},
],
"numberOfItems": [ # Required. 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", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # Required. 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.
"A String",
],
"prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The price represented as a number and currency.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
],
"weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The weight represented as the value in string and the unit.
"amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
"unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
},
],
},
"rows": [ # Required. The list of rows that constitute the table. Must have the same length as `row_headers`.
{ # Include a list of cells.
"cells": [ # Required. 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.
{ # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set.
"carrierRate": "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.
"flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
"subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
},
],
},
],
},
"name": "A String", # Optional. Name of the rate group. If set has to be unique within shipping service.
"singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set. # The value of the rate group (For example flat rate $10). Can only be set if `main_table` and `subtables` are not set.
"carrierRate": "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.
"flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
"subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
},
"subtables": [ # Optional. A list of subtables referred to by `main_table`. Can only be set if `main_table` is set.
{ # A table defining the rate group, when `single_value` is not expressive enough.
"columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
"locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
"locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
"A String",
],
},
],
"numberOfItems": [ # Required. 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", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # Required. 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.
"A String",
],
"prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The price represented as a number and currency.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
],
"weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The weight represented as the value in string and the unit.
"amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
"unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
},
],
},
"name": "A String", # Name of the table. Required for subtables, ignored for the main table.
"rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Required. Headers of the table's rows.
"locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
"locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
"A String",
],
},
],
"numberOfItems": [ # Required. 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", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # Required. 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.
"A String",
],
"prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The price represented as a number and currency.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
],
"weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The weight represented as the value in string and the unit.
"amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
"unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
},
],
},
"rows": [ # Required. The list of rows that constitute the table. Must have the same length as `row_headers`.
{ # Include a list of cells.
"cells": [ # Required. 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.
{ # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set.
"carrierRate": "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.
"flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
"subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
},
],
},
],
},
],
},
],
"serviceName": "A String", # Required. Free-form name of the service. Must be unique within target account.
"shipmentType": "A String", # Optional. Type of locations this service ships orders to.
"storeConfig": { # A list of stores your products are delivered from. This is only valid for the local delivery shipment type. # A list of stores your products are delivered from. This is only valid for the local delivery shipment type.
"cutoffConfig": { # Configs related to local delivery ends for the day. # Configs related to local delivery ends for the day.
"localCutoffTime": { # Time that local delivery ends for the day. # Time that local delivery ends for the day.
"hour": "A String", # Hour local delivery orders must be placed by to process the same day.
"minute": "A String", # Minute local delivery orders must be placed by to process the same day.
},
"noDeliveryPostCutoff": True or False, # Businesses can opt-out of showing n+1 day local delivery when they have a shipping service configured to n day local delivery. For example, if the shipping service defines same-day delivery, and it's past the cut-off, setting this field to `true` results in the calculated shipping service rate returning `NO_DELIVERY_POST_CUTOFF`. In the same example, setting this field to `false` results in the calculated shipping time being one day. This is only for local delivery.
"storeCloseOffsetHours": "A String", # Only valid with local delivery fulfillment. Represents cutoff time as the number of hours before store closing. Mutually exclusive with `local_cutoff_time`.
},
"serviceRadius": { # Maximum delivery radius. This is only required for the local delivery shipment type. # Maximum delivery radius. This is only required for the local delivery shipment type.
"unit": "A String", # Unit can differ based on country, it is parameterized to include miles and kilometers.
"value": "A String", # Integer value of distance.
},
"storeCodes": [ # Optional. A list of store codes that provide local delivery. If empty, then `all_stores` must be true.
"A String",
],
"storeServiceType": "A String", # Indicates whether all stores, or selected stores, listed by this business provide local delivery.
},
},
],
"warehouses": [ # Optional. A list of warehouses which can be referred to in `services`.
{ # A fulfillment warehouse, which stores and handles inventory.
"businessDayConfig": { # Business days of the warehouse. # Business days of the warehouse. If not set, will be Monday to Friday by default.
"businessDays": [ # Required. Regular business days. May not be empty.
"A String",
],
},
"cutoffTime": { # The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code. # Required. The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code.
"hour": 42, # Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Hour is based on the timezone of warehouse.
"minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Minute is based on the timezone of warehouse.
},
"handlingDays": "A String", # Required. The number of days it takes for this warehouse to pack up and ship an item. This is on the warehouse level, but can be overridden on the offer level based on the attributes of an item.
"name": "A String", # Required. The name of the warehouse. Must be unique within account.
"shippingAddress": { # Shipping address of the warehouse. # Required. Shipping address of the warehouse.
"administrativeArea": "A String", # Required. Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
"city": "A String", # Required. City, town or commune. May also include dependent localities or sublocalities (For example neighborhoods or suburbs).
"postalCode": "A String", # Required. Postal code or ZIP (For example "94043").
"regionCode": "A String", # Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (For example "US").
"streetAddress": "A String", # Street-level part of the address. For example: `111w 31st Street`.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(parent, body=None, x__xgafv=None)</code>
<pre>Replace the shipping setting of a business with the request shipping setting. Executing this method requires admin access.
Args:
parent: string, Required. The account for which this shipping setting will be inserted. If you are using an advanced account, you must specify the unique identifier of the sub-account for which you want to insert the shipping setting. Format: `accounts/{ACCOUNT_ID}` (required)
body: object, The request body.
The object takes the form of:
{ # The Merchant Center account's [shipping settings](https://support.google.com/merchants/answer/6069284). The `ShippingSettings` resource lets you retrieve and update the shipping settings of your advanced account and all its associated sub-accounts.
"etag": "A String", # Required. This field helps avoid async issues. It ensures that the shipping setting data doesn't change between the `get` call and the `insert` call. The user should follow these steps: 1. Set the etag field as an empty string for the initial shipping setting creation. 2. After the initial creation, call the `get` method to obtain an etag and the current shipping setting data before calling `insert`. 3. Modify the shipping setting information. 4. Call the `insert` method with the shipping setting information and the etag obtained in step 2. 5. If the shipping setting data changes between step 2 and step 4, the insert request will fail because the etag changes every time the shipping setting data changes. In this case, the user should repeat steps 2-4 with the new etag.
"name": "A String", # Identifier. The resource name of the shipping settings. Format: `accounts/{account}/shippingSettings`. For example, `accounts/123456/shippingSettings`.
"services": [ # Optional. The target account's list of services.
{ # Shipping service.
"active": True or False, # Required. A boolean exposing the active status of the shipping service.
"currencyCode": "A String", # Required. The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
"deliveryCountries": [ # Required. The CLDR territory code of the countries to which the service applies.
"A String",
],
"deliveryTime": { # Time spent in various aspects from order to the delivery of the product. # Required. Time spent in various aspects from order to the delivery of the product.
"cutoffTime": { # Business days cutoff time definition. # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
"hour": 42, # Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day.
"minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day.
"timeZone": "A String", # Required. [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example "Europe/Zurich".
},
"handlingBusinessDayConfig": { # Business days of the warehouse. # The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
"businessDays": [ # Required. Regular business days. May not be empty.
"A String",
],
},
"maxHandlingDays": 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 `min_handling_days`. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time.
"maxTransitDays": 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 `min_transit_days`.
"minHandlingDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time.
"minTransitDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `min_transit_days`, `max_transit_days` or `transit_time_table` must be set, but not both.
"transitBusinessDayConfig": { # Business days of the warehouse. # The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.
"businessDays": [ # Required. Regular business days. May not be empty.
"A String",
],
},
"transitTimeTable": { # Transit time table, number of business days spent in transit based on row and column dimensions. Either `min_transit_days`, `max_transit_days` or `transit_time_table` can be set, but not both. # Transit time table, number of business days spent in transit based on row and column dimensions. Either `min_transit_days`, `max_transit_days` or `transit_time_table` can be set, but not both.
"postalCodeGroupNames": [ # Required. A list of region names Region.name . 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.
"A String",
],
"rows": [ # Required. If there's only one dimension set of `postal_code_group_names` or `transit_time_labels`, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a `postal_code_group_names`, and columns (values) to a `transit_time_labels`.
{ # If there's only one dimension set of `postal_code_group_names` or `transit_time_labels`, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a `postal_code_group_names`, and columns (values) to a `transit_time_labels`.
"values": [ # Required. Transit time range (min-max) in business days.
{ # Transit time range (min-max) in business days.
"maxTransitDays": 42, # Must be greater than or equal to `min_transit_days`.
"minTransitDays": 42, # Minimum transit time range in business days. 0 means same day delivery, 1 means next day delivery.
},
],
},
],
"transitTimeLabels": [ # Required. A list of transit time labels. The last value can be `"all other labels"`. Example: `["food", "electronics", "all other labels"]`.
"A String",
],
},
"warehouseBasedDeliveryTimes": [ # Optional. Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in delivery time should be set.
{ # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in `delivery_time` should be set.
"carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. [supported carriers](https://support.google.com/merchants/answer/7050921#zippy=%2Ccarrier-rates-au-de-uk-and-us-only)
"carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The name of the service must be in the eddSupportedServices list.
"warehouse": "A String", # Required. Warehouse name. This should match warehouse.
},
],
},
"loyaltyPrograms": [ # Optional. Loyalty programs that this shipping service is limited to.
{ # [Loyalty program](https://support.google.com/merchants/answer/12922446) provided by a business.
"loyaltyProgramTiers": [ # Optional. Loyalty program tier of this shipping service.
{ # Subset of a business's loyalty program.
"tierLabel": "A String", # The tier label [tier_label] sub-attribute differentiates offer level benefits between each tier. This value is also set in your program settings in Merchant Center, and is required for data source changes even if your loyalty program only has 1 tier.
},
],
"programLabel": "A String", # This is the loyalty program label set in your loyalty program settings in Merchant Center. This sub-attribute allows Google to map your loyalty program to eligible offers.
},
],
"minimumOrderValue": { # The price represented as a number and currency. # Optional. 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`.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"minimumOrderValueTable": { # Table of per store minimum order values for the pickup fulfillment type. # Optional. Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with `minimum_order_value`.
"storeCodeSetWithMovs": [ # Required. A list of store code sets sharing the same minimum order value (MOV). 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.
{ # 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.
"storeCodes": [ # Optional. A list of unique store codes or empty for the catch all.
"A String",
],
"value": { # The price represented as a number and currency. # The minimum order value for the given stores.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
},
],
},
"rateGroups": [ # Optional. Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap.
{ # Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap.
"applicableShippingLabels": [ # Required. A list of [shipping labels](https://support.google.com/merchants/answer/6324504) 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.
"A String",
],
"carrierRates": [ # Optional. A list of carrier rates that can be referred to by `main_table` or `single_value`.
{ # A list of carrier rates that can be referred to by `main_table` or `single_value`. Supported carrier services are defined in https://support.google.com/merchants/answer/12577710?ref_topic=12570808&sjid=10662598224319463032-NC#zippy=%2Cdelivery-cost-rate-type%2Ccarrier-rate-au-de-uk-and-us-only.
"carrier": "A String", # Required. Carrier service, such as `"UPS"` or `"Fedex"`.
"carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`.
"flatAdjustment": { # The price represented as a number and currency. # Optional. Additive shipping rate modifier. Can be negative. For example `{ "amount_micros": 1, "currency_code" : "USD" }` adds $1 to the rate, `{ "amount_micros": -3, "currency_code" : "USD" }` removes $3 from the rate.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"name": "A String", # Required. Name of the carrier rate. Must be unique per rate group.
"originPostalCode": "A String", # Required. Shipping origin for this carrier rate.
"percentageAdjustment": "A String", # Optional. 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%.
},
],
"mainTable": { # A table defining the rate group, when `single_value` is not expressive enough. # A table defining the rate group, when `single_value` is not expressive enough. Can only be set if `single_value` is not set.
"columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
"locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
"locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
"A String",
],
},
],
"numberOfItems": [ # Required. 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", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # Required. 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.
"A String",
],
"prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The price represented as a number and currency.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
],
"weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The weight represented as the value in string and the unit.
"amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
"unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
},
],
},
"name": "A String", # Name of the table. Required for subtables, ignored for the main table.
"rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Required. Headers of the table's rows.
"locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
"locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
"A String",
],
},
],
"numberOfItems": [ # Required. 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", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # Required. 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.
"A String",
],
"prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The price represented as a number and currency.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
],
"weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The weight represented as the value in string and the unit.
"amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
"unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
},
],
},
"rows": [ # Required. The list of rows that constitute the table. Must have the same length as `row_headers`.
{ # Include a list of cells.
"cells": [ # Required. 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.
{ # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set.
"carrierRate": "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.
"flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
"subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
},
],
},
],
},
"name": "A String", # Optional. Name of the rate group. If set has to be unique within shipping service.
"singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set. # The value of the rate group (For example flat rate $10). Can only be set if `main_table` and `subtables` are not set.
"carrierRate": "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.
"flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
"subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
},
"subtables": [ # Optional. A list of subtables referred to by `main_table`. Can only be set if `main_table` is set.
{ # A table defining the rate group, when `single_value` is not expressive enough.
"columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
"locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
"locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
"A String",
],
},
],
"numberOfItems": [ # Required. 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", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # Required. 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.
"A String",
],
"prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The price represented as a number and currency.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
],
"weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The weight represented as the value in string and the unit.
"amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
"unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
},
],
},
"name": "A String", # Name of the table. Required for subtables, ignored for the main table.
"rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Required. Headers of the table's rows.
"locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
"locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
"A String",
],
},
],
"numberOfItems": [ # Required. 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", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # Required. 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.
"A String",
],
"prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The price represented as a number and currency.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
],
"weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The weight represented as the value in string and the unit.
"amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
"unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
},
],
},
"rows": [ # Required. The list of rows that constitute the table. Must have the same length as `row_headers`.
{ # Include a list of cells.
"cells": [ # Required. 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.
{ # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set.
"carrierRate": "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.
"flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
"subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
},
],
},
],
},
],
},
],
"serviceName": "A String", # Required. Free-form name of the service. Must be unique within target account.
"shipmentType": "A String", # Optional. Type of locations this service ships orders to.
"storeConfig": { # A list of stores your products are delivered from. This is only valid for the local delivery shipment type. # A list of stores your products are delivered from. This is only valid for the local delivery shipment type.
"cutoffConfig": { # Configs related to local delivery ends for the day. # Configs related to local delivery ends for the day.
"localCutoffTime": { # Time that local delivery ends for the day. # Time that local delivery ends for the day.
"hour": "A String", # Hour local delivery orders must be placed by to process the same day.
"minute": "A String", # Minute local delivery orders must be placed by to process the same day.
},
"noDeliveryPostCutoff": True or False, # Businesses can opt-out of showing n+1 day local delivery when they have a shipping service configured to n day local delivery. For example, if the shipping service defines same-day delivery, and it's past the cut-off, setting this field to `true` results in the calculated shipping service rate returning `NO_DELIVERY_POST_CUTOFF`. In the same example, setting this field to `false` results in the calculated shipping time being one day. This is only for local delivery.
"storeCloseOffsetHours": "A String", # Only valid with local delivery fulfillment. Represents cutoff time as the number of hours before store closing. Mutually exclusive with `local_cutoff_time`.
},
"serviceRadius": { # Maximum delivery radius. This is only required for the local delivery shipment type. # Maximum delivery radius. This is only required for the local delivery shipment type.
"unit": "A String", # Unit can differ based on country, it is parameterized to include miles and kilometers.
"value": "A String", # Integer value of distance.
},
"storeCodes": [ # Optional. A list of store codes that provide local delivery. If empty, then `all_stores` must be true.
"A String",
],
"storeServiceType": "A String", # Indicates whether all stores, or selected stores, listed by this business provide local delivery.
},
},
],
"warehouses": [ # Optional. A list of warehouses which can be referred to in `services`.
{ # A fulfillment warehouse, which stores and handles inventory.
"businessDayConfig": { # Business days of the warehouse. # Business days of the warehouse. If not set, will be Monday to Friday by default.
"businessDays": [ # Required. Regular business days. May not be empty.
"A String",
],
},
"cutoffTime": { # The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code. # Required. The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code.
"hour": 42, # Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Hour is based on the timezone of warehouse.
"minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Minute is based on the timezone of warehouse.
},
"handlingDays": "A String", # Required. The number of days it takes for this warehouse to pack up and ship an item. This is on the warehouse level, but can be overridden on the offer level based on the attributes of an item.
"name": "A String", # Required. The name of the warehouse. Must be unique within account.
"shippingAddress": { # Shipping address of the warehouse. # Required. Shipping address of the warehouse.
"administrativeArea": "A String", # Required. Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
"city": "A String", # Required. City, town or commune. May also include dependent localities or sublocalities (For example neighborhoods or suburbs).
"postalCode": "A String", # Required. Postal code or ZIP (For example "94043").
"regionCode": "A String", # Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (For example "US").
"streetAddress": "A String", # Street-level part of the address. For example: `111w 31st Street`.
},
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The Merchant Center account's [shipping settings](https://support.google.com/merchants/answer/6069284). The `ShippingSettings` resource lets you retrieve and update the shipping settings of your advanced account and all its associated sub-accounts.
"etag": "A String", # Required. This field helps avoid async issues. It ensures that the shipping setting data doesn't change between the `get` call and the `insert` call. The user should follow these steps: 1. Set the etag field as an empty string for the initial shipping setting creation. 2. After the initial creation, call the `get` method to obtain an etag and the current shipping setting data before calling `insert`. 3. Modify the shipping setting information. 4. Call the `insert` method with the shipping setting information and the etag obtained in step 2. 5. If the shipping setting data changes between step 2 and step 4, the insert request will fail because the etag changes every time the shipping setting data changes. In this case, the user should repeat steps 2-4 with the new etag.
"name": "A String", # Identifier. The resource name of the shipping settings. Format: `accounts/{account}/shippingSettings`. For example, `accounts/123456/shippingSettings`.
"services": [ # Optional. The target account's list of services.
{ # Shipping service.
"active": True or False, # Required. A boolean exposing the active status of the shipping service.
"currencyCode": "A String", # Required. The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
"deliveryCountries": [ # Required. The CLDR territory code of the countries to which the service applies.
"A String",
],
"deliveryTime": { # Time spent in various aspects from order to the delivery of the product. # Required. Time spent in various aspects from order to the delivery of the product.
"cutoffTime": { # Business days cutoff time definition. # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
"hour": 42, # Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day.
"minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day.
"timeZone": "A String", # Required. [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example "Europe/Zurich".
},
"handlingBusinessDayConfig": { # Business days of the warehouse. # The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
"businessDays": [ # Required. Regular business days. May not be empty.
"A String",
],
},
"maxHandlingDays": 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 `min_handling_days`. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time.
"maxTransitDays": 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 `min_transit_days`.
"minHandlingDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time.
"minTransitDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `min_transit_days`, `max_transit_days` or `transit_time_table` must be set, but not both.
"transitBusinessDayConfig": { # Business days of the warehouse. # The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.
"businessDays": [ # Required. Regular business days. May not be empty.
"A String",
],
},
"transitTimeTable": { # Transit time table, number of business days spent in transit based on row and column dimensions. Either `min_transit_days`, `max_transit_days` or `transit_time_table` can be set, but not both. # Transit time table, number of business days spent in transit based on row and column dimensions. Either `min_transit_days`, `max_transit_days` or `transit_time_table` can be set, but not both.
"postalCodeGroupNames": [ # Required. A list of region names Region.name . 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.
"A String",
],
"rows": [ # Required. If there's only one dimension set of `postal_code_group_names` or `transit_time_labels`, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a `postal_code_group_names`, and columns (values) to a `transit_time_labels`.
{ # If there's only one dimension set of `postal_code_group_names` or `transit_time_labels`, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a `postal_code_group_names`, and columns (values) to a `transit_time_labels`.
"values": [ # Required. Transit time range (min-max) in business days.
{ # Transit time range (min-max) in business days.
"maxTransitDays": 42, # Must be greater than or equal to `min_transit_days`.
"minTransitDays": 42, # Minimum transit time range in business days. 0 means same day delivery, 1 means next day delivery.
},
],
},
],
"transitTimeLabels": [ # Required. A list of transit time labels. The last value can be `"all other labels"`. Example: `["food", "electronics", "all other labels"]`.
"A String",
],
},
"warehouseBasedDeliveryTimes": [ # Optional. Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in delivery time should be set.
{ # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in `delivery_time` should be set.
"carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. [supported carriers](https://support.google.com/merchants/answer/7050921#zippy=%2Ccarrier-rates-au-de-uk-and-us-only)
"carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The name of the service must be in the eddSupportedServices list.
"warehouse": "A String", # Required. Warehouse name. This should match warehouse.
},
],
},
"loyaltyPrograms": [ # Optional. Loyalty programs that this shipping service is limited to.
{ # [Loyalty program](https://support.google.com/merchants/answer/12922446) provided by a business.
"loyaltyProgramTiers": [ # Optional. Loyalty program tier of this shipping service.
{ # Subset of a business's loyalty program.
"tierLabel": "A String", # The tier label [tier_label] sub-attribute differentiates offer level benefits between each tier. This value is also set in your program settings in Merchant Center, and is required for data source changes even if your loyalty program only has 1 tier.
},
],
"programLabel": "A String", # This is the loyalty program label set in your loyalty program settings in Merchant Center. This sub-attribute allows Google to map your loyalty program to eligible offers.
},
],
"minimumOrderValue": { # The price represented as a number and currency. # Optional. 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`.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"minimumOrderValueTable": { # Table of per store minimum order values for the pickup fulfillment type. # Optional. Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with `minimum_order_value`.
"storeCodeSetWithMovs": [ # Required. A list of store code sets sharing the same minimum order value (MOV). 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.
{ # 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.
"storeCodes": [ # Optional. A list of unique store codes or empty for the catch all.
"A String",
],
"value": { # The price represented as a number and currency. # The minimum order value for the given stores.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
},
],
},
"rateGroups": [ # Optional. Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap.
{ # Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap.
"applicableShippingLabels": [ # Required. A list of [shipping labels](https://support.google.com/merchants/answer/6324504) 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.
"A String",
],
"carrierRates": [ # Optional. A list of carrier rates that can be referred to by `main_table` or `single_value`.
{ # A list of carrier rates that can be referred to by `main_table` or `single_value`. Supported carrier services are defined in https://support.google.com/merchants/answer/12577710?ref_topic=12570808&sjid=10662598224319463032-NC#zippy=%2Cdelivery-cost-rate-type%2Ccarrier-rate-au-de-uk-and-us-only.
"carrier": "A String", # Required. Carrier service, such as `"UPS"` or `"Fedex"`.
"carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`.
"flatAdjustment": { # The price represented as a number and currency. # Optional. Additive shipping rate modifier. Can be negative. For example `{ "amount_micros": 1, "currency_code" : "USD" }` adds $1 to the rate, `{ "amount_micros": -3, "currency_code" : "USD" }` removes $3 from the rate.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"name": "A String", # Required. Name of the carrier rate. Must be unique per rate group.
"originPostalCode": "A String", # Required. Shipping origin for this carrier rate.
"percentageAdjustment": "A String", # Optional. 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%.
},
],
"mainTable": { # A table defining the rate group, when `single_value` is not expressive enough. # A table defining the rate group, when `single_value` is not expressive enough. Can only be set if `single_value` is not set.
"columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
"locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
"locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
"A String",
],
},
],
"numberOfItems": [ # Required. 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", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # Required. 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.
"A String",
],
"prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The price represented as a number and currency.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
],
"weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The weight represented as the value in string and the unit.
"amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
"unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
},
],
},
"name": "A String", # Name of the table. Required for subtables, ignored for the main table.
"rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Required. Headers of the table's rows.
"locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
"locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
"A String",
],
},
],
"numberOfItems": [ # Required. 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", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # Required. 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.
"A String",
],
"prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The price represented as a number and currency.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
],
"weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The weight represented as the value in string and the unit.
"amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
"unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
},
],
},
"rows": [ # Required. The list of rows that constitute the table. Must have the same length as `row_headers`.
{ # Include a list of cells.
"cells": [ # Required. 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.
{ # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set.
"carrierRate": "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.
"flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
"subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
},
],
},
],
},
"name": "A String", # Optional. Name of the rate group. If set has to be unique within shipping service.
"singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set. # The value of the rate group (For example flat rate $10). Can only be set if `main_table` and `subtables` are not set.
"carrierRate": "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.
"flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
"subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
},
"subtables": [ # Optional. A list of subtables referred to by `main_table`. Can only be set if `main_table` is set.
{ # A table defining the rate group, when `single_value` is not expressive enough.
"columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
"locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
"locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
"A String",
],
},
],
"numberOfItems": [ # Required. 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", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # Required. 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.
"A String",
],
"prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The price represented as a number and currency.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
],
"weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The weight represented as the value in string and the unit.
"amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
"unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
},
],
},
"name": "A String", # Name of the table. Required for subtables, ignored for the main table.
"rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Required. Headers of the table's rows.
"locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
"locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
"A String",
],
},
],
"numberOfItems": [ # Required. 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", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # Required. 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.
"A String",
],
"prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The price represented as a number and currency.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
],
"weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
{ # The weight represented as the value in string and the unit.
"amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
"unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
},
],
},
"rows": [ # Required. The list of rows that constitute the table. Must have the same length as `row_headers`.
{ # Include a list of cells.
"cells": [ # Required. 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.
{ # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set.
"carrierRate": "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.
"flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
"subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
},
],
},
],
},
],
},
],
"serviceName": "A String", # Required. Free-form name of the service. Must be unique within target account.
"shipmentType": "A String", # Optional. Type of locations this service ships orders to.
"storeConfig": { # A list of stores your products are delivered from. This is only valid for the local delivery shipment type. # A list of stores your products are delivered from. This is only valid for the local delivery shipment type.
"cutoffConfig": { # Configs related to local delivery ends for the day. # Configs related to local delivery ends for the day.
"localCutoffTime": { # Time that local delivery ends for the day. # Time that local delivery ends for the day.
"hour": "A String", # Hour local delivery orders must be placed by to process the same day.
"minute": "A String", # Minute local delivery orders must be placed by to process the same day.
},
"noDeliveryPostCutoff": True or False, # Businesses can opt-out of showing n+1 day local delivery when they have a shipping service configured to n day local delivery. For example, if the shipping service defines same-day delivery, and it's past the cut-off, setting this field to `true` results in the calculated shipping service rate returning `NO_DELIVERY_POST_CUTOFF`. In the same example, setting this field to `false` results in the calculated shipping time being one day. This is only for local delivery.
"storeCloseOffsetHours": "A String", # Only valid with local delivery fulfillment. Represents cutoff time as the number of hours before store closing. Mutually exclusive with `local_cutoff_time`.
},
"serviceRadius": { # Maximum delivery radius. This is only required for the local delivery shipment type. # Maximum delivery radius. This is only required for the local delivery shipment type.
"unit": "A String", # Unit can differ based on country, it is parameterized to include miles and kilometers.
"value": "A String", # Integer value of distance.
},
"storeCodes": [ # Optional. A list of store codes that provide local delivery. If empty, then `all_stores` must be true.
"A String",
],
"storeServiceType": "A String", # Indicates whether all stores, or selected stores, listed by this business provide local delivery.
},
},
],
"warehouses": [ # Optional. A list of warehouses which can be referred to in `services`.
{ # A fulfillment warehouse, which stores and handles inventory.
"businessDayConfig": { # Business days of the warehouse. # Business days of the warehouse. If not set, will be Monday to Friday by default.
"businessDays": [ # Required. Regular business days. May not be empty.
"A String",
],
},
"cutoffTime": { # The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code. # Required. The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code.
"hour": 42, # Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Hour is based on the timezone of warehouse.
"minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Minute is based on the timezone of warehouse.
},
"handlingDays": "A String", # Required. The number of days it takes for this warehouse to pack up and ship an item. This is on the warehouse level, but can be overridden on the offer level based on the attributes of an item.
"name": "A String", # Required. The name of the warehouse. Must be unique within account.
"shippingAddress": { # Shipping address of the warehouse. # Required. Shipping address of the warehouse.
"administrativeArea": "A String", # Required. Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
"city": "A String", # Required. City, town or commune. May also include dependent localities or sublocalities (For example neighborhoods or suburbs).
"postalCode": "A String", # Required. Postal code or ZIP (For example "94043").
"regionCode": "A String", # Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (For example "US").
"streetAddress": "A String", # Street-level part of the address. For example: `111w 31st Street`.
},
},
],
}</pre>
</div>
</body></html>
|
