@whiplashmerch/whiplash-api-client 1.0.11 → 1.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 +133 -1
- package/dist/client.esm.js.map +1 -1
- package/dist/generated/Items.d.ts +37 -1
- package/dist/generated/data-contracts.d.ts +180 -0
- package/dist/utils/shipnoticeItem.d.ts +2 -0
- package/generated/Items.ts +89 -0
- package/generated/data-contracts.ts +189 -0
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiV21EntitiesIncident, ApiV21EntitiesItem, ApiV21EntitiesLocation, ApiV21EntitiesPostResponse, ApiV21EntitiesShipnoticeItem, ApiV2EntitiesAudits, ApiV2EntitiesBundleItem, ApiV2EntitiesCount, ApiV2EntitiesIncident, ApiV2EntitiesItem, ApiV2EntitiesItemWarehouseQuantity, ApiV2EntitiesLocation, ApiV2EntitiesMetaFields, ApiV2EntitiesOriginator, ApiV2EntitiesResult, ApiV2EntitiesScancode, ApiV2EntitiesShipnoticeItem, ApiV2EntitiesSidekiqBatch, ApiV2EntitiesTransaction, GetApiV21ItemsAggregateParams, GetApiV21ItemsCountParams, GetApiV21ItemsIdCallTraitParams, GetApiV21ItemsIdInboundParams, GetApiV21ItemsIdIncidentsCountParams, GetApiV21ItemsIdIncidentsParams, GetApiV21ItemsIdLocationsCountParams, GetApiV21ItemsIdLocationsParams, GetApiV21ItemsIdMetaFieldsParams, GetApiV21ItemsIdOriginatorsParams, GetApiV21ItemsIdScancodesParams, GetApiV21ItemsIdShipnoticeItemsCountParams, GetApiV21ItemsIdShipnoticeItemsParams, GetApiV21ItemsIdTraitsParams, GetApiV21ItemsIdTransactionsCountParams, GetApiV21ItemsIdTransactionsParams, GetApiV21ItemsOriginatorOriginatorIdInboundParams, GetApiV21ItemsOriginatorOriginatorIdScancodesParams, GetApiV21ItemsParams, GetApiV2ItemsAggregateParams, GetApiV2ItemsCountParams, GetApiV2ItemsIdCallTraitParams, GetApiV2ItemsIdInboundParams, GetApiV2ItemsIdIncidentsCountParams, GetApiV2ItemsIdIncidentsParams, GetApiV2ItemsIdLocationsCountParams, GetApiV2ItemsIdLocationsParams, GetApiV2ItemsIdMetaFieldsParams, GetApiV2ItemsIdOriginatorsParams, GetApiV2ItemsIdScancodesParams, GetApiV2ItemsIdShipnoticeItemsCountParams, GetApiV2ItemsIdShipnoticeItemsParams, GetApiV2ItemsIdTraitsParams, GetApiV2ItemsIdTransactionsCountParams, GetApiV2ItemsIdTransactionsParams, GetApiV2ItemsOriginatorOriginatorIdInboundParams, GetApiV2ItemsOriginatorOriginatorIdScancodesParams, GetApiV2ItemsParams, PostApiV21Items, PostApiV21ItemsIdBundleItems, PostApiV21ItemsIdIncidents, PostApiV21ItemsIdLocations, PostApiV21ItemsIdOriginators, PostApiV2Items, PostApiV2ItemsIdBundleItems, PostApiV2ItemsIdIncidents, PostApiV2ItemsIdLocations, PostApiV2ItemsIdOriginators, PutApiV21ItemsId, PutApiV21ItemsIdCallAction, PutApiV21ItemsIdCallAsyncAction, PutApiV21ItemsIdMetaFields, PutApiV21ItemsOriginatorOriginatorId, PutApiV2ItemsId, PutApiV2ItemsIdCallAction, PutApiV2ItemsIdCallAsyncAction, PutApiV2ItemsIdMetaFields, PutApiV2ItemsOriginatorOriginatorId } from "./data-contracts";
|
|
1
|
+
import { ApiV21EntitiesIncident, ApiV21EntitiesItem, ApiV21EntitiesLocation, ApiV21EntitiesPostResponse, ApiV21EntitiesShipnoticeItem, ApiV2EntitiesAudits, ApiV2EntitiesBundleItem, ApiV2EntitiesCount, ApiV2EntitiesIncident, ApiV2EntitiesItem, ApiV2EntitiesItemLocation, ApiV2EntitiesItemWarehouseQuantity, ApiV2EntitiesLocation, ApiV2EntitiesMetaFields, ApiV2EntitiesOriginator, ApiV2EntitiesResult, ApiV2EntitiesScancode, ApiV2EntitiesShipnoticeItem, ApiV2EntitiesSidekiqBatch, ApiV2EntitiesTransaction, GetApiV21ItemsAggregateParams, GetApiV21ItemsCountParams, GetApiV21ItemsIdCallTraitParams, GetApiV21ItemsIdInboundParams, GetApiV21ItemsIdIncidentsCountParams, GetApiV21ItemsIdIncidentsParams, GetApiV21ItemsIdLocationsCountParams, GetApiV21ItemsIdLocationsParams, GetApiV21ItemsIdLocationsWithTransferCountParams, GetApiV21ItemsIdMetaFieldsParams, GetApiV21ItemsIdOriginatorsParams, GetApiV21ItemsIdScancodesParams, GetApiV21ItemsIdShipnoticeItemsCountParams, GetApiV21ItemsIdShipnoticeItemsParams, GetApiV21ItemsIdTraitsParams, GetApiV21ItemsIdTransactionsCountParams, GetApiV21ItemsIdTransactionsParams, GetApiV21ItemsOriginatorOriginatorIdInboundParams, GetApiV21ItemsOriginatorOriginatorIdLocationsWithTransferCountParams, GetApiV21ItemsOriginatorOriginatorIdScancodesParams, GetApiV21ItemsParams, GetApiV2ItemsAggregateParams, GetApiV2ItemsCountParams, GetApiV2ItemsIdCallTraitParams, GetApiV2ItemsIdInboundParams, GetApiV2ItemsIdIncidentsCountParams, GetApiV2ItemsIdIncidentsParams, GetApiV2ItemsIdLocationsCountParams, GetApiV2ItemsIdLocationsParams, GetApiV2ItemsIdLocationsWithTransferCountParams, GetApiV2ItemsIdMetaFieldsParams, GetApiV2ItemsIdOriginatorsParams, GetApiV2ItemsIdScancodesParams, GetApiV2ItemsIdShipnoticeItemsCountParams, GetApiV2ItemsIdShipnoticeItemsParams, GetApiV2ItemsIdTraitsParams, GetApiV2ItemsIdTransactionsCountParams, GetApiV2ItemsIdTransactionsParams, GetApiV2ItemsOriginatorOriginatorIdInboundParams, GetApiV2ItemsOriginatorOriginatorIdLocationsWithTransferCountParams, GetApiV2ItemsOriginatorOriginatorIdScancodesParams, GetApiV2ItemsParams, PostApiV21Items, PostApiV21ItemsIdBundleItems, PostApiV21ItemsIdIncidents, PostApiV21ItemsIdLocations, PostApiV21ItemsIdOriginators, PostApiV2Items, PostApiV2ItemsIdBundleItems, PostApiV2ItemsIdIncidents, PostApiV2ItemsIdLocations, PostApiV2ItemsIdOriginators, PutApiV21ItemsId, PutApiV21ItemsIdCallAction, PutApiV21ItemsIdCallAsyncAction, PutApiV21ItemsIdMetaFields, PutApiV21ItemsOriginatorOriginatorId, PutApiV2ItemsId, PutApiV2ItemsIdCallAction, PutApiV2ItemsIdCallAsyncAction, PutApiV2ItemsIdMetaFields, PutApiV2ItemsOriginatorOriginatorId } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Get resource actions
|
|
@@ -116,6 +116,15 @@ export declare const getApiV2ItemsOriginatorOriginatorIdWarehouseQuantities: (cl
|
|
|
116
116
|
* @request GET:/api/v2/items/originator/{originator_id}/scancodes
|
|
117
117
|
*/
|
|
118
118
|
export declare const getApiV2ItemsOriginatorOriginatorIdScancodes: (client: HttpClient, { originatorId, ...query }: GetApiV2ItemsOriginatorOriginatorIdScancodesParams, params?: RequestParams) => Promise<ApiV2EntitiesScancode[]>;
|
|
119
|
+
/**
|
|
120
|
+
* No description
|
|
121
|
+
*
|
|
122
|
+
* @tags originators
|
|
123
|
+
* @name GetApiV2ItemsOriginatorOriginatorIdLocationsWithTransferCount
|
|
124
|
+
* @summary List locations associated with this item - by role
|
|
125
|
+
* @request GET:/api/v2/items/originator/{originator_id}/locations_with_transfer_count
|
|
126
|
+
*/
|
|
127
|
+
export declare const getApiV2ItemsOriginatorOriginatorIdLocationsWithTransferCount: (client: HttpClient, { originatorId, ...query }: GetApiV2ItemsOriginatorOriginatorIdLocationsWithTransferCountParams, params?: RequestParams) => Promise<ApiV2EntitiesItemLocation[]>;
|
|
119
128
|
/**
|
|
120
129
|
* @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
|
|
121
130
|
*
|
|
@@ -233,6 +242,15 @@ export declare const getApiV2ItemsIdWarehouseQuantities: (client: HttpClient, id
|
|
|
233
242
|
* @request GET:/api/v2/items/{id}/scancodes
|
|
234
243
|
*/
|
|
235
244
|
export declare const getApiV2ItemsIdScancodes: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdScancodesParams, params?: RequestParams) => Promise<ApiV2EntitiesScancode[]>;
|
|
245
|
+
/**
|
|
246
|
+
* No description
|
|
247
|
+
*
|
|
248
|
+
* @tags items
|
|
249
|
+
* @name GetApiV2ItemsIdLocationsWithTransferCount
|
|
250
|
+
* @summary List locations associated with this item - by role
|
|
251
|
+
* @request GET:/api/v2/items/{id}/locations_with_transfer_count
|
|
252
|
+
*/
|
|
253
|
+
export declare const getApiV2ItemsIdLocationsWithTransferCount: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdLocationsWithTransferCountParams, params?: RequestParams) => Promise<ApiV2EntitiesItemLocation[]>;
|
|
236
254
|
/**
|
|
237
255
|
* @description Get the meta fields for a(n) Item
|
|
238
256
|
*
|
|
@@ -493,6 +511,15 @@ export declare const getApiV21ItemsOriginatorOriginatorIdWarehouseQuantities: (c
|
|
|
493
511
|
* @request GET:/api/v2.1/items/originator/{originator_id}/scancodes
|
|
494
512
|
*/
|
|
495
513
|
export declare const getApiV21ItemsOriginatorOriginatorIdScancodes: (client: HttpClient, { originatorId, ...query }: GetApiV21ItemsOriginatorOriginatorIdScancodesParams, params?: RequestParams) => Promise<ApiV2EntitiesScancode[]>;
|
|
514
|
+
/**
|
|
515
|
+
* No description
|
|
516
|
+
*
|
|
517
|
+
* @tags originators
|
|
518
|
+
* @name GetApiV21ItemsOriginatorOriginatorIdLocationsWithTransferCount
|
|
519
|
+
* @summary List locations associated with this item - by role
|
|
520
|
+
* @request GET:/api/v2.1/items/originator/{originator_id}/locations_with_transfer_count
|
|
521
|
+
*/
|
|
522
|
+
export declare const getApiV21ItemsOriginatorOriginatorIdLocationsWithTransferCount: (client: HttpClient, { originatorId, ...query }: GetApiV21ItemsOriginatorOriginatorIdLocationsWithTransferCountParams, params?: RequestParams) => Promise<ApiV2EntitiesItemLocation[]>;
|
|
496
523
|
/**
|
|
497
524
|
* @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
|
|
498
525
|
*
|
|
@@ -601,6 +628,15 @@ export declare const getApiV21ItemsIdWarehouseQuantities: (client: HttpClient, i
|
|
|
601
628
|
* @request GET:/api/v2.1/items/{id}/scancodes
|
|
602
629
|
*/
|
|
603
630
|
export declare const getApiV21ItemsIdScancodes: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdScancodesParams, params?: RequestParams) => Promise<ApiV2EntitiesScancode[]>;
|
|
631
|
+
/**
|
|
632
|
+
* No description
|
|
633
|
+
*
|
|
634
|
+
* @tags items
|
|
635
|
+
* @name GetApiV21ItemsIdLocationsWithTransferCount
|
|
636
|
+
* @summary List locations associated with this item - by role
|
|
637
|
+
* @request GET:/api/v2.1/items/{id}/locations_with_transfer_count
|
|
638
|
+
*/
|
|
639
|
+
export declare const getApiV21ItemsIdLocationsWithTransferCount: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdLocationsWithTransferCountParams, params?: RequestParams) => Promise<ApiV2EntitiesItemLocation[]>;
|
|
604
640
|
/**
|
|
605
641
|
* @description Get the meta fields for a(n) Item
|
|
606
642
|
*
|
|
@@ -4734,6 +4734,42 @@ export interface ApiV2EntitiesItem {
|
|
|
4734
4734
|
*/
|
|
4735
4735
|
width?: number;
|
|
4736
4736
|
}
|
|
4737
|
+
/** Api_V2_Entities_ItemLocation model */
|
|
4738
|
+
export interface ApiV2EntitiesItemLocation {
|
|
4739
|
+
/** Human readable version of the location name */
|
|
4740
|
+
humanize_shelf_name?: string;
|
|
4741
|
+
/**
|
|
4742
|
+
* the location id
|
|
4743
|
+
* @format int32
|
|
4744
|
+
*/
|
|
4745
|
+
id?: number;
|
|
4746
|
+
/**
|
|
4747
|
+
* the number of in progress transfers
|
|
4748
|
+
* @format int32
|
|
4749
|
+
*/
|
|
4750
|
+
in_progress_transfers?: number;
|
|
4751
|
+
/**
|
|
4752
|
+
* the lot expiration date
|
|
4753
|
+
* @format date-time
|
|
4754
|
+
*/
|
|
4755
|
+
lot_expires_on?: string;
|
|
4756
|
+
/** the lot number associated to the location */
|
|
4757
|
+
lot_number?: string;
|
|
4758
|
+
/** the location name */
|
|
4759
|
+
name?: string;
|
|
4760
|
+
/**
|
|
4761
|
+
* the quantity of the location
|
|
4762
|
+
* @format int32
|
|
4763
|
+
*/
|
|
4764
|
+
quantity?: number;
|
|
4765
|
+
/** the location role */
|
|
4766
|
+
role?: string;
|
|
4767
|
+
/**
|
|
4768
|
+
* the uncommitted quantity of the location
|
|
4769
|
+
* @format int32
|
|
4770
|
+
*/
|
|
4771
|
+
uncommitted?: number;
|
|
4772
|
+
}
|
|
4737
4773
|
/** Api_V2_Entities_ItemWarehouseQuantity model */
|
|
4738
4774
|
export interface ApiV2EntitiesItemWarehouseQuantity {
|
|
4739
4775
|
/** Warehouse address line 1 */
|
|
@@ -8857,6 +8893,27 @@ export interface GetApiV21ItemsIdLocationsParams {
|
|
|
8857
8893
|
/** @format int32 */
|
|
8858
8894
|
id: number;
|
|
8859
8895
|
}
|
|
8896
|
+
export interface GetApiV21ItemsIdLocationsWithTransferCountParams {
|
|
8897
|
+
/**
|
|
8898
|
+
* Pickable, backstock, etc
|
|
8899
|
+
* @default "pickable"
|
|
8900
|
+
*/
|
|
8901
|
+
role?: GetApiV21ItemsIdLocationsWithTransferCountParamsRole;
|
|
8902
|
+
/**
|
|
8903
|
+
* Page number for pagination
|
|
8904
|
+
* @format int32
|
|
8905
|
+
* @default 1
|
|
8906
|
+
*/
|
|
8907
|
+
page?: number;
|
|
8908
|
+
/**
|
|
8909
|
+
* Number of locations per page for pagination
|
|
8910
|
+
* @format int32
|
|
8911
|
+
* @default 25
|
|
8912
|
+
*/
|
|
8913
|
+
per_page?: number;
|
|
8914
|
+
/** @format int32 */
|
|
8915
|
+
id: number;
|
|
8916
|
+
}
|
|
8860
8917
|
export interface GetApiV21ItemsIdMetaFieldsParams {
|
|
8861
8918
|
/** Include meta fields for associations */
|
|
8862
8919
|
associations?: string[];
|
|
@@ -8972,6 +9029,27 @@ export interface GetApiV21ItemsOriginatorOriginatorIdInboundParams {
|
|
|
8972
9029
|
/** @format int32 */
|
|
8973
9030
|
originatorId: number;
|
|
8974
9031
|
}
|
|
9032
|
+
export interface GetApiV21ItemsOriginatorOriginatorIdLocationsWithTransferCountParams {
|
|
9033
|
+
/**
|
|
9034
|
+
* Pickable, backstock, etc
|
|
9035
|
+
* @default "pickable"
|
|
9036
|
+
*/
|
|
9037
|
+
role?: GetApiV21ItemsOriginatorOriginatorIdLocationsWithTransferCountParamsRole;
|
|
9038
|
+
/**
|
|
9039
|
+
* Page number for pagination
|
|
9040
|
+
* @format int32
|
|
9041
|
+
* @default 1
|
|
9042
|
+
*/
|
|
9043
|
+
page?: number;
|
|
9044
|
+
/**
|
|
9045
|
+
* Number of locations per page for pagination
|
|
9046
|
+
* @format int32
|
|
9047
|
+
* @default 25
|
|
9048
|
+
*/
|
|
9049
|
+
per_page?: number;
|
|
9050
|
+
/** @format int32 */
|
|
9051
|
+
originatorId: number;
|
|
9052
|
+
}
|
|
8975
9053
|
export interface GetApiV21ItemsOriginatorOriginatorIdScancodesParams {
|
|
8976
9054
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
8977
9055
|
search?: string;
|
|
@@ -11164,6 +11242,27 @@ export interface GetApiV2ItemsIdLocationsParams {
|
|
|
11164
11242
|
/** @format int32 */
|
|
11165
11243
|
id: number;
|
|
11166
11244
|
}
|
|
11245
|
+
export interface GetApiV2ItemsIdLocationsWithTransferCountParams {
|
|
11246
|
+
/**
|
|
11247
|
+
* Pickable, backstock, etc
|
|
11248
|
+
* @default "pickable"
|
|
11249
|
+
*/
|
|
11250
|
+
role?: GetApiV2ItemsIdLocationsWithTransferCountParamsRole;
|
|
11251
|
+
/**
|
|
11252
|
+
* Page number for pagination
|
|
11253
|
+
* @format int32
|
|
11254
|
+
* @default 1
|
|
11255
|
+
*/
|
|
11256
|
+
page?: number;
|
|
11257
|
+
/**
|
|
11258
|
+
* Number of locations per page for pagination
|
|
11259
|
+
* @format int32
|
|
11260
|
+
* @default 25
|
|
11261
|
+
*/
|
|
11262
|
+
per_page?: number;
|
|
11263
|
+
/** @format int32 */
|
|
11264
|
+
id: number;
|
|
11265
|
+
}
|
|
11167
11266
|
export interface GetApiV2ItemsIdMetaFieldsParams {
|
|
11168
11267
|
/** Include meta fields for associations */
|
|
11169
11268
|
"associations[]"?: string[];
|
|
@@ -11279,6 +11378,27 @@ export interface GetApiV2ItemsOriginatorOriginatorIdInboundParams {
|
|
|
11279
11378
|
/** @format int32 */
|
|
11280
11379
|
originatorId: number;
|
|
11281
11380
|
}
|
|
11381
|
+
export interface GetApiV2ItemsOriginatorOriginatorIdLocationsWithTransferCountParams {
|
|
11382
|
+
/**
|
|
11383
|
+
* Pickable, backstock, etc
|
|
11384
|
+
* @default "pickable"
|
|
11385
|
+
*/
|
|
11386
|
+
role?: GetApiV2ItemsOriginatorOriginatorIdLocationsWithTransferCountParamsRole;
|
|
11387
|
+
/**
|
|
11388
|
+
* Page number for pagination
|
|
11389
|
+
* @format int32
|
|
11390
|
+
* @default 1
|
|
11391
|
+
*/
|
|
11392
|
+
page?: number;
|
|
11393
|
+
/**
|
|
11394
|
+
* Number of locations per page for pagination
|
|
11395
|
+
* @format int32
|
|
11396
|
+
* @default 25
|
|
11397
|
+
*/
|
|
11398
|
+
per_page?: number;
|
|
11399
|
+
/** @format int32 */
|
|
11400
|
+
originatorId: number;
|
|
11401
|
+
}
|
|
11282
11402
|
export interface GetApiV2ItemsOriginatorOriginatorIdScancodesParams {
|
|
11283
11403
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
11284
11404
|
search?: string;
|
|
@@ -13993,6 +14113,21 @@ export declare enum GetApiV21ItemsIdInboundParamsType {
|
|
|
13993
14113
|
ConsumerReturn = "ConsumerReturn",
|
|
13994
14114
|
All = "all"
|
|
13995
14115
|
}
|
|
14116
|
+
/**
|
|
14117
|
+
* Pickable, backstock, etc
|
|
14118
|
+
* @default "pickable"
|
|
14119
|
+
*/
|
|
14120
|
+
export declare enum GetApiV21ItemsIdLocationsWithTransferCountParamsRole {
|
|
14121
|
+
Pickable = "pickable",
|
|
14122
|
+
Backstock = "backstock",
|
|
14123
|
+
Damaged = "damaged",
|
|
14124
|
+
Expired = "expired",
|
|
14125
|
+
Reserved = "reserved",
|
|
14126
|
+
Pending = "pending",
|
|
14127
|
+
External = "external",
|
|
14128
|
+
Dropoff = "dropoff",
|
|
14129
|
+
BStock = "b_stock"
|
|
14130
|
+
}
|
|
13996
14131
|
/**
|
|
13997
14132
|
* Type of inbound ship notice to fetch (Shipnotice or ConsumerReturn)
|
|
13998
14133
|
* @default "all"
|
|
@@ -14002,6 +14137,21 @@ export declare enum GetApiV21ItemsOriginatorOriginatorIdInboundParamsType {
|
|
|
14002
14137
|
ConsumerReturn = "ConsumerReturn",
|
|
14003
14138
|
All = "all"
|
|
14004
14139
|
}
|
|
14140
|
+
/**
|
|
14141
|
+
* Pickable, backstock, etc
|
|
14142
|
+
* @default "pickable"
|
|
14143
|
+
*/
|
|
14144
|
+
export declare enum GetApiV21ItemsOriginatorOriginatorIdLocationsWithTransferCountParamsRole {
|
|
14145
|
+
Pickable = "pickable",
|
|
14146
|
+
Backstock = "backstock",
|
|
14147
|
+
Damaged = "damaged",
|
|
14148
|
+
Expired = "expired",
|
|
14149
|
+
Reserved = "reserved",
|
|
14150
|
+
Pending = "pending",
|
|
14151
|
+
External = "external",
|
|
14152
|
+
Dropoff = "dropoff",
|
|
14153
|
+
BStock = "b_stock"
|
|
14154
|
+
}
|
|
14005
14155
|
/**
|
|
14006
14156
|
* Type of inbound ship notice to fetch (Shipnotice or ConsumerReturn)
|
|
14007
14157
|
* @default "all"
|
|
@@ -14011,6 +14161,21 @@ export declare enum GetApiV2ItemsIdInboundParamsType {
|
|
|
14011
14161
|
ConsumerReturn = "ConsumerReturn",
|
|
14012
14162
|
All = "all"
|
|
14013
14163
|
}
|
|
14164
|
+
/**
|
|
14165
|
+
* Pickable, backstock, etc
|
|
14166
|
+
* @default "pickable"
|
|
14167
|
+
*/
|
|
14168
|
+
export declare enum GetApiV2ItemsIdLocationsWithTransferCountParamsRole {
|
|
14169
|
+
Pickable = "pickable",
|
|
14170
|
+
Backstock = "backstock",
|
|
14171
|
+
Damaged = "damaged",
|
|
14172
|
+
Expired = "expired",
|
|
14173
|
+
Reserved = "reserved",
|
|
14174
|
+
Pending = "pending",
|
|
14175
|
+
External = "external",
|
|
14176
|
+
Dropoff = "dropoff",
|
|
14177
|
+
BStock = "b_stock"
|
|
14178
|
+
}
|
|
14014
14179
|
/**
|
|
14015
14180
|
* Type of inbound ship notice to fetch (Shipnotice or ConsumerReturn)
|
|
14016
14181
|
* @default "all"
|
|
@@ -14020,6 +14185,21 @@ export declare enum GetApiV2ItemsOriginatorOriginatorIdInboundParamsType {
|
|
|
14020
14185
|
ConsumerReturn = "ConsumerReturn",
|
|
14021
14186
|
All = "all"
|
|
14022
14187
|
}
|
|
14188
|
+
/**
|
|
14189
|
+
* Pickable, backstock, etc
|
|
14190
|
+
* @default "pickable"
|
|
14191
|
+
*/
|
|
14192
|
+
export declare enum GetApiV2ItemsOriginatorOriginatorIdLocationsWithTransferCountParamsRole {
|
|
14193
|
+
Pickable = "pickable",
|
|
14194
|
+
Backstock = "backstock",
|
|
14195
|
+
Damaged = "damaged",
|
|
14196
|
+
Expired = "expired",
|
|
14197
|
+
Reserved = "reserved",
|
|
14198
|
+
Pending = "pending",
|
|
14199
|
+
External = "external",
|
|
14200
|
+
Dropoff = "dropoff",
|
|
14201
|
+
BStock = "b_stock"
|
|
14202
|
+
}
|
|
14023
14203
|
/** Create an account */
|
|
14024
14204
|
export interface PostApiV21Accounts {
|
|
14025
14205
|
/**
|
|
@@ -4,6 +4,7 @@ export interface ApiV21EntitiesShipnoticeItemTransaction {
|
|
|
4
4
|
condition: string;
|
|
5
5
|
type: string;
|
|
6
6
|
user_full_name: string;
|
|
7
|
+
user_id: number;
|
|
7
8
|
datetime: string;
|
|
8
9
|
}
|
|
9
10
|
export interface ApiV21EntitiesTimelineAllocation {
|
|
@@ -14,6 +15,7 @@ export interface ApiV21EntitiesTimelineAllocation {
|
|
|
14
15
|
quantity: number;
|
|
15
16
|
type: string;
|
|
16
17
|
user_full_name: string;
|
|
18
|
+
user_id: number;
|
|
17
19
|
datetime: string;
|
|
18
20
|
}
|
|
19
21
|
export interface ApiV21ShipnoticeItemReceivingTimelineResult {
|
package/generated/Items.ts
CHANGED
|
@@ -17,6 +17,7 @@ import {
|
|
|
17
17
|
ApiV2EntitiesBundleItem,
|
|
18
18
|
ApiV2EntitiesCount,
|
|
19
19
|
ApiV2EntitiesItem,
|
|
20
|
+
ApiV2EntitiesItemLocation,
|
|
20
21
|
ApiV2EntitiesItemWarehouseQuantity,
|
|
21
22
|
ApiV2EntitiesMetaFields,
|
|
22
23
|
ApiV2EntitiesOriginator,
|
|
@@ -24,6 +25,7 @@ import {
|
|
|
24
25
|
ApiV2EntitiesShipnoticeItem,
|
|
25
26
|
ApiV2EntitiesTransaction,
|
|
26
27
|
GetApiV21ItemsCountParams,
|
|
28
|
+
GetApiV21ItemsIdLocationsWithTransferCountParams,
|
|
27
29
|
GetApiV21ItemsIdMetaFieldsParams,
|
|
28
30
|
GetApiV21ItemsIdOriginatorsParams,
|
|
29
31
|
GetApiV21ItemsIdScancodesParams,
|
|
@@ -31,9 +33,11 @@ import {
|
|
|
31
33
|
GetApiV21ItemsIdShipnoticeItemsParams,
|
|
32
34
|
GetApiV21ItemsIdTransactionsCountParams,
|
|
33
35
|
GetApiV21ItemsIdTransactionsParams,
|
|
36
|
+
GetApiV21ItemsOriginatorOriginatorIdLocationsWithTransferCountParams,
|
|
34
37
|
GetApiV21ItemsOriginatorOriginatorIdScancodesParams,
|
|
35
38
|
GetApiV21ItemsParams,
|
|
36
39
|
GetApiV2ItemsCountParams,
|
|
40
|
+
GetApiV2ItemsIdLocationsWithTransferCountParams,
|
|
37
41
|
GetApiV2ItemsIdMetaFieldsParams,
|
|
38
42
|
GetApiV2ItemsIdOriginatorsParams,
|
|
39
43
|
GetApiV2ItemsIdScancodesParams,
|
|
@@ -41,6 +45,7 @@ import {
|
|
|
41
45
|
GetApiV2ItemsIdShipnoticeItemsParams,
|
|
42
46
|
GetApiV2ItemsIdTransactionsCountParams,
|
|
43
47
|
GetApiV2ItemsIdTransactionsParams,
|
|
48
|
+
GetApiV2ItemsOriginatorOriginatorIdLocationsWithTransferCountParams,
|
|
44
49
|
GetApiV2ItemsOriginatorOriginatorIdScancodesParams,
|
|
45
50
|
GetApiV2ItemsParams,
|
|
46
51
|
PostApiV21Items,
|
|
@@ -251,6 +256,27 @@ export const getApiV2ItemsOriginatorOriginatorIdScancodes = (
|
|
|
251
256
|
...params,
|
|
252
257
|
});
|
|
253
258
|
};
|
|
259
|
+
/**
|
|
260
|
+
* No description
|
|
261
|
+
*
|
|
262
|
+
* @tags originators
|
|
263
|
+
* @name GetApiV2ItemsOriginatorOriginatorIdLocationsWithTransferCount
|
|
264
|
+
* @summary List locations associated with this item - by role
|
|
265
|
+
* @request GET:/api/v2/items/originator/{originator_id}/locations_with_transfer_count
|
|
266
|
+
*/
|
|
267
|
+
export const getApiV2ItemsOriginatorOriginatorIdLocationsWithTransferCount = (
|
|
268
|
+
client: HttpClient,
|
|
269
|
+
{ originatorId, ...query }: GetApiV2ItemsOriginatorOriginatorIdLocationsWithTransferCountParams,
|
|
270
|
+
params: RequestParams = {},
|
|
271
|
+
) => {
|
|
272
|
+
return client.request<ApiV2EntitiesItemLocation[], ApiV2EntitiesApiError>({
|
|
273
|
+
path: `/api/v2/items/originator/${originatorId}/locations_with_transfer_count`,
|
|
274
|
+
method: "GET",
|
|
275
|
+
query: query,
|
|
276
|
+
format: "json",
|
|
277
|
+
...params,
|
|
278
|
+
});
|
|
279
|
+
};
|
|
254
280
|
/**
|
|
255
281
|
* @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
|
|
256
282
|
*
|
|
@@ -418,6 +444,27 @@ export const getApiV2ItemsIdScancodes = (
|
|
|
418
444
|
...params,
|
|
419
445
|
});
|
|
420
446
|
};
|
|
447
|
+
/**
|
|
448
|
+
* No description
|
|
449
|
+
*
|
|
450
|
+
* @tags items
|
|
451
|
+
* @name GetApiV2ItemsIdLocationsWithTransferCount
|
|
452
|
+
* @summary List locations associated with this item - by role
|
|
453
|
+
* @request GET:/api/v2/items/{id}/locations_with_transfer_count
|
|
454
|
+
*/
|
|
455
|
+
export const getApiV2ItemsIdLocationsWithTransferCount = (
|
|
456
|
+
client: HttpClient,
|
|
457
|
+
{ id, ...query }: GetApiV2ItemsIdLocationsWithTransferCountParams,
|
|
458
|
+
params: RequestParams = {},
|
|
459
|
+
) => {
|
|
460
|
+
return client.request<ApiV2EntitiesItemLocation[], ApiV2EntitiesApiError>({
|
|
461
|
+
path: `/api/v2/items/${id}/locations_with_transfer_count`,
|
|
462
|
+
method: "GET",
|
|
463
|
+
query: query,
|
|
464
|
+
format: "json",
|
|
465
|
+
...params,
|
|
466
|
+
});
|
|
467
|
+
};
|
|
421
468
|
/**
|
|
422
469
|
* @description Get the meta fields for a(n) Item
|
|
423
470
|
*
|
|
@@ -778,6 +825,27 @@ export const getApiV21ItemsOriginatorOriginatorIdScancodes = (
|
|
|
778
825
|
...params,
|
|
779
826
|
});
|
|
780
827
|
};
|
|
828
|
+
/**
|
|
829
|
+
* No description
|
|
830
|
+
*
|
|
831
|
+
* @tags originators
|
|
832
|
+
* @name GetApiV21ItemsOriginatorOriginatorIdLocationsWithTransferCount
|
|
833
|
+
* @summary List locations associated with this item - by role
|
|
834
|
+
* @request GET:/api/v2.1/items/originator/{originator_id}/locations_with_transfer_count
|
|
835
|
+
*/
|
|
836
|
+
export const getApiV21ItemsOriginatorOriginatorIdLocationsWithTransferCount = (
|
|
837
|
+
client: HttpClient,
|
|
838
|
+
{ originatorId, ...query }: GetApiV21ItemsOriginatorOriginatorIdLocationsWithTransferCountParams,
|
|
839
|
+
params: RequestParams = {},
|
|
840
|
+
) => {
|
|
841
|
+
return client.request<ApiV2EntitiesItemLocation[], ApiV2EntitiesApiError>({
|
|
842
|
+
path: `/api/v2.1/items/originator/${originatorId}/locations_with_transfer_count`,
|
|
843
|
+
method: "GET",
|
|
844
|
+
query: query,
|
|
845
|
+
format: "json",
|
|
846
|
+
...params,
|
|
847
|
+
});
|
|
848
|
+
};
|
|
781
849
|
/**
|
|
782
850
|
* @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
|
|
783
851
|
*
|
|
@@ -944,6 +1012,27 @@ export const getApiV21ItemsIdScancodes = (
|
|
|
944
1012
|
...params,
|
|
945
1013
|
});
|
|
946
1014
|
};
|
|
1015
|
+
/**
|
|
1016
|
+
* No description
|
|
1017
|
+
*
|
|
1018
|
+
* @tags items
|
|
1019
|
+
* @name GetApiV21ItemsIdLocationsWithTransferCount
|
|
1020
|
+
* @summary List locations associated with this item - by role
|
|
1021
|
+
* @request GET:/api/v2.1/items/{id}/locations_with_transfer_count
|
|
1022
|
+
*/
|
|
1023
|
+
export const getApiV21ItemsIdLocationsWithTransferCount = (
|
|
1024
|
+
client: HttpClient,
|
|
1025
|
+
{ id, ...query }: GetApiV21ItemsIdLocationsWithTransferCountParams,
|
|
1026
|
+
params: RequestParams = {},
|
|
1027
|
+
) => {
|
|
1028
|
+
return client.request<ApiV2EntitiesItemLocation[], ApiV2EntitiesApiError>({
|
|
1029
|
+
path: `/api/v2.1/items/${id}/locations_with_transfer_count`,
|
|
1030
|
+
method: "GET",
|
|
1031
|
+
query: query,
|
|
1032
|
+
format: "json",
|
|
1033
|
+
...params,
|
|
1034
|
+
});
|
|
1035
|
+
};
|
|
947
1036
|
/**
|
|
948
1037
|
* @description Get the meta fields for a(n) Item
|
|
949
1038
|
*
|