@erp-galoper/types 1.0.1829 → 1.0.1830
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 +312 -15
- package/package.json +1 -1
package/openapi.ts
CHANGED
|
@@ -28205,6 +28205,313 @@ export interface components {
|
|
|
28205
28205
|
/** Index */
|
|
28206
28206
|
index?: number | null;
|
|
28207
28207
|
};
|
|
28208
|
+
/** PatchChildItemSchema */
|
|
28209
|
+
PatchChildItemSchema: {
|
|
28210
|
+
/** Availableinpos */
|
|
28211
|
+
availableInPos?: boolean | null;
|
|
28212
|
+
/** Image */
|
|
28213
|
+
image?: string | null;
|
|
28214
|
+
/**
|
|
28215
|
+
* Images
|
|
28216
|
+
* @description List of images with default selection, only one image should be default, other images should be false
|
|
28217
|
+
* @default []
|
|
28218
|
+
*/
|
|
28219
|
+
images: components["schemas"]["ImageSchema"][] | null;
|
|
28220
|
+
/** Name */
|
|
28221
|
+
name?: string | null;
|
|
28222
|
+
/**
|
|
28223
|
+
* Shortname
|
|
28224
|
+
* @description short name length should be less than name length
|
|
28225
|
+
*/
|
|
28226
|
+
shortName?: string | null;
|
|
28227
|
+
/** Active */
|
|
28228
|
+
active?: boolean | null;
|
|
28229
|
+
/** Description */
|
|
28230
|
+
description?: string | null;
|
|
28231
|
+
/**
|
|
28232
|
+
* Skucode
|
|
28233
|
+
* @description Not applicable for service items - always null for type=service
|
|
28234
|
+
*/
|
|
28235
|
+
skuCode?: string | null;
|
|
28236
|
+
/**
|
|
28237
|
+
* Barcodes
|
|
28238
|
+
* @description list of barcodes with type and code
|
|
28239
|
+
* @default []
|
|
28240
|
+
*/
|
|
28241
|
+
barcodes: components["schemas"]["UpdateBarcodeSchema"][];
|
|
28242
|
+
type?: components["schemas"]["ItemType"] | null;
|
|
28243
|
+
/**
|
|
28244
|
+
* @description - when type is service usage should be disabled and set its value to service
|
|
28245
|
+
* - when type is product usage should be either goods or works only
|
|
28246
|
+
*/
|
|
28247
|
+
usage?: components["schemas"]["ItemUsage"] | null;
|
|
28248
|
+
/** Variant Of */
|
|
28249
|
+
variant_of?: string | null;
|
|
28250
|
+
/** Unitofmeasure */
|
|
28251
|
+
unitOfMeasure?: string[] | null;
|
|
28252
|
+
/**
|
|
28253
|
+
* Tags
|
|
28254
|
+
* @default []
|
|
28255
|
+
*/
|
|
28256
|
+
tags: string[] | null;
|
|
28257
|
+
/** Family */
|
|
28258
|
+
family?: string | null;
|
|
28259
|
+
/** Brand */
|
|
28260
|
+
brand?: string | null;
|
|
28261
|
+
/**
|
|
28262
|
+
* Categories
|
|
28263
|
+
* @description get categories from api/v1/inventory/categories/?type=item
|
|
28264
|
+
* @default []
|
|
28265
|
+
*/
|
|
28266
|
+
categories: string[];
|
|
28267
|
+
/**
|
|
28268
|
+
* Specs
|
|
28269
|
+
* @default []
|
|
28270
|
+
*/
|
|
28271
|
+
specs: number[];
|
|
28272
|
+
/** Isvariant */
|
|
28273
|
+
isVariant?: boolean | null;
|
|
28274
|
+
/**
|
|
28275
|
+
* Trackingstockbyvariant
|
|
28276
|
+
* @description if tracking Stock By Variant was true and variants exist and user change it to be false you should delete the variants but notimmediately you should ask him for confirmation
|
|
28277
|
+
*/
|
|
28278
|
+
trackingStockByVariant?: boolean | null;
|
|
28279
|
+
/**
|
|
28280
|
+
* Variations
|
|
28281
|
+
* @default []
|
|
28282
|
+
*/
|
|
28283
|
+
variations: number[];
|
|
28284
|
+
/**
|
|
28285
|
+
* Alternativeitems
|
|
28286
|
+
* @description get items using route /api/v1/inventory/items/?viewType=flat and filter by isActive=True, role not equal to template, type equals to current item type, and id not equal to current item id
|
|
28287
|
+
* @default []
|
|
28288
|
+
*/
|
|
28289
|
+
alternativeItems: components["schemas"]["AlternativeItemIsTwoWaysSchema"][];
|
|
28290
|
+
/** Returnableitem */
|
|
28291
|
+
returnableItem?: boolean | null;
|
|
28292
|
+
/**
|
|
28293
|
+
* Width
|
|
28294
|
+
* @description Not applicable for service items - always null for type=service
|
|
28295
|
+
*/
|
|
28296
|
+
width?: number | null;
|
|
28297
|
+
/**
|
|
28298
|
+
* Widthunitofmeasure
|
|
28299
|
+
* @description Not applicable for service items - always null for type=service
|
|
28300
|
+
*/
|
|
28301
|
+
widthUnitOfMeasure?: string | null;
|
|
28302
|
+
/**
|
|
28303
|
+
* Height
|
|
28304
|
+
* @description Not applicable for service items - always null for type=service
|
|
28305
|
+
*/
|
|
28306
|
+
height?: number | null;
|
|
28307
|
+
/**
|
|
28308
|
+
* Heightunitofmeasure
|
|
28309
|
+
* @description Not applicable for service items - always null for type=service
|
|
28310
|
+
*/
|
|
28311
|
+
heightUnitOfMeasure?: string | null;
|
|
28312
|
+
/**
|
|
28313
|
+
* Length
|
|
28314
|
+
* @description Not applicable for service items - always null for type=service
|
|
28315
|
+
*/
|
|
28316
|
+
length?: number | null;
|
|
28317
|
+
/**
|
|
28318
|
+
* Lengthunitofmeasure
|
|
28319
|
+
* @description Not applicable for service items - always null for type=service
|
|
28320
|
+
*/
|
|
28321
|
+
lengthUnitOfMeasure?: string | null;
|
|
28322
|
+
/**
|
|
28323
|
+
* Weight
|
|
28324
|
+
* @description Not applicable for service items - always null for type=service
|
|
28325
|
+
*/
|
|
28326
|
+
weight?: number | null;
|
|
28327
|
+
/**
|
|
28328
|
+
* Weightunitofmeasure
|
|
28329
|
+
* @description Not applicable for service items - always null for type=service
|
|
28330
|
+
*/
|
|
28331
|
+
weightUnitOfMeasure?: string | null;
|
|
28332
|
+
/**
|
|
28333
|
+
* Isexchangeable
|
|
28334
|
+
* @description this field only appears if pos in galoper settings is enabled and available in pos is true
|
|
28335
|
+
* @default false
|
|
28336
|
+
*/
|
|
28337
|
+
isExchangeable: boolean | null;
|
|
28338
|
+
/**
|
|
28339
|
+
* Onlineprice
|
|
28340
|
+
* @description Price for online store sales; may be set regardless of per-store listing.
|
|
28341
|
+
*/
|
|
28342
|
+
onlinePrice?: number | null;
|
|
28343
|
+
/**
|
|
28344
|
+
* Onlinepricebeforediscount
|
|
28345
|
+
* @description Original price before discount for online store; may be set regardless of per-store listing.
|
|
28346
|
+
*/
|
|
28347
|
+
onlinePriceBeforeDiscount?: number | null;
|
|
28348
|
+
/**
|
|
28349
|
+
* Seotitle
|
|
28350
|
+
* @description SEO page title for search engines (70 characters recommended); may be set regardless of per-store listing.
|
|
28351
|
+
*/
|
|
28352
|
+
seoTitle?: string | null;
|
|
28353
|
+
/**
|
|
28354
|
+
* Seodescription
|
|
28355
|
+
* @description SEO meta description for search engines (160 characters recommended); may be set regardless of per-store listing.
|
|
28356
|
+
*/
|
|
28357
|
+
seoDescription?: string | null;
|
|
28358
|
+
/**
|
|
28359
|
+
* Onlinesyncstores
|
|
28360
|
+
* @description Replace per-store links when set; each entry controls listing on that sync store.
|
|
28361
|
+
*/
|
|
28362
|
+
onlineSyncStores?: components["schemas"]["OnlineSyncStoreLinkInputSchema"][] | null;
|
|
28363
|
+
/** Allowsales */
|
|
28364
|
+
allowSales?: boolean | null;
|
|
28365
|
+
/** Maxdiscountsales */
|
|
28366
|
+
maxDiscountSales?: number | null;
|
|
28367
|
+
/**
|
|
28368
|
+
* Defaultsaleunitofmeasure
|
|
28369
|
+
* @description required when module sales is enabled in galoper settings and allow sales is true for the item
|
|
28370
|
+
*/
|
|
28371
|
+
defaultSaleUnitOfMeasure?: string | null;
|
|
28372
|
+
/** Defaultsellingprice */
|
|
28373
|
+
defaultSellingPrice?: number;
|
|
28374
|
+
/**
|
|
28375
|
+
* Defaultsellingpricecurrency
|
|
28376
|
+
* Format: uuid
|
|
28377
|
+
* @description currency should be either companys currency or usd
|
|
28378
|
+
*/
|
|
28379
|
+
defaultSellingPriceCurrency?: string;
|
|
28380
|
+
/** Purchaseprice */
|
|
28381
|
+
purchasePrice?: number;
|
|
28382
|
+
/**
|
|
28383
|
+
* Defaultpurchasepricecurrency
|
|
28384
|
+
* @description currency should be either in companys currency or usd
|
|
28385
|
+
*/
|
|
28386
|
+
defaultPurchasePriceCurrency?: string | null;
|
|
28387
|
+
/** Leadtime */
|
|
28388
|
+
leadTime?: string | null;
|
|
28389
|
+
/**
|
|
28390
|
+
* Minimumquantityorder
|
|
28391
|
+
* @description Not applicable for service items - always null for type=service
|
|
28392
|
+
*/
|
|
28393
|
+
minimumQuantityOrder?: number | null;
|
|
28394
|
+
/** Defaultpurchaseunitofmeasure */
|
|
28395
|
+
defaultPurchaseUnitOfMeasure?: string | null;
|
|
28396
|
+
/**
|
|
28397
|
+
* Minimumquantitiesinstock
|
|
28398
|
+
* @description Per-branch minimum quantity in stock settings.
|
|
28399
|
+
* Each entry sets the minimum stock level for a specific branch.
|
|
28400
|
+
* Branches must be filtered to the user's assigned branches only (use the user's assigned branches list in the UI).
|
|
28401
|
+
* The API returns only entries for assigned branches on read and rejects assignments to unassigned branches on write (noBranchAccess).
|
|
28402
|
+
* Once created, an entry cannot be deleted — set minimumQuantityInStock to 0 instead of null.
|
|
28403
|
+
* On update, only entries included in the payload are updated; omitted entries are left unchanged.
|
|
28404
|
+
*/
|
|
28405
|
+
minimumQuantitiesInStock?: components["schemas"]["CreateOrUpdateMinimumQuantitiesInStockSchema"][] | null;
|
|
28406
|
+
/** Warrantyperiod */
|
|
28407
|
+
warrantyPeriod?: string | null;
|
|
28408
|
+
/**
|
|
28409
|
+
* Allownegativestock
|
|
28410
|
+
* @description Not applicable for service items - always null for type=service. Cannot be enabled for items tracked by serial number or batch. Get default value from inventory settings(/api/v1/settings/inventory/)
|
|
28411
|
+
*/
|
|
28412
|
+
allowNegativeStock?: boolean | null;
|
|
28413
|
+
/** Autoreorder */
|
|
28414
|
+
autoReorder?: boolean | null;
|
|
28415
|
+
/**
|
|
28416
|
+
* Taxes
|
|
28417
|
+
* @default []
|
|
28418
|
+
*/
|
|
28419
|
+
taxes: string[];
|
|
28420
|
+
/**
|
|
28421
|
+
* Transactionalgroup
|
|
28422
|
+
* @description Visibility and Requirement:
|
|
28423
|
+
* - Visible if the accounting module is active
|
|
28424
|
+
* API Endpoints to get default of transactional group:
|
|
28425
|
+
* API Route : /api/v1/settings/accounting/transactional_subsidiary_accounts/ and filter by initialGroup = true
|
|
28426
|
+
*/
|
|
28427
|
+
transactionalGroup?: number | null;
|
|
28428
|
+
/**
|
|
28429
|
+
* Isinventorytracked
|
|
28430
|
+
* @default false
|
|
28431
|
+
*/
|
|
28432
|
+
isInventoryTracked: boolean | null;
|
|
28433
|
+
/**
|
|
28434
|
+
* @description Not applicable for service items - always null for type=service
|
|
28435
|
+
* - When set to 'batch', inventoryMovementMethod is **REQUIRED**
|
|
28436
|
+
*/
|
|
28437
|
+
trackInventoryBy?: components["schemas"]["TrackInventoryBy"] | null;
|
|
28438
|
+
/**
|
|
28439
|
+
* Hasexpirydate
|
|
28440
|
+
* @description expiry date should be false if item is a service, or if it is a product that is tracked by quantity.
|
|
28441
|
+
* @default false
|
|
28442
|
+
*/
|
|
28443
|
+
hasExpiryDate: boolean | null;
|
|
28444
|
+
/**
|
|
28445
|
+
* Bestbeforedate
|
|
28446
|
+
* @description - The date by which the item is best to be consumed or used for optimal quality. Quality may decline after this date, but the item might still be safe to use for a period
|
|
28447
|
+
* - visible when hasExpiryDate is true
|
|
28448
|
+
*/
|
|
28449
|
+
bestBeforeDate?: number | null;
|
|
28450
|
+
/**
|
|
28451
|
+
* Removaldate
|
|
28452
|
+
* @description - The date after which the item must be removed from inventory or use.It is unsafe or completely unusable after this date
|
|
28453
|
+
* - visible when hasExpiryDate is true
|
|
28454
|
+
*/
|
|
28455
|
+
removalDate?: number | null;
|
|
28456
|
+
/**
|
|
28457
|
+
* Alertdate
|
|
28458
|
+
* @description - A date to trigger an alert or notification before the expiry or removal date, allowing time for action (e.g., promotional sales, transfer, or disposal planning)
|
|
28459
|
+
* - visible when hasExpiryDate is true
|
|
28460
|
+
*/
|
|
28461
|
+
alertDate?: number | null;
|
|
28462
|
+
/**
|
|
28463
|
+
* Packages
|
|
28464
|
+
* @description Not applicable for service items - always empty list for type=service. Package and unit of measure should be unique
|
|
28465
|
+
* @default []
|
|
28466
|
+
*/
|
|
28467
|
+
packages: components["schemas"]["CreateOrUpdatePackageItemSchema"][];
|
|
28468
|
+
/**
|
|
28469
|
+
* @default []
|
|
28470
|
+
* @example {
|
|
28471
|
+
* "add": [],
|
|
28472
|
+
* "delete": [
|
|
28473
|
+
* {
|
|
28474
|
+
* "id": "uuid",
|
|
28475
|
+
* "index": 0
|
|
28476
|
+
* }
|
|
28477
|
+
* ],
|
|
28478
|
+
* "update": [
|
|
28479
|
+
* {
|
|
28480
|
+
* "active": false,
|
|
28481
|
+
* "id": "uuid",
|
|
28482
|
+
* "index": 0
|
|
28483
|
+
* }
|
|
28484
|
+
* ]
|
|
28485
|
+
* }
|
|
28486
|
+
*/
|
|
28487
|
+
children: components["schemas"]["UpdateChildrenItemSchema"] | null;
|
|
28488
|
+
/** @description if canDelete for the item is false then this field should be disabled */
|
|
28489
|
+
costStrategy?: components["schemas"]["CostStrategy"] | null;
|
|
28490
|
+
/**
|
|
28491
|
+
* @description Hint: description for each option should be visible to users in the UI
|
|
28492
|
+
* - Net Sales: Commission is calculated on the item price after discount, excluding tax and cost.
|
|
28493
|
+
* - Formula (per item): (Price - Discount) × Commission Rate
|
|
28494
|
+
* - Profit Margin: Commission is calculated on the profit of each item, after deducting both the discount and the cost of goods sold (COGS).
|
|
28495
|
+
* - Formula (per item): (Price - Discount - Cost) × Commission Rate
|
|
28496
|
+
*/
|
|
28497
|
+
commissionCalculation?: components["schemas"]["ItemCommissionCalculation"] | null;
|
|
28498
|
+
/**
|
|
28499
|
+
* @description - fifo(First In, First Out): Items purchased or produced first are sold or used first
|
|
28500
|
+
* - lifo(Last In, First Out): Items purchased or produced most recently are sold or used first
|
|
28501
|
+
* - **REQUIRED** when trackInventoryBy is 'batch'
|
|
28502
|
+
* - For variants: inherited from parent if not explicitly set
|
|
28503
|
+
*/
|
|
28504
|
+
inventoryMovementMethod?: components["schemas"]["INVENTORY_MOVEMENT_METHOD"] | null;
|
|
28505
|
+
/**
|
|
28506
|
+
* Id
|
|
28507
|
+
* Format: uuid
|
|
28508
|
+
*/
|
|
28509
|
+
id: string;
|
|
28510
|
+
/** Index */
|
|
28511
|
+
index?: number | null;
|
|
28512
|
+
/** Selectedattributes */
|
|
28513
|
+
selectedAttributes?: number[] | null;
|
|
28514
|
+
};
|
|
28208
28515
|
/** PatchItemSchema */
|
|
28209
28516
|
PatchItemSchema: {
|
|
28210
28517
|
/** Availableinpos */
|
|
@@ -28514,11 +28821,13 @@ export interface components {
|
|
|
28514
28821
|
* Update
|
|
28515
28822
|
* @default []
|
|
28516
28823
|
* @example {
|
|
28517
|
-
* "active":
|
|
28518
|
-
* "
|
|
28824
|
+
* "active": false,
|
|
28825
|
+
* "defaultSellingPrice": 10,
|
|
28826
|
+
* "id": "uuid",
|
|
28827
|
+
* "index": 0
|
|
28519
28828
|
* }
|
|
28520
28829
|
*/
|
|
28521
|
-
update: components["schemas"]["
|
|
28830
|
+
update: components["schemas"]["PatchChildItemSchema"][];
|
|
28522
28831
|
/**
|
|
28523
28832
|
* Delete
|
|
28524
28833
|
* @default []
|
|
@@ -28529,18 +28838,6 @@ export interface components {
|
|
|
28529
28838
|
*/
|
|
28530
28839
|
delete: components["schemas"]["DeleteItemSchema"][];
|
|
28531
28840
|
};
|
|
28532
|
-
/** UpdateStatusItems */
|
|
28533
|
-
UpdateStatusItems: {
|
|
28534
|
-
/**
|
|
28535
|
-
* Id
|
|
28536
|
-
* Format: uuid
|
|
28537
|
-
*/
|
|
28538
|
-
id: string;
|
|
28539
|
-
/** Active */
|
|
28540
|
-
active: boolean;
|
|
28541
|
-
/** Index */
|
|
28542
|
-
index?: number | null;
|
|
28543
|
-
};
|
|
28544
28841
|
/** ItemCheckResponse */
|
|
28545
28842
|
ItemCheckResponse: {
|
|
28546
28843
|
/**
|