@whiplashmerch/whiplash-api-client 3.1.12 → 3.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.esm.js +4 -4
- package/dist/client.esm.js.map +1 -1
- package/dist/generated/data-contracts.d.ts +1024 -2551
- package/dist/utils/orderBatchItems.d.ts +2 -2
- package/dist/utils/warehouse.d.ts +2 -2
- package/generated/data-contracts.ts +356 -890
- package/package.json +1 -1
|
@@ -71,11 +71,8 @@ export interface ApiV2EntitiesBundleItem {
|
|
|
71
71
|
|
|
72
72
|
/** V2 */
|
|
73
73
|
export interface ApiV2EntitiesConsumerReturn {
|
|
74
|
-
/**
|
|
75
|
-
|
|
76
|
-
* @format float
|
|
77
|
-
*/
|
|
78
|
-
ship_3rdparty_cost?: number | null;
|
|
74
|
+
/** 3rd party cost for the consumer return */
|
|
75
|
+
ship_3rdparty_cost?: string | null;
|
|
79
76
|
/**
|
|
80
77
|
* the consumer return arrival date and time
|
|
81
78
|
* @format date-time
|
|
@@ -153,11 +150,8 @@ export interface ApiV2EntitiesConsumerReturn {
|
|
|
153
150
|
return_items?: ApiV2EntitiesReturnItem[];
|
|
154
151
|
/** the consumer return sender */
|
|
155
152
|
sender?: string | null;
|
|
156
|
-
/**
|
|
157
|
-
|
|
158
|
-
* @format float
|
|
159
|
-
*/
|
|
160
|
-
ship_actual_cost?: number | null;
|
|
153
|
+
/** the consumer return actual cost of shipping */
|
|
154
|
+
ship_actual_cost?: string | null;
|
|
161
155
|
/** currency used for this consumer return */
|
|
162
156
|
ship_actual_currency?: string | null;
|
|
163
157
|
/** url of the shipping label */
|
|
@@ -398,16 +392,10 @@ export interface ApiV2EntitiesCustomer {
|
|
|
398
392
|
primary_contact?: string;
|
|
399
393
|
project_task_labels?: string[];
|
|
400
394
|
receiving_fields?: object[];
|
|
401
|
-
/**
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
replenishment_min?: number | null;
|
|
406
|
-
/**
|
|
407
|
-
* Target number of days stock to replenish forward pick locations
|
|
408
|
-
* @format float
|
|
409
|
-
*/
|
|
410
|
-
replenishment_target?: number | null;
|
|
395
|
+
/** Minimum number of days worth of stock to keep in forward pick locations */
|
|
396
|
+
replenishment_min?: string | null;
|
|
397
|
+
/** Target number of days stock to replenish forward pick locations */
|
|
398
|
+
replenishment_target?: string | null;
|
|
411
399
|
/** request serial numbers? */
|
|
412
400
|
request_serial_numbers?: boolean | null;
|
|
413
401
|
/** Customer return city. */
|
|
@@ -621,16 +609,10 @@ export interface ApiV2EntitiesCustomerShallow {
|
|
|
621
609
|
primary_contact?: string;
|
|
622
610
|
project_task_labels?: string[];
|
|
623
611
|
receiving_fields?: object[];
|
|
624
|
-
/**
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
replenishment_min?: number;
|
|
629
|
-
/**
|
|
630
|
-
* Target number of days stock to replenish forward pick locations
|
|
631
|
-
* @format float
|
|
632
|
-
*/
|
|
633
|
-
replenishment_target?: number;
|
|
612
|
+
/** Minimum number of days worth of stock to keep in forward pick locations */
|
|
613
|
+
replenishment_min?: string;
|
|
614
|
+
/** Target number of days stock to replenish forward pick locations */
|
|
615
|
+
replenishment_target?: string;
|
|
634
616
|
/** request serial numbers? */
|
|
635
617
|
request_serial_numbers?: boolean;
|
|
636
618
|
/** Customer return city. */
|
|
@@ -850,11 +832,8 @@ export interface ApiV2EntitiesItem {
|
|
|
850
832
|
hazmat?: boolean;
|
|
851
833
|
/** hazmat class */
|
|
852
834
|
hazmat_type?: ApiV2EntitiesItemHazmatType;
|
|
853
|
-
/**
|
|
854
|
-
|
|
855
|
-
* @format float
|
|
856
|
-
*/
|
|
857
|
-
height?: number | null;
|
|
835
|
+
/** the item height (in inches) */
|
|
836
|
+
height?: string | null;
|
|
858
837
|
/**
|
|
859
838
|
* the item id
|
|
860
839
|
* @format int32
|
|
@@ -870,11 +849,8 @@ export interface ApiV2EntitiesItem {
|
|
|
870
849
|
is_bundle?: boolean | null;
|
|
871
850
|
/** label format */
|
|
872
851
|
label_format?: ApiV2EntitiesItemLabelFormat;
|
|
873
|
-
/**
|
|
874
|
-
|
|
875
|
-
* @format float
|
|
876
|
-
*/
|
|
877
|
-
length?: number | null;
|
|
852
|
+
/** the item length (in inches) */
|
|
853
|
+
length?: string | null;
|
|
878
854
|
/** does this item require lot control? */
|
|
879
855
|
lot_control?: boolean | null;
|
|
880
856
|
/**
|
|
@@ -903,11 +879,8 @@ export interface ApiV2EntitiesItem {
|
|
|
903
879
|
packaging?: boolean | null;
|
|
904
880
|
/** the item packaging type */
|
|
905
881
|
packaging_type?: ApiV2EntitiesItemPackagingType;
|
|
906
|
-
/**
|
|
907
|
-
|
|
908
|
-
* @format float
|
|
909
|
-
*/
|
|
910
|
-
price?: number | null;
|
|
882
|
+
/** the item price */
|
|
883
|
+
price?: string | null;
|
|
911
884
|
/** is the item a promo? */
|
|
912
885
|
promo?: boolean | null;
|
|
913
886
|
/**
|
|
@@ -920,16 +893,10 @@ export interface ApiV2EntitiesItem {
|
|
|
920
893
|
* @format int32
|
|
921
894
|
*/
|
|
922
895
|
quantity?: number;
|
|
923
|
-
/**
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
replenishment_min?: number | null;
|
|
928
|
-
/**
|
|
929
|
-
* Target number of days stock to replenish forward pick locations
|
|
930
|
-
* @format float
|
|
931
|
-
*/
|
|
932
|
-
replenishment_target?: number | null;
|
|
896
|
+
/** Minimum number of days worth of stock to keep in forward pick locations */
|
|
897
|
+
replenishment_min?: string | null;
|
|
898
|
+
/** Target number of days stock to replenish forward pick locations */
|
|
899
|
+
replenishment_target?: string | null;
|
|
933
900
|
/** does the item require a serial number when shipping? */
|
|
934
901
|
request_serial_number?: boolean | null;
|
|
935
902
|
/** is the item return price restricted? */
|
|
@@ -970,21 +937,12 @@ export interface ApiV2EntitiesItem {
|
|
|
970
937
|
velocity?: number | null;
|
|
971
938
|
/** the item vendor */
|
|
972
939
|
vendor?: string | null;
|
|
973
|
-
/**
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
* the wholesale cost of the item
|
|
980
|
-
* @format float
|
|
981
|
-
*/
|
|
982
|
-
wholesale_cost?: number | null;
|
|
983
|
-
/**
|
|
984
|
-
* the item width (in inches)
|
|
985
|
-
* @format float
|
|
986
|
-
*/
|
|
987
|
-
width?: number | null;
|
|
940
|
+
/** the weight of the item (in pounds) */
|
|
941
|
+
weight?: string | null;
|
|
942
|
+
/** the wholesale cost of the item */
|
|
943
|
+
wholesale_cost?: string | null;
|
|
944
|
+
/** the item width (in inches) */
|
|
945
|
+
width?: string | null;
|
|
988
946
|
}
|
|
989
947
|
|
|
990
948
|
/** V2 */
|
|
@@ -1038,11 +996,8 @@ export interface ApiV2EntitiesItemWarehouseQuantity {
|
|
|
1038
996
|
accepting_new_customers?: boolean;
|
|
1039
997
|
/** Is the Warehouse active? (partners only) */
|
|
1040
998
|
active?: boolean;
|
|
1041
|
-
/**
|
|
1042
|
-
|
|
1043
|
-
* @format float
|
|
1044
|
-
*/
|
|
1045
|
-
bin_cubic_volume_max?: number;
|
|
999
|
+
/** Maximum cubic volume per bin (staff only) */
|
|
1000
|
+
bin_cubic_volume_max?: string;
|
|
1046
1001
|
/**
|
|
1047
1002
|
* Maximum total items per bin (staff only)
|
|
1048
1003
|
* @format int32
|
|
@@ -1078,21 +1033,15 @@ export interface ApiV2EntitiesItemWarehouseQuantity {
|
|
|
1078
1033
|
international_return_labels?: boolean;
|
|
1079
1034
|
/** Warehouse label format (partners only) */
|
|
1080
1035
|
label_format?: string;
|
|
1081
|
-
/**
|
|
1082
|
-
|
|
1083
|
-
* @format float
|
|
1084
|
-
*/
|
|
1085
|
-
latitude?: number;
|
|
1036
|
+
/** Warehouse latitude */
|
|
1037
|
+
latitude?: string;
|
|
1086
1038
|
/**
|
|
1087
1039
|
* Loading Dock Quantity (partners only)
|
|
1088
1040
|
* @format int32
|
|
1089
1041
|
*/
|
|
1090
1042
|
loading_dock_quantity?: number;
|
|
1091
|
-
/**
|
|
1092
|
-
|
|
1093
|
-
* @format float
|
|
1094
|
-
*/
|
|
1095
|
-
longitude?: number;
|
|
1043
|
+
/** Warehouse longitude */
|
|
1044
|
+
longitude?: string;
|
|
1096
1045
|
/** the warehouse name */
|
|
1097
1046
|
name?: string;
|
|
1098
1047
|
/** Miscellaneous notes/info (partners only) */
|
|
@@ -1165,11 +1114,8 @@ export interface ApiV2EntitiesItemWarehouseQuantity {
|
|
|
1165
1114
|
ups_carrier_facility?: string;
|
|
1166
1115
|
/** Warehouse UPS shipping number (partners only) */
|
|
1167
1116
|
ups_shipper_number?: string;
|
|
1168
|
-
/**
|
|
1169
|
-
|
|
1170
|
-
* @format float
|
|
1171
|
-
*/
|
|
1172
|
-
vat?: number;
|
|
1117
|
+
/** Warehouse VAT number (partners only) */
|
|
1118
|
+
vat?: string;
|
|
1173
1119
|
warehouse_features?: ApiV2EntitiesWarehouseFeature[];
|
|
1174
1120
|
}
|
|
1175
1121
|
|
|
@@ -1326,11 +1272,8 @@ export interface ApiV2EntitiesOrder {
|
|
|
1326
1272
|
return_address_2?: string | null;
|
|
1327
1273
|
/** the order third party shipping account */
|
|
1328
1274
|
ship_3rdparty_account?: string | null;
|
|
1329
|
-
/**
|
|
1330
|
-
|
|
1331
|
-
* @format float
|
|
1332
|
-
*/
|
|
1333
|
-
ship_3rdparty_cost?: number;
|
|
1275
|
+
/** the order third party shipping cost */
|
|
1276
|
+
ship_3rdparty_cost?: string;
|
|
1334
1277
|
/** the order third party shipping country */
|
|
1335
1278
|
ship_3rdparty_country?: string | null;
|
|
1336
1279
|
/** the order third party shipping zip */
|
|
@@ -1494,11 +1437,8 @@ export interface ApiV2EntitiesOrder {
|
|
|
1494
1437
|
* @format int32
|
|
1495
1438
|
*/
|
|
1496
1439
|
quote_id?: number | null;
|
|
1497
|
-
/**
|
|
1498
|
-
|
|
1499
|
-
* @format float
|
|
1500
|
-
*/
|
|
1501
|
-
req_insurance_value?: number | null;
|
|
1440
|
+
/** the order requested insurance value */
|
|
1441
|
+
req_insurance_value?: string | null;
|
|
1502
1442
|
/** the order requested address */
|
|
1503
1443
|
requested_address?: string | null;
|
|
1504
1444
|
/** does the order require an adult signature upon delivery? */
|
|
@@ -1540,11 +1480,8 @@ export interface ApiV2EntitiesOrder {
|
|
|
1540
1480
|
/** the orders Standard Carrier Alpha Code number */
|
|
1541
1481
|
scac?: string | null;
|
|
1542
1482
|
serial_numbers?: ApiV2EntitiesSerialNumber[];
|
|
1543
|
-
/**
|
|
1544
|
-
|
|
1545
|
-
* @format float
|
|
1546
|
-
*/
|
|
1547
|
-
ship_actual_cost?: number | null;
|
|
1483
|
+
/** the order actual cost of shipping */
|
|
1484
|
+
ship_actual_cost?: string | null;
|
|
1548
1485
|
/** the order ship method */
|
|
1549
1486
|
ship_method?: string;
|
|
1550
1487
|
/** the order ship notes */
|
|
@@ -1586,11 +1523,8 @@ export interface ApiV2EntitiesOrder {
|
|
|
1586
1523
|
shop_created_at?: string | null;
|
|
1587
1524
|
/** the order shop shipping method currency */
|
|
1588
1525
|
shop_shipping_method_currency?: string | null;
|
|
1589
|
-
/**
|
|
1590
|
-
|
|
1591
|
-
* @format float
|
|
1592
|
-
*/
|
|
1593
|
-
shop_shipping_method_price?: number | null;
|
|
1526
|
+
/** the order shop shipping method price */
|
|
1527
|
+
shop_shipping_method_price?: string | null;
|
|
1594
1528
|
/**
|
|
1595
1529
|
* the order shop shipping method text
|
|
1596
1530
|
* ge_standard = order uses global-e standard shipping method
|
|
@@ -1758,11 +1692,8 @@ export interface ApiV2EntitiesOrderItem {
|
|
|
1758
1692
|
* @format int32
|
|
1759
1693
|
*/
|
|
1760
1694
|
packed?: number | null;
|
|
1761
|
-
/**
|
|
1762
|
-
|
|
1763
|
-
* @format float
|
|
1764
|
-
*/
|
|
1765
|
-
price?: number | null;
|
|
1695
|
+
/** price of this item */
|
|
1696
|
+
price?: string | null;
|
|
1766
1697
|
/** is this item a promo? */
|
|
1767
1698
|
promo?: boolean | null;
|
|
1768
1699
|
/**
|
|
@@ -1777,11 +1708,8 @@ export interface ApiV2EntitiesOrderItem {
|
|
|
1777
1708
|
quote_item_id?: number | null;
|
|
1778
1709
|
/** does the item require a serial number when shipping? */
|
|
1779
1710
|
request_serial_number?: boolean | null;
|
|
1780
|
-
/**
|
|
1781
|
-
|
|
1782
|
-
* @format float
|
|
1783
|
-
*/
|
|
1784
|
-
retail_fee?: number | null;
|
|
1711
|
+
/** retail fee of this item */
|
|
1712
|
+
retail_fee?: string | null;
|
|
1785
1713
|
/** is this item returnable? */
|
|
1786
1714
|
returnable?: boolean | null;
|
|
1787
1715
|
/** the SKU of this item */
|
|
@@ -1793,16 +1721,10 @@ export interface ApiV2EntitiesOrderItem {
|
|
|
1793
1721
|
* @format date-time
|
|
1794
1722
|
*/
|
|
1795
1723
|
updated_at?: string | null;
|
|
1796
|
-
/**
|
|
1797
|
-
|
|
1798
|
-
|
|
1799
|
-
|
|
1800
|
-
wholesale_cost?: number | null;
|
|
1801
|
-
/**
|
|
1802
|
-
* wholesale fee of this item
|
|
1803
|
-
* @format float
|
|
1804
|
-
*/
|
|
1805
|
-
wholesale_fee?: number | null;
|
|
1724
|
+
/** wholesale cost of the item */
|
|
1725
|
+
wholesale_cost?: string | null;
|
|
1726
|
+
/** wholesale fee of this item */
|
|
1727
|
+
wholesale_fee?: string | null;
|
|
1806
1728
|
wholesale_item?: ApiV2EntitiesWholesaleItem;
|
|
1807
1729
|
}
|
|
1808
1730
|
|
|
@@ -1879,31 +1801,16 @@ export interface ApiV2EntitiesPackage {
|
|
|
1879
1801
|
barcode_sscc18?: string | null;
|
|
1880
1802
|
/** the UCC128 carton label for the package */
|
|
1881
1803
|
ucc128?: string | null;
|
|
1882
|
-
/**
|
|
1883
|
-
|
|
1884
|
-
|
|
1885
|
-
|
|
1886
|
-
|
|
1887
|
-
|
|
1888
|
-
|
|
1889
|
-
|
|
1890
|
-
|
|
1891
|
-
|
|
1892
|
-
/**
|
|
1893
|
-
* the package length (in inches)
|
|
1894
|
-
* @format float
|
|
1895
|
-
*/
|
|
1896
|
-
actual_length?: number | null;
|
|
1897
|
-
/**
|
|
1898
|
-
* the package weight (in ounces)
|
|
1899
|
-
* @format float
|
|
1900
|
-
*/
|
|
1901
|
-
actual_weight?: number | null;
|
|
1902
|
-
/**
|
|
1903
|
-
* the package width (in inches)
|
|
1904
|
-
* @format float
|
|
1905
|
-
*/
|
|
1906
|
-
actual_width?: number | null;
|
|
1804
|
+
/** the package dimensional weight (in ounces) */
|
|
1805
|
+
actual_dimensional_weight?: string | null;
|
|
1806
|
+
/** the package height (in inches) */
|
|
1807
|
+
actual_height?: string | null;
|
|
1808
|
+
/** the package length (in inches) */
|
|
1809
|
+
actual_length?: string | null;
|
|
1810
|
+
/** the package weight (in ounces) */
|
|
1811
|
+
actual_weight?: string | null;
|
|
1812
|
+
/** the package width (in inches) */
|
|
1813
|
+
actual_width?: string | null;
|
|
1907
1814
|
/**
|
|
1908
1815
|
* the package batch id (staff only)
|
|
1909
1816
|
* @format int32
|
|
@@ -1947,11 +1854,8 @@ export interface ApiV2EntitiesPackage {
|
|
|
1947
1854
|
* @format date-time
|
|
1948
1855
|
*/
|
|
1949
1856
|
scanned_to_pallet_at?: string | null;
|
|
1950
|
-
/**
|
|
1951
|
-
|
|
1952
|
-
* @format float
|
|
1953
|
-
*/
|
|
1954
|
-
ship_actual_cost?: number | null;
|
|
1857
|
+
/** the package shipping cost */
|
|
1858
|
+
ship_actual_cost?: string | null;
|
|
1955
1859
|
/** currency used for this package */
|
|
1956
1860
|
ship_actual_currency?: string | null;
|
|
1957
1861
|
/**
|
|
@@ -1991,11 +1895,8 @@ export interface ApiV2EntitiesPackage {
|
|
|
1991
1895
|
|
|
1992
1896
|
/** V2 */
|
|
1993
1897
|
export interface ApiV2EntitiesProjectTask {
|
|
1994
|
-
/**
|
|
1995
|
-
|
|
1996
|
-
* @format float
|
|
1997
|
-
*/
|
|
1998
|
-
cost_per_unit?: number | null;
|
|
1898
|
+
/** cost per unit, if task has custom label */
|
|
1899
|
+
cost_per_unit?: string | null;
|
|
1999
1900
|
/**
|
|
2000
1901
|
* project_task created_at
|
|
2001
1902
|
* @format date-time
|
|
@@ -2017,11 +1918,8 @@ export interface ApiV2EntitiesProjectTask {
|
|
|
2017
1918
|
* @format int32
|
|
2018
1919
|
*/
|
|
2019
1920
|
project_id?: number;
|
|
2020
|
-
/**
|
|
2021
|
-
|
|
2022
|
-
* @format float
|
|
2023
|
-
*/
|
|
2024
|
-
quantity?: number;
|
|
1921
|
+
/** quantity of units */
|
|
1922
|
+
quantity?: string;
|
|
2025
1923
|
/**
|
|
2026
1924
|
* project_task updated_at
|
|
2027
1925
|
* @format date-time
|
|
@@ -2165,11 +2063,8 @@ export interface ApiV2EntitiesSerialNumber {
|
|
|
2165
2063
|
|
|
2166
2064
|
/** V2 */
|
|
2167
2065
|
export interface ApiV2EntitiesShipnotice {
|
|
2168
|
-
/**
|
|
2169
|
-
|
|
2170
|
-
* @format float
|
|
2171
|
-
*/
|
|
2172
|
-
ship_3rdparty_cost?: number | null;
|
|
2066
|
+
/** 3rd party cost for the shipnotice */
|
|
2067
|
+
ship_3rdparty_cost?: string | null;
|
|
2173
2068
|
/**
|
|
2174
2069
|
* the shipnotice arrival date and time
|
|
2175
2070
|
* @format date-time
|
|
@@ -2260,11 +2155,8 @@ export interface ApiV2EntitiesShipnotice {
|
|
|
2260
2155
|
requires_label?: boolean | null;
|
|
2261
2156
|
/** the shipnotice sender */
|
|
2262
2157
|
sender?: string | null;
|
|
2263
|
-
/**
|
|
2264
|
-
|
|
2265
|
-
* @format float
|
|
2266
|
-
*/
|
|
2267
|
-
ship_actual_cost?: number | null;
|
|
2158
|
+
/** the shipnotice actual cost of shipping */
|
|
2159
|
+
ship_actual_cost?: string | null;
|
|
2268
2160
|
/** currency used for this shipnotice */
|
|
2269
2161
|
ship_actual_currency?: string | null;
|
|
2270
2162
|
/**
|
|
@@ -2406,11 +2298,8 @@ export interface ApiV2EntitiesShipnoticeItem {
|
|
|
2406
2298
|
* @format int32
|
|
2407
2299
|
*/
|
|
2408
2300
|
unallocated?: number;
|
|
2409
|
-
/**
|
|
2410
|
-
|
|
2411
|
-
* @format float
|
|
2412
|
-
*/
|
|
2413
|
-
unit_cost?: number | null;
|
|
2301
|
+
/** unit cost for this shipnotice item */
|
|
2302
|
+
unit_cost?: string | null;
|
|
2414
2303
|
/**
|
|
2415
2304
|
* the shipnotice item last update date and time
|
|
2416
2305
|
* @format date-time
|
|
@@ -2680,11 +2569,8 @@ export interface ApiV2EntitiesWarehouse {
|
|
|
2680
2569
|
accepting_new_customers?: boolean | null;
|
|
2681
2570
|
/** Is the Warehouse active? (partners only) */
|
|
2682
2571
|
active?: boolean | null;
|
|
2683
|
-
/**
|
|
2684
|
-
|
|
2685
|
-
* @format float
|
|
2686
|
-
*/
|
|
2687
|
-
bin_cubic_volume_max?: number | null;
|
|
2572
|
+
/** Maximum cubic volume per bin (staff only) */
|
|
2573
|
+
bin_cubic_volume_max?: string | null;
|
|
2688
2574
|
/**
|
|
2689
2575
|
* Maximum total items per bin (staff only)
|
|
2690
2576
|
* @format int32
|
|
@@ -2720,21 +2606,15 @@ export interface ApiV2EntitiesWarehouse {
|
|
|
2720
2606
|
international_return_labels?: boolean | null;
|
|
2721
2607
|
/** Warehouse label format (partners only) */
|
|
2722
2608
|
label_format?: string | null;
|
|
2723
|
-
/**
|
|
2724
|
-
|
|
2725
|
-
* @format float
|
|
2726
|
-
*/
|
|
2727
|
-
latitude?: number | null;
|
|
2609
|
+
/** Warehouse latitude */
|
|
2610
|
+
latitude?: string | null;
|
|
2728
2611
|
/**
|
|
2729
2612
|
* Loading Dock Quantity (partners only)
|
|
2730
2613
|
* @format int32
|
|
2731
2614
|
*/
|
|
2732
2615
|
loading_dock_quantity?: number | null;
|
|
2733
|
-
/**
|
|
2734
|
-
|
|
2735
|
-
* @format float
|
|
2736
|
-
*/
|
|
2737
|
-
longitude?: number | null;
|
|
2616
|
+
/** Warehouse longitude */
|
|
2617
|
+
longitude?: string | null;
|
|
2738
2618
|
/** the warehouse name */
|
|
2739
2619
|
name?: string | null;
|
|
2740
2620
|
/** Miscellaneous notes/info (partners only) */
|
|
@@ -2792,11 +2672,8 @@ export interface ApiV2EntitiesWarehouse {
|
|
|
2792
2672
|
ups_carrier_facility?: string | null;
|
|
2793
2673
|
/** Warehouse UPS shipping number (partners only) */
|
|
2794
2674
|
ups_shipper_number?: string | null;
|
|
2795
|
-
/**
|
|
2796
|
-
|
|
2797
|
-
* @format float
|
|
2798
|
-
*/
|
|
2799
|
-
vat?: number | null;
|
|
2675
|
+
/** Warehouse VAT number (partners only) */
|
|
2676
|
+
vat?: string | null;
|
|
2800
2677
|
warehouse_features?: ApiV2EntitiesWarehouseFeature[];
|
|
2801
2678
|
}
|
|
2802
2679
|
|
|
@@ -2836,11 +2713,8 @@ export interface ApiV2EntitiesWarehouseShallow {
|
|
|
2836
2713
|
accepting_new_customers?: boolean;
|
|
2837
2714
|
/** Is the Warehouse active? (partners only) */
|
|
2838
2715
|
active?: boolean;
|
|
2839
|
-
/**
|
|
2840
|
-
|
|
2841
|
-
* @format float
|
|
2842
|
-
*/
|
|
2843
|
-
bin_cubic_volume_max?: number;
|
|
2716
|
+
/** Maximum cubic volume per bin (staff only) */
|
|
2717
|
+
bin_cubic_volume_max?: string;
|
|
2844
2718
|
/**
|
|
2845
2719
|
* Maximum total items per bin (staff only)
|
|
2846
2720
|
* @format int32
|
|
@@ -2876,21 +2750,15 @@ export interface ApiV2EntitiesWarehouseShallow {
|
|
|
2876
2750
|
international_return_labels?: boolean;
|
|
2877
2751
|
/** Warehouse label format (partners only) */
|
|
2878
2752
|
label_format?: string;
|
|
2879
|
-
/**
|
|
2880
|
-
|
|
2881
|
-
* @format float
|
|
2882
|
-
*/
|
|
2883
|
-
latitude?: number;
|
|
2753
|
+
/** Warehouse latitude */
|
|
2754
|
+
latitude?: string;
|
|
2884
2755
|
/**
|
|
2885
2756
|
* Loading Dock Quantity (partners only)
|
|
2886
2757
|
* @format int32
|
|
2887
2758
|
*/
|
|
2888
2759
|
loading_dock_quantity?: number;
|
|
2889
|
-
/**
|
|
2890
|
-
|
|
2891
|
-
* @format float
|
|
2892
|
-
*/
|
|
2893
|
-
longitude?: number;
|
|
2760
|
+
/** Warehouse longitude */
|
|
2761
|
+
longitude?: string;
|
|
2894
2762
|
/** the warehouse name */
|
|
2895
2763
|
name?: string;
|
|
2896
2764
|
/** Miscellaneous notes/info (partners only) */
|
|
@@ -2950,11 +2818,8 @@ export interface ApiV2EntitiesWarehouseShallow {
|
|
|
2950
2818
|
ups_carrier_facility?: string;
|
|
2951
2819
|
/** Warehouse UPS shipping number (partners only) */
|
|
2952
2820
|
ups_shipper_number?: string;
|
|
2953
|
-
/**
|
|
2954
|
-
|
|
2955
|
-
* @format float
|
|
2956
|
-
*/
|
|
2957
|
-
vat?: number;
|
|
2821
|
+
/** Warehouse VAT number (partners only) */
|
|
2822
|
+
vat?: string;
|
|
2958
2823
|
warehouse_features?: ApiV2EntitiesWarehouseFeature[];
|
|
2959
2824
|
}
|
|
2960
2825
|
|
|
@@ -3152,11 +3017,8 @@ export interface ApiV21EntitiesBundleItem {
|
|
|
3152
3017
|
|
|
3153
3018
|
/** V3 */
|
|
3154
3019
|
export interface ApiV21EntitiesConsumerReturn {
|
|
3155
|
-
/**
|
|
3156
|
-
|
|
3157
|
-
* @format float
|
|
3158
|
-
*/
|
|
3159
|
-
ship_3rdparty_cost?: number | null;
|
|
3020
|
+
/** 3rd party cost for the consumer return */
|
|
3021
|
+
ship_3rdparty_cost?: string | null;
|
|
3160
3022
|
/**
|
|
3161
3023
|
* the consumer return arrival date and time
|
|
3162
3024
|
* @format date-time
|
|
@@ -3230,11 +3092,8 @@ export interface ApiV21EntitiesConsumerReturn {
|
|
|
3230
3092
|
requires_label?: boolean | null;
|
|
3231
3093
|
/** the consumer return sender */
|
|
3232
3094
|
sender?: string | null;
|
|
3233
|
-
/**
|
|
3234
|
-
|
|
3235
|
-
* @format float
|
|
3236
|
-
*/
|
|
3237
|
-
ship_actual_cost?: number | null;
|
|
3095
|
+
/** the consumer return actual cost of shipping */
|
|
3096
|
+
ship_actual_cost?: string | null;
|
|
3238
3097
|
/** currency used for this consumer return */
|
|
3239
3098
|
ship_actual_currency?: string | null;
|
|
3240
3099
|
/** url of the shipping label */
|
|
@@ -3433,16 +3292,10 @@ export interface ApiV21EntitiesCustomer {
|
|
|
3433
3292
|
primary_contact?: string;
|
|
3434
3293
|
project_task_labels?: string[];
|
|
3435
3294
|
receiving_fields?: object[];
|
|
3436
|
-
/**
|
|
3437
|
-
|
|
3438
|
-
|
|
3439
|
-
|
|
3440
|
-
replenishment_min?: number | null;
|
|
3441
|
-
/**
|
|
3442
|
-
* Target number of days stock to replenish forward pick locations
|
|
3443
|
-
* @format float
|
|
3444
|
-
*/
|
|
3445
|
-
replenishment_target?: number | null;
|
|
3295
|
+
/** Minimum number of days worth of stock to keep in forward pick locations */
|
|
3296
|
+
replenishment_min?: string | null;
|
|
3297
|
+
/** Target number of days stock to replenish forward pick locations */
|
|
3298
|
+
replenishment_target?: string | null;
|
|
3446
3299
|
/** request serial numbers? */
|
|
3447
3300
|
request_serial_numbers?: boolean | null;
|
|
3448
3301
|
/** Customer return city. */
|
|
@@ -3649,11 +3502,8 @@ export interface ApiV21EntitiesItem {
|
|
|
3649
3502
|
hazmat?: boolean;
|
|
3650
3503
|
/** hazmat class */
|
|
3651
3504
|
hazmat_type?: ApiV21EntitiesItemHazmatType;
|
|
3652
|
-
/**
|
|
3653
|
-
|
|
3654
|
-
* @format float
|
|
3655
|
-
*/
|
|
3656
|
-
height?: number | null;
|
|
3505
|
+
/** the item height (in inches) */
|
|
3506
|
+
height?: string | null;
|
|
3657
3507
|
/**
|
|
3658
3508
|
* the item id
|
|
3659
3509
|
* @format int32
|
|
@@ -3669,11 +3519,8 @@ export interface ApiV21EntitiesItem {
|
|
|
3669
3519
|
is_bundle?: boolean | null;
|
|
3670
3520
|
/** label format */
|
|
3671
3521
|
label_format?: ApiV21EntitiesItemLabelFormat;
|
|
3672
|
-
/**
|
|
3673
|
-
|
|
3674
|
-
* @format float
|
|
3675
|
-
*/
|
|
3676
|
-
length?: number | null;
|
|
3522
|
+
/** the item length (in inches) */
|
|
3523
|
+
length?: string | null;
|
|
3677
3524
|
/** does this item require lot control? */
|
|
3678
3525
|
lot_control?: boolean | null;
|
|
3679
3526
|
/**
|
|
@@ -3702,11 +3549,8 @@ export interface ApiV21EntitiesItem {
|
|
|
3702
3549
|
packaging?: boolean | null;
|
|
3703
3550
|
/** the item packaging type */
|
|
3704
3551
|
packaging_type?: ApiV21EntitiesItemPackagingType;
|
|
3705
|
-
/**
|
|
3706
|
-
|
|
3707
|
-
* @format float
|
|
3708
|
-
*/
|
|
3709
|
-
price?: number | null;
|
|
3552
|
+
/** the item price */
|
|
3553
|
+
price?: string | null;
|
|
3710
3554
|
/** is the item a promo? */
|
|
3711
3555
|
promo?: boolean | null;
|
|
3712
3556
|
/**
|
|
@@ -3734,16 +3578,10 @@ export interface ApiV21EntitiesItem {
|
|
|
3734
3578
|
* @format int32
|
|
3735
3579
|
*/
|
|
3736
3580
|
quantity_published?: number;
|
|
3737
|
-
/**
|
|
3738
|
-
|
|
3739
|
-
|
|
3740
|
-
|
|
3741
|
-
replenishment_min?: number | null;
|
|
3742
|
-
/**
|
|
3743
|
-
* Target number of days stock to replenish forward pick locations
|
|
3744
|
-
* @format float
|
|
3745
|
-
*/
|
|
3746
|
-
replenishment_target?: number | null;
|
|
3581
|
+
/** Minimum number of days worth of stock to keep in forward pick locations */
|
|
3582
|
+
replenishment_min?: string | null;
|
|
3583
|
+
/** Target number of days stock to replenish forward pick locations */
|
|
3584
|
+
replenishment_target?: string | null;
|
|
3747
3585
|
/** does the item require a serial number when shipping? */
|
|
3748
3586
|
request_serial_number?: boolean | null;
|
|
3749
3587
|
/** is the item return price restricted? */
|
|
@@ -3784,21 +3622,12 @@ export interface ApiV21EntitiesItem {
|
|
|
3784
3622
|
velocity?: number | null;
|
|
3785
3623
|
/** the item vendor */
|
|
3786
3624
|
vendor?: string | null;
|
|
3787
|
-
/**
|
|
3788
|
-
|
|
3789
|
-
|
|
3790
|
-
|
|
3791
|
-
|
|
3792
|
-
|
|
3793
|
-
* the wholesale cost of the item
|
|
3794
|
-
* @format float
|
|
3795
|
-
*/
|
|
3796
|
-
wholesale_cost?: number | null;
|
|
3797
|
-
/**
|
|
3798
|
-
* the item width (in inches)
|
|
3799
|
-
* @format float
|
|
3800
|
-
*/
|
|
3801
|
-
width?: number | null;
|
|
3625
|
+
/** the weight of the item (in pounds) */
|
|
3626
|
+
weight?: string | null;
|
|
3627
|
+
/** the wholesale cost of the item */
|
|
3628
|
+
wholesale_cost?: string | null;
|
|
3629
|
+
/** the item width (in inches) */
|
|
3630
|
+
width?: string | null;
|
|
3802
3631
|
}
|
|
3803
3632
|
|
|
3804
3633
|
/** V3 */
|
|
@@ -3980,11 +3809,8 @@ export interface ApiV21EntitiesOrder {
|
|
|
3980
3809
|
return_address_2?: string | null;
|
|
3981
3810
|
/** the order third party shipping account */
|
|
3982
3811
|
ship_3rdparty_account?: string | null;
|
|
3983
|
-
/**
|
|
3984
|
-
|
|
3985
|
-
* @format float
|
|
3986
|
-
*/
|
|
3987
|
-
ship_3rdparty_cost?: number;
|
|
3812
|
+
/** the order third party shipping cost */
|
|
3813
|
+
ship_3rdparty_cost?: string;
|
|
3988
3814
|
/** the order third party shipping country */
|
|
3989
3815
|
ship_3rdparty_country?: string | null;
|
|
3990
3816
|
/** the order third party shipping zip */
|
|
@@ -4155,11 +3981,8 @@ export interface ApiV21EntitiesOrder {
|
|
|
4155
3981
|
* @format int32
|
|
4156
3982
|
*/
|
|
4157
3983
|
quote_id?: number | null;
|
|
4158
|
-
/**
|
|
4159
|
-
|
|
4160
|
-
* @format float
|
|
4161
|
-
*/
|
|
4162
|
-
req_insurance_value?: number | null;
|
|
3984
|
+
/** the order requested insurance value */
|
|
3985
|
+
req_insurance_value?: string | null;
|
|
4163
3986
|
/** the order requested address */
|
|
4164
3987
|
requested_address?: string | null;
|
|
4165
3988
|
/** does the order require an adult signature upon delivery? */
|
|
@@ -4200,11 +4023,8 @@ export interface ApiV21EntitiesOrder {
|
|
|
4200
4023
|
saturday_delivery?: boolean | null;
|
|
4201
4024
|
/** the order scac number */
|
|
4202
4025
|
scac?: string | null;
|
|
4203
|
-
/**
|
|
4204
|
-
|
|
4205
|
-
* @format float
|
|
4206
|
-
*/
|
|
4207
|
-
ship_actual_cost?: number | null;
|
|
4026
|
+
/** the order actual cost of shipping */
|
|
4027
|
+
ship_actual_cost?: string | null;
|
|
4208
4028
|
/** the order ship notes */
|
|
4209
4029
|
ship_notes?: string | null;
|
|
4210
4030
|
/**
|
|
@@ -4247,11 +4067,8 @@ export interface ApiV21EntitiesOrder {
|
|
|
4247
4067
|
shop_created_at?: string | null;
|
|
4248
4068
|
/** the order shop shipping method currency */
|
|
4249
4069
|
shop_shipping_method_currency?: string | null;
|
|
4250
|
-
/**
|
|
4251
|
-
|
|
4252
|
-
* @format float
|
|
4253
|
-
*/
|
|
4254
|
-
shop_shipping_method_price?: number | null;
|
|
4070
|
+
/** the order shop shipping method price */
|
|
4071
|
+
shop_shipping_method_price?: string | null;
|
|
4255
4072
|
/**
|
|
4256
4073
|
* the order shop shipping method text
|
|
4257
4074
|
* ge_standard = order uses global-e standard shipping method
|
|
@@ -4413,11 +4230,8 @@ export interface ApiV21EntitiesOrderItem {
|
|
|
4413
4230
|
* @format int32
|
|
4414
4231
|
*/
|
|
4415
4232
|
packed?: number | null;
|
|
4416
|
-
/**
|
|
4417
|
-
|
|
4418
|
-
* @format float
|
|
4419
|
-
*/
|
|
4420
|
-
price?: number | null;
|
|
4233
|
+
/** price of this item */
|
|
4234
|
+
price?: string | null;
|
|
4421
4235
|
/** is this item a promo? */
|
|
4422
4236
|
promo?: boolean | null;
|
|
4423
4237
|
/**
|
|
@@ -4432,11 +4246,8 @@ export interface ApiV21EntitiesOrderItem {
|
|
|
4432
4246
|
quote_item_id?: number | null;
|
|
4433
4247
|
/** does the item require a serial number when shipping? */
|
|
4434
4248
|
request_serial_number?: boolean | null;
|
|
4435
|
-
/**
|
|
4436
|
-
|
|
4437
|
-
* @format float
|
|
4438
|
-
*/
|
|
4439
|
-
retail_fee?: number | null;
|
|
4249
|
+
/** retail fee of this item */
|
|
4250
|
+
retail_fee?: string | null;
|
|
4440
4251
|
/** is this item returnable? */
|
|
4441
4252
|
returnable?: boolean | null;
|
|
4442
4253
|
/** the SKU of this item */
|
|
@@ -4448,16 +4259,10 @@ export interface ApiV21EntitiesOrderItem {
|
|
|
4448
4259
|
* @format date-time
|
|
4449
4260
|
*/
|
|
4450
4261
|
updated_at?: string | null;
|
|
4451
|
-
/**
|
|
4452
|
-
|
|
4453
|
-
|
|
4454
|
-
|
|
4455
|
-
wholesale_cost?: number | null;
|
|
4456
|
-
/**
|
|
4457
|
-
* wholesale fee of this item
|
|
4458
|
-
* @format float
|
|
4459
|
-
*/
|
|
4460
|
-
wholesale_fee?: number | null;
|
|
4262
|
+
/** wholesale cost of the item */
|
|
4263
|
+
wholesale_cost?: string | null;
|
|
4264
|
+
/** wholesale fee of this item */
|
|
4265
|
+
wholesale_fee?: string | null;
|
|
4461
4266
|
wholesale_item?: ApiV21EntitiesWholesaleItem;
|
|
4462
4267
|
}
|
|
4463
4268
|
|
|
@@ -4532,11 +4337,8 @@ export interface ApiV21EntitiesPostResponse {
|
|
|
4532
4337
|
|
|
4533
4338
|
/** V3 */
|
|
4534
4339
|
export interface ApiV21EntitiesProjectTask {
|
|
4535
|
-
/**
|
|
4536
|
-
|
|
4537
|
-
* @format float
|
|
4538
|
-
*/
|
|
4539
|
-
cost_per_unit?: number | null;
|
|
4340
|
+
/** cost per unit, if task has custom label */
|
|
4341
|
+
cost_per_unit?: string | null;
|
|
4540
4342
|
/**
|
|
4541
4343
|
* project_task created_at
|
|
4542
4344
|
* @format date-time
|
|
@@ -4558,11 +4360,8 @@ export interface ApiV21EntitiesProjectTask {
|
|
|
4558
4360
|
* @format int32
|
|
4559
4361
|
*/
|
|
4560
4362
|
project_id?: number;
|
|
4561
|
-
/**
|
|
4562
|
-
|
|
4563
|
-
* @format float
|
|
4564
|
-
*/
|
|
4565
|
-
quantity?: number;
|
|
4363
|
+
/** quantity of units */
|
|
4364
|
+
quantity?: string;
|
|
4566
4365
|
/**
|
|
4567
4366
|
* project_task updated_at
|
|
4568
4367
|
* @format date-time
|
|
@@ -4648,11 +4447,8 @@ export interface ApiV21EntitiesSerialNumber {
|
|
|
4648
4447
|
|
|
4649
4448
|
/** V3 */
|
|
4650
4449
|
export interface ApiV21EntitiesShipnotice {
|
|
4651
|
-
/**
|
|
4652
|
-
|
|
4653
|
-
* @format float
|
|
4654
|
-
*/
|
|
4655
|
-
ship_3rdparty_cost?: number | null;
|
|
4450
|
+
/** 3rd party cost for the shipnotice */
|
|
4451
|
+
ship_3rdparty_cost?: string | null;
|
|
4656
4452
|
/**
|
|
4657
4453
|
* the shipnotice arrival date and time
|
|
4658
4454
|
* @format date-time
|
|
@@ -4741,11 +4537,8 @@ export interface ApiV21EntitiesShipnotice {
|
|
|
4741
4537
|
requires_label?: boolean | null;
|
|
4742
4538
|
/** the shipnotice sender */
|
|
4743
4539
|
sender?: string | null;
|
|
4744
|
-
/**
|
|
4745
|
-
|
|
4746
|
-
* @format float
|
|
4747
|
-
*/
|
|
4748
|
-
ship_actual_cost?: number | null;
|
|
4540
|
+
/** the shipnotice actual cost of shipping */
|
|
4541
|
+
ship_actual_cost?: string | null;
|
|
4749
4542
|
/** currency used for this shipnotice */
|
|
4750
4543
|
ship_actual_currency?: string | null;
|
|
4751
4544
|
/**
|
|
@@ -4871,11 +4664,8 @@ export interface ApiV21EntitiesShipnoticeItem {
|
|
|
4871
4664
|
* @format int32
|
|
4872
4665
|
*/
|
|
4873
4666
|
shipnotice_id?: number | null;
|
|
4874
|
-
/**
|
|
4875
|
-
|
|
4876
|
-
* @format float
|
|
4877
|
-
*/
|
|
4878
|
-
unit_cost?: number | null;
|
|
4667
|
+
/** unit cost for this shipnotice item */
|
|
4668
|
+
unit_cost?: string | null;
|
|
4879
4669
|
/**
|
|
4880
4670
|
* the shipnotice item last update date and time
|
|
4881
4671
|
* @format date-time
|
|
@@ -6476,11 +6266,8 @@ export interface PostApiV21ConsumerReturnsBulkRequest {
|
|
|
6476
6266
|
easypostable_type?: string;
|
|
6477
6267
|
/** url of the shipping label */
|
|
6478
6268
|
shipping_label_url?: string;
|
|
6479
|
-
/**
|
|
6480
|
-
|
|
6481
|
-
* @format float
|
|
6482
|
-
*/
|
|
6483
|
-
ship_actual_cost?: number;
|
|
6269
|
+
/** the consumer return actual cost of shipping */
|
|
6270
|
+
ship_actual_cost?: string;
|
|
6484
6271
|
/** the method of shipping for the consumer return */
|
|
6485
6272
|
shipping_method_text?: string;
|
|
6486
6273
|
/** shipping carrier */
|
|
@@ -6493,11 +6280,8 @@ export interface PostApiV21ConsumerReturnsBulkRequest {
|
|
|
6493
6280
|
postage_billed?: boolean;
|
|
6494
6281
|
/** was handling billed? */
|
|
6495
6282
|
handling_billed?: boolean;
|
|
6496
|
-
/**
|
|
6497
|
-
|
|
6498
|
-
* @format float
|
|
6499
|
-
*/
|
|
6500
|
-
ship_3rdparty_cost?: number;
|
|
6283
|
+
/** the consumer return actual cost of shipping */
|
|
6284
|
+
ship_3rdparty_cost?: string;
|
|
6501
6285
|
/** does this consumer return require a label? */
|
|
6502
6286
|
requires_label: boolean;
|
|
6503
6287
|
/**
|
|
@@ -6570,11 +6354,8 @@ export interface PostApiV21ConsumerReturnsBulkRequest {
|
|
|
6570
6354
|
}
|
|
6571
6355
|
|
|
6572
6356
|
export interface PostApiV21ConsumerReturnsRequest {
|
|
6573
|
-
/**
|
|
6574
|
-
|
|
6575
|
-
* @format float
|
|
6576
|
-
*/
|
|
6577
|
-
ship_3rdparty_cost?: number;
|
|
6357
|
+
/** the consumer return actual cost of shipping */
|
|
6358
|
+
ship_3rdparty_cost?: string;
|
|
6578
6359
|
/**
|
|
6579
6360
|
* the consumer return arrival date and time
|
|
6580
6361
|
* @format date-time
|
|
@@ -6659,11 +6440,8 @@ export interface PostApiV21ConsumerReturnsRequest {
|
|
|
6659
6440
|
requires_label: boolean;
|
|
6660
6441
|
/** the consumer return sender */
|
|
6661
6442
|
sender?: string;
|
|
6662
|
-
/**
|
|
6663
|
-
|
|
6664
|
-
* @format float
|
|
6665
|
-
*/
|
|
6666
|
-
ship_actual_cost?: number;
|
|
6443
|
+
/** the consumer return actual cost of shipping */
|
|
6444
|
+
ship_actual_cost?: string;
|
|
6667
6445
|
/** currency used for this consumer return */
|
|
6668
6446
|
ship_actual_currency?: string;
|
|
6669
6447
|
shipnotice_items_attributes?: {
|
|
@@ -6813,11 +6591,8 @@ export interface PostApiV21ItemsRequest {
|
|
|
6813
6591
|
hazmat?: boolean;
|
|
6814
6592
|
/** hazmat class */
|
|
6815
6593
|
hazmat_type?: PostApiV21ItemsRequestHazmatType;
|
|
6816
|
-
/**
|
|
6817
|
-
|
|
6818
|
-
* @format float
|
|
6819
|
-
*/
|
|
6820
|
-
height?: number;
|
|
6594
|
+
/** the item height (in inches) */
|
|
6595
|
+
height?: string;
|
|
6821
6596
|
/** the originator url for the item image */
|
|
6822
6597
|
image_originator_url?: string;
|
|
6823
6598
|
/** include inbound items in published? */
|
|
@@ -6826,11 +6601,8 @@ export interface PostApiV21ItemsRequest {
|
|
|
6826
6601
|
is_bundle?: boolean;
|
|
6827
6602
|
/** label format */
|
|
6828
6603
|
label_format?: PostApiV21ItemsRequestLabelFormat;
|
|
6829
|
-
/**
|
|
6830
|
-
|
|
6831
|
-
* @format float
|
|
6832
|
-
*/
|
|
6833
|
-
length?: number;
|
|
6604
|
+
/** the item length (in inches) */
|
|
6605
|
+
length?: string;
|
|
6834
6606
|
/** does this item require lot control? */
|
|
6835
6607
|
lot_control?: boolean;
|
|
6836
6608
|
/**
|
|
@@ -6870,23 +6642,14 @@ export interface PostApiV21ItemsRequest {
|
|
|
6870
6642
|
packaging?: boolean;
|
|
6871
6643
|
/** the item packaging type */
|
|
6872
6644
|
packaging_type?: PostApiV21ItemsRequestPackagingType;
|
|
6873
|
-
/**
|
|
6874
|
-
|
|
6875
|
-
* @format float
|
|
6876
|
-
*/
|
|
6877
|
-
price?: number;
|
|
6645
|
+
/** the item price */
|
|
6646
|
+
price?: string;
|
|
6878
6647
|
/** is the item a promo? */
|
|
6879
6648
|
promo?: boolean;
|
|
6880
|
-
/**
|
|
6881
|
-
|
|
6882
|
-
|
|
6883
|
-
|
|
6884
|
-
replenishment_min?: number;
|
|
6885
|
-
/**
|
|
6886
|
-
* Target number of days stock to replenish forward pick locations
|
|
6887
|
-
* @format float
|
|
6888
|
-
*/
|
|
6889
|
-
replenishment_target?: number;
|
|
6649
|
+
/** Minimum number of days worth of stock to keep in forward pick locations */
|
|
6650
|
+
replenishment_min?: string;
|
|
6651
|
+
/** Target number of days stock to replenish forward pick locations */
|
|
6652
|
+
replenishment_target?: string;
|
|
6890
6653
|
/** does the item require a serial number when shipping? */
|
|
6891
6654
|
request_serial_number?: boolean;
|
|
6892
6655
|
/** is the item return price restricted? */
|
|
@@ -6922,21 +6685,12 @@ export interface PostApiV21ItemsRequest {
|
|
|
6922
6685
|
velocity?: number;
|
|
6923
6686
|
/** the item vendor */
|
|
6924
6687
|
vendor?: string;
|
|
6925
|
-
/**
|
|
6926
|
-
|
|
6927
|
-
|
|
6928
|
-
|
|
6929
|
-
|
|
6930
|
-
|
|
6931
|
-
* the wholesale cost of the item
|
|
6932
|
-
* @format float
|
|
6933
|
-
*/
|
|
6934
|
-
wholesale_cost?: number;
|
|
6935
|
-
/**
|
|
6936
|
-
* the item width (in inches)
|
|
6937
|
-
* @format float
|
|
6938
|
-
*/
|
|
6939
|
-
width?: number;
|
|
6688
|
+
/** the weight of the item (in pounds) */
|
|
6689
|
+
weight?: string;
|
|
6690
|
+
/** the wholesale cost of the item */
|
|
6691
|
+
wholesale_cost?: string;
|
|
6692
|
+
/** the item width (in inches) */
|
|
6693
|
+
width?: string;
|
|
6940
6694
|
}
|
|
6941
6695
|
|
|
6942
6696
|
export interface PostApiV21NotificationSubscriptionsRequest {
|
|
@@ -7042,11 +6796,8 @@ export interface PostApiV21OrdersBulkRequest {
|
|
|
7042
6796
|
* ge_express = order uses global-e express shipping method
|
|
7043
6797
|
*/
|
|
7044
6798
|
shop_shipping_method_text?: string;
|
|
7045
|
-
/**
|
|
7046
|
-
|
|
7047
|
-
* @format float
|
|
7048
|
-
*/
|
|
7049
|
-
shop_shipping_method_price?: number;
|
|
6799
|
+
/** the order shop shipping method price */
|
|
6800
|
+
shop_shipping_method_price?: string;
|
|
7050
6801
|
/** the order billing company */
|
|
7051
6802
|
billing_company?: string;
|
|
7052
6803
|
/** the order billing street address 1 */
|
|
@@ -7117,11 +6868,8 @@ export interface PostApiV21OrdersBulkRequest {
|
|
|
7117
6868
|
shipping_hold_for_pickup?: boolean;
|
|
7118
6869
|
/** the order ship notes */
|
|
7119
6870
|
ship_notes?: string;
|
|
7120
|
-
/**
|
|
7121
|
-
|
|
7122
|
-
* @format float
|
|
7123
|
-
*/
|
|
7124
|
-
ship_3rdparty_cost?: number;
|
|
6871
|
+
/** the order third party shipping cost */
|
|
6872
|
+
ship_3rdparty_cost?: string;
|
|
7125
6873
|
/** the order third party shipping account */
|
|
7126
6874
|
ship_3rdparty_account?: string;
|
|
7127
6875
|
/** the order third party shipping zip */
|
|
@@ -7142,11 +6890,8 @@ export interface PostApiV21OrdersBulkRequest {
|
|
|
7142
6890
|
* @format int32
|
|
7143
6891
|
*/
|
|
7144
6892
|
days_in_transit_carrier_estimate?: number;
|
|
7145
|
-
/**
|
|
7146
|
-
|
|
7147
|
-
* @format float
|
|
7148
|
-
*/
|
|
7149
|
-
req_insurance_value?: number;
|
|
6893
|
+
/** the order requested insurance value */
|
|
6894
|
+
req_insurance_value?: string;
|
|
7150
6895
|
/** Value Added Tax identifcation number for the sender of the order */
|
|
7151
6896
|
customs_vat_number?: string;
|
|
7152
6897
|
/** Economic Operators Registration and Identification number for the sender of the order */
|
|
@@ -7236,11 +6981,8 @@ export interface PostApiV21OrdersBulkRequest {
|
|
|
7236
6981
|
sku?: string;
|
|
7237
6982
|
/** description for this order item. This will appear in packing slips. If not set, the description will be inherited from the parent Item. */
|
|
7238
6983
|
description?: string;
|
|
7239
|
-
/**
|
|
7240
|
-
|
|
7241
|
-
* @format float
|
|
7242
|
-
*/
|
|
7243
|
-
price?: number;
|
|
6984
|
+
/** price of this item */
|
|
6985
|
+
price?: string;
|
|
7244
6986
|
/** is this item unshippable? */
|
|
7245
6987
|
unshippable?: boolean;
|
|
7246
6988
|
/** is this item available? */
|
|
@@ -7252,29 +6994,20 @@ export interface PostApiV21OrdersBulkRequest {
|
|
|
7252
6994
|
packed?: number;
|
|
7253
6995
|
/** is this item packaging? */
|
|
7254
6996
|
packaging?: boolean;
|
|
7255
|
-
/**
|
|
7256
|
-
|
|
7257
|
-
* @format float
|
|
7258
|
-
*/
|
|
7259
|
-
wholesale_cost?: number;
|
|
6997
|
+
/** wholesale cost of the item */
|
|
6998
|
+
wholesale_cost?: string;
|
|
7260
6999
|
/** is this item a bundle? */
|
|
7261
7000
|
is_bundle?: boolean;
|
|
7262
|
-
/**
|
|
7263
|
-
|
|
7264
|
-
* @format float
|
|
7265
|
-
*/
|
|
7266
|
-
retail_fee?: number;
|
|
7001
|
+
/** retail fee of this item */
|
|
7002
|
+
retail_fee?: string;
|
|
7267
7003
|
/** is this item a promo? */
|
|
7268
7004
|
promo?: boolean;
|
|
7269
7005
|
/** is this item returnable? */
|
|
7270
7006
|
returnable?: boolean;
|
|
7271
7007
|
/** currency code for this item */
|
|
7272
7008
|
currency?: string;
|
|
7273
|
-
/**
|
|
7274
|
-
|
|
7275
|
-
* @format float
|
|
7276
|
-
*/
|
|
7277
|
-
wholesale_fee?: number;
|
|
7009
|
+
/** wholesale fee of this item */
|
|
7010
|
+
wholesale_fee?: string;
|
|
7278
7011
|
/** (deprecated) is the order item hazmat? */
|
|
7279
7012
|
hazmat?: boolean;
|
|
7280
7013
|
/** miscellaneous information about the order item */
|
|
@@ -7391,11 +7124,8 @@ export interface PostApiV21OrdersIdOrderItemsRequest {
|
|
|
7391
7124
|
* @format int32
|
|
7392
7125
|
*/
|
|
7393
7126
|
packed?: number;
|
|
7394
|
-
/**
|
|
7395
|
-
|
|
7396
|
-
* @format float
|
|
7397
|
-
*/
|
|
7398
|
-
price?: number;
|
|
7127
|
+
/** price of this item */
|
|
7128
|
+
price?: string;
|
|
7399
7129
|
/** is this item a promo? */
|
|
7400
7130
|
promo?: boolean;
|
|
7401
7131
|
/**
|
|
@@ -7410,27 +7140,18 @@ export interface PostApiV21OrdersIdOrderItemsRequest {
|
|
|
7410
7140
|
quote_item_id?: number;
|
|
7411
7141
|
/** does the item require a serial number when shipping? */
|
|
7412
7142
|
request_serial_number?: boolean;
|
|
7413
|
-
/**
|
|
7414
|
-
|
|
7415
|
-
* @format float
|
|
7416
|
-
*/
|
|
7417
|
-
retail_fee?: number;
|
|
7143
|
+
/** retail fee of this item */
|
|
7144
|
+
retail_fee?: string;
|
|
7418
7145
|
/** is this item returnable? */
|
|
7419
7146
|
returnable?: boolean;
|
|
7420
7147
|
/** the SKU of this item */
|
|
7421
7148
|
sku?: string;
|
|
7422
7149
|
/** is this item unshippable? */
|
|
7423
7150
|
unshippable?: boolean;
|
|
7424
|
-
/**
|
|
7425
|
-
|
|
7426
|
-
|
|
7427
|
-
|
|
7428
|
-
wholesale_cost?: number;
|
|
7429
|
-
/**
|
|
7430
|
-
* wholesale fee of this item
|
|
7431
|
-
* @format float
|
|
7432
|
-
*/
|
|
7433
|
-
wholesale_fee?: number;
|
|
7151
|
+
/** wholesale cost of the item */
|
|
7152
|
+
wholesale_cost?: string;
|
|
7153
|
+
/** wholesale fee of this item */
|
|
7154
|
+
wholesale_fee?: string;
|
|
7434
7155
|
wholesale_item_attributes?: {
|
|
7435
7156
|
/**
|
|
7436
7157
|
* the associated order item id
|
|
@@ -7497,11 +7218,8 @@ export interface PostApiV21OrdersRequest {
|
|
|
7497
7218
|
return_address_2?: string;
|
|
7498
7219
|
/** the order third party shipping account */
|
|
7499
7220
|
ship_3rdparty_account?: string;
|
|
7500
|
-
/**
|
|
7501
|
-
|
|
7502
|
-
* @format float
|
|
7503
|
-
*/
|
|
7504
|
-
ship_3rdparty_cost?: number;
|
|
7221
|
+
/** the order third party shipping cost */
|
|
7222
|
+
ship_3rdparty_cost?: string;
|
|
7505
7223
|
/** the order third party shipping country */
|
|
7506
7224
|
ship_3rdparty_country?: string;
|
|
7507
7225
|
/** the order third party shipping zip */
|
|
@@ -7648,11 +7366,8 @@ export interface PostApiV21OrdersRequest {
|
|
|
7648
7366
|
sku?: string;
|
|
7649
7367
|
/** description for this order item. This will appear in packing slips. If not set, the description will be inherited from the parent Item. */
|
|
7650
7368
|
description?: string;
|
|
7651
|
-
/**
|
|
7652
|
-
|
|
7653
|
-
* @format float
|
|
7654
|
-
*/
|
|
7655
|
-
price?: number;
|
|
7369
|
+
/** price of this item */
|
|
7370
|
+
price?: string;
|
|
7656
7371
|
/**
|
|
7657
7372
|
* the order item creation date and time
|
|
7658
7373
|
* @format date-time
|
|
@@ -7674,29 +7389,20 @@ export interface PostApiV21OrdersRequest {
|
|
|
7674
7389
|
packed?: number;
|
|
7675
7390
|
/** is this item packaging? */
|
|
7676
7391
|
packaging?: boolean;
|
|
7677
|
-
/**
|
|
7678
|
-
|
|
7679
|
-
* @format float
|
|
7680
|
-
*/
|
|
7681
|
-
wholesale_cost?: number;
|
|
7392
|
+
/** wholesale cost of the item */
|
|
7393
|
+
wholesale_cost?: string;
|
|
7682
7394
|
/** is this item a bundle? */
|
|
7683
7395
|
is_bundle?: boolean;
|
|
7684
|
-
/**
|
|
7685
|
-
|
|
7686
|
-
* @format float
|
|
7687
|
-
*/
|
|
7688
|
-
retail_fee?: number;
|
|
7396
|
+
/** retail fee of this item */
|
|
7397
|
+
retail_fee?: string;
|
|
7689
7398
|
/** is this item a promo? */
|
|
7690
7399
|
promo?: boolean;
|
|
7691
7400
|
/** is this item returnable? */
|
|
7692
7401
|
returnable?: boolean;
|
|
7693
7402
|
/** currency code for this item */
|
|
7694
7403
|
currency?: string;
|
|
7695
|
-
/**
|
|
7696
|
-
|
|
7697
|
-
* @format float
|
|
7698
|
-
*/
|
|
7699
|
-
wholesale_fee?: number;
|
|
7404
|
+
/** wholesale fee of this item */
|
|
7405
|
+
wholesale_fee?: string;
|
|
7700
7406
|
/** (deprecated) is the order item hazmat? */
|
|
7701
7407
|
hazmat?: boolean;
|
|
7702
7408
|
/** miscellaneous information about the order item */
|
|
@@ -7803,11 +7509,8 @@ export interface PostApiV21OrdersRequest {
|
|
|
7803
7509
|
public_note?: string;
|
|
7804
7510
|
/** the purchase order this order */
|
|
7805
7511
|
purchase_order?: string;
|
|
7806
|
-
/**
|
|
7807
|
-
|
|
7808
|
-
* @format float
|
|
7809
|
-
*/
|
|
7810
|
-
req_insurance_value?: number;
|
|
7512
|
+
/** the order requested insurance value */
|
|
7513
|
+
req_insurance_value?: string;
|
|
7811
7514
|
/** the order requested address */
|
|
7812
7515
|
requested_address?: string;
|
|
7813
7516
|
/** does the order require an adult signature upon delivery? */
|
|
@@ -7873,11 +7576,8 @@ export interface PostApiV21OrdersRequest {
|
|
|
7873
7576
|
shop_created_at?: string;
|
|
7874
7577
|
/** the order shop shipping method currency */
|
|
7875
7578
|
shop_shipping_method_currency?: string;
|
|
7876
|
-
/**
|
|
7877
|
-
|
|
7878
|
-
* @format float
|
|
7879
|
-
*/
|
|
7880
|
-
shop_shipping_method_price?: number;
|
|
7579
|
+
/** the order shop shipping method price */
|
|
7580
|
+
shop_shipping_method_price?: string;
|
|
7881
7581
|
/**
|
|
7882
7582
|
* the order shop shipping method text
|
|
7883
7583
|
* ge_standard = order uses global-e standard shipping method
|
|
@@ -8040,11 +7740,8 @@ export interface PostApiV21ShipnoticesBulkRequest {
|
|
|
8040
7740
|
easypostable_type?: string;
|
|
8041
7741
|
/** url of the shipping label */
|
|
8042
7742
|
shipping_label_url?: string;
|
|
8043
|
-
/**
|
|
8044
|
-
|
|
8045
|
-
* @format float
|
|
8046
|
-
*/
|
|
8047
|
-
ship_actual_cost?: number;
|
|
7743
|
+
/** the shipnotice actual cost of shipping */
|
|
7744
|
+
ship_actual_cost?: string;
|
|
8048
7745
|
/** the method of shipping for the shipnotice */
|
|
8049
7746
|
shipping_method_text?: string;
|
|
8050
7747
|
/**
|
|
@@ -8065,11 +7762,8 @@ export interface PostApiV21ShipnoticesBulkRequest {
|
|
|
8065
7762
|
postage_billed?: boolean;
|
|
8066
7763
|
/** was handling billed? */
|
|
8067
7764
|
handling_billed?: boolean;
|
|
8068
|
-
/**
|
|
8069
|
-
|
|
8070
|
-
* @format float
|
|
8071
|
-
*/
|
|
8072
|
-
ship_3rdparty_cost?: number;
|
|
7765
|
+
/** 3rd party cost for the shipnotice */
|
|
7766
|
+
ship_3rdparty_cost?: string;
|
|
8073
7767
|
/** does this shipnotice require a label? */
|
|
8074
7768
|
requires_label?: boolean;
|
|
8075
7769
|
/**
|
|
@@ -8213,11 +7907,8 @@ export interface PostApiV21ShipnoticesIdShipnoticeItemsRequest {
|
|
|
8213
7907
|
}
|
|
8214
7908
|
|
|
8215
7909
|
export interface PostApiV21ShipnoticesRequest {
|
|
8216
|
-
/**
|
|
8217
|
-
|
|
8218
|
-
* @format float
|
|
8219
|
-
*/
|
|
8220
|
-
ship_3rdparty_cost?: number;
|
|
7910
|
+
/** 3rd party cost for the shipnotice */
|
|
7911
|
+
ship_3rdparty_cost?: string;
|
|
8221
7912
|
/**
|
|
8222
7913
|
* the shipnotice arrival date and time
|
|
8223
7914
|
* @format date-time
|
|
@@ -8299,11 +7990,8 @@ export interface PostApiV21ShipnoticesRequest {
|
|
|
8299
7990
|
requires_label?: boolean;
|
|
8300
7991
|
/** the shipnotice sender */
|
|
8301
7992
|
sender: string;
|
|
8302
|
-
/**
|
|
8303
|
-
|
|
8304
|
-
* @format float
|
|
8305
|
-
*/
|
|
8306
|
-
ship_actual_cost?: number;
|
|
7993
|
+
/** the shipnotice actual cost of shipping */
|
|
7994
|
+
ship_actual_cost?: string;
|
|
8307
7995
|
/** currency used for this shipnotice */
|
|
8308
7996
|
ship_actual_currency?: string;
|
|
8309
7997
|
shipnotice_items_attributes?: {
|
|
@@ -8465,11 +8153,8 @@ export interface PostApiV2ConsumerReturnsBulkRequest {
|
|
|
8465
8153
|
easypostable_type?: string;
|
|
8466
8154
|
/** url of the shipping label */
|
|
8467
8155
|
shipping_label_url?: string;
|
|
8468
|
-
/**
|
|
8469
|
-
|
|
8470
|
-
* @format float
|
|
8471
|
-
*/
|
|
8472
|
-
ship_actual_cost?: number;
|
|
8156
|
+
/** the consumer return actual cost of shipping */
|
|
8157
|
+
ship_actual_cost?: string;
|
|
8473
8158
|
/** the method of shipping for the consumer return */
|
|
8474
8159
|
shipping_method_text?: string;
|
|
8475
8160
|
/** shipping carrier */
|
|
@@ -8482,11 +8167,8 @@ export interface PostApiV2ConsumerReturnsBulkRequest {
|
|
|
8482
8167
|
postage_billed?: boolean;
|
|
8483
8168
|
/** was handling billed? */
|
|
8484
8169
|
handling_billed?: boolean;
|
|
8485
|
-
/**
|
|
8486
|
-
|
|
8487
|
-
* @format float
|
|
8488
|
-
*/
|
|
8489
|
-
ship_3rdparty_cost?: number;
|
|
8170
|
+
/** the consumer return actual cost of shipping */
|
|
8171
|
+
ship_3rdparty_cost?: string;
|
|
8490
8172
|
/** does this consumer return require a label? */
|
|
8491
8173
|
requires_label: boolean;
|
|
8492
8174
|
/**
|
|
@@ -8559,11 +8241,8 @@ export interface PostApiV2ConsumerReturnsBulkRequest {
|
|
|
8559
8241
|
}
|
|
8560
8242
|
|
|
8561
8243
|
export interface PostApiV2ConsumerReturnsRequest {
|
|
8562
|
-
/**
|
|
8563
|
-
|
|
8564
|
-
* @format float
|
|
8565
|
-
*/
|
|
8566
|
-
ship_3rdparty_cost?: number;
|
|
8244
|
+
/** the consumer return actual cost of shipping */
|
|
8245
|
+
ship_3rdparty_cost?: string;
|
|
8567
8246
|
/**
|
|
8568
8247
|
* the consumer return arrival date and time
|
|
8569
8248
|
* @format date-time
|
|
@@ -8648,11 +8327,8 @@ export interface PostApiV2ConsumerReturnsRequest {
|
|
|
8648
8327
|
requires_label: boolean;
|
|
8649
8328
|
/** the consumer return sender */
|
|
8650
8329
|
sender?: string;
|
|
8651
|
-
/**
|
|
8652
|
-
|
|
8653
|
-
* @format float
|
|
8654
|
-
*/
|
|
8655
|
-
ship_actual_cost?: number;
|
|
8330
|
+
/** the consumer return actual cost of shipping */
|
|
8331
|
+
ship_actual_cost?: string;
|
|
8656
8332
|
/** currency used for this consumer return */
|
|
8657
8333
|
ship_actual_currency?: string;
|
|
8658
8334
|
shipnotice_items_attributes?: {
|
|
@@ -8802,11 +8478,8 @@ export interface PostApiV2ItemsRequest {
|
|
|
8802
8478
|
hazmat?: boolean;
|
|
8803
8479
|
/** hazmat class */
|
|
8804
8480
|
hazmat_type?: PostApiV2ItemsRequestHazmatType;
|
|
8805
|
-
/**
|
|
8806
|
-
|
|
8807
|
-
* @format float
|
|
8808
|
-
*/
|
|
8809
|
-
height?: number;
|
|
8481
|
+
/** the item height (in inches) */
|
|
8482
|
+
height?: string;
|
|
8810
8483
|
/** the originator url for the item image */
|
|
8811
8484
|
image_originator_url?: string;
|
|
8812
8485
|
/** include inbound items in published? */
|
|
@@ -8815,11 +8488,8 @@ export interface PostApiV2ItemsRequest {
|
|
|
8815
8488
|
is_bundle?: boolean;
|
|
8816
8489
|
/** label format */
|
|
8817
8490
|
label_format?: PostApiV2ItemsRequestLabelFormat;
|
|
8818
|
-
/**
|
|
8819
|
-
|
|
8820
|
-
* @format float
|
|
8821
|
-
*/
|
|
8822
|
-
length?: number;
|
|
8491
|
+
/** the item length (in inches) */
|
|
8492
|
+
length?: string;
|
|
8823
8493
|
/** does this item require lot control? */
|
|
8824
8494
|
lot_control?: boolean;
|
|
8825
8495
|
/**
|
|
@@ -8859,23 +8529,14 @@ export interface PostApiV2ItemsRequest {
|
|
|
8859
8529
|
packaging?: boolean;
|
|
8860
8530
|
/** the item packaging type */
|
|
8861
8531
|
packaging_type?: PostApiV2ItemsRequestPackagingType;
|
|
8862
|
-
/**
|
|
8863
|
-
|
|
8864
|
-
* @format float
|
|
8865
|
-
*/
|
|
8866
|
-
price?: number;
|
|
8532
|
+
/** the item price */
|
|
8533
|
+
price?: string;
|
|
8867
8534
|
/** is the item a promo? */
|
|
8868
8535
|
promo?: boolean;
|
|
8869
|
-
/**
|
|
8870
|
-
|
|
8871
|
-
|
|
8872
|
-
|
|
8873
|
-
replenishment_min?: number;
|
|
8874
|
-
/**
|
|
8875
|
-
* Target number of days stock to replenish forward pick locations
|
|
8876
|
-
* @format float
|
|
8877
|
-
*/
|
|
8878
|
-
replenishment_target?: number;
|
|
8536
|
+
/** Minimum number of days worth of stock to keep in forward pick locations */
|
|
8537
|
+
replenishment_min?: string;
|
|
8538
|
+
/** Target number of days stock to replenish forward pick locations */
|
|
8539
|
+
replenishment_target?: string;
|
|
8879
8540
|
/** does the item require a serial number when shipping? */
|
|
8880
8541
|
request_serial_number?: boolean;
|
|
8881
8542
|
/** is the item return price restricted? */
|
|
@@ -8911,21 +8572,12 @@ export interface PostApiV2ItemsRequest {
|
|
|
8911
8572
|
velocity?: number;
|
|
8912
8573
|
/** the item vendor */
|
|
8913
8574
|
vendor?: string;
|
|
8914
|
-
/**
|
|
8915
|
-
|
|
8916
|
-
|
|
8917
|
-
|
|
8918
|
-
|
|
8919
|
-
|
|
8920
|
-
* the wholesale cost of the item
|
|
8921
|
-
* @format float
|
|
8922
|
-
*/
|
|
8923
|
-
wholesale_cost?: number;
|
|
8924
|
-
/**
|
|
8925
|
-
* the item width (in inches)
|
|
8926
|
-
* @format float
|
|
8927
|
-
*/
|
|
8928
|
-
width?: number;
|
|
8575
|
+
/** the weight of the item (in pounds) */
|
|
8576
|
+
weight?: string;
|
|
8577
|
+
/** the wholesale cost of the item */
|
|
8578
|
+
wholesale_cost?: string;
|
|
8579
|
+
/** the item width (in inches) */
|
|
8580
|
+
width?: string;
|
|
8929
8581
|
}
|
|
8930
8582
|
|
|
8931
8583
|
export interface PostApiV2NotificationSubscriptionsRequest {
|
|
@@ -9031,11 +8683,8 @@ export interface PostApiV2OrdersBulkRequest {
|
|
|
9031
8683
|
* ge_express = order uses global-e express shipping method
|
|
9032
8684
|
*/
|
|
9033
8685
|
shop_shipping_method_text?: string;
|
|
9034
|
-
/**
|
|
9035
|
-
|
|
9036
|
-
* @format float
|
|
9037
|
-
*/
|
|
9038
|
-
shop_shipping_method_price?: number;
|
|
8686
|
+
/** the order shop shipping method price */
|
|
8687
|
+
shop_shipping_method_price?: string;
|
|
9039
8688
|
/** the order billing company */
|
|
9040
8689
|
billing_company?: string;
|
|
9041
8690
|
/** the order billing street address 1 */
|
|
@@ -9106,11 +8755,8 @@ export interface PostApiV2OrdersBulkRequest {
|
|
|
9106
8755
|
shipping_hold_for_pickup?: boolean;
|
|
9107
8756
|
/** the order ship notes */
|
|
9108
8757
|
ship_notes?: string;
|
|
9109
|
-
/**
|
|
9110
|
-
|
|
9111
|
-
* @format float
|
|
9112
|
-
*/
|
|
9113
|
-
ship_3rdparty_cost?: number;
|
|
8758
|
+
/** the order third party shipping cost */
|
|
8759
|
+
ship_3rdparty_cost?: string;
|
|
9114
8760
|
/** the order third party shipping account */
|
|
9115
8761
|
ship_3rdparty_account?: string;
|
|
9116
8762
|
/** the order third party shipping zip */
|
|
@@ -9131,11 +8777,8 @@ export interface PostApiV2OrdersBulkRequest {
|
|
|
9131
8777
|
* @format int32
|
|
9132
8778
|
*/
|
|
9133
8779
|
days_in_transit_carrier_estimate?: number;
|
|
9134
|
-
/**
|
|
9135
|
-
|
|
9136
|
-
* @format float
|
|
9137
|
-
*/
|
|
9138
|
-
req_insurance_value?: number;
|
|
8780
|
+
/** the order requested insurance value */
|
|
8781
|
+
req_insurance_value?: string;
|
|
9139
8782
|
/** Value Added Tax identifcation number for the sender of the order */
|
|
9140
8783
|
customs_vat_number?: string;
|
|
9141
8784
|
/** Economic Operators Registration and Identification number for the sender of the order */
|
|
@@ -9225,11 +8868,8 @@ export interface PostApiV2OrdersBulkRequest {
|
|
|
9225
8868
|
sku?: string;
|
|
9226
8869
|
/** description for this order item. This will appear in packing slips. If not set, the description will be inherited from the parent Item. */
|
|
9227
8870
|
description?: string;
|
|
9228
|
-
/**
|
|
9229
|
-
|
|
9230
|
-
* @format float
|
|
9231
|
-
*/
|
|
9232
|
-
price?: number;
|
|
8871
|
+
/** price of this item */
|
|
8872
|
+
price?: string;
|
|
9233
8873
|
/** is this item unshippable? */
|
|
9234
8874
|
unshippable?: boolean;
|
|
9235
8875
|
/** is this item available? */
|
|
@@ -9241,29 +8881,20 @@ export interface PostApiV2OrdersBulkRequest {
|
|
|
9241
8881
|
packed?: number;
|
|
9242
8882
|
/** is this item packaging? */
|
|
9243
8883
|
packaging?: boolean;
|
|
9244
|
-
/**
|
|
9245
|
-
|
|
9246
|
-
* @format float
|
|
9247
|
-
*/
|
|
9248
|
-
wholesale_cost?: number;
|
|
8884
|
+
/** wholesale cost of the item */
|
|
8885
|
+
wholesale_cost?: string;
|
|
9249
8886
|
/** is this item a bundle? */
|
|
9250
8887
|
is_bundle?: boolean;
|
|
9251
|
-
/**
|
|
9252
|
-
|
|
9253
|
-
* @format float
|
|
9254
|
-
*/
|
|
9255
|
-
retail_fee?: number;
|
|
8888
|
+
/** retail fee of this item */
|
|
8889
|
+
retail_fee?: string;
|
|
9256
8890
|
/** is this item a promo? */
|
|
9257
8891
|
promo?: boolean;
|
|
9258
8892
|
/** is this item returnable? */
|
|
9259
8893
|
returnable?: boolean;
|
|
9260
8894
|
/** currency code for this item */
|
|
9261
8895
|
currency?: string;
|
|
9262
|
-
/**
|
|
9263
|
-
|
|
9264
|
-
* @format float
|
|
9265
|
-
*/
|
|
9266
|
-
wholesale_fee?: number;
|
|
8896
|
+
/** wholesale fee of this item */
|
|
8897
|
+
wholesale_fee?: string;
|
|
9267
8898
|
/** (deprecated) is the order item hazmat? */
|
|
9268
8899
|
hazmat?: boolean;
|
|
9269
8900
|
/** miscellaneous information about the order item */
|
|
@@ -9380,11 +9011,8 @@ export interface PostApiV2OrdersIdOrderItemsRequest {
|
|
|
9380
9011
|
* @format int32
|
|
9381
9012
|
*/
|
|
9382
9013
|
packed?: number;
|
|
9383
|
-
/**
|
|
9384
|
-
|
|
9385
|
-
* @format float
|
|
9386
|
-
*/
|
|
9387
|
-
price?: number;
|
|
9014
|
+
/** price of this item */
|
|
9015
|
+
price?: string;
|
|
9388
9016
|
/** is this item a promo? */
|
|
9389
9017
|
promo?: boolean;
|
|
9390
9018
|
/**
|
|
@@ -9399,27 +9027,18 @@ export interface PostApiV2OrdersIdOrderItemsRequest {
|
|
|
9399
9027
|
quote_item_id?: number;
|
|
9400
9028
|
/** does the item require a serial number when shipping? */
|
|
9401
9029
|
request_serial_number?: boolean;
|
|
9402
|
-
/**
|
|
9403
|
-
|
|
9404
|
-
* @format float
|
|
9405
|
-
*/
|
|
9406
|
-
retail_fee?: number;
|
|
9030
|
+
/** retail fee of this item */
|
|
9031
|
+
retail_fee?: string;
|
|
9407
9032
|
/** is this item returnable? */
|
|
9408
9033
|
returnable?: boolean;
|
|
9409
9034
|
/** the SKU of this item */
|
|
9410
9035
|
sku?: string;
|
|
9411
9036
|
/** is this item unshippable? */
|
|
9412
9037
|
unshippable?: boolean;
|
|
9413
|
-
/**
|
|
9414
|
-
|
|
9415
|
-
|
|
9416
|
-
|
|
9417
|
-
wholesale_cost?: number;
|
|
9418
|
-
/**
|
|
9419
|
-
* wholesale fee of this item
|
|
9420
|
-
* @format float
|
|
9421
|
-
*/
|
|
9422
|
-
wholesale_fee?: number;
|
|
9038
|
+
/** wholesale cost of the item */
|
|
9039
|
+
wholesale_cost?: string;
|
|
9040
|
+
/** wholesale fee of this item */
|
|
9041
|
+
wholesale_fee?: string;
|
|
9423
9042
|
wholesale_item_attributes?: {
|
|
9424
9043
|
/**
|
|
9425
9044
|
* the associated order item id
|
|
@@ -9486,11 +9105,8 @@ export interface PostApiV2OrdersRequest {
|
|
|
9486
9105
|
return_address_2?: string;
|
|
9487
9106
|
/** the order third party shipping account */
|
|
9488
9107
|
ship_3rdparty_account?: string;
|
|
9489
|
-
/**
|
|
9490
|
-
|
|
9491
|
-
* @format float
|
|
9492
|
-
*/
|
|
9493
|
-
ship_3rdparty_cost?: number;
|
|
9108
|
+
/** the order third party shipping cost */
|
|
9109
|
+
ship_3rdparty_cost?: string;
|
|
9494
9110
|
/** the order third party shipping country */
|
|
9495
9111
|
ship_3rdparty_country?: string;
|
|
9496
9112
|
/** the order third party shipping zip */
|
|
@@ -9637,11 +9253,8 @@ export interface PostApiV2OrdersRequest {
|
|
|
9637
9253
|
sku?: string;
|
|
9638
9254
|
/** description for this order item. This will appear in packing slips. If not set, the description will be inherited from the parent Item. */
|
|
9639
9255
|
description?: string;
|
|
9640
|
-
/**
|
|
9641
|
-
|
|
9642
|
-
* @format float
|
|
9643
|
-
*/
|
|
9644
|
-
price?: number;
|
|
9256
|
+
/** price of this item */
|
|
9257
|
+
price?: string;
|
|
9645
9258
|
/**
|
|
9646
9259
|
* the order item creation date and time
|
|
9647
9260
|
* @format date-time
|
|
@@ -9663,29 +9276,20 @@ export interface PostApiV2OrdersRequest {
|
|
|
9663
9276
|
packed?: number;
|
|
9664
9277
|
/** is this item packaging? */
|
|
9665
9278
|
packaging?: boolean;
|
|
9666
|
-
/**
|
|
9667
|
-
|
|
9668
|
-
* @format float
|
|
9669
|
-
*/
|
|
9670
|
-
wholesale_cost?: number;
|
|
9279
|
+
/** wholesale cost of the item */
|
|
9280
|
+
wholesale_cost?: string;
|
|
9671
9281
|
/** is this item a bundle? */
|
|
9672
9282
|
is_bundle?: boolean;
|
|
9673
|
-
/**
|
|
9674
|
-
|
|
9675
|
-
* @format float
|
|
9676
|
-
*/
|
|
9677
|
-
retail_fee?: number;
|
|
9283
|
+
/** retail fee of this item */
|
|
9284
|
+
retail_fee?: string;
|
|
9678
9285
|
/** is this item a promo? */
|
|
9679
9286
|
promo?: boolean;
|
|
9680
9287
|
/** is this item returnable? */
|
|
9681
9288
|
returnable?: boolean;
|
|
9682
9289
|
/** currency code for this item */
|
|
9683
9290
|
currency?: string;
|
|
9684
|
-
/**
|
|
9685
|
-
|
|
9686
|
-
* @format float
|
|
9687
|
-
*/
|
|
9688
|
-
wholesale_fee?: number;
|
|
9291
|
+
/** wholesale fee of this item */
|
|
9292
|
+
wholesale_fee?: string;
|
|
9689
9293
|
/** (deprecated) is the order item hazmat? */
|
|
9690
9294
|
hazmat?: boolean;
|
|
9691
9295
|
/** miscellaneous information about the order item */
|
|
@@ -9792,11 +9396,8 @@ export interface PostApiV2OrdersRequest {
|
|
|
9792
9396
|
public_note?: string;
|
|
9793
9397
|
/** the purchase order this order */
|
|
9794
9398
|
purchase_order?: string;
|
|
9795
|
-
/**
|
|
9796
|
-
|
|
9797
|
-
* @format float
|
|
9798
|
-
*/
|
|
9799
|
-
req_insurance_value?: number;
|
|
9399
|
+
/** the order requested insurance value */
|
|
9400
|
+
req_insurance_value?: string;
|
|
9800
9401
|
/** the order requested address */
|
|
9801
9402
|
requested_address?: string;
|
|
9802
9403
|
/** does the order require an adult signature upon delivery? */
|
|
@@ -9862,11 +9463,8 @@ export interface PostApiV2OrdersRequest {
|
|
|
9862
9463
|
shop_created_at?: string;
|
|
9863
9464
|
/** the order shop shipping method currency */
|
|
9864
9465
|
shop_shipping_method_currency?: string;
|
|
9865
|
-
/**
|
|
9866
|
-
|
|
9867
|
-
* @format float
|
|
9868
|
-
*/
|
|
9869
|
-
shop_shipping_method_price?: number;
|
|
9466
|
+
/** the order shop shipping method price */
|
|
9467
|
+
shop_shipping_method_price?: string;
|
|
9870
9468
|
/**
|
|
9871
9469
|
* the order shop shipping method text
|
|
9872
9470
|
* ge_standard = order uses global-e standard shipping method
|
|
@@ -10029,11 +9627,8 @@ export interface PostApiV2ShipnoticesBulkRequest {
|
|
|
10029
9627
|
easypostable_type?: string;
|
|
10030
9628
|
/** url of the shipping label */
|
|
10031
9629
|
shipping_label_url?: string;
|
|
10032
|
-
/**
|
|
10033
|
-
|
|
10034
|
-
* @format float
|
|
10035
|
-
*/
|
|
10036
|
-
ship_actual_cost?: number;
|
|
9630
|
+
/** the shipnotice actual cost of shipping */
|
|
9631
|
+
ship_actual_cost?: string;
|
|
10037
9632
|
/** the method of shipping for the shipnotice */
|
|
10038
9633
|
shipping_method_text?: string;
|
|
10039
9634
|
/**
|
|
@@ -10054,11 +9649,8 @@ export interface PostApiV2ShipnoticesBulkRequest {
|
|
|
10054
9649
|
postage_billed?: boolean;
|
|
10055
9650
|
/** was handling billed? */
|
|
10056
9651
|
handling_billed?: boolean;
|
|
10057
|
-
/**
|
|
10058
|
-
|
|
10059
|
-
* @format float
|
|
10060
|
-
*/
|
|
10061
|
-
ship_3rdparty_cost?: number;
|
|
9652
|
+
/** 3rd party cost for the shipnotice */
|
|
9653
|
+
ship_3rdparty_cost?: string;
|
|
10062
9654
|
/** does this shipnotice require a label? */
|
|
10063
9655
|
requires_label?: boolean;
|
|
10064
9656
|
/**
|
|
@@ -10202,11 +9794,8 @@ export interface PostApiV2ShipnoticesIdShipnoticeItemsRequest {
|
|
|
10202
9794
|
}
|
|
10203
9795
|
|
|
10204
9796
|
export interface PostApiV2ShipnoticesRequest {
|
|
10205
|
-
/**
|
|
10206
|
-
|
|
10207
|
-
* @format float
|
|
10208
|
-
*/
|
|
10209
|
-
ship_3rdparty_cost?: number;
|
|
9797
|
+
/** 3rd party cost for the shipnotice */
|
|
9798
|
+
ship_3rdparty_cost?: string;
|
|
10210
9799
|
/**
|
|
10211
9800
|
* the shipnotice arrival date and time
|
|
10212
9801
|
* @format date-time
|
|
@@ -10288,11 +9877,8 @@ export interface PostApiV2ShipnoticesRequest {
|
|
|
10288
9877
|
requires_label?: boolean;
|
|
10289
9878
|
/** the shipnotice sender */
|
|
10290
9879
|
sender: string;
|
|
10291
|
-
/**
|
|
10292
|
-
|
|
10293
|
-
* @format float
|
|
10294
|
-
*/
|
|
10295
|
-
ship_actual_cost?: number;
|
|
9880
|
+
/** the shipnotice actual cost of shipping */
|
|
9881
|
+
ship_actual_cost?: string;
|
|
10296
9882
|
/** currency used for this shipnotice */
|
|
10297
9883
|
ship_actual_currency?: string;
|
|
10298
9884
|
shipnotice_items_attributes?: {
|
|
@@ -10416,11 +10002,8 @@ export interface PutApiV21ConsumerReturnsIdMetaFieldsRequest {
|
|
|
10416
10002
|
}
|
|
10417
10003
|
|
|
10418
10004
|
export interface PutApiV21ConsumerReturnsIdRequest {
|
|
10419
|
-
/**
|
|
10420
|
-
|
|
10421
|
-
* @format float
|
|
10422
|
-
*/
|
|
10423
|
-
ship_3rdparty_cost?: number;
|
|
10005
|
+
/** 3rd party cost for the consumer return */
|
|
10006
|
+
ship_3rdparty_cost?: string;
|
|
10424
10007
|
/** shipping carrier */
|
|
10425
10008
|
carrier?: string;
|
|
10426
10009
|
/**
|
|
@@ -10623,16 +10206,10 @@ export interface PutApiV21CustomersIdRequest {
|
|
|
10623
10206
|
project_task_labels?: string[];
|
|
10624
10207
|
/** JSON array of required and optional receiving fields in the form: {"label": "cases", "required": true} */
|
|
10625
10208
|
receiving_fields?: object[];
|
|
10626
|
-
/**
|
|
10627
|
-
|
|
10628
|
-
|
|
10629
|
-
|
|
10630
|
-
replenishment_min?: number;
|
|
10631
|
-
/**
|
|
10632
|
-
* Target number of days stock to replenish forward pick locations
|
|
10633
|
-
* @format float
|
|
10634
|
-
*/
|
|
10635
|
-
replenishment_target?: number;
|
|
10209
|
+
/** Minimum number of days worth of stock to keep in forward pick locations */
|
|
10210
|
+
replenishment_min?: string;
|
|
10211
|
+
/** Target number of days stock to replenish forward pick locations */
|
|
10212
|
+
replenishment_target?: string;
|
|
10636
10213
|
/** request serial numbers? */
|
|
10637
10214
|
request_serial_numbers?: boolean;
|
|
10638
10215
|
/** Customer return city. */
|
|
@@ -10751,11 +10328,8 @@ export interface PutApiV21ItemsIdRequest {
|
|
|
10751
10328
|
hazmat?: boolean;
|
|
10752
10329
|
/** hazmat class */
|
|
10753
10330
|
hazmat_type?: PutApiV21ItemsIdRequestHazmatType;
|
|
10754
|
-
/**
|
|
10755
|
-
|
|
10756
|
-
* @format float
|
|
10757
|
-
*/
|
|
10758
|
-
height?: number;
|
|
10331
|
+
/** the item height (in inches) */
|
|
10332
|
+
height?: string;
|
|
10759
10333
|
/** the originator url for the item image */
|
|
10760
10334
|
image_originator_url?: string;
|
|
10761
10335
|
/** include inbound items in published? */
|
|
@@ -10764,11 +10338,8 @@ export interface PutApiV21ItemsIdRequest {
|
|
|
10764
10338
|
is_bundle?: boolean;
|
|
10765
10339
|
/** label format */
|
|
10766
10340
|
label_format?: PutApiV21ItemsIdRequestLabelFormat;
|
|
10767
|
-
/**
|
|
10768
|
-
|
|
10769
|
-
* @format float
|
|
10770
|
-
*/
|
|
10771
|
-
length?: number;
|
|
10341
|
+
/** the item length (in inches) */
|
|
10342
|
+
length?: string;
|
|
10772
10343
|
/** does this item require lot control? */
|
|
10773
10344
|
lot_control?: boolean;
|
|
10774
10345
|
/**
|
|
@@ -10795,23 +10366,14 @@ export interface PutApiV21ItemsIdRequest {
|
|
|
10795
10366
|
packaging?: boolean;
|
|
10796
10367
|
/** the item packaging type */
|
|
10797
10368
|
packaging_type?: PutApiV21ItemsIdRequestPackagingType;
|
|
10798
|
-
/**
|
|
10799
|
-
|
|
10800
|
-
* @format float
|
|
10801
|
-
*/
|
|
10802
|
-
price?: number;
|
|
10369
|
+
/** the item price */
|
|
10370
|
+
price?: string;
|
|
10803
10371
|
/** is the item a promo? */
|
|
10804
10372
|
promo?: boolean;
|
|
10805
|
-
/**
|
|
10806
|
-
|
|
10807
|
-
|
|
10808
|
-
|
|
10809
|
-
replenishment_min?: number;
|
|
10810
|
-
/**
|
|
10811
|
-
* Target number of days stock to replenish forward pick locations
|
|
10812
|
-
* @format float
|
|
10813
|
-
*/
|
|
10814
|
-
replenishment_target?: number;
|
|
10373
|
+
/** Minimum number of days worth of stock to keep in forward pick locations */
|
|
10374
|
+
replenishment_min?: string;
|
|
10375
|
+
/** Target number of days stock to replenish forward pick locations */
|
|
10376
|
+
replenishment_target?: string;
|
|
10815
10377
|
/** does the item require a serial number when shipping? */
|
|
10816
10378
|
request_serial_number?: boolean;
|
|
10817
10379
|
/** is the item return price restricted? */
|
|
@@ -10847,21 +10409,12 @@ export interface PutApiV21ItemsIdRequest {
|
|
|
10847
10409
|
velocity?: number;
|
|
10848
10410
|
/** the item vendor */
|
|
10849
10411
|
vendor?: string;
|
|
10850
|
-
/**
|
|
10851
|
-
|
|
10852
|
-
|
|
10853
|
-
|
|
10854
|
-
|
|
10855
|
-
|
|
10856
|
-
* the wholesale cost of the item
|
|
10857
|
-
* @format float
|
|
10858
|
-
*/
|
|
10859
|
-
wholesale_cost?: number;
|
|
10860
|
-
/**
|
|
10861
|
-
* the item width (in inches)
|
|
10862
|
-
* @format float
|
|
10863
|
-
*/
|
|
10864
|
-
width?: number;
|
|
10412
|
+
/** the weight of the item (in pounds) */
|
|
10413
|
+
weight?: string;
|
|
10414
|
+
/** the wholesale cost of the item */
|
|
10415
|
+
wholesale_cost?: string;
|
|
10416
|
+
/** the item width (in inches) */
|
|
10417
|
+
width?: string;
|
|
10865
10418
|
}
|
|
10866
10419
|
|
|
10867
10420
|
export interface PutApiV21NotificationSubscriptionsIdRequest {
|
|
@@ -10958,11 +10511,8 @@ export interface PutApiV21OrderItemsIdRequest {
|
|
|
10958
10511
|
* @format int32
|
|
10959
10512
|
*/
|
|
10960
10513
|
packed?: number;
|
|
10961
|
-
/**
|
|
10962
|
-
|
|
10963
|
-
* @format float
|
|
10964
|
-
*/
|
|
10965
|
-
price?: number;
|
|
10514
|
+
/** price of this item */
|
|
10515
|
+
price?: string;
|
|
10966
10516
|
/** is this item a promo? */
|
|
10967
10517
|
promo?: boolean;
|
|
10968
10518
|
/**
|
|
@@ -10977,27 +10527,18 @@ export interface PutApiV21OrderItemsIdRequest {
|
|
|
10977
10527
|
quote_item_id?: number;
|
|
10978
10528
|
/** does the item require a serial number when shipping? */
|
|
10979
10529
|
request_serial_number?: boolean;
|
|
10980
|
-
/**
|
|
10981
|
-
|
|
10982
|
-
* @format float
|
|
10983
|
-
*/
|
|
10984
|
-
retail_fee?: number;
|
|
10530
|
+
/** retail fee of this item */
|
|
10531
|
+
retail_fee?: string;
|
|
10985
10532
|
/** is this item returnable? */
|
|
10986
10533
|
returnable?: boolean;
|
|
10987
10534
|
/** the SKU of this item */
|
|
10988
10535
|
sku?: string;
|
|
10989
10536
|
/** is this item unshippable? */
|
|
10990
10537
|
unshippable?: boolean;
|
|
10991
|
-
/**
|
|
10992
|
-
|
|
10993
|
-
|
|
10994
|
-
|
|
10995
|
-
wholesale_cost?: number;
|
|
10996
|
-
/**
|
|
10997
|
-
* wholesale fee of this item
|
|
10998
|
-
* @format float
|
|
10999
|
-
*/
|
|
11000
|
-
wholesale_fee?: number;
|
|
10538
|
+
/** wholesale cost of the item */
|
|
10539
|
+
wholesale_cost?: string;
|
|
10540
|
+
/** wholesale fee of this item */
|
|
10541
|
+
wholesale_fee?: string;
|
|
11001
10542
|
wholesale_item_attributes?: {
|
|
11002
10543
|
/**
|
|
11003
10544
|
* the associated order item id
|
|
@@ -11125,11 +10666,8 @@ export interface PutApiV21OrdersIdRequest {
|
|
|
11125
10666
|
return_address_2?: string;
|
|
11126
10667
|
/** the order third party shipping account */
|
|
11127
10668
|
ship_3rdparty_account?: string;
|
|
11128
|
-
/**
|
|
11129
|
-
|
|
11130
|
-
* @format float
|
|
11131
|
-
*/
|
|
11132
|
-
ship_3rdparty_cost?: number;
|
|
10669
|
+
/** the order third party shipping cost */
|
|
10670
|
+
ship_3rdparty_cost?: string;
|
|
11133
10671
|
/** the order third party shipping country */
|
|
11134
10672
|
ship_3rdparty_country?: string;
|
|
11135
10673
|
/** the order third party shipping zip */
|
|
@@ -11244,11 +10782,8 @@ export interface PutApiV21OrdersIdRequest {
|
|
|
11244
10782
|
public_note?: string;
|
|
11245
10783
|
/** the purchase order this order */
|
|
11246
10784
|
purchase_order?: string;
|
|
11247
|
-
/**
|
|
11248
|
-
|
|
11249
|
-
* @format float
|
|
11250
|
-
*/
|
|
11251
|
-
req_insurance_value?: number;
|
|
10785
|
+
/** the order requested insurance value */
|
|
10786
|
+
req_insurance_value?: string;
|
|
11252
10787
|
/** the order requested address */
|
|
11253
10788
|
requested_address?: string;
|
|
11254
10789
|
/** does the order require an adult signature upon delivery? */
|
|
@@ -11314,11 +10849,8 @@ export interface PutApiV21OrdersIdRequest {
|
|
|
11314
10849
|
shop_created_at?: string;
|
|
11315
10850
|
/** the order shop shipping method currency */
|
|
11316
10851
|
shop_shipping_method_currency?: string;
|
|
11317
|
-
/**
|
|
11318
|
-
|
|
11319
|
-
* @format float
|
|
11320
|
-
*/
|
|
11321
|
-
shop_shipping_method_price?: number;
|
|
10852
|
+
/** the order shop shipping method price */
|
|
10853
|
+
shop_shipping_method_price?: string;
|
|
11322
10854
|
/**
|
|
11323
10855
|
* the order shop shipping method text
|
|
11324
10856
|
* ge_standard = order uses global-e standard shipping method
|
|
@@ -11470,11 +11002,8 @@ export interface PutApiV21ShipnoticesIdMetaFieldsRequest {
|
|
|
11470
11002
|
}
|
|
11471
11003
|
|
|
11472
11004
|
export interface PutApiV21ShipnoticesIdRequest {
|
|
11473
|
-
/**
|
|
11474
|
-
|
|
11475
|
-
* @format float
|
|
11476
|
-
*/
|
|
11477
|
-
ship_3rdparty_cost?: number;
|
|
11005
|
+
/** 3rd party cost for the shipnotice */
|
|
11006
|
+
ship_3rdparty_cost?: string;
|
|
11478
11007
|
/**
|
|
11479
11008
|
* the shipnotice arrival date and time
|
|
11480
11009
|
* @format date-time
|
|
@@ -11534,11 +11063,8 @@ export interface PutApiV21ShipnoticesIdRequest {
|
|
|
11534
11063
|
requires_label?: boolean;
|
|
11535
11064
|
/** the shipnotice sender */
|
|
11536
11065
|
sender?: string;
|
|
11537
|
-
/**
|
|
11538
|
-
|
|
11539
|
-
* @format float
|
|
11540
|
-
*/
|
|
11541
|
-
ship_actual_cost?: number;
|
|
11066
|
+
/** the shipnotice actual cost of shipping */
|
|
11067
|
+
ship_actual_cost?: string;
|
|
11542
11068
|
/** currency used for this shipnotice */
|
|
11543
11069
|
ship_actual_currency?: string;
|
|
11544
11070
|
shipnotice_items?: string;
|
|
@@ -11659,11 +11185,8 @@ export interface PutApiV2ConsumerReturnsIdMetaFieldsRequest {
|
|
|
11659
11185
|
}
|
|
11660
11186
|
|
|
11661
11187
|
export interface PutApiV2ConsumerReturnsIdRequest {
|
|
11662
|
-
/**
|
|
11663
|
-
|
|
11664
|
-
* @format float
|
|
11665
|
-
*/
|
|
11666
|
-
ship_3rdparty_cost?: number;
|
|
11188
|
+
/** 3rd party cost for the consumer return */
|
|
11189
|
+
ship_3rdparty_cost?: string;
|
|
11667
11190
|
/** shipping carrier */
|
|
11668
11191
|
carrier?: string;
|
|
11669
11192
|
/**
|
|
@@ -11866,16 +11389,10 @@ export interface PutApiV2CustomersIdRequest {
|
|
|
11866
11389
|
project_task_labels?: string[];
|
|
11867
11390
|
/** JSON array of required and optional receiving fields in the form: {"label": "cases", "required": true} */
|
|
11868
11391
|
receiving_fields?: object[];
|
|
11869
|
-
/**
|
|
11870
|
-
|
|
11871
|
-
|
|
11872
|
-
|
|
11873
|
-
replenishment_min?: number;
|
|
11874
|
-
/**
|
|
11875
|
-
* Target number of days stock to replenish forward pick locations
|
|
11876
|
-
* @format float
|
|
11877
|
-
*/
|
|
11878
|
-
replenishment_target?: number;
|
|
11392
|
+
/** Minimum number of days worth of stock to keep in forward pick locations */
|
|
11393
|
+
replenishment_min?: string;
|
|
11394
|
+
/** Target number of days stock to replenish forward pick locations */
|
|
11395
|
+
replenishment_target?: string;
|
|
11879
11396
|
/** request serial numbers? */
|
|
11880
11397
|
request_serial_numbers?: boolean;
|
|
11881
11398
|
/** Customer return city. */
|
|
@@ -11994,11 +11511,8 @@ export interface PutApiV2ItemsIdRequest {
|
|
|
11994
11511
|
hazmat?: boolean;
|
|
11995
11512
|
/** hazmat class */
|
|
11996
11513
|
hazmat_type?: PutApiV2ItemsIdRequestHazmatType;
|
|
11997
|
-
/**
|
|
11998
|
-
|
|
11999
|
-
* @format float
|
|
12000
|
-
*/
|
|
12001
|
-
height?: number;
|
|
11514
|
+
/** the item height (in inches) */
|
|
11515
|
+
height?: string;
|
|
12002
11516
|
/** the originator url for the item image */
|
|
12003
11517
|
image_originator_url?: string;
|
|
12004
11518
|
/** include inbound items in published? */
|
|
@@ -12007,11 +11521,8 @@ export interface PutApiV2ItemsIdRequest {
|
|
|
12007
11521
|
is_bundle?: boolean;
|
|
12008
11522
|
/** label format */
|
|
12009
11523
|
label_format?: PutApiV2ItemsIdRequestLabelFormat;
|
|
12010
|
-
/**
|
|
12011
|
-
|
|
12012
|
-
* @format float
|
|
12013
|
-
*/
|
|
12014
|
-
length?: number;
|
|
11524
|
+
/** the item length (in inches) */
|
|
11525
|
+
length?: string;
|
|
12015
11526
|
/** does this item require lot control? */
|
|
12016
11527
|
lot_control?: boolean;
|
|
12017
11528
|
/**
|
|
@@ -12038,23 +11549,14 @@ export interface PutApiV2ItemsIdRequest {
|
|
|
12038
11549
|
packaging?: boolean;
|
|
12039
11550
|
/** the item packaging type */
|
|
12040
11551
|
packaging_type?: PutApiV2ItemsIdRequestPackagingType;
|
|
12041
|
-
/**
|
|
12042
|
-
|
|
12043
|
-
* @format float
|
|
12044
|
-
*/
|
|
12045
|
-
price?: number;
|
|
11552
|
+
/** the item price */
|
|
11553
|
+
price?: string;
|
|
12046
11554
|
/** is the item a promo? */
|
|
12047
11555
|
promo?: boolean;
|
|
12048
|
-
/**
|
|
12049
|
-
|
|
12050
|
-
|
|
12051
|
-
|
|
12052
|
-
replenishment_min?: number;
|
|
12053
|
-
/**
|
|
12054
|
-
* Target number of days stock to replenish forward pick locations
|
|
12055
|
-
* @format float
|
|
12056
|
-
*/
|
|
12057
|
-
replenishment_target?: number;
|
|
11556
|
+
/** Minimum number of days worth of stock to keep in forward pick locations */
|
|
11557
|
+
replenishment_min?: string;
|
|
11558
|
+
/** Target number of days stock to replenish forward pick locations */
|
|
11559
|
+
replenishment_target?: string;
|
|
12058
11560
|
/** does the item require a serial number when shipping? */
|
|
12059
11561
|
request_serial_number?: boolean;
|
|
12060
11562
|
/** is the item return price restricted? */
|
|
@@ -12090,21 +11592,12 @@ export interface PutApiV2ItemsIdRequest {
|
|
|
12090
11592
|
velocity?: number;
|
|
12091
11593
|
/** the item vendor */
|
|
12092
11594
|
vendor?: string;
|
|
12093
|
-
/**
|
|
12094
|
-
|
|
12095
|
-
|
|
12096
|
-
|
|
12097
|
-
|
|
12098
|
-
|
|
12099
|
-
* the wholesale cost of the item
|
|
12100
|
-
* @format float
|
|
12101
|
-
*/
|
|
12102
|
-
wholesale_cost?: number;
|
|
12103
|
-
/**
|
|
12104
|
-
* the item width (in inches)
|
|
12105
|
-
* @format float
|
|
12106
|
-
*/
|
|
12107
|
-
width?: number;
|
|
11595
|
+
/** the weight of the item (in pounds) */
|
|
11596
|
+
weight?: string;
|
|
11597
|
+
/** the wholesale cost of the item */
|
|
11598
|
+
wholesale_cost?: string;
|
|
11599
|
+
/** the item width (in inches) */
|
|
11600
|
+
width?: string;
|
|
12108
11601
|
}
|
|
12109
11602
|
|
|
12110
11603
|
export interface PutApiV2NotificationSubscriptionsIdRequest {
|
|
@@ -12201,11 +11694,8 @@ export interface PutApiV2OrderItemsIdRequest {
|
|
|
12201
11694
|
* @format int32
|
|
12202
11695
|
*/
|
|
12203
11696
|
packed?: number;
|
|
12204
|
-
/**
|
|
12205
|
-
|
|
12206
|
-
* @format float
|
|
12207
|
-
*/
|
|
12208
|
-
price?: number;
|
|
11697
|
+
/** price of this item */
|
|
11698
|
+
price?: string;
|
|
12209
11699
|
/** is this item a promo? */
|
|
12210
11700
|
promo?: boolean;
|
|
12211
11701
|
/**
|
|
@@ -12220,27 +11710,18 @@ export interface PutApiV2OrderItemsIdRequest {
|
|
|
12220
11710
|
quote_item_id?: number;
|
|
12221
11711
|
/** does the item require a serial number when shipping? */
|
|
12222
11712
|
request_serial_number?: boolean;
|
|
12223
|
-
/**
|
|
12224
|
-
|
|
12225
|
-
* @format float
|
|
12226
|
-
*/
|
|
12227
|
-
retail_fee?: number;
|
|
11713
|
+
/** retail fee of this item */
|
|
11714
|
+
retail_fee?: string;
|
|
12228
11715
|
/** is this item returnable? */
|
|
12229
11716
|
returnable?: boolean;
|
|
12230
11717
|
/** the SKU of this item */
|
|
12231
11718
|
sku?: string;
|
|
12232
11719
|
/** is this item unshippable? */
|
|
12233
11720
|
unshippable?: boolean;
|
|
12234
|
-
/**
|
|
12235
|
-
|
|
12236
|
-
|
|
12237
|
-
|
|
12238
|
-
wholesale_cost?: number;
|
|
12239
|
-
/**
|
|
12240
|
-
* wholesale fee of this item
|
|
12241
|
-
* @format float
|
|
12242
|
-
*/
|
|
12243
|
-
wholesale_fee?: number;
|
|
11721
|
+
/** wholesale cost of the item */
|
|
11722
|
+
wholesale_cost?: string;
|
|
11723
|
+
/** wholesale fee of this item */
|
|
11724
|
+
wholesale_fee?: string;
|
|
12244
11725
|
wholesale_item_attributes?: {
|
|
12245
11726
|
/**
|
|
12246
11727
|
* the associated order item id
|
|
@@ -12368,11 +11849,8 @@ export interface PutApiV2OrdersIdRequest {
|
|
|
12368
11849
|
return_address_2?: string;
|
|
12369
11850
|
/** the order third party shipping account */
|
|
12370
11851
|
ship_3rdparty_account?: string;
|
|
12371
|
-
/**
|
|
12372
|
-
|
|
12373
|
-
* @format float
|
|
12374
|
-
*/
|
|
12375
|
-
ship_3rdparty_cost?: number;
|
|
11852
|
+
/** the order third party shipping cost */
|
|
11853
|
+
ship_3rdparty_cost?: string;
|
|
12376
11854
|
/** the order third party shipping country */
|
|
12377
11855
|
ship_3rdparty_country?: string;
|
|
12378
11856
|
/** the order third party shipping zip */
|
|
@@ -12487,11 +11965,8 @@ export interface PutApiV2OrdersIdRequest {
|
|
|
12487
11965
|
public_note?: string;
|
|
12488
11966
|
/** the purchase order this order */
|
|
12489
11967
|
purchase_order?: string;
|
|
12490
|
-
/**
|
|
12491
|
-
|
|
12492
|
-
* @format float
|
|
12493
|
-
*/
|
|
12494
|
-
req_insurance_value?: number;
|
|
11968
|
+
/** the order requested insurance value */
|
|
11969
|
+
req_insurance_value?: string;
|
|
12495
11970
|
/** the order requested address */
|
|
12496
11971
|
requested_address?: string;
|
|
12497
11972
|
/** does the order require an adult signature upon delivery? */
|
|
@@ -12557,11 +12032,8 @@ export interface PutApiV2OrdersIdRequest {
|
|
|
12557
12032
|
shop_created_at?: string;
|
|
12558
12033
|
/** the order shop shipping method currency */
|
|
12559
12034
|
shop_shipping_method_currency?: string;
|
|
12560
|
-
/**
|
|
12561
|
-
|
|
12562
|
-
* @format float
|
|
12563
|
-
*/
|
|
12564
|
-
shop_shipping_method_price?: number;
|
|
12035
|
+
/** the order shop shipping method price */
|
|
12036
|
+
shop_shipping_method_price?: string;
|
|
12565
12037
|
/**
|
|
12566
12038
|
* the order shop shipping method text
|
|
12567
12039
|
* ge_standard = order uses global-e standard shipping method
|
|
@@ -12713,11 +12185,8 @@ export interface PutApiV2ShipnoticesIdMetaFieldsRequest {
|
|
|
12713
12185
|
}
|
|
12714
12186
|
|
|
12715
12187
|
export interface PutApiV2ShipnoticesIdRequest {
|
|
12716
|
-
/**
|
|
12717
|
-
|
|
12718
|
-
* @format float
|
|
12719
|
-
*/
|
|
12720
|
-
ship_3rdparty_cost?: number;
|
|
12188
|
+
/** 3rd party cost for the shipnotice */
|
|
12189
|
+
ship_3rdparty_cost?: string;
|
|
12721
12190
|
/**
|
|
12722
12191
|
* the shipnotice arrival date and time
|
|
12723
12192
|
* @format date-time
|
|
@@ -12777,11 +12246,8 @@ export interface PutApiV2ShipnoticesIdRequest {
|
|
|
12777
12246
|
requires_label?: boolean;
|
|
12778
12247
|
/** the shipnotice sender */
|
|
12779
12248
|
sender?: string;
|
|
12780
|
-
/**
|
|
12781
|
-
|
|
12782
|
-
* @format float
|
|
12783
|
-
*/
|
|
12784
|
-
ship_actual_cost?: number;
|
|
12249
|
+
/** the shipnotice actual cost of shipping */
|
|
12250
|
+
ship_actual_cost?: string;
|
|
12785
12251
|
/** currency used for this shipnotice */
|
|
12786
12252
|
ship_actual_currency?: string;
|
|
12787
12253
|
shipnotice_items?: string;
|