@whiplashmerch/whiplash-api-client 2.0.12 → 2.0.13
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 +185 -130
- package/dist/generated/index.d.ts +1 -0
- package/dist/mock-data/index.d.ts +1 -0
- package/generated/data-contracts.ts +10 -130
- package/package.json +1 -1
|
@@ -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,11 +2141,6 @@ 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
|
-
*/
|
|
2138
|
-
bol_proxy?: string | null;
|
|
2139
2144
|
/** shipping carrier */
|
|
2140
2145
|
carrier?: string;
|
|
2141
2146
|
/**
|
|
@@ -2189,11 +2194,6 @@ export interface ApiV2EntitiesShipnotice {
|
|
|
2189
2194
|
inspection_required?: boolean;
|
|
2190
2195
|
/** meta data for this shipnotice as stringified JSON */
|
|
2191
2196
|
meta_data?: string | null;
|
|
2192
|
-
/**
|
|
2193
|
-
* MID code for this shipnotice.
|
|
2194
|
-
* Note: this field has a limit of 15 chars.
|
|
2195
|
-
*/
|
|
2196
|
-
mid_code?: string | null;
|
|
2197
2197
|
/** notes by customer */
|
|
2198
2198
|
notes_by_customer?: string | null;
|
|
2199
2199
|
/** notes by whiplash */
|
|
@@ -2284,11 +2284,6 @@ export interface ApiV2EntitiesShipnotice {
|
|
|
2284
2284
|
* @format int32
|
|
2285
2285
|
*/
|
|
2286
2286
|
warehouse_id?: number;
|
|
2287
|
-
/**
|
|
2288
|
-
* zone status of this shipnotice.
|
|
2289
|
-
* Note: this field has a limit of 3 chars.
|
|
2290
|
-
*/
|
|
2291
|
-
zone_status?: string | null;
|
|
2292
2287
|
}
|
|
2293
2288
|
|
|
2294
2289
|
/** V2 */
|
|
@@ -2371,11 +2366,6 @@ export interface ApiV2EntitiesShipnoticeItem {
|
|
|
2371
2366
|
* @format int32
|
|
2372
2367
|
*/
|
|
2373
2368
|
unallocated?: number;
|
|
2374
|
-
/**
|
|
2375
|
-
* unit price for this shipnotice item
|
|
2376
|
-
* @format float
|
|
2377
|
-
*/
|
|
2378
|
-
unit_price?: number | null;
|
|
2379
2369
|
/**
|
|
2380
2370
|
* the shipnotice item last update date and time
|
|
2381
2371
|
* @format date-time
|
|
@@ -4168,11 +4158,6 @@ export interface ApiV21EntitiesShipnotice {
|
|
|
4168
4158
|
* @format date-time
|
|
4169
4159
|
*/
|
|
4170
4160
|
arrived_at?: string;
|
|
4171
|
-
/**
|
|
4172
|
-
* BOL proxy for this shipnotice.
|
|
4173
|
-
* Note: this field has a limit of 30 chars.
|
|
4174
|
-
*/
|
|
4175
|
-
bol_proxy?: string | null;
|
|
4176
4161
|
/**
|
|
4177
4162
|
* the shipnotice must be completed by date and time
|
|
4178
4163
|
* @format date-time
|
|
@@ -4225,11 +4210,6 @@ export interface ApiV21EntitiesShipnotice {
|
|
|
4225
4210
|
inspection_required?: boolean;
|
|
4226
4211
|
/** meta data for this shipnotice as stringified JSON */
|
|
4227
4212
|
meta_data?: string | null;
|
|
4228
|
-
/**
|
|
4229
|
-
* MID code for this shipnotice.
|
|
4230
|
-
* Note: this field has a limit of 15 chars.
|
|
4231
|
-
*/
|
|
4232
|
-
mid_code?: string | null;
|
|
4233
4213
|
/** notes by customer */
|
|
4234
4214
|
notes_by_customer?: string | null;
|
|
4235
4215
|
/** notes by whiplash */
|
|
@@ -4318,11 +4298,6 @@ export interface ApiV21EntitiesShipnotice {
|
|
|
4318
4298
|
warehouse_id?: number;
|
|
4319
4299
|
/** The name of the associated warehouse */
|
|
4320
4300
|
warehouse_name?: string;
|
|
4321
|
-
/**
|
|
4322
|
-
* zone status of this shipnotice.
|
|
4323
|
-
* Note: this field has a limit of 3 chars.
|
|
4324
|
-
*/
|
|
4325
|
-
zone_status?: string | null;
|
|
4326
4301
|
}
|
|
4327
4302
|
|
|
4328
4303
|
/** V2_1 */
|
|
@@ -4388,11 +4363,6 @@ export interface ApiV21EntitiesShipnoticeItem {
|
|
|
4388
4363
|
* @format int32
|
|
4389
4364
|
*/
|
|
4390
4365
|
shipnotice_id?: number | null;
|
|
4391
|
-
/**
|
|
4392
|
-
* unit price for this shipnotice item
|
|
4393
|
-
* @format float
|
|
4394
|
-
*/
|
|
4395
|
-
unit_price?: number | null;
|
|
4396
4366
|
/**
|
|
4397
4367
|
* the shipnotice item last update date and time
|
|
4398
4368
|
* @format date-time
|
|
@@ -7443,21 +7413,6 @@ export interface PostApiV21ShipnoticesBulkRequest {
|
|
|
7443
7413
|
reference?: string;
|
|
7444
7414
|
/** JSON object of required and optional receiving quantities verified by staff */
|
|
7445
7415
|
quantities_verified?: object;
|
|
7446
|
-
/**
|
|
7447
|
-
* BOL proxy for this shipnotice.
|
|
7448
|
-
* Note: this field has a limit of 30 chars.
|
|
7449
|
-
*/
|
|
7450
|
-
bol_proxy?: string;
|
|
7451
|
-
/**
|
|
7452
|
-
* MID code for this shipnotice.
|
|
7453
|
-
* Note: this field has a limit of 15 chars.
|
|
7454
|
-
*/
|
|
7455
|
-
mid_code?: string;
|
|
7456
|
-
/**
|
|
7457
|
-
* zone status of this shipnotice.
|
|
7458
|
-
* Note: this field has a limit of 3 chars.
|
|
7459
|
-
*/
|
|
7460
|
-
zone_status?: string;
|
|
7461
7416
|
/** is inspection required? (default: false) */
|
|
7462
7417
|
inspection_required?: boolean;
|
|
7463
7418
|
/**
|
|
@@ -7575,11 +7530,6 @@ export interface PostApiV21ShipnoticesRequest {
|
|
|
7575
7530
|
* @format date-time
|
|
7576
7531
|
*/
|
|
7577
7532
|
arrived_at?: string;
|
|
7578
|
-
/**
|
|
7579
|
-
* BOL proxy for this shipnotice.
|
|
7580
|
-
* Note: this field has a limit of 30 chars.
|
|
7581
|
-
*/
|
|
7582
|
-
bol_proxy?: string;
|
|
7583
7533
|
carrier?: string;
|
|
7584
7534
|
/**
|
|
7585
7535
|
* the shipnotice completion date and time
|
|
@@ -7618,11 +7568,6 @@ export interface PostApiV21ShipnoticesRequest {
|
|
|
7618
7568
|
/** Included meta fields for associations */
|
|
7619
7569
|
association_fields?: object;
|
|
7620
7570
|
};
|
|
7621
|
-
/**
|
|
7622
|
-
* MID code for this shipnotice.
|
|
7623
|
-
* Note: this field has a limit of 15 chars.
|
|
7624
|
-
*/
|
|
7625
|
-
mid_code?: string;
|
|
7626
7571
|
/** notes by customer */
|
|
7627
7572
|
notes_by_customer?: string;
|
|
7628
7573
|
/** notes by whiplash */
|
|
@@ -7727,11 +7672,6 @@ export interface PostApiV21ShipnoticesRequest {
|
|
|
7727
7672
|
* @format int32
|
|
7728
7673
|
*/
|
|
7729
7674
|
warehouse_id?: number;
|
|
7730
|
-
/**
|
|
7731
|
-
* zone status of this shipnotice.
|
|
7732
|
-
* Note: this field has a limit of 3 chars.
|
|
7733
|
-
*/
|
|
7734
|
-
zone_status?: string;
|
|
7735
7675
|
}
|
|
7736
7676
|
|
|
7737
7677
|
export interface PostApiV21SimulateConsumerReturnsCreateRequest {
|
|
@@ -9402,21 +9342,6 @@ export interface PostApiV2ShipnoticesBulkRequest {
|
|
|
9402
9342
|
reference?: string;
|
|
9403
9343
|
/** JSON object of required and optional receiving quantities verified by staff */
|
|
9404
9344
|
quantities_verified?: object;
|
|
9405
|
-
/**
|
|
9406
|
-
* BOL proxy for this shipnotice.
|
|
9407
|
-
* Note: this field has a limit of 30 chars.
|
|
9408
|
-
*/
|
|
9409
|
-
bol_proxy?: string;
|
|
9410
|
-
/**
|
|
9411
|
-
* MID code for this shipnotice.
|
|
9412
|
-
* Note: this field has a limit of 15 chars.
|
|
9413
|
-
*/
|
|
9414
|
-
mid_code?: string;
|
|
9415
|
-
/**
|
|
9416
|
-
* zone status of this shipnotice.
|
|
9417
|
-
* Note: this field has a limit of 3 chars.
|
|
9418
|
-
*/
|
|
9419
|
-
zone_status?: string;
|
|
9420
9345
|
/** is inspection required? (default: false) */
|
|
9421
9346
|
inspection_required?: boolean;
|
|
9422
9347
|
/**
|
|
@@ -9534,11 +9459,6 @@ export interface PostApiV2ShipnoticesRequest {
|
|
|
9534
9459
|
* @format date-time
|
|
9535
9460
|
*/
|
|
9536
9461
|
arrived_at?: string;
|
|
9537
|
-
/**
|
|
9538
|
-
* BOL proxy for this shipnotice.
|
|
9539
|
-
* Note: this field has a limit of 30 chars.
|
|
9540
|
-
*/
|
|
9541
|
-
bol_proxy?: string;
|
|
9542
9462
|
carrier?: string;
|
|
9543
9463
|
/**
|
|
9544
9464
|
* the shipnotice completion date and time
|
|
@@ -9577,11 +9497,6 @@ export interface PostApiV2ShipnoticesRequest {
|
|
|
9577
9497
|
/** Included meta fields for associations */
|
|
9578
9498
|
association_fields?: object;
|
|
9579
9499
|
};
|
|
9580
|
-
/**
|
|
9581
|
-
* MID code for this shipnotice.
|
|
9582
|
-
* Note: this field has a limit of 15 chars.
|
|
9583
|
-
*/
|
|
9584
|
-
mid_code?: string;
|
|
9585
9500
|
/** notes by customer */
|
|
9586
9501
|
notes_by_customer?: string;
|
|
9587
9502
|
/** notes by whiplash */
|
|
@@ -9686,11 +9601,6 @@ export interface PostApiV2ShipnoticesRequest {
|
|
|
9686
9601
|
* @format int32
|
|
9687
9602
|
*/
|
|
9688
9603
|
warehouse_id?: number;
|
|
9689
|
-
/**
|
|
9690
|
-
* zone status of this shipnotice.
|
|
9691
|
-
* Note: this field has a limit of 3 chars.
|
|
9692
|
-
*/
|
|
9693
|
-
zone_status?: string;
|
|
9694
9604
|
}
|
|
9695
9605
|
|
|
9696
9606
|
export interface PostApiV2SimulateConsumerReturnsCreateRequest {
|
|
@@ -10791,11 +10701,6 @@ export interface PutApiV21ShipnoticesIdRequest {
|
|
|
10791
10701
|
* @format date-time
|
|
10792
10702
|
*/
|
|
10793
10703
|
arrived_at?: string;
|
|
10794
|
-
/**
|
|
10795
|
-
* BOL proxy for this shipnotice.
|
|
10796
|
-
* Note: this field has a limit of 30 chars.
|
|
10797
|
-
*/
|
|
10798
|
-
bol_proxy?: string;
|
|
10799
10704
|
carrier?: string;
|
|
10800
10705
|
/**
|
|
10801
10706
|
* the shipnotice completion date and time
|
|
@@ -10825,11 +10730,6 @@ export interface PutApiV21ShipnoticesIdRequest {
|
|
|
10825
10730
|
handling_billed?: boolean;
|
|
10826
10731
|
/** meta data for this shipnotice as stringified JSON */
|
|
10827
10732
|
meta_data?: string;
|
|
10828
|
-
/**
|
|
10829
|
-
* MID code for this shipnotice.
|
|
10830
|
-
* Note: this field has a limit of 15 chars.
|
|
10831
|
-
*/
|
|
10832
|
-
mid_code?: string;
|
|
10833
10733
|
/** notes by customer */
|
|
10834
10734
|
notes_by_customer?: string;
|
|
10835
10735
|
/** notes by whiplash */
|
|
@@ -10884,11 +10784,6 @@ export interface PutApiV21ShipnoticesIdRequest {
|
|
|
10884
10784
|
tracking?: string;
|
|
10885
10785
|
/** shipnotice type (Shipnotice, ConsumerReturn) */
|
|
10886
10786
|
type?: string;
|
|
10887
|
-
/**
|
|
10888
|
-
* zone status of this shipnotice.
|
|
10889
|
-
* Note: this field has a limit of 3 chars.
|
|
10890
|
-
*/
|
|
10891
|
-
zone_status?: string;
|
|
10892
10787
|
}
|
|
10893
10788
|
|
|
10894
10789
|
export interface PutApiV21SimulateConsumerReturnsConsumerReturnIdProcessingRequest {
|
|
@@ -12023,11 +11918,6 @@ export interface PutApiV2ShipnoticesIdRequest {
|
|
|
12023
11918
|
* @format date-time
|
|
12024
11919
|
*/
|
|
12025
11920
|
arrived_at?: string;
|
|
12026
|
-
/**
|
|
12027
|
-
* BOL proxy for this shipnotice.
|
|
12028
|
-
* Note: this field has a limit of 30 chars.
|
|
12029
|
-
*/
|
|
12030
|
-
bol_proxy?: string;
|
|
12031
11921
|
carrier?: string;
|
|
12032
11922
|
/**
|
|
12033
11923
|
* the shipnotice completion date and time
|
|
@@ -12057,11 +11947,6 @@ export interface PutApiV2ShipnoticesIdRequest {
|
|
|
12057
11947
|
handling_billed?: boolean;
|
|
12058
11948
|
/** meta data for this shipnotice as stringified JSON */
|
|
12059
11949
|
meta_data?: string;
|
|
12060
|
-
/**
|
|
12061
|
-
* MID code for this shipnotice.
|
|
12062
|
-
* Note: this field has a limit of 15 chars.
|
|
12063
|
-
*/
|
|
12064
|
-
mid_code?: string;
|
|
12065
11950
|
/** notes by customer */
|
|
12066
11951
|
notes_by_customer?: string;
|
|
12067
11952
|
/** notes by whiplash */
|
|
@@ -12116,11 +12001,6 @@ export interface PutApiV2ShipnoticesIdRequest {
|
|
|
12116
12001
|
tracking?: string;
|
|
12117
12002
|
/** shipnotice type (Shipnotice, ConsumerReturn) */
|
|
12118
12003
|
type?: string;
|
|
12119
|
-
/**
|
|
12120
|
-
* zone status of this shipnotice.
|
|
12121
|
-
* Note: this field has a limit of 3 chars.
|
|
12122
|
-
*/
|
|
12123
|
-
zone_status?: string;
|
|
12124
12004
|
}
|
|
12125
12005
|
|
|
12126
12006
|
export interface PutApiV2SimulateConsumerReturnsConsumerReturnIdProcessingRequest {
|