@whiplashmerch/whiplash-api-client 2.0.12 → 2.0.14
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 +280 -1
- package/dist/client.esm.js.map +1 -1
- package/dist/generated/Pallets.d.ts +146 -0
- package/dist/generated/data-contracts.d.ts +233 -100
- package/dist/generated/index.d.ts +1 -0
- package/dist/mock-data/index.d.ts +1 -0
- package/generated/data-contracts.ts +58 -100
- package/package.json +1 -1
|
@@ -49,6 +49,7 @@ export * from './v2_1/order/processing';
|
|
|
49
49
|
export * from './v2_1/shipnotice/processing';
|
|
50
50
|
export * from './v2_1/originator/created';
|
|
51
51
|
export * from './v2_1/package/created';
|
|
52
|
+
export * from './v2_1/pallet/created';
|
|
52
53
|
export * from './v2_1/partner/created';
|
|
53
54
|
export * from './v2_1/prepack/created';
|
|
54
55
|
export * from './v2_1/project-task/created';
|
|
@@ -1901,8 +1901,18 @@ export interface ApiV2EntitiesPackage {
|
|
|
1901
1901
|
*/
|
|
1902
1902
|
order_id?: number | null;
|
|
1903
1903
|
order_item_ids?: number[];
|
|
1904
|
+
/**
|
|
1905
|
+
* the pallet id this package is on (staff only)
|
|
1906
|
+
* @format int32
|
|
1907
|
+
*/
|
|
1908
|
+
pallet_id?: number | null;
|
|
1904
1909
|
/** the package scan form url (staff only) */
|
|
1905
1910
|
scan_form_url?: string | null;
|
|
1911
|
+
/**
|
|
1912
|
+
* when the package was scanned to a pallet (staff only)
|
|
1913
|
+
* @format date-time
|
|
1914
|
+
*/
|
|
1915
|
+
scanned_to_pallet_at?: string | null;
|
|
1906
1916
|
/**
|
|
1907
1917
|
* the package shipping cost
|
|
1908
1918
|
* @format float
|
|
@@ -2131,10 +2141,7 @@ export interface ApiV2EntitiesShipnotice {
|
|
|
2131
2141
|
* @format date-time
|
|
2132
2142
|
*/
|
|
2133
2143
|
arrived_at?: string;
|
|
2134
|
-
/**
|
|
2135
|
-
* BOL proxy for this shipnotice.
|
|
2136
|
-
* Note: this field has a limit of 30 chars.
|
|
2137
|
-
*/
|
|
2144
|
+
/** BOL proxy for this shipnotice. */
|
|
2138
2145
|
bol_proxy?: string | null;
|
|
2139
2146
|
/** shipping carrier */
|
|
2140
2147
|
carrier?: string;
|
|
@@ -2189,10 +2196,7 @@ export interface ApiV2EntitiesShipnotice {
|
|
|
2189
2196
|
inspection_required?: boolean;
|
|
2190
2197
|
/** meta data for this shipnotice as stringified JSON */
|
|
2191
2198
|
meta_data?: string | null;
|
|
2192
|
-
/**
|
|
2193
|
-
* MID code for this shipnotice.
|
|
2194
|
-
* Note: this field has a limit of 15 chars.
|
|
2195
|
-
*/
|
|
2199
|
+
/** MID code for this shipnotice. */
|
|
2196
2200
|
mid_code?: string | null;
|
|
2197
2201
|
/** notes by customer */
|
|
2198
2202
|
notes_by_customer?: string | null;
|
|
@@ -2284,10 +2288,7 @@ export interface ApiV2EntitiesShipnotice {
|
|
|
2284
2288
|
* @format int32
|
|
2285
2289
|
*/
|
|
2286
2290
|
warehouse_id?: number;
|
|
2287
|
-
/**
|
|
2288
|
-
* zone status of this shipnotice.
|
|
2289
|
-
* Note: this field has a limit of 3 chars.
|
|
2290
|
-
*/
|
|
2291
|
+
/** zone status of this shipnotice. */
|
|
2291
2292
|
zone_status?: string | null;
|
|
2292
2293
|
}
|
|
2293
2294
|
|
|
@@ -2372,10 +2373,10 @@ export interface ApiV2EntitiesShipnoticeItem {
|
|
|
2372
2373
|
*/
|
|
2373
2374
|
unallocated?: number;
|
|
2374
2375
|
/**
|
|
2375
|
-
* unit
|
|
2376
|
+
* unit cost for this shipnotice item
|
|
2376
2377
|
* @format float
|
|
2377
2378
|
*/
|
|
2378
|
-
|
|
2379
|
+
unit_cost?: number | null;
|
|
2379
2380
|
/**
|
|
2380
2381
|
* the shipnotice item last update date and time
|
|
2381
2382
|
* @format date-time
|
|
@@ -4168,10 +4169,7 @@ export interface ApiV21EntitiesShipnotice {
|
|
|
4168
4169
|
* @format date-time
|
|
4169
4170
|
*/
|
|
4170
4171
|
arrived_at?: string;
|
|
4171
|
-
/**
|
|
4172
|
-
* BOL proxy for this shipnotice.
|
|
4173
|
-
* Note: this field has a limit of 30 chars.
|
|
4174
|
-
*/
|
|
4172
|
+
/** BOL proxy for this shipnotice. */
|
|
4175
4173
|
bol_proxy?: string | null;
|
|
4176
4174
|
/**
|
|
4177
4175
|
* the shipnotice must be completed by date and time
|
|
@@ -4225,10 +4223,7 @@ export interface ApiV21EntitiesShipnotice {
|
|
|
4225
4223
|
inspection_required?: boolean;
|
|
4226
4224
|
/** meta data for this shipnotice as stringified JSON */
|
|
4227
4225
|
meta_data?: string | null;
|
|
4228
|
-
/**
|
|
4229
|
-
* MID code for this shipnotice.
|
|
4230
|
-
* Note: this field has a limit of 15 chars.
|
|
4231
|
-
*/
|
|
4226
|
+
/** MID code for this shipnotice. */
|
|
4232
4227
|
mid_code?: string | null;
|
|
4233
4228
|
/** notes by customer */
|
|
4234
4229
|
notes_by_customer?: string | null;
|
|
@@ -4318,10 +4313,7 @@ export interface ApiV21EntitiesShipnotice {
|
|
|
4318
4313
|
warehouse_id?: number;
|
|
4319
4314
|
/** The name of the associated warehouse */
|
|
4320
4315
|
warehouse_name?: string;
|
|
4321
|
-
/**
|
|
4322
|
-
* zone status of this shipnotice.
|
|
4323
|
-
* Note: this field has a limit of 3 chars.
|
|
4324
|
-
*/
|
|
4316
|
+
/** zone status of this shipnotice. */
|
|
4325
4317
|
zone_status?: string | null;
|
|
4326
4318
|
}
|
|
4327
4319
|
|
|
@@ -4389,10 +4381,10 @@ export interface ApiV21EntitiesShipnoticeItem {
|
|
|
4389
4381
|
*/
|
|
4390
4382
|
shipnotice_id?: number | null;
|
|
4391
4383
|
/**
|
|
4392
|
-
* unit
|
|
4384
|
+
* unit cost for this shipnotice item
|
|
4393
4385
|
* @format float
|
|
4394
4386
|
*/
|
|
4395
|
-
|
|
4387
|
+
unit_cost?: number | null;
|
|
4396
4388
|
/**
|
|
4397
4389
|
* the shipnotice item last update date and time
|
|
4398
4390
|
* @format date-time
|
|
@@ -7443,20 +7435,11 @@ export interface PostApiV21ShipnoticesBulkRequest {
|
|
|
7443
7435
|
reference?: string;
|
|
7444
7436
|
/** JSON object of required and optional receiving quantities verified by staff */
|
|
7445
7437
|
quantities_verified?: object;
|
|
7446
|
-
/**
|
|
7447
|
-
* BOL proxy for this shipnotice.
|
|
7448
|
-
* Note: this field has a limit of 30 chars.
|
|
7449
|
-
*/
|
|
7438
|
+
/** BOL proxy for this shipnotice. */
|
|
7450
7439
|
bol_proxy?: string;
|
|
7451
|
-
/**
|
|
7452
|
-
* MID code for this shipnotice.
|
|
7453
|
-
* Note: this field has a limit of 15 chars.
|
|
7454
|
-
*/
|
|
7440
|
+
/** MID code for this shipnotice. */
|
|
7455
7441
|
mid_code?: string;
|
|
7456
|
-
/**
|
|
7457
|
-
* zone status of this shipnotice.
|
|
7458
|
-
* Note: this field has a limit of 3 chars.
|
|
7459
|
-
*/
|
|
7442
|
+
/** zone status of this shipnotice. */
|
|
7460
7443
|
zone_status?: string;
|
|
7461
7444
|
/** is inspection required? (default: false) */
|
|
7462
7445
|
inspection_required?: boolean;
|
|
@@ -7562,6 +7545,11 @@ export interface PostApiV21ShipnoticesIdShipnoticeItemsRequest {
|
|
|
7562
7545
|
quantity?: number;
|
|
7563
7546
|
/** action to perform on item return */
|
|
7564
7547
|
return_action?: string;
|
|
7548
|
+
/**
|
|
7549
|
+
* Unit cost per item
|
|
7550
|
+
* @format float
|
|
7551
|
+
*/
|
|
7552
|
+
unit_cost?: number;
|
|
7565
7553
|
}
|
|
7566
7554
|
|
|
7567
7555
|
export interface PostApiV21ShipnoticesRequest {
|
|
@@ -7575,10 +7563,7 @@ export interface PostApiV21ShipnoticesRequest {
|
|
|
7575
7563
|
* @format date-time
|
|
7576
7564
|
*/
|
|
7577
7565
|
arrived_at?: string;
|
|
7578
|
-
/**
|
|
7579
|
-
* BOL proxy for this shipnotice.
|
|
7580
|
-
* Note: this field has a limit of 30 chars.
|
|
7581
|
-
*/
|
|
7566
|
+
/** BOL proxy for this shipnotice. */
|
|
7582
7567
|
bol_proxy?: string;
|
|
7583
7568
|
carrier?: string;
|
|
7584
7569
|
/**
|
|
@@ -7618,10 +7603,7 @@ export interface PostApiV21ShipnoticesRequest {
|
|
|
7618
7603
|
/** Included meta fields for associations */
|
|
7619
7604
|
association_fields?: object;
|
|
7620
7605
|
};
|
|
7621
|
-
/**
|
|
7622
|
-
* MID code for this shipnotice.
|
|
7623
|
-
* Note: this field has a limit of 15 chars.
|
|
7624
|
-
*/
|
|
7606
|
+
/** MID code for this shipnotice. */
|
|
7625
7607
|
mid_code?: string;
|
|
7626
7608
|
/** notes by customer */
|
|
7627
7609
|
notes_by_customer?: string;
|
|
@@ -7727,10 +7709,7 @@ export interface PostApiV21ShipnoticesRequest {
|
|
|
7727
7709
|
* @format int32
|
|
7728
7710
|
*/
|
|
7729
7711
|
warehouse_id?: number;
|
|
7730
|
-
/**
|
|
7731
|
-
* zone status of this shipnotice.
|
|
7732
|
-
* Note: this field has a limit of 3 chars.
|
|
7733
|
-
*/
|
|
7712
|
+
/** zone status of this shipnotice. */
|
|
7734
7713
|
zone_status?: string;
|
|
7735
7714
|
}
|
|
7736
7715
|
|
|
@@ -9402,20 +9381,11 @@ export interface PostApiV2ShipnoticesBulkRequest {
|
|
|
9402
9381
|
reference?: string;
|
|
9403
9382
|
/** JSON object of required and optional receiving quantities verified by staff */
|
|
9404
9383
|
quantities_verified?: object;
|
|
9405
|
-
/**
|
|
9406
|
-
* BOL proxy for this shipnotice.
|
|
9407
|
-
* Note: this field has a limit of 30 chars.
|
|
9408
|
-
*/
|
|
9384
|
+
/** BOL proxy for this shipnotice. */
|
|
9409
9385
|
bol_proxy?: string;
|
|
9410
|
-
/**
|
|
9411
|
-
* MID code for this shipnotice.
|
|
9412
|
-
* Note: this field has a limit of 15 chars.
|
|
9413
|
-
*/
|
|
9386
|
+
/** MID code for this shipnotice. */
|
|
9414
9387
|
mid_code?: string;
|
|
9415
|
-
/**
|
|
9416
|
-
* zone status of this shipnotice.
|
|
9417
|
-
* Note: this field has a limit of 3 chars.
|
|
9418
|
-
*/
|
|
9388
|
+
/** zone status of this shipnotice. */
|
|
9419
9389
|
zone_status?: string;
|
|
9420
9390
|
/** is inspection required? (default: false) */
|
|
9421
9391
|
inspection_required?: boolean;
|
|
@@ -9521,6 +9491,11 @@ export interface PostApiV2ShipnoticesIdShipnoticeItemsRequest {
|
|
|
9521
9491
|
quantity?: number;
|
|
9522
9492
|
/** action to perform on item return */
|
|
9523
9493
|
return_action?: string;
|
|
9494
|
+
/**
|
|
9495
|
+
* Unit cost per item
|
|
9496
|
+
* @format float
|
|
9497
|
+
*/
|
|
9498
|
+
unit_cost?: number;
|
|
9524
9499
|
}
|
|
9525
9500
|
|
|
9526
9501
|
export interface PostApiV2ShipnoticesRequest {
|
|
@@ -9534,10 +9509,7 @@ export interface PostApiV2ShipnoticesRequest {
|
|
|
9534
9509
|
* @format date-time
|
|
9535
9510
|
*/
|
|
9536
9511
|
arrived_at?: string;
|
|
9537
|
-
/**
|
|
9538
|
-
* BOL proxy for this shipnotice.
|
|
9539
|
-
* Note: this field has a limit of 30 chars.
|
|
9540
|
-
*/
|
|
9512
|
+
/** BOL proxy for this shipnotice. */
|
|
9541
9513
|
bol_proxy?: string;
|
|
9542
9514
|
carrier?: string;
|
|
9543
9515
|
/**
|
|
@@ -9577,10 +9549,7 @@ export interface PostApiV2ShipnoticesRequest {
|
|
|
9577
9549
|
/** Included meta fields for associations */
|
|
9578
9550
|
association_fields?: object;
|
|
9579
9551
|
};
|
|
9580
|
-
/**
|
|
9581
|
-
* MID code for this shipnotice.
|
|
9582
|
-
* Note: this field has a limit of 15 chars.
|
|
9583
|
-
*/
|
|
9552
|
+
/** MID code for this shipnotice. */
|
|
9584
9553
|
mid_code?: string;
|
|
9585
9554
|
/** notes by customer */
|
|
9586
9555
|
notes_by_customer?: string;
|
|
@@ -9686,10 +9655,7 @@ export interface PostApiV2ShipnoticesRequest {
|
|
|
9686
9655
|
* @format int32
|
|
9687
9656
|
*/
|
|
9688
9657
|
warehouse_id?: number;
|
|
9689
|
-
/**
|
|
9690
|
-
* zone status of this shipnotice.
|
|
9691
|
-
* Note: this field has a limit of 3 chars.
|
|
9692
|
-
*/
|
|
9658
|
+
/** zone status of this shipnotice. */
|
|
9693
9659
|
zone_status?: string;
|
|
9694
9660
|
}
|
|
9695
9661
|
|
|
@@ -10771,6 +10737,11 @@ export interface PutApiV21ShipnoticeItemsIdRequest {
|
|
|
10771
10737
|
* @format int32
|
|
10772
10738
|
*/
|
|
10773
10739
|
quantity?: number;
|
|
10740
|
+
/**
|
|
10741
|
+
* Unit cost per item
|
|
10742
|
+
* @format float
|
|
10743
|
+
*/
|
|
10744
|
+
unit_cost?: number;
|
|
10774
10745
|
}
|
|
10775
10746
|
|
|
10776
10747
|
export interface PutApiV21ShipnoticesIdMetaFieldsRequest {
|
|
@@ -10791,10 +10762,7 @@ export interface PutApiV21ShipnoticesIdRequest {
|
|
|
10791
10762
|
* @format date-time
|
|
10792
10763
|
*/
|
|
10793
10764
|
arrived_at?: string;
|
|
10794
|
-
/**
|
|
10795
|
-
* BOL proxy for this shipnotice.
|
|
10796
|
-
* Note: this field has a limit of 30 chars.
|
|
10797
|
-
*/
|
|
10765
|
+
/** BOL proxy for this shipnotice. */
|
|
10798
10766
|
bol_proxy?: string;
|
|
10799
10767
|
carrier?: string;
|
|
10800
10768
|
/**
|
|
@@ -10825,10 +10793,7 @@ export interface PutApiV21ShipnoticesIdRequest {
|
|
|
10825
10793
|
handling_billed?: boolean;
|
|
10826
10794
|
/** meta data for this shipnotice as stringified JSON */
|
|
10827
10795
|
meta_data?: string;
|
|
10828
|
-
/**
|
|
10829
|
-
* MID code for this shipnotice.
|
|
10830
|
-
* Note: this field has a limit of 15 chars.
|
|
10831
|
-
*/
|
|
10796
|
+
/** MID code for this shipnotice. */
|
|
10832
10797
|
mid_code?: string;
|
|
10833
10798
|
/** notes by customer */
|
|
10834
10799
|
notes_by_customer?: string;
|
|
@@ -10884,10 +10849,7 @@ export interface PutApiV21ShipnoticesIdRequest {
|
|
|
10884
10849
|
tracking?: string;
|
|
10885
10850
|
/** shipnotice type (Shipnotice, ConsumerReturn) */
|
|
10886
10851
|
type?: string;
|
|
10887
|
-
/**
|
|
10888
|
-
* zone status of this shipnotice.
|
|
10889
|
-
* Note: this field has a limit of 3 chars.
|
|
10890
|
-
*/
|
|
10852
|
+
/** zone status of this shipnotice. */
|
|
10891
10853
|
zone_status?: string;
|
|
10892
10854
|
}
|
|
10893
10855
|
|
|
@@ -12003,6 +11965,11 @@ export interface PutApiV2ShipnoticeItemsIdRequest {
|
|
|
12003
11965
|
* @format int32
|
|
12004
11966
|
*/
|
|
12005
11967
|
quantity?: number;
|
|
11968
|
+
/**
|
|
11969
|
+
* Unit cost per item
|
|
11970
|
+
* @format float
|
|
11971
|
+
*/
|
|
11972
|
+
unit_cost?: number;
|
|
12006
11973
|
}
|
|
12007
11974
|
|
|
12008
11975
|
export interface PutApiV2ShipnoticesIdMetaFieldsRequest {
|
|
@@ -12023,10 +11990,7 @@ export interface PutApiV2ShipnoticesIdRequest {
|
|
|
12023
11990
|
* @format date-time
|
|
12024
11991
|
*/
|
|
12025
11992
|
arrived_at?: string;
|
|
12026
|
-
/**
|
|
12027
|
-
* BOL proxy for this shipnotice.
|
|
12028
|
-
* Note: this field has a limit of 30 chars.
|
|
12029
|
-
*/
|
|
11993
|
+
/** BOL proxy for this shipnotice. */
|
|
12030
11994
|
bol_proxy?: string;
|
|
12031
11995
|
carrier?: string;
|
|
12032
11996
|
/**
|
|
@@ -12057,10 +12021,7 @@ export interface PutApiV2ShipnoticesIdRequest {
|
|
|
12057
12021
|
handling_billed?: boolean;
|
|
12058
12022
|
/** meta data for this shipnotice as stringified JSON */
|
|
12059
12023
|
meta_data?: string;
|
|
12060
|
-
/**
|
|
12061
|
-
* MID code for this shipnotice.
|
|
12062
|
-
* Note: this field has a limit of 15 chars.
|
|
12063
|
-
*/
|
|
12024
|
+
/** MID code for this shipnotice. */
|
|
12064
12025
|
mid_code?: string;
|
|
12065
12026
|
/** notes by customer */
|
|
12066
12027
|
notes_by_customer?: string;
|
|
@@ -12116,10 +12077,7 @@ export interface PutApiV2ShipnoticesIdRequest {
|
|
|
12116
12077
|
tracking?: string;
|
|
12117
12078
|
/** shipnotice type (Shipnotice, ConsumerReturn) */
|
|
12118
12079
|
type?: string;
|
|
12119
|
-
/**
|
|
12120
|
-
* zone status of this shipnotice.
|
|
12121
|
-
* Note: this field has a limit of 3 chars.
|
|
12122
|
-
*/
|
|
12080
|
+
/** zone status of this shipnotice. */
|
|
12123
12081
|
zone_status?: string;
|
|
12124
12082
|
}
|
|
12125
12083
|
|