@erp-galoper/types 1.0.1034 → 1.0.1036
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/openapi.ts +143 -89
- package/package.json +1 -1
package/openapi.ts
CHANGED
|
@@ -697,6 +697,7 @@ export interface paths {
|
|
|
697
697
|
* Retrieve Item
|
|
698
698
|
* @description Endpoint for retrieving a single item
|
|
699
699
|
* - 200: ItemSchema
|
|
700
|
+
* - 403: {"message": "You do not have permission to perform this action", "code": "permissionDenied"}
|
|
700
701
|
* - 404: {"message": "Item not found", "code": "itemDoesNotExist"}
|
|
701
702
|
* - 500: {"message": "An internal server error has occurred", "code": "serverError"}
|
|
702
703
|
*/
|
|
@@ -21621,6 +21622,22 @@ export interface components {
|
|
|
21621
21622
|
* @enum {string}
|
|
21622
21623
|
*/
|
|
21623
21624
|
BarcodeTypeValues: "EAN8" | "EAN13" | "UPCA" | "Code128";
|
|
21625
|
+
/** BatchInfoSchema */
|
|
21626
|
+
BatchInfoSchema: {
|
|
21627
|
+
/**
|
|
21628
|
+
* Id
|
|
21629
|
+
* Format: uuid
|
|
21630
|
+
*/
|
|
21631
|
+
id: string;
|
|
21632
|
+
/** Number */
|
|
21633
|
+
number: string;
|
|
21634
|
+
/** Stockquantity */
|
|
21635
|
+
stockQuantity: number;
|
|
21636
|
+
/** Availableforsale */
|
|
21637
|
+
availableForSale: number;
|
|
21638
|
+
/** Expirydate */
|
|
21639
|
+
expiryDate?: string | null;
|
|
21640
|
+
};
|
|
21624
21641
|
/** BrandSchema */
|
|
21625
21642
|
BrandSchema: {
|
|
21626
21643
|
/** Id */
|
|
@@ -21635,27 +21652,6 @@ export interface components {
|
|
|
21635
21652
|
/** Name */
|
|
21636
21653
|
name: string;
|
|
21637
21654
|
};
|
|
21638
|
-
/** CommonBrandSchema */
|
|
21639
|
-
CommonBrandSchema: {
|
|
21640
|
-
/** Id */
|
|
21641
|
-
id: number;
|
|
21642
|
-
/** Name */
|
|
21643
|
-
name: string;
|
|
21644
|
-
};
|
|
21645
|
-
/** CommonCategorySchema */
|
|
21646
|
-
CommonCategorySchema: {
|
|
21647
|
-
/** Id */
|
|
21648
|
-
id: number;
|
|
21649
|
-
/** Name */
|
|
21650
|
-
name: string;
|
|
21651
|
-
};
|
|
21652
|
-
/** CommonFamilySchema */
|
|
21653
|
-
CommonFamilySchema: {
|
|
21654
|
-
/** Id */
|
|
21655
|
-
id: number;
|
|
21656
|
-
/** Name */
|
|
21657
|
-
name: string;
|
|
21658
|
-
};
|
|
21659
21655
|
/** CurrencySummaryInfo */
|
|
21660
21656
|
CurrencySummaryInfo: {
|
|
21661
21657
|
/** Name */
|
|
@@ -21701,27 +21697,6 @@ export interface components {
|
|
|
21701
21697
|
*/
|
|
21702
21698
|
results: components["schemas"]["ItemWithChildrenSchema"][];
|
|
21703
21699
|
};
|
|
21704
|
-
/** ItemMinimalSchema */
|
|
21705
|
-
ItemMinimalSchema: {
|
|
21706
|
-
/** Id */
|
|
21707
|
-
id: number;
|
|
21708
|
-
/** Name */
|
|
21709
|
-
name: string;
|
|
21710
|
-
/** Barcode */
|
|
21711
|
-
barcode?: string | null;
|
|
21712
|
-
/** Skucode */
|
|
21713
|
-
skuCode?: string | null;
|
|
21714
|
-
family?: components["schemas"]["CommonFamilySchema"] | null;
|
|
21715
|
-
brand?: components["schemas"]["CommonBrandSchema"] | null;
|
|
21716
|
-
category?: components["schemas"]["CommonCategorySchema"] | null;
|
|
21717
|
-
/** Returnableitem */
|
|
21718
|
-
returnableItem: boolean;
|
|
21719
|
-
trackInventoryBy: components["schemas"]["TrackInventoryBy"] | null;
|
|
21720
|
-
/** Hasexpirydate */
|
|
21721
|
-
hasExpiryDate: boolean;
|
|
21722
|
-
/** Allownegativestock */
|
|
21723
|
-
allowNegativeStock: boolean;
|
|
21724
|
-
};
|
|
21725
21700
|
/** ItemPackageWithCanDeleteAndCanUpdateQuantityOrUomSchema */
|
|
21726
21701
|
ItemPackageWithCanDeleteAndCanUpdateQuantityOrUomSchema: {
|
|
21727
21702
|
/**
|
|
@@ -21770,6 +21745,11 @@ export interface components {
|
|
|
21770
21745
|
* @description Indicates if the quantity or UOM can be updated
|
|
21771
21746
|
*/
|
|
21772
21747
|
canUpdateQuantityOrUom: boolean;
|
|
21748
|
+
/**
|
|
21749
|
+
* Quantities
|
|
21750
|
+
* @description Quantity information for the packed items in this package
|
|
21751
|
+
*/
|
|
21752
|
+
quantities?: components["schemas"]["QuantityGroupSchema"][] | null;
|
|
21773
21753
|
};
|
|
21774
21754
|
/** ItemSchema */
|
|
21775
21755
|
ItemSchema: {
|
|
@@ -21940,8 +21920,11 @@ export interface components {
|
|
|
21940
21920
|
* @default []
|
|
21941
21921
|
*/
|
|
21942
21922
|
itemPackages: components["schemas"]["ItemPackageWithCanDeleteAndCanUpdateQuantityOrUomSchema"][];
|
|
21943
|
-
/**
|
|
21944
|
-
|
|
21923
|
+
/**
|
|
21924
|
+
* Quantities
|
|
21925
|
+
* @description Quantity information for the unpacked items
|
|
21926
|
+
*/
|
|
21927
|
+
quantities?: components["schemas"]["QuantityGroupSchema"][] | null;
|
|
21945
21928
|
costStrategy: components["schemas"]["GetCostStrategy"] | null;
|
|
21946
21929
|
commissionCalculation: components["schemas"]["ItemCommissionCalculation"] | null;
|
|
21947
21930
|
inventoryMovementMethod?: components["schemas"]["INVENTORY_MOVEMENT_METHOD"] | null;
|
|
@@ -22127,8 +22110,11 @@ export interface components {
|
|
|
22127
22110
|
* @default []
|
|
22128
22111
|
*/
|
|
22129
22112
|
itemPackages: components["schemas"]["ItemPackageWithCanDeleteAndCanUpdateQuantityOrUomSchema"][];
|
|
22130
|
-
/**
|
|
22131
|
-
|
|
22113
|
+
/**
|
|
22114
|
+
* Quantities
|
|
22115
|
+
* @description Quantity information for the unpacked items
|
|
22116
|
+
*/
|
|
22117
|
+
quantities?: components["schemas"]["QuantityGroupSchema"][] | null;
|
|
22132
22118
|
costStrategy: components["schemas"]["GetCostStrategy"] | null;
|
|
22133
22119
|
commissionCalculation: components["schemas"]["ItemCommissionCalculation"] | null;
|
|
22134
22120
|
inventoryMovementMethod?: components["schemas"]["INVENTORY_MOVEMENT_METHOD"] | null;
|
|
@@ -22140,15 +22126,6 @@ export interface components {
|
|
|
22140
22126
|
*/
|
|
22141
22127
|
children: components["schemas"]["ItemSchema"][];
|
|
22142
22128
|
};
|
|
22143
|
-
/** ItemsWarehouseQuantitySchema */
|
|
22144
|
-
ItemsWarehouseQuantitySchema: {
|
|
22145
|
-
/** Id */
|
|
22146
|
-
id: number;
|
|
22147
|
-
item: components["schemas"]["ItemMinimalSchema"];
|
|
22148
|
-
warehouse: components["schemas"]["WarehouseSummaryInfo"];
|
|
22149
|
-
/** Stockquantity */
|
|
22150
|
-
stockQuantity: number;
|
|
22151
|
-
};
|
|
22152
22129
|
/** PackageSummarySchema */
|
|
22153
22130
|
PackageSummarySchema: {
|
|
22154
22131
|
/**
|
|
@@ -22164,6 +22141,37 @@ export interface components {
|
|
|
22164
22141
|
/** @description Category of the package */
|
|
22165
22142
|
category: components["schemas"]["PackageCategory"];
|
|
22166
22143
|
};
|
|
22144
|
+
/** QuantityGroupSchema */
|
|
22145
|
+
QuantityGroupSchema: {
|
|
22146
|
+
unitOfMeasure: components["schemas"]["UnitOfMeasureSummaryInfo"];
|
|
22147
|
+
/** Stockquantity */
|
|
22148
|
+
stockQuantity: number;
|
|
22149
|
+
/** Availableforsale */
|
|
22150
|
+
availableForSale: number;
|
|
22151
|
+
/**
|
|
22152
|
+
* Warehouses
|
|
22153
|
+
* @default []
|
|
22154
|
+
*/
|
|
22155
|
+
warehouses: components["schemas"]["UOMWarehouseQuantitySchema"][];
|
|
22156
|
+
};
|
|
22157
|
+
/** SerialInfoSchema */
|
|
22158
|
+
SerialInfoSchema: {
|
|
22159
|
+
/**
|
|
22160
|
+
* Id
|
|
22161
|
+
* Format: uuid
|
|
22162
|
+
*/
|
|
22163
|
+
id: string;
|
|
22164
|
+
/** Number */
|
|
22165
|
+
number: string;
|
|
22166
|
+
/** Status */
|
|
22167
|
+
status: string;
|
|
22168
|
+
/** Stockquantity */
|
|
22169
|
+
stockQuantity: number;
|
|
22170
|
+
/** Availableforsale */
|
|
22171
|
+
availableForSale: number;
|
|
22172
|
+
/** Expirydate */
|
|
22173
|
+
expiryDate?: string | null;
|
|
22174
|
+
};
|
|
22167
22175
|
/** SpecSchema */
|
|
22168
22176
|
SpecSchema: {
|
|
22169
22177
|
/** Id */
|
|
@@ -22199,6 +22207,24 @@ export interface components {
|
|
|
22199
22207
|
* @enum {string}
|
|
22200
22208
|
*/
|
|
22201
22209
|
TrackInventoryBy: "serial_number" | "batch" | "quantity";
|
|
22210
|
+
/** UOMWarehouseQuantitySchema */
|
|
22211
|
+
UOMWarehouseQuantitySchema: {
|
|
22212
|
+
warehouse: components["schemas"]["WarehouseSummaryInfo"];
|
|
22213
|
+
/** Stockquantity */
|
|
22214
|
+
stockQuantity: number;
|
|
22215
|
+
/** Availableforsale */
|
|
22216
|
+
availableForSale: number;
|
|
22217
|
+
/**
|
|
22218
|
+
* Batches
|
|
22219
|
+
* @default []
|
|
22220
|
+
*/
|
|
22221
|
+
batches: components["schemas"]["BatchInfoSchema"][];
|
|
22222
|
+
/**
|
|
22223
|
+
* Serials
|
|
22224
|
+
* @default []
|
|
22225
|
+
*/
|
|
22226
|
+
serials: components["schemas"]["SerialInfoSchema"][];
|
|
22227
|
+
};
|
|
22202
22228
|
/** UnitOfMeasureSchema */
|
|
22203
22229
|
UnitOfMeasureSchema: {
|
|
22204
22230
|
/** Id */
|
|
@@ -25496,21 +25522,47 @@ export interface components {
|
|
|
25496
25522
|
* @enum {string}
|
|
25497
25523
|
*/
|
|
25498
25524
|
ResourceType: "batch" | "serial";
|
|
25499
|
-
/**
|
|
25500
|
-
|
|
25501
|
-
/**
|
|
25502
|
-
|
|
25503
|
-
|
|
25504
|
-
|
|
25505
|
-
|
|
25506
|
-
|
|
25507
|
-
|
|
25508
|
-
/**
|
|
25509
|
-
|
|
25510
|
-
/**
|
|
25511
|
-
|
|
25512
|
-
|
|
25513
|
-
|
|
25525
|
+
/** CommonBrandSchema */
|
|
25526
|
+
CommonBrandSchema: {
|
|
25527
|
+
/** Id */
|
|
25528
|
+
id: number;
|
|
25529
|
+
/** Name */
|
|
25530
|
+
name: string;
|
|
25531
|
+
};
|
|
25532
|
+
/** CommonCategorySchema */
|
|
25533
|
+
CommonCategorySchema: {
|
|
25534
|
+
/** Id */
|
|
25535
|
+
id: number;
|
|
25536
|
+
/** Name */
|
|
25537
|
+
name: string;
|
|
25538
|
+
};
|
|
25539
|
+
/** CommonFamilySchema */
|
|
25540
|
+
CommonFamilySchema: {
|
|
25541
|
+
/** Id */
|
|
25542
|
+
id: number;
|
|
25543
|
+
/** Name */
|
|
25544
|
+
name: string;
|
|
25545
|
+
};
|
|
25546
|
+
/** ItemMinimalSchema */
|
|
25547
|
+
ItemMinimalSchema: {
|
|
25548
|
+
/** Id */
|
|
25549
|
+
id: number;
|
|
25550
|
+
/** Name */
|
|
25551
|
+
name: string;
|
|
25552
|
+
/** Barcode */
|
|
25553
|
+
barcode?: string | null;
|
|
25554
|
+
/** Skucode */
|
|
25555
|
+
skuCode?: string | null;
|
|
25556
|
+
family?: components["schemas"]["CommonFamilySchema"] | null;
|
|
25557
|
+
brand?: components["schemas"]["CommonBrandSchema"] | null;
|
|
25558
|
+
category?: components["schemas"]["CommonCategorySchema"] | null;
|
|
25559
|
+
/** Returnableitem */
|
|
25560
|
+
returnableItem: boolean;
|
|
25561
|
+
trackInventoryBy: components["schemas"]["TrackInventoryBy"] | null;
|
|
25562
|
+
/** Hasexpirydate */
|
|
25563
|
+
hasExpiryDate: boolean;
|
|
25564
|
+
/** Allownegativestock */
|
|
25565
|
+
allowNegativeStock: boolean;
|
|
25514
25566
|
};
|
|
25515
25567
|
/** ItemPackageSummarySchema */
|
|
25516
25568
|
ItemPackageSummarySchema: {
|
|
@@ -25608,24 +25660,6 @@ export interface components {
|
|
|
25608
25660
|
*/
|
|
25609
25661
|
locations: components["schemas"]["LocationInfoSchema"][];
|
|
25610
25662
|
};
|
|
25611
|
-
/** SerialInfoSchema */
|
|
25612
|
-
SerialInfoSchema: {
|
|
25613
|
-
/**
|
|
25614
|
-
* Id
|
|
25615
|
-
* Format: uuid
|
|
25616
|
-
*/
|
|
25617
|
-
id: string;
|
|
25618
|
-
/** Number */
|
|
25619
|
-
number: string;
|
|
25620
|
-
/** Status */
|
|
25621
|
-
status: string;
|
|
25622
|
-
/** Stockquantity */
|
|
25623
|
-
stockQuantity: number;
|
|
25624
|
-
/** Availableforsale */
|
|
25625
|
-
availableForSale: number;
|
|
25626
|
-
/** Expirydate */
|
|
25627
|
-
expiryDate?: string | null;
|
|
25628
|
-
};
|
|
25629
25663
|
/** UOMGroupingSchema */
|
|
25630
25664
|
UOMGroupingSchema: {
|
|
25631
25665
|
unitOfMeasure: components["schemas"]["UnitOfMeasureSummaryInfo"];
|
|
@@ -50473,6 +50507,10 @@ export interface operations {
|
|
|
50473
50507
|
/** @description search by item name , sku code or barcode */
|
|
50474
50508
|
search?: string;
|
|
50475
50509
|
priceListId?: string;
|
|
50510
|
+
/** @description List of warehouse IDs to filter quantities by. If not provided, all warehouses will be included. */
|
|
50511
|
+
warehouses?: number[] | null;
|
|
50512
|
+
/** @description Include detailed quantity breakdown with warehouse information for each item and item package */
|
|
50513
|
+
includeQuantities?: boolean;
|
|
50476
50514
|
};
|
|
50477
50515
|
header?: never;
|
|
50478
50516
|
path?: never;
|
|
@@ -50647,7 +50685,14 @@ export interface operations {
|
|
|
50647
50685
|
};
|
|
50648
50686
|
inventory_item_views_retrieve_item: {
|
|
50649
50687
|
parameters: {
|
|
50650
|
-
query?:
|
|
50688
|
+
query?: {
|
|
50689
|
+
/** @description List of warehouse IDs to filter quantities by. If not provided, all warehouses will be included. */
|
|
50690
|
+
warehouses?: number[] | null;
|
|
50691
|
+
/** @description Branch ID to filter quantities by */
|
|
50692
|
+
branchId?: number | null;
|
|
50693
|
+
/** @description Include detailed quantity breakdown with warehouse information for each item and item package */
|
|
50694
|
+
includeQuantities?: boolean;
|
|
50695
|
+
};
|
|
50651
50696
|
header?: never;
|
|
50652
50697
|
path: {
|
|
50653
50698
|
id: number;
|
|
@@ -50674,6 +50719,15 @@ export interface operations {
|
|
|
50674
50719
|
"application/json": components["schemas"]["MessageWithCode"];
|
|
50675
50720
|
};
|
|
50676
50721
|
};
|
|
50722
|
+
/** @description Forbidden */
|
|
50723
|
+
403: {
|
|
50724
|
+
headers: {
|
|
50725
|
+
[name: string]: unknown;
|
|
50726
|
+
};
|
|
50727
|
+
content: {
|
|
50728
|
+
"application/json": components["schemas"]["MessageWithCode"];
|
|
50729
|
+
};
|
|
50730
|
+
};
|
|
50677
50731
|
/** @description Not Found */
|
|
50678
50732
|
404: {
|
|
50679
50733
|
headers: {
|