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 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165
|
<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="content_v2.html">Content API for Shopping</a> . <a href="content_v2.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="#custombatch">custombatch(body=None, dryRun=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves and updates the shipping settings of multiple accounts in a single request.</p>
<p class="toc_element">
<code><a href="#get">get(merchantId, accountId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the shipping settings of the account.</p>
<p class="toc_element">
<code><a href="#getsupportedcarriers">getsupportedcarriers(merchantId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves supported carriers and carrier services for an account.</p>
<p class="toc_element">
<code><a href="#getsupportedholidays">getsupportedholidays(merchantId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves supported holidays for an account.</p>
<p class="toc_element">
<code><a href="#getsupportedpickupservices">getsupportedpickupservices(merchantId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves supported pickup services for an account.</p>
<p class="toc_element">
<code><a href="#list">list(merchantId, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the shipping settings of the sub-accounts in your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(merchantId, accountId, body=None, dryRun=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the shipping settings of the account. Any fields that are not provided are deleted from the resource.</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="custombatch">custombatch(body=None, dryRun=None, x__xgafv=None)</code>
<pre>Retrieves and updates the shipping settings of multiple accounts in a single request.
Args:
body: object, The request body.
The object takes the form of:
{
"entries": [ # The request entries to be processed in the batch.
{ # A batch entry encoding a single non-batch shippingsettings request.
"accountId": "A String", # The ID of the account for which to get/update account shipping settings.
"batchId": 42, # An entry ID, unique within the batch request.
"merchantId": "A String", # The ID of the managing account.
"method": "A String", # The method of the batch entry. Acceptable values are: - "`get`" - "`update`"
"shippingSettings": { # The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role. # The account shipping settings to update. Only defined if the method is `update`.
"accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
"postalCodeGroups": [ # A list of postal code groups that can be referred to in `services`. Optional.
{
"country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
"name": "A String", # The name of the postal code group, referred to in headers. Required.
"postalCodeRanges": [ # A range of postal codes. Required.
{
"postalCodeRangeBegin": "A String", # A postal code or a pattern of the form `prefix*` denoting the inclusive lower bound of the range defining the area. Examples values: `"94108"`, `"9410*"`, `"9*"`. Required.
"postalCodeRangeEnd": "A String", # A postal code or a pattern of the form `prefix*` denoting the inclusive upper bound of the range defining the area. It must have the same length as `postalCodeRangeBegin`: if `postalCodeRangeBegin` is a postal code then `postalCodeRangeEnd` must be a postal code too; if `postalCodeRangeBegin` is a pattern then `postalCodeRangeEnd` must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching `postalCodeRangeBegin`.
},
],
},
],
"services": [ # The target account's list of services. Optional.
{
"active": True or False, # A boolean exposing the active status of the shipping service. Required.
"currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
"deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
"deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
"cutoffTime": { # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
"hour": 42, # Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.
"minute": 42, # Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.
"timezone": "A String", # Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
},
"handlingBusinessDayConfig": { # The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
"businessDays": [ # Regular business days, such as '"monday"'. May not be empty.
"A String",
],
},
"holidayCutoffs": [ # Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
{
"deadlineDate": "A String", # Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.
"deadlineHour": 42, # Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.
"deadlineTimezone": "A String", # Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
"holidayId": "A String", # Unique identifier for the holiday. Required.
"visibleFromDate": "A String", # Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.
},
],
"maxHandlingTimeInDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `minHandlingTimeInDays`.
"maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `minTransitTimeInDays`.
"minHandlingTimeInDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
"minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `{min,max}TransitTimeInDays` or `transitTimeTable` must be set, but not both.
"transitBusinessDayConfig": { # The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.
"businessDays": [ # Regular business days, such as '"monday"'. 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,max}TransitTimeInDays` or `transitTimeTable` can be set, but not both.
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service.
"A String",
],
"rows": [
{
"values": [
{
"maxTransitTimeInDays": 42, # Must be greater than or equal to `minTransitTimeInDays`.
"minTransitTimeInDays": 42, # Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.
},
],
},
],
"transitTimeLabels": [ # A list of transit time labels. The last value can be `"all other labels"`. Example: `["food", "electronics", "all other labels"]`.
"A String",
],
},
"warehouseBasedDeliveryTimes": [ # 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 DeliveryTime should be set.
{
"carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method.
"carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list.
"originAdministrativeArea": "A String", # Shipping origin's state.
"originCity": "A String", # Shipping origin's city.
"originCountry": "A String", # Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml).
"originPostalCode": "A String", # Shipping origin.
"originStreetAddress": "A String", # Shipping origin's street address
"warehouseName": "A String", # The name of the warehouse. Warehouse name need to be matched with name. If warehouseName is set, the below fields will be ignored. The warehouse info will be read from warehouse.
},
],
},
"eligibility": "A String", # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`"
"minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"minimumOrderValueTable": { # Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value.
"storeCodeSetWithMovs": [
{ # 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": [ # A list of unique store codes or empty for the catch all.
"A String",
],
"value": { # The minimum order value for the given stores.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
],
},
"name": "A String", # Free-form name of the service. Must be unique within target account. Required.
"pickupService": { # The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the `getSupportedPickupServices` method. Required if and only if the service delivery type is `pickup`.
"carrierName": "A String", # The name of the pickup carrier (e.g., `"UPS"`). Required.
"serviceName": "A String", # The name of the pickup service (e.g., `"Access point"`). Required.
},
"rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty `applicableShippingLabels`, which means "everything else". The other `applicableShippingLabels` must not overlap.
{
"applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
"A String",
],
"carrierRates": [ # A list of carrier rates that can be referred to by `mainTable` or `singleValue`.
{
"carrierName": "A String", # Carrier service, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `getSupportedCarriers` method. Required.
"carrierService": "A String", # Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `getSupportedCarriers` method. Required.
"flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example `{ "value": "1", "currency" : "USD" }` adds $1 to the rate, `{ "value": "-3", "currency" : "USD" }` removes $3 from the rate. Optional.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
"originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
"percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the rate by 3%. Optional.
},
],
"mainTable": { # A table defining the rate group, when `singleValue` is not expressive enough. Can only be set if `singleValue` is not set.
"columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"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`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's rows. Required.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"rows": [ # The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required.
{
"cells": [ # The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
{ # The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set.
"carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
"flatRate": { # A flat rate. Can only be set if all other fields are not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set.
"subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
},
],
},
],
},
"name": "A String", # Name of the rate group. Optional. 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 `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if `mainTable` and `subtables` are not set.
"carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
"flatRate": { # A flat rate. Can only be set if all other fields are not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set.
"subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
},
"subtables": [ # A list of subtables referred to by `mainTable`. Can only be set if `mainTable` is set.
{
"columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"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`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's rows. Required.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"rows": [ # The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required.
{
"cells": [ # The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
{ # The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set.
"carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
"flatRate": { # A flat rate. Can only be set if all other fields are not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set.
"subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
},
],
},
],
},
],
},
],
"shipmentType": "A String", # Type of locations this service ships orders to. Acceptable values are: - "`delivery`" - "`pickup`"
},
],
"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. If not set, will be Monday to Friday by default.
"businessDays": [ # Regular business days, such as '"monday"'. May not be empty.
"A String",
],
},
"cutoffTime": { # 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 (24-hour clock) 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": { # 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 (e.g. neighborhoods or suburbs).
"country": "A String", # Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)(e.g. "US").
"postalCode": "A String", # Required. Postal code or ZIP (e.g. "94043"). Required.
"streetAddress": "A String", # Street-level part of the address.
},
},
],
},
},
],
}
dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"entries": [ # The result of the execution of the batch requests.
{ # A batch entry encoding a single non-batch shipping settings response.
"batchId": 42, # The ID of the request entry to which this entry responds.
"errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if, and only if, the request failed.
"code": 42, # The HTTP status of the first error in `errors`.
"errors": [ # A list of errors.
{ # An error returned by the API.
"domain": "A String", # The domain of the error.
"message": "A String", # A description of the error.
"reason": "A String", # The error code.
},
],
"message": "A String", # The message of the first error in `errors`.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#shippingsettingsCustomBatchResponseEntry`"
"shippingSettings": { # The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role. # The retrieved or updated account shipping settings.
"accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
"postalCodeGroups": [ # A list of postal code groups that can be referred to in `services`. Optional.
{
"country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
"name": "A String", # The name of the postal code group, referred to in headers. Required.
"postalCodeRanges": [ # A range of postal codes. Required.
{
"postalCodeRangeBegin": "A String", # A postal code or a pattern of the form `prefix*` denoting the inclusive lower bound of the range defining the area. Examples values: `"94108"`, `"9410*"`, `"9*"`. Required.
"postalCodeRangeEnd": "A String", # A postal code or a pattern of the form `prefix*` denoting the inclusive upper bound of the range defining the area. It must have the same length as `postalCodeRangeBegin`: if `postalCodeRangeBegin` is a postal code then `postalCodeRangeEnd` must be a postal code too; if `postalCodeRangeBegin` is a pattern then `postalCodeRangeEnd` must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching `postalCodeRangeBegin`.
},
],
},
],
"services": [ # The target account's list of services. Optional.
{
"active": True or False, # A boolean exposing the active status of the shipping service. Required.
"currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
"deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
"deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
"cutoffTime": { # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
"hour": 42, # Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.
"minute": 42, # Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.
"timezone": "A String", # Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
},
"handlingBusinessDayConfig": { # The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
"businessDays": [ # Regular business days, such as '"monday"'. May not be empty.
"A String",
],
},
"holidayCutoffs": [ # Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
{
"deadlineDate": "A String", # Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.
"deadlineHour": 42, # Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.
"deadlineTimezone": "A String", # Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
"holidayId": "A String", # Unique identifier for the holiday. Required.
"visibleFromDate": "A String", # Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.
},
],
"maxHandlingTimeInDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `minHandlingTimeInDays`.
"maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `minTransitTimeInDays`.
"minHandlingTimeInDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
"minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `{min,max}TransitTimeInDays` or `transitTimeTable` must be set, but not both.
"transitBusinessDayConfig": { # The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.
"businessDays": [ # Regular business days, such as '"monday"'. 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,max}TransitTimeInDays` or `transitTimeTable` can be set, but not both.
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service.
"A String",
],
"rows": [
{
"values": [
{
"maxTransitTimeInDays": 42, # Must be greater than or equal to `minTransitTimeInDays`.
"minTransitTimeInDays": 42, # Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.
},
],
},
],
"transitTimeLabels": [ # A list of transit time labels. The last value can be `"all other labels"`. Example: `["food", "electronics", "all other labels"]`.
"A String",
],
},
"warehouseBasedDeliveryTimes": [ # 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 DeliveryTime should be set.
{
"carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method.
"carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list.
"originAdministrativeArea": "A String", # Shipping origin's state.
"originCity": "A String", # Shipping origin's city.
"originCountry": "A String", # Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml).
"originPostalCode": "A String", # Shipping origin.
"originStreetAddress": "A String", # Shipping origin's street address
"warehouseName": "A String", # The name of the warehouse. Warehouse name need to be matched with name. If warehouseName is set, the below fields will be ignored. The warehouse info will be read from warehouse.
},
],
},
"eligibility": "A String", # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`"
"minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"minimumOrderValueTable": { # Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value.
"storeCodeSetWithMovs": [
{ # 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": [ # A list of unique store codes or empty for the catch all.
"A String",
],
"value": { # The minimum order value for the given stores.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
],
},
"name": "A String", # Free-form name of the service. Must be unique within target account. Required.
"pickupService": { # The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the `getSupportedPickupServices` method. Required if and only if the service delivery type is `pickup`.
"carrierName": "A String", # The name of the pickup carrier (e.g., `"UPS"`). Required.
"serviceName": "A String", # The name of the pickup service (e.g., `"Access point"`). Required.
},
"rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty `applicableShippingLabels`, which means "everything else". The other `applicableShippingLabels` must not overlap.
{
"applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
"A String",
],
"carrierRates": [ # A list of carrier rates that can be referred to by `mainTable` or `singleValue`.
{
"carrierName": "A String", # Carrier service, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `getSupportedCarriers` method. Required.
"carrierService": "A String", # Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `getSupportedCarriers` method. Required.
"flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example `{ "value": "1", "currency" : "USD" }` adds $1 to the rate, `{ "value": "-3", "currency" : "USD" }` removes $3 from the rate. Optional.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
"originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
"percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the rate by 3%. Optional.
},
],
"mainTable": { # A table defining the rate group, when `singleValue` is not expressive enough. Can only be set if `singleValue` is not set.
"columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"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`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's rows. Required.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"rows": [ # The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required.
{
"cells": [ # The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
{ # The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set.
"carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
"flatRate": { # A flat rate. Can only be set if all other fields are not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set.
"subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
},
],
},
],
},
"name": "A String", # Name of the rate group. Optional. 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 `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if `mainTable` and `subtables` are not set.
"carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
"flatRate": { # A flat rate. Can only be set if all other fields are not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set.
"subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
},
"subtables": [ # A list of subtables referred to by `mainTable`. Can only be set if `mainTable` is set.
{
"columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"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`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's rows. Required.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"rows": [ # The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required.
{
"cells": [ # The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
{ # The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set.
"carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
"flatRate": { # A flat rate. Can only be set if all other fields are not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set.
"subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
},
],
},
],
},
],
},
],
"shipmentType": "A String", # Type of locations this service ships orders to. Acceptable values are: - "`delivery`" - "`pickup`"
},
],
"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. If not set, will be Monday to Friday by default.
"businessDays": [ # Regular business days, such as '"monday"'. May not be empty.
"A String",
],
},
"cutoffTime": { # 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 (24-hour clock) 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": { # 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 (e.g. neighborhoods or suburbs).
"country": "A String", # Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)(e.g. "US").
"postalCode": "A String", # Required. Postal code or ZIP (e.g. "94043"). Required.
"streetAddress": "A String", # Street-level part of the address.
},
},
],
},
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponse".
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(merchantId, accountId, x__xgafv=None)</code>
<pre>Retrieves the shipping settings of the account.
Args:
merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. (required)
accountId: string, The ID of the account for which to get/update shipping settings. (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 account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.
"accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
"postalCodeGroups": [ # A list of postal code groups that can be referred to in `services`. Optional.
{
"country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
"name": "A String", # The name of the postal code group, referred to in headers. Required.
"postalCodeRanges": [ # A range of postal codes. Required.
{
"postalCodeRangeBegin": "A String", # A postal code or a pattern of the form `prefix*` denoting the inclusive lower bound of the range defining the area. Examples values: `"94108"`, `"9410*"`, `"9*"`. Required.
"postalCodeRangeEnd": "A String", # A postal code or a pattern of the form `prefix*` denoting the inclusive upper bound of the range defining the area. It must have the same length as `postalCodeRangeBegin`: if `postalCodeRangeBegin` is a postal code then `postalCodeRangeEnd` must be a postal code too; if `postalCodeRangeBegin` is a pattern then `postalCodeRangeEnd` must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching `postalCodeRangeBegin`.
},
],
},
],
"services": [ # The target account's list of services. Optional.
{
"active": True or False, # A boolean exposing the active status of the shipping service. Required.
"currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
"deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
"deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
"cutoffTime": { # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
"hour": 42, # Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.
"minute": 42, # Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.
"timezone": "A String", # Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
},
"handlingBusinessDayConfig": { # The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
"businessDays": [ # Regular business days, such as '"monday"'. May not be empty.
"A String",
],
},
"holidayCutoffs": [ # Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
{
"deadlineDate": "A String", # Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.
"deadlineHour": 42, # Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.
"deadlineTimezone": "A String", # Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
"holidayId": "A String", # Unique identifier for the holiday. Required.
"visibleFromDate": "A String", # Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.
},
],
"maxHandlingTimeInDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `minHandlingTimeInDays`.
"maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `minTransitTimeInDays`.
"minHandlingTimeInDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
"minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `{min,max}TransitTimeInDays` or `transitTimeTable` must be set, but not both.
"transitBusinessDayConfig": { # The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.
"businessDays": [ # Regular business days, such as '"monday"'. 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,max}TransitTimeInDays` or `transitTimeTable` can be set, but not both.
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service.
"A String",
],
"rows": [
{
"values": [
{
"maxTransitTimeInDays": 42, # Must be greater than or equal to `minTransitTimeInDays`.
"minTransitTimeInDays": 42, # Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.
},
],
},
],
"transitTimeLabels": [ # A list of transit time labels. The last value can be `"all other labels"`. Example: `["food", "electronics", "all other labels"]`.
"A String",
],
},
"warehouseBasedDeliveryTimes": [ # 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 DeliveryTime should be set.
{
"carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method.
"carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list.
"originAdministrativeArea": "A String", # Shipping origin's state.
"originCity": "A String", # Shipping origin's city.
"originCountry": "A String", # Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml).
"originPostalCode": "A String", # Shipping origin.
"originStreetAddress": "A String", # Shipping origin's street address
"warehouseName": "A String", # The name of the warehouse. Warehouse name need to be matched with name. If warehouseName is set, the below fields will be ignored. The warehouse info will be read from warehouse.
},
],
},
"eligibility": "A String", # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`"
"minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"minimumOrderValueTable": { # Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value.
"storeCodeSetWithMovs": [
{ # 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": [ # A list of unique store codes or empty for the catch all.
"A String",
],
"value": { # The minimum order value for the given stores.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
],
},
"name": "A String", # Free-form name of the service. Must be unique within target account. Required.
"pickupService": { # The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the `getSupportedPickupServices` method. Required if and only if the service delivery type is `pickup`.
"carrierName": "A String", # The name of the pickup carrier (e.g., `"UPS"`). Required.
"serviceName": "A String", # The name of the pickup service (e.g., `"Access point"`). Required.
},
"rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty `applicableShippingLabels`, which means "everything else". The other `applicableShippingLabels` must not overlap.
{
"applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
"A String",
],
"carrierRates": [ # A list of carrier rates that can be referred to by `mainTable` or `singleValue`.
{
"carrierName": "A String", # Carrier service, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `getSupportedCarriers` method. Required.
"carrierService": "A String", # Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `getSupportedCarriers` method. Required.
"flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example `{ "value": "1", "currency" : "USD" }` adds $1 to the rate, `{ "value": "-3", "currency" : "USD" }` removes $3 from the rate. Optional.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
"originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
"percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the rate by 3%. Optional.
},
],
"mainTable": { # A table defining the rate group, when `singleValue` is not expressive enough. Can only be set if `singleValue` is not set.
"columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"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`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's rows. Required.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"rows": [ # The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required.
{
"cells": [ # The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
{ # The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set.
"carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
"flatRate": { # A flat rate. Can only be set if all other fields are not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set.
"subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
},
],
},
],
},
"name": "A String", # Name of the rate group. Optional. 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 `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if `mainTable` and `subtables` are not set.
"carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
"flatRate": { # A flat rate. Can only be set if all other fields are not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set.
"subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
},
"subtables": [ # A list of subtables referred to by `mainTable`. Can only be set if `mainTable` is set.
{
"columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"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`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's rows. Required.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"rows": [ # The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required.
{
"cells": [ # The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
{ # The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set.
"carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
"flatRate": { # A flat rate. Can only be set if all other fields are not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set.
"subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
},
],
},
],
},
],
},
],
"shipmentType": "A String", # Type of locations this service ships orders to. Acceptable values are: - "`delivery`" - "`pickup`"
},
],
"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. If not set, will be Monday to Friday by default.
"businessDays": [ # Regular business days, such as '"monday"'. May not be empty.
"A String",
],
},
"cutoffTime": { # 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 (24-hour clock) 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": { # 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 (e.g. neighborhoods or suburbs).
"country": "A String", # Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)(e.g. "US").
"postalCode": "A String", # Required. Postal code or ZIP (e.g. "94043"). Required.
"streetAddress": "A String", # Street-level part of the address.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="getsupportedcarriers">getsupportedcarriers(merchantId, x__xgafv=None)</code>
<pre>Retrieves supported carriers and carrier services for an account.
Args:
merchantId: string, The ID of the account for which to retrieve the supported carriers. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"carriers": [ # A list of supported carriers. May be empty.
{
"country": "A String", # The CLDR country code of the carrier (e.g., "US"). Always present.
"eddServices": [ # A list of services supported for EDD (Estimated Delivery Date) calculation. This is the list of valid values for WarehouseBasedDeliveryTime.carrierService.
"A String",
],
"name": "A String", # The name of the carrier (e.g., `"UPS"`). Always present.
"services": [ # A list of supported services (e.g., `"ground"`) for that carrier. Contains at least one service. This is the list of valid values for CarrierRate.carrierService.
"A String",
],
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedCarriersResponse".
}</pre>
</div>
<div class="method">
<code class="details" id="getsupportedholidays">getsupportedholidays(merchantId, x__xgafv=None)</code>
<pre>Retrieves supported holidays for an account.
Args:
merchantId: string, The ID of the account for which to retrieve the supported holidays. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"holidays": [ # A list of holidays applicable for delivery guarantees. May be empty.
{
"countryCode": "A String", # The CLDR territory code of the country in which the holiday is available. E.g. "US", "DE", "GB". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present.
"date": "A String", # Date of the holiday, in ISO 8601 format. E.g. "2016-12-25" for Christmas 2016. Always present.
"deliveryGuaranteeDate": "A String", # Date on which the order has to arrive at the customer's, in ISO 8601 format. E.g. "2016-12-24" for 24th December 2016. Always present.
"deliveryGuaranteeHour": "A String", # Hour of the day in the delivery location's timezone on the guaranteed delivery date by which the order has to arrive at the customer's. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always present.
"id": "A String", # Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present.
"type": "A String", # The holiday type. Always present. Acceptable values are: - "`Christmas`" - "`Easter`" - "`Father's Day`" - "`Halloween`" - "`Independence Day (USA)`" - "`Mother's Day`" - "`Thanksgiving`" - "`Valentine's Day`"
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedHolidaysResponse".
}</pre>
</div>
<div class="method">
<code class="details" id="getsupportedpickupservices">getsupportedpickupservices(merchantId, x__xgafv=None)</code>
<pre>Retrieves supported pickup services for an account.
Args:
merchantId: string, The ID of the account for which to retrieve the supported pickup services. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedPickupServicesResponse".
"pickupServices": [ # A list of supported pickup services. May be empty.
{
"carrierName": "A String", # The name of the carrier (e.g., `"UPS"`). Always present.
"country": "A String", # The CLDR country code of the carrier (e.g., "US"). Always present.
"serviceName": "A String", # The name of the pickup service (e.g., `"Access point"`). Always present.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(merchantId, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the shipping settings of the sub-accounts in your Merchant Center account.
Args:
merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
maxResults: integer, The maximum number of shipping settings to return in the response, used for paging.
pageToken: string, The token returned by the previous request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsListResponse".
"nextPageToken": "A String", # The token for the retrieval of the next page of shipping settings.
"resources": [
{ # The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.
"accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
"postalCodeGroups": [ # A list of postal code groups that can be referred to in `services`. Optional.
{
"country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
"name": "A String", # The name of the postal code group, referred to in headers. Required.
"postalCodeRanges": [ # A range of postal codes. Required.
{
"postalCodeRangeBegin": "A String", # A postal code or a pattern of the form `prefix*` denoting the inclusive lower bound of the range defining the area. Examples values: `"94108"`, `"9410*"`, `"9*"`. Required.
"postalCodeRangeEnd": "A String", # A postal code or a pattern of the form `prefix*` denoting the inclusive upper bound of the range defining the area. It must have the same length as `postalCodeRangeBegin`: if `postalCodeRangeBegin` is a postal code then `postalCodeRangeEnd` must be a postal code too; if `postalCodeRangeBegin` is a pattern then `postalCodeRangeEnd` must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching `postalCodeRangeBegin`.
},
],
},
],
"services": [ # The target account's list of services. Optional.
{
"active": True or False, # A boolean exposing the active status of the shipping service. Required.
"currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
"deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
"deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
"cutoffTime": { # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
"hour": 42, # Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.
"minute": 42, # Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.
"timezone": "A String", # Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
},
"handlingBusinessDayConfig": { # The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
"businessDays": [ # Regular business days, such as '"monday"'. May not be empty.
"A String",
],
},
"holidayCutoffs": [ # Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
{
"deadlineDate": "A String", # Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.
"deadlineHour": 42, # Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.
"deadlineTimezone": "A String", # Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
"holidayId": "A String", # Unique identifier for the holiday. Required.
"visibleFromDate": "A String", # Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.
},
],
"maxHandlingTimeInDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `minHandlingTimeInDays`.
"maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `minTransitTimeInDays`.
"minHandlingTimeInDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
"minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `{min,max}TransitTimeInDays` or `transitTimeTable` must be set, but not both.
"transitBusinessDayConfig": { # The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.
"businessDays": [ # Regular business days, such as '"monday"'. 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,max}TransitTimeInDays` or `transitTimeTable` can be set, but not both.
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service.
"A String",
],
"rows": [
{
"values": [
{
"maxTransitTimeInDays": 42, # Must be greater than or equal to `minTransitTimeInDays`.
"minTransitTimeInDays": 42, # Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.
},
],
},
],
"transitTimeLabels": [ # A list of transit time labels. The last value can be `"all other labels"`. Example: `["food", "electronics", "all other labels"]`.
"A String",
],
},
"warehouseBasedDeliveryTimes": [ # 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 DeliveryTime should be set.
{
"carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method.
"carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list.
"originAdministrativeArea": "A String", # Shipping origin's state.
"originCity": "A String", # Shipping origin's city.
"originCountry": "A String", # Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml).
"originPostalCode": "A String", # Shipping origin.
"originStreetAddress": "A String", # Shipping origin's street address
"warehouseName": "A String", # The name of the warehouse. Warehouse name need to be matched with name. If warehouseName is set, the below fields will be ignored. The warehouse info will be read from warehouse.
},
],
},
"eligibility": "A String", # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`"
"minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"minimumOrderValueTable": { # Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value.
"storeCodeSetWithMovs": [
{ # 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": [ # A list of unique store codes or empty for the catch all.
"A String",
],
"value": { # The minimum order value for the given stores.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
],
},
"name": "A String", # Free-form name of the service. Must be unique within target account. Required.
"pickupService": { # The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the `getSupportedPickupServices` method. Required if and only if the service delivery type is `pickup`.
"carrierName": "A String", # The name of the pickup carrier (e.g., `"UPS"`). Required.
"serviceName": "A String", # The name of the pickup service (e.g., `"Access point"`). Required.
},
"rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty `applicableShippingLabels`, which means "everything else". The other `applicableShippingLabels` must not overlap.
{
"applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
"A String",
],
"carrierRates": [ # A list of carrier rates that can be referred to by `mainTable` or `singleValue`.
{
"carrierName": "A String", # Carrier service, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `getSupportedCarriers` method. Required.
"carrierService": "A String", # Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `getSupportedCarriers` method. Required.
"flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example `{ "value": "1", "currency" : "USD" }` adds $1 to the rate, `{ "value": "-3", "currency" : "USD" }` removes $3 from the rate. Optional.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
"originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
"percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the rate by 3%. Optional.
},
],
"mainTable": { # A table defining the rate group, when `singleValue` is not expressive enough. Can only be set if `singleValue` is not set.
"columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"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`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's rows. Required.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"rows": [ # The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required.
{
"cells": [ # The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
{ # The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set.
"carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
"flatRate": { # A flat rate. Can only be set if all other fields are not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set.
"subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
},
],
},
],
},
"name": "A String", # Name of the rate group. Optional. 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 `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if `mainTable` and `subtables` are not set.
"carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
"flatRate": { # A flat rate. Can only be set if all other fields are not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set.
"subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
},
"subtables": [ # A list of subtables referred to by `mainTable`. Can only be set if `mainTable` is set.
{
"columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"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`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's rows. Required.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"rows": [ # The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required.
{
"cells": [ # The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
{ # The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set.
"carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
"flatRate": { # A flat rate. Can only be set if all other fields are not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set.
"subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
},
],
},
],
},
],
},
],
"shipmentType": "A String", # Type of locations this service ships orders to. Acceptable values are: - "`delivery`" - "`pickup`"
},
],
"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. If not set, will be Monday to Friday by default.
"businessDays": [ # Regular business days, such as '"monday"'. May not be empty.
"A String",
],
},
"cutoffTime": { # 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 (24-hour clock) 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": { # 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 (e.g. neighborhoods or suburbs).
"country": "A String", # Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)(e.g. "US").
"postalCode": "A String", # Required. Postal code or ZIP (e.g. "94043"). Required.
"streetAddress": "A String", # Street-level part of the address.
},
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="update">update(merchantId, accountId, body=None, dryRun=None, x__xgafv=None)</code>
<pre>Updates the shipping settings of the account. Any fields that are not provided are deleted from the resource.
Args:
merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. (required)
accountId: string, The ID of the account for which to get/update shipping settings. (required)
body: object, The request body.
The object takes the form of:
{ # The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.
"accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
"postalCodeGroups": [ # A list of postal code groups that can be referred to in `services`. Optional.
{
"country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
"name": "A String", # The name of the postal code group, referred to in headers. Required.
"postalCodeRanges": [ # A range of postal codes. Required.
{
"postalCodeRangeBegin": "A String", # A postal code or a pattern of the form `prefix*` denoting the inclusive lower bound of the range defining the area. Examples values: `"94108"`, `"9410*"`, `"9*"`. Required.
"postalCodeRangeEnd": "A String", # A postal code or a pattern of the form `prefix*` denoting the inclusive upper bound of the range defining the area. It must have the same length as `postalCodeRangeBegin`: if `postalCodeRangeBegin` is a postal code then `postalCodeRangeEnd` must be a postal code too; if `postalCodeRangeBegin` is a pattern then `postalCodeRangeEnd` must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching `postalCodeRangeBegin`.
},
],
},
],
"services": [ # The target account's list of services. Optional.
{
"active": True or False, # A boolean exposing the active status of the shipping service. Required.
"currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
"deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
"deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
"cutoffTime": { # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
"hour": 42, # Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.
"minute": 42, # Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.
"timezone": "A String", # Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
},
"handlingBusinessDayConfig": { # The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
"businessDays": [ # Regular business days, such as '"monday"'. May not be empty.
"A String",
],
},
"holidayCutoffs": [ # Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
{
"deadlineDate": "A String", # Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.
"deadlineHour": 42, # Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.
"deadlineTimezone": "A String", # Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
"holidayId": "A String", # Unique identifier for the holiday. Required.
"visibleFromDate": "A String", # Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.
},
],
"maxHandlingTimeInDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `minHandlingTimeInDays`.
"maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `minTransitTimeInDays`.
"minHandlingTimeInDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
"minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `{min,max}TransitTimeInDays` or `transitTimeTable` must be set, but not both.
"transitBusinessDayConfig": { # The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.
"businessDays": [ # Regular business days, such as '"monday"'. 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,max}TransitTimeInDays` or `transitTimeTable` can be set, but not both.
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service.
"A String",
],
"rows": [
{
"values": [
{
"maxTransitTimeInDays": 42, # Must be greater than or equal to `minTransitTimeInDays`.
"minTransitTimeInDays": 42, # Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.
},
],
},
],
"transitTimeLabels": [ # A list of transit time labels. The last value can be `"all other labels"`. Example: `["food", "electronics", "all other labels"]`.
"A String",
],
},
"warehouseBasedDeliveryTimes": [ # 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 DeliveryTime should be set.
{
"carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method.
"carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list.
"originAdministrativeArea": "A String", # Shipping origin's state.
"originCity": "A String", # Shipping origin's city.
"originCountry": "A String", # Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml).
"originPostalCode": "A String", # Shipping origin.
"originStreetAddress": "A String", # Shipping origin's street address
"warehouseName": "A String", # The name of the warehouse. Warehouse name need to be matched with name. If warehouseName is set, the below fields will be ignored. The warehouse info will be read from warehouse.
},
],
},
"eligibility": "A String", # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`"
"minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"minimumOrderValueTable": { # Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value.
"storeCodeSetWithMovs": [
{ # 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": [ # A list of unique store codes or empty for the catch all.
"A String",
],
"value": { # The minimum order value for the given stores.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
],
},
"name": "A String", # Free-form name of the service. Must be unique within target account. Required.
"pickupService": { # The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the `getSupportedPickupServices` method. Required if and only if the service delivery type is `pickup`.
"carrierName": "A String", # The name of the pickup carrier (e.g., `"UPS"`). Required.
"serviceName": "A String", # The name of the pickup service (e.g., `"Access point"`). Required.
},
"rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty `applicableShippingLabels`, which means "everything else". The other `applicableShippingLabels` must not overlap.
{
"applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
"A String",
],
"carrierRates": [ # A list of carrier rates that can be referred to by `mainTable` or `singleValue`.
{
"carrierName": "A String", # Carrier service, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `getSupportedCarriers` method. Required.
"carrierService": "A String", # Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `getSupportedCarriers` method. Required.
"flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example `{ "value": "1", "currency" : "USD" }` adds $1 to the rate, `{ "value": "-3", "currency" : "USD" }` removes $3 from the rate. Optional.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
"originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
"percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the rate by 3%. Optional.
},
],
"mainTable": { # A table defining the rate group, when `singleValue` is not expressive enough. Can only be set if `singleValue` is not set.
"columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"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`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's rows. Required.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"rows": [ # The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required.
{
"cells": [ # The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
{ # The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set.
"carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
"flatRate": { # A flat rate. Can only be set if all other fields are not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set.
"subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
},
],
},
],
},
"name": "A String", # Name of the rate group. Optional. 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 `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if `mainTable` and `subtables` are not set.
"carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
"flatRate": { # A flat rate. Can only be set if all other fields are not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set.
"subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
},
"subtables": [ # A list of subtables referred to by `mainTable`. Can only be set if `mainTable` is set.
{
"columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"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`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's rows. Required.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"rows": [ # The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required.
{
"cells": [ # The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
{ # The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set.
"carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
"flatRate": { # A flat rate. Can only be set if all other fields are not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set.
"subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
},
],
},
],
},
],
},
],
"shipmentType": "A String", # Type of locations this service ships orders to. Acceptable values are: - "`delivery`" - "`pickup`"
},
],
"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. If not set, will be Monday to Friday by default.
"businessDays": [ # Regular business days, such as '"monday"'. May not be empty.
"A String",
],
},
"cutoffTime": { # 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 (24-hour clock) 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": { # 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 (e.g. neighborhoods or suburbs).
"country": "A String", # Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)(e.g. "US").
"postalCode": "A String", # Required. Postal code or ZIP (e.g. "94043"). Required.
"streetAddress": "A String", # Street-level part of the address.
},
},
],
}
dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.
"accountId": "A String", # The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.
"postalCodeGroups": [ # A list of postal code groups that can be referred to in `services`. Optional.
{
"country": "A String", # The CLDR territory code of the country the postal code group applies to. Required.
"name": "A String", # The name of the postal code group, referred to in headers. Required.
"postalCodeRanges": [ # A range of postal codes. Required.
{
"postalCodeRangeBegin": "A String", # A postal code or a pattern of the form `prefix*` denoting the inclusive lower bound of the range defining the area. Examples values: `"94108"`, `"9410*"`, `"9*"`. Required.
"postalCodeRangeEnd": "A String", # A postal code or a pattern of the form `prefix*` denoting the inclusive upper bound of the range defining the area. It must have the same length as `postalCodeRangeBegin`: if `postalCodeRangeBegin` is a postal code then `postalCodeRangeEnd` must be a postal code too; if `postalCodeRangeBegin` is a pattern then `postalCodeRangeEnd` must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching `postalCodeRangeBegin`.
},
],
},
],
"services": [ # The target account's list of services. Optional.
{
"active": True or False, # A boolean exposing the active status of the shipping service. Required.
"currency": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
"deliveryCountry": "A String", # The CLDR territory code of the country to which the service applies. Required.
"deliveryTime": { # Time spent in various aspects from order to the delivery of the product. Required.
"cutoffTime": { # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
"hour": 42, # Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.
"minute": 42, # Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.
"timezone": "A String", # Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
},
"handlingBusinessDayConfig": { # The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
"businessDays": [ # Regular business days, such as '"monday"'. May not be empty.
"A String",
],
},
"holidayCutoffs": [ # Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
{
"deadlineDate": "A String", # Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.
"deadlineHour": 42, # Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.
"deadlineTimezone": "A String", # Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
"holidayId": "A String", # Unique identifier for the holiday. Required.
"visibleFromDate": "A String", # Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.
},
],
"maxHandlingTimeInDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `minHandlingTimeInDays`.
"maxTransitTimeInDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `minTransitTimeInDays`.
"minHandlingTimeInDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
"minTransitTimeInDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `{min,max}TransitTimeInDays` or `transitTimeTable` must be set, but not both.
"transitBusinessDayConfig": { # The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.
"businessDays": [ # Regular business days, such as '"monday"'. 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,max}TransitTimeInDays` or `transitTimeTable` can be set, but not both.
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service.
"A String",
],
"rows": [
{
"values": [
{
"maxTransitTimeInDays": 42, # Must be greater than or equal to `minTransitTimeInDays`.
"minTransitTimeInDays": 42, # Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.
},
],
},
],
"transitTimeLabels": [ # A list of transit time labels. The last value can be `"all other labels"`. Example: `["food", "electronics", "all other labels"]`.
"A String",
],
},
"warehouseBasedDeliveryTimes": [ # 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 DeliveryTime should be set.
{
"carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method.
"carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list.
"originAdministrativeArea": "A String", # Shipping origin's state.
"originCity": "A String", # Shipping origin's city.
"originCountry": "A String", # Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml).
"originPostalCode": "A String", # Shipping origin.
"originStreetAddress": "A String", # Shipping origin's street address
"warehouseName": "A String", # The name of the warehouse. Warehouse name need to be matched with name. If warehouseName is set, the below fields will be ignored. The warehouse info will be read from warehouse.
},
],
},
"eligibility": "A String", # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`"
"minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"minimumOrderValueTable": { # Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value.
"storeCodeSetWithMovs": [
{ # 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": [ # A list of unique store codes or empty for the catch all.
"A String",
],
"value": { # The minimum order value for the given stores.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
],
},
"name": "A String", # Free-form name of the service. Must be unique within target account. Required.
"pickupService": { # The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the `getSupportedPickupServices` method. Required if and only if the service delivery type is `pickup`.
"carrierName": "A String", # The name of the pickup carrier (e.g., `"UPS"`). Required.
"serviceName": "A String", # The name of the pickup service (e.g., `"Access point"`). Required.
},
"rateGroups": [ # Shipping rate group definitions. Only the last one is allowed to have an empty `applicableShippingLabels`, which means "everything else". The other `applicableShippingLabels` must not overlap.
{
"applicableShippingLabels": [ # A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
"A String",
],
"carrierRates": [ # A list of carrier rates that can be referred to by `mainTable` or `singleValue`.
{
"carrierName": "A String", # Carrier service, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `getSupportedCarriers` method. Required.
"carrierService": "A String", # Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `getSupportedCarriers` method. Required.
"flatAdjustment": { # Additive shipping rate modifier. Can be negative. For example `{ "value": "1", "currency" : "USD" }` adds $1 to the rate, `{ "value": "-3", "currency" : "USD" }` removes $3 from the rate. Optional.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"name": "A String", # Name of the carrier rate. Must be unique per rate group. Required.
"originPostalCode": "A String", # Shipping origin for this carrier rate. Required.
"percentageAdjustment": "A String", # Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the rate by 3%. Optional.
},
],
"mainTable": { # A table defining the rate group, when `singleValue` is not expressive enough. Can only be set if `singleValue` is not set.
"columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"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`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's rows. Required.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"rows": [ # The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required.
{
"cells": [ # The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
{ # The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set.
"carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
"flatRate": { # A flat rate. Can only be set if all other fields are not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set.
"subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
},
],
},
],
},
"name": "A String", # Name of the rate group. Optional. 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 `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set. # The value of the rate group (e.g. flat rate $10). Can only be set if `mainTable` and `subtables` are not set.
"carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
"flatRate": { # A flat rate. Can only be set if all other fields are not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set.
"subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
},
"subtables": [ # A list of subtables referred to by `mainTable`. Can only be set if `mainTable` is set.
{
"columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"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`, `numItems`, `postalCodeGroupNames`, or `location` must be set. # Headers of the table's rows. Required.
"locations": [ # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
{
"locationIds": [ # A non-empty list of location IDs. They must all be of the same location type (e.g., state).
"A String",
],
},
],
"numberOfItems": [ # A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"postalCodeGroupNames": [ # A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
"A String",
],
"prices": [ # A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.
{
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
],
"weights": [ # A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.
{
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`"
"value": "A String", # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
],
},
"rows": [ # The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required.
{
"cells": [ # The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required.
{ # The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set.
"carrierRateName": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
"flatRate": { # A flat rate. Can only be set if all other fields are not set.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"noShipping": True or False, # If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.
"pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set.
"subtableName": "A String", # The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.
},
],
},
],
},
],
},
],
"shipmentType": "A String", # Type of locations this service ships orders to. Acceptable values are: - "`delivery`" - "`pickup`"
},
],
"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. If not set, will be Monday to Friday by default.
"businessDays": [ # Regular business days, such as '"monday"'. May not be empty.
"A String",
],
},
"cutoffTime": { # 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 (24-hour clock) 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": { # 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 (e.g. neighborhoods or suburbs).
"country": "A String", # Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)(e.g. "US").
"postalCode": "A String", # Required. Postal code or ZIP (e.g. "94043"). Required.
"streetAddress": "A String", # Street-level part of the address.
},
},
],
}</pre>
</div>
</body></html>
|