@whiplashmerch/whiplash-api-client 0.4.6 → 0.4.8

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.
@@ -739,7 +739,10 @@ export interface APIV21EntitiesOrder {
739
739
  * @format int32
740
740
  */
741
741
  order_item_quantity?: number;
742
- /** the order original id (from the shop that sent whiplash the order) */
742
+ /**
743
+ * the order original id (from the shop that sent whiplash the order)
744
+ * Note: contains the global-e order id for any global-e order.
745
+ */
743
746
  order_orig?: string;
744
747
  /** the order type */
745
748
  order_type?: string;
@@ -859,7 +862,12 @@ export interface APIV21EntitiesOrder {
859
862
  * @format float
860
863
  */
861
864
  shop_shipping_method_price?: number;
862
- /** the order shop shipping method text */
865
+ /**
866
+ * the order shop shipping method text
867
+ * ge_standard = order uses global-e standard shipping method
868
+ * ge_express = order uses global-e express shipping method
869
+ * Note: the global-e values will not match the global-e official shipping method mappings set up in the UI
870
+ */
863
871
  shop_shipping_method_text?: string;
864
872
  /**
865
873
  * the order shop last update date and time
@@ -2484,7 +2492,10 @@ export interface APIV2EntitiesOrder {
2484
2492
  order_batch_id?: number;
2485
2493
  /** Perform an action on an order_item */
2486
2494
  order_items?: APIV2EntitiesOrderItem;
2487
- /** the order original id (from the shop that sent whiplash the order) */
2495
+ /**
2496
+ * the order original id (from the shop that sent whiplash the order)
2497
+ * Note: contains the global-e order id for any global-e order.
2498
+ */
2488
2499
  order_orig?: string;
2489
2500
  /** the order type */
2490
2501
  order_type?: string;
@@ -2604,7 +2615,12 @@ export interface APIV2EntitiesOrder {
2604
2615
  * @format float
2605
2616
  */
2606
2617
  shop_shipping_method_price?: number;
2607
- /** the order shop shipping method text */
2618
+ /**
2619
+ * the order shop shipping method text
2620
+ * ge_standard = order uses global-e standard shipping method
2621
+ * ge_express = order uses global-e express shipping method
2622
+ * Note: the global-e values will not match the global-e official shipping method mappings set up in the UI
2623
+ */
2608
2624
  shop_shipping_method_text?: string;
2609
2625
  /**
2610
2626
  * the order shop last update date and time
@@ -6305,7 +6321,10 @@ export interface PostApiV21Orders {
6305
6321
  misc?: string;
6306
6322
  };
6307
6323
  }[];
6308
- /** the order original id (from the shop that sent whiplash the order) */
6324
+ /**
6325
+ * the order original id (from the shop that sent whiplash the order)
6326
+ * Note: contains the global-e order id for any global-e order.
6327
+ */
6309
6328
  order_orig?: string;
6310
6329
  /** the order type */
6311
6330
  order_type?: PostApiV21OrdersOrderType;
@@ -6402,7 +6421,12 @@ export interface PostApiV21Orders {
6402
6421
  * @format float
6403
6422
  */
6404
6423
  shop_shipping_method_price?: number;
6405
- /** the order shop shipping method text */
6424
+ /**
6425
+ * the order shop shipping method text
6426
+ * ge_standard = order uses global-e standard shipping method
6427
+ * ge_express = order uses global-e express shipping method
6428
+ * Note: the global-e values will not match the global-e official shipping method mappings set up in the UI
6429
+ */
6406
6430
  shop_shipping_method_text?: string;
6407
6431
  /**
6408
6432
  * the order shop last update date and time
@@ -7785,7 +7809,10 @@ export interface PostApiV2Orders {
7785
7809
  misc?: string;
7786
7810
  };
7787
7811
  }[];
7788
- /** the order original id (from the shop that sent whiplash the order) */
7812
+ /**
7813
+ * the order original id (from the shop that sent whiplash the order)
7814
+ * Note: contains the global-e order id for any global-e order.
7815
+ */
7789
7816
  order_orig?: string;
7790
7817
  /** the order type */
7791
7818
  order_type?: PostApiV2OrdersOrderType;
@@ -7876,7 +7903,12 @@ export interface PostApiV2Orders {
7876
7903
  * @format float
7877
7904
  */
7878
7905
  shop_shipping_method_price?: number;
7879
- /** the order shop shipping method text */
7906
+ /**
7907
+ * the order shop shipping method text
7908
+ * ge_standard = order uses global-e standard shipping method
7909
+ * ge_express = order uses global-e express shipping method
7910
+ * Note: the global-e values will not match the global-e official shipping method mappings set up in the UI
7911
+ */
7880
7912
  shop_shipping_method_text?: string;
7881
7913
  /**
7882
7914
  * the order shop last update date and time
@@ -9788,7 +9820,10 @@ export interface PutApiV21Orders {
9788
9820
  last_name?: string;
9789
9821
  /** meta data for this order as stringified JSON */
9790
9822
  meta_data?: string;
9791
- /** the order original id (from the shop that sent whiplash the order) */
9823
+ /**
9824
+ * the order original id (from the shop that sent whiplash the order)
9825
+ * Note: contains the global-e order id for any global-e order.
9826
+ */
9792
9827
  order_orig?: string;
9793
9828
  /** the order type */
9794
9829
  order_type?: string;
@@ -9873,7 +9908,12 @@ export interface PutApiV21Orders {
9873
9908
  * @format float
9874
9909
  */
9875
9910
  shop_shipping_method_price?: number;
9876
- /** the order shop shipping method text */
9911
+ /**
9912
+ * the order shop shipping method text
9913
+ * ge_standard = order uses global-e standard shipping method
9914
+ * ge_express = order uses global-e express shipping method
9915
+ * Note: the global-e values will not match the global-e official shipping method mappings set up in the UI
9916
+ */
9877
9917
  shop_shipping_method_text?: string;
9878
9918
  /**
9879
9919
  * the order shop last update date and time
@@ -10042,7 +10082,10 @@ export interface PutApiV21OrdersOriginator {
10042
10082
  last_name?: string;
10043
10083
  /** meta data for this order as stringified JSON */
10044
10084
  meta_data?: string;
10045
- /** the order original id (from the shop that sent whiplash the order) */
10085
+ /**
10086
+ * the order original id (from the shop that sent whiplash the order)
10087
+ * Note: contains the global-e order id for any global-e order.
10088
+ */
10046
10089
  order_orig?: string;
10047
10090
  /** the order type */
10048
10091
  order_type?: string;
@@ -10127,7 +10170,12 @@ export interface PutApiV21OrdersOriginator {
10127
10170
  * @format float
10128
10171
  */
10129
10172
  shop_shipping_method_price?: number;
10130
- /** the order shop shipping method text */
10173
+ /**
10174
+ * the order shop shipping method text
10175
+ * ge_standard = order uses global-e standard shipping method
10176
+ * ge_express = order uses global-e express shipping method
10177
+ * Note: the global-e values will not match the global-e official shipping method mappings set up in the UI
10178
+ */
10131
10179
  shop_shipping_method_text?: string;
10132
10180
  /**
10133
10181
  * the order shop last update date and time
@@ -11965,7 +12013,10 @@ export interface PutApiV2Orders {
11965
12013
  last_name?: string;
11966
12014
  /** meta data for this order as stringified JSON */
11967
12015
  meta_data?: string;
11968
- /** the order original id (from the shop that sent whiplash the order) */
12016
+ /**
12017
+ * the order original id (from the shop that sent whiplash the order)
12018
+ * Note: contains the global-e order id for any global-e order.
12019
+ */
11969
12020
  order_orig?: string;
11970
12021
  /** the order type */
11971
12022
  order_type?: string;
@@ -12050,7 +12101,12 @@ export interface PutApiV2Orders {
12050
12101
  * @format float
12051
12102
  */
12052
12103
  shop_shipping_method_price?: number;
12053
- /** the order shop shipping method text */
12104
+ /**
12105
+ * the order shop shipping method text
12106
+ * ge_standard = order uses global-e standard shipping method
12107
+ * ge_express = order uses global-e express shipping method
12108
+ * Note: the global-e values will not match the global-e official shipping method mappings set up in the UI
12109
+ */
12054
12110
  shop_shipping_method_text?: string;
12055
12111
  /**
12056
12112
  * the order shop last update date and time
@@ -12217,7 +12273,10 @@ export interface PutApiV2OrdersOriginator {
12217
12273
  last_name?: string;
12218
12274
  /** meta data for this order as stringified JSON */
12219
12275
  meta_data?: string;
12220
- /** the order original id (from the shop that sent whiplash the order) */
12276
+ /**
12277
+ * the order original id (from the shop that sent whiplash the order)
12278
+ * Note: contains the global-e order id for any global-e order.
12279
+ */
12221
12280
  order_orig?: string;
12222
12281
  /** the order type */
12223
12282
  order_type?: string;
@@ -12302,7 +12361,12 @@ export interface PutApiV2OrdersOriginator {
12302
12361
  * @format float
12303
12362
  */
12304
12363
  shop_shipping_method_price?: number;
12305
- /** the order shop shipping method text */
12364
+ /**
12365
+ * the order shop shipping method text
12366
+ * ge_standard = order uses global-e standard shipping method
12367
+ * ge_express = order uses global-e express shipping method
12368
+ * Note: the global-e values will not match the global-e official shipping method mappings set up in the UI
12369
+ */
12306
12370
  shop_shipping_method_text?: string;
12307
12371
  /**
12308
12372
  * the order shop last update date and time
@@ -755,7 +755,10 @@ export interface APIV21EntitiesOrder {
755
755
  * @format int32
756
756
  */
757
757
  order_item_quantity?: number;
758
- /** the order original id (from the shop that sent whiplash the order) */
758
+ /**
759
+ * the order original id (from the shop that sent whiplash the order)
760
+ * Note: contains the global-e order id for any global-e order.
761
+ */
759
762
  order_orig?: string;
760
763
  /** the order type */
761
764
  order_type?: string;
@@ -875,7 +878,12 @@ export interface APIV21EntitiesOrder {
875
878
  * @format float
876
879
  */
877
880
  shop_shipping_method_price?: number;
878
- /** the order shop shipping method text */
881
+ /**
882
+ * the order shop shipping method text
883
+ * ge_standard = order uses global-e standard shipping method
884
+ * ge_express = order uses global-e express shipping method
885
+ * Note: the global-e values will not match the global-e official shipping method mappings set up in the UI
886
+ */
879
887
  shop_shipping_method_text?: string;
880
888
  /**
881
889
  * the order shop last update date and time
@@ -2520,7 +2528,10 @@ export interface APIV2EntitiesOrder {
2520
2528
  order_batch_id?: number;
2521
2529
  /** Perform an action on an order_item */
2522
2530
  order_items?: APIV2EntitiesOrderItem;
2523
- /** the order original id (from the shop that sent whiplash the order) */
2531
+ /**
2532
+ * the order original id (from the shop that sent whiplash the order)
2533
+ * Note: contains the global-e order id for any global-e order.
2534
+ */
2524
2535
  order_orig?: string;
2525
2536
  /** the order type */
2526
2537
  order_type?: string;
@@ -2640,7 +2651,12 @@ export interface APIV2EntitiesOrder {
2640
2651
  * @format float
2641
2652
  */
2642
2653
  shop_shipping_method_price?: number;
2643
- /** the order shop shipping method text */
2654
+ /**
2655
+ * the order shop shipping method text
2656
+ * ge_standard = order uses global-e standard shipping method
2657
+ * ge_express = order uses global-e express shipping method
2658
+ * Note: the global-e values will not match the global-e official shipping method mappings set up in the UI
2659
+ */
2644
2660
  shop_shipping_method_text?: string;
2645
2661
  /**
2646
2662
  * the order shop last update date and time
@@ -6455,7 +6471,10 @@ export interface PostApiV21Orders {
6455
6471
  misc?: string;
6456
6472
  };
6457
6473
  }[];
6458
- /** the order original id (from the shop that sent whiplash the order) */
6474
+ /**
6475
+ * the order original id (from the shop that sent whiplash the order)
6476
+ * Note: contains the global-e order id for any global-e order.
6477
+ */
6459
6478
  order_orig?: string;
6460
6479
  /** the order type */
6461
6480
  order_type?: PostApiV21OrdersOrderType;
@@ -6552,7 +6571,12 @@ export interface PostApiV21Orders {
6552
6571
  * @format float
6553
6572
  */
6554
6573
  shop_shipping_method_price?: number;
6555
- /** the order shop shipping method text */
6574
+ /**
6575
+ * the order shop shipping method text
6576
+ * ge_standard = order uses global-e standard shipping method
6577
+ * ge_express = order uses global-e express shipping method
6578
+ * Note: the global-e values will not match the global-e official shipping method mappings set up in the UI
6579
+ */
6556
6580
  shop_shipping_method_text?: string;
6557
6581
  /**
6558
6582
  * the order shop last update date and time
@@ -7955,7 +7979,10 @@ export interface PostApiV2Orders {
7955
7979
  misc?: string;
7956
7980
  };
7957
7981
  }[];
7958
- /** the order original id (from the shop that sent whiplash the order) */
7982
+ /**
7983
+ * the order original id (from the shop that sent whiplash the order)
7984
+ * Note: contains the global-e order id for any global-e order.
7985
+ */
7959
7986
  order_orig?: string;
7960
7987
  /** the order type */
7961
7988
  order_type?: PostApiV2OrdersOrderType;
@@ -8046,7 +8073,12 @@ export interface PostApiV2Orders {
8046
8073
  * @format float
8047
8074
  */
8048
8075
  shop_shipping_method_price?: number;
8049
- /** the order shop shipping method text */
8076
+ /**
8077
+ * the order shop shipping method text
8078
+ * ge_standard = order uses global-e standard shipping method
8079
+ * ge_express = order uses global-e express shipping method
8080
+ * Note: the global-e values will not match the global-e official shipping method mappings set up in the UI
8081
+ */
8050
8082
  shop_shipping_method_text?: string;
8051
8083
  /**
8052
8084
  * the order shop last update date and time
@@ -9989,7 +10021,10 @@ export interface PutApiV21Orders {
9989
10021
  last_name?: string;
9990
10022
  /** meta data for this order as stringified JSON */
9991
10023
  meta_data?: string;
9992
- /** the order original id (from the shop that sent whiplash the order) */
10024
+ /**
10025
+ * the order original id (from the shop that sent whiplash the order)
10026
+ * Note: contains the global-e order id for any global-e order.
10027
+ */
9993
10028
  order_orig?: string;
9994
10029
  /** the order type */
9995
10030
  order_type?: string;
@@ -10074,7 +10109,12 @@ export interface PutApiV21Orders {
10074
10109
  * @format float
10075
10110
  */
10076
10111
  shop_shipping_method_price?: number;
10077
- /** the order shop shipping method text */
10112
+ /**
10113
+ * the order shop shipping method text
10114
+ * ge_standard = order uses global-e standard shipping method
10115
+ * ge_express = order uses global-e express shipping method
10116
+ * Note: the global-e values will not match the global-e official shipping method mappings set up in the UI
10117
+ */
10078
10118
  shop_shipping_method_text?: string;
10079
10119
  /**
10080
10120
  * the order shop last update date and time
@@ -10247,7 +10287,10 @@ export interface PutApiV21OrdersOriginator {
10247
10287
  last_name?: string;
10248
10288
  /** meta data for this order as stringified JSON */
10249
10289
  meta_data?: string;
10250
- /** the order original id (from the shop that sent whiplash the order) */
10290
+ /**
10291
+ * the order original id (from the shop that sent whiplash the order)
10292
+ * Note: contains the global-e order id for any global-e order.
10293
+ */
10251
10294
  order_orig?: string;
10252
10295
  /** the order type */
10253
10296
  order_type?: string;
@@ -10332,7 +10375,12 @@ export interface PutApiV21OrdersOriginator {
10332
10375
  * @format float
10333
10376
  */
10334
10377
  shop_shipping_method_price?: number;
10335
- /** the order shop shipping method text */
10378
+ /**
10379
+ * the order shop shipping method text
10380
+ * ge_standard = order uses global-e standard shipping method
10381
+ * ge_express = order uses global-e express shipping method
10382
+ * Note: the global-e values will not match the global-e official shipping method mappings set up in the UI
10383
+ */
10336
10384
  shop_shipping_method_text?: string;
10337
10385
  /**
10338
10386
  * the order shop last update date and time
@@ -12201,7 +12249,10 @@ export interface PutApiV2Orders {
12201
12249
  last_name?: string;
12202
12250
  /** meta data for this order as stringified JSON */
12203
12251
  meta_data?: string;
12204
- /** the order original id (from the shop that sent whiplash the order) */
12252
+ /**
12253
+ * the order original id (from the shop that sent whiplash the order)
12254
+ * Note: contains the global-e order id for any global-e order.
12255
+ */
12205
12256
  order_orig?: string;
12206
12257
  /** the order type */
12207
12258
  order_type?: string;
@@ -12286,7 +12337,12 @@ export interface PutApiV2Orders {
12286
12337
  * @format float
12287
12338
  */
12288
12339
  shop_shipping_method_price?: number;
12289
- /** the order shop shipping method text */
12340
+ /**
12341
+ * the order shop shipping method text
12342
+ * ge_standard = order uses global-e standard shipping method
12343
+ * ge_express = order uses global-e express shipping method
12344
+ * Note: the global-e values will not match the global-e official shipping method mappings set up in the UI
12345
+ */
12290
12346
  shop_shipping_method_text?: string;
12291
12347
  /**
12292
12348
  * the order shop last update date and time
@@ -12457,7 +12513,10 @@ export interface PutApiV2OrdersOriginator {
12457
12513
  last_name?: string;
12458
12514
  /** meta data for this order as stringified JSON */
12459
12515
  meta_data?: string;
12460
- /** the order original id (from the shop that sent whiplash the order) */
12516
+ /**
12517
+ * the order original id (from the shop that sent whiplash the order)
12518
+ * Note: contains the global-e order id for any global-e order.
12519
+ */
12461
12520
  order_orig?: string;
12462
12521
  /** the order type */
12463
12522
  order_type?: string;
@@ -12542,7 +12601,12 @@ export interface PutApiV2OrdersOriginator {
12542
12601
  * @format float
12543
12602
  */
12544
12603
  shop_shipping_method_price?: number;
12545
- /** the order shop shipping method text */
12604
+ /**
12605
+ * the order shop shipping method text
12606
+ * ge_standard = order uses global-e standard shipping method
12607
+ * ge_express = order uses global-e express shipping method
12608
+ * Note: the global-e values will not match the global-e official shipping method mappings set up in the UI
12609
+ */
12546
12610
  shop_shipping_method_text?: string;
12547
12611
  /**
12548
12612
  * the order shop last update date and time
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@whiplashmerch/whiplash-api-client",
3
- "version": "0.4.6",
3
+ "version": "0.4.8",
4
4
  "description": "",
5
5
  "devDependencies": {},
6
6
  "scripts": {