Skip to main content
Skip to main content

IInventoryService

Methods​

__joinerConfig​

**__joinerConfig**(): [ModuleJoinerConfig](/references/services/types/ModuleJoinerConfig)

Returns​

ModuleJoinerConfig

ModuleJoinerConfigOmit<JoinerServiceConfig, "serviceName" | "primaryKeys" | "relationships" | "extends"> & &#123; databaseConfig?: &#123; extraFields?: Record&#60;string, &#123; defaultValue?: string ; nullable?: boolean ; options?: Record&#60;string, unknown&#62; ; type: "date"\|"time"\|"datetime"\|"bigint"\|"blob"\|"uint8array"\|"array"\|"enumArray"\|"enum"\|"json"\|"integer"\|"smallint"\|"tinyint"\|"mediumint"\|"float"\|"double"\|"boolean"\|"decimal"\|"string"\|"uuid"\|"text" &#125;&#62; ; idPrefix?: string ; tableName?: string &#125; ; extends?: &#123; fieldAlias?: Record&#60;string, string \| &#123; forwardArgumentsOnPath: string[] ; path: string &#125;&#62; ; relationship: [ModuleJoinerRelationship](/references/services/types/ModuleJoinerRelationship) ; serviceName: string &#125;[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record&#60;string, string&#62; ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](/references/services/types/ModuleJoinerRelationship)[] ; schema?: string ; serviceName?: string &#125;Required

adjustInventory​

**adjustInventory**(inventoryItemId, locationId, adjustment, context?): Promise&#60;[InventoryLevelDTO](/references/services/types/InventoryLevelDTO)&#62;

Parameters​

inventoryItemIdstringRequired
locationIdstringRequired
adjustmentnumberRequired
contextSharedContext

Returns​

Promise<InventoryLevelDTO>

PromisePromise<InventoryLevelDTO>Required

confirmInventory​

**confirmInventory**(inventoryItemId, locationIds, quantity, context?): Promise&#60;boolean&#62;

Parameters​

inventoryItemIdstringRequired
locationIdsstring[]Required
quantitynumberRequired
contextSharedContext

Returns​

Promise<boolean>

PromisePromise<boolean>Required

createInventoryItem​

**createInventoryItem**(input, context?): Promise&#60;[InventoryItemDTO](/references/services/types/InventoryItemDTO)&#62;

Parameters​

Returns​

Promise<InventoryItemDTO>

PromisePromise<InventoryItemDTO>Required

createInventoryItems​

**createInventoryItems**(input, context?): Promise&#60;[InventoryItemDTO](/references/services/types/InventoryItemDTO)[]&#62;

Parameters​

Returns​

Promise<InventoryItemDTO[]>

PromisePromise<InventoryItemDTO[]>Required

createInventoryLevel​

**createInventoryLevel**(data, context?): Promise&#60;[InventoryLevelDTO](/references/services/types/InventoryLevelDTO)&#62;

Parameters​

Returns​

Promise<InventoryLevelDTO>

PromisePromise<InventoryLevelDTO>Required

createInventoryLevels​

**createInventoryLevels**(data, context?): Promise&#60;[InventoryLevelDTO](/references/services/types/InventoryLevelDTO)[]&#62;

Parameters​

Returns​

Promise<InventoryLevelDTO[]>

PromisePromise<InventoryLevelDTO[]>Required

createReservationItem​

**createReservationItem**(input, context?): Promise&#60;[ReservationItemDTO](/references/services/types/ReservationItemDTO)&#62;

Parameters​

Returns​

Promise<ReservationItemDTO>

PromisePromise<ReservationItemDTO>Required

createReservationItems​

**createReservationItems**(input, context?): Promise&#60;[ReservationItemDTO](/references/services/types/ReservationItemDTO)[]&#62;

Parameters​

Returns​

Promise<ReservationItemDTO[]>

PromisePromise<ReservationItemDTO[]>Required

deleteInventoryItem​

**deleteInventoryItem**(inventoryItemId, context?): Promise&#60;void&#62;

Parameters​

inventoryItemIdstring | string[]Required
contextSharedContext

Returns​

Promise<void>

PromisePromise<void>Required

deleteInventoryItemLevelByLocationId​

**deleteInventoryItemLevelByLocationId**(locationId, context?): Promise&#60;void&#62;

Parameters​

locationIdstring | string[]Required
contextSharedContext

Returns​

Promise<void>

PromisePromise<void>Required

deleteInventoryLevel​

**deleteInventoryLevel**(inventoryLevelId, locationId, context?): Promise&#60;void&#62;

Parameters​

inventoryLevelIdstringRequired
locationIdstringRequired
contextSharedContext

Returns​

Promise<void>

PromisePromise<void>Required

deleteReservationItem​

**deleteReservationItem**(reservationItemId, context?): Promise&#60;void&#62;

Parameters​

reservationItemIdstring | string[]Required
contextSharedContext

Returns​

Promise<void>

PromisePromise<void>Required

deleteReservationItemByLocationId​

**deleteReservationItemByLocationId**(locationId, context?): Promise&#60;void&#62;

Parameters​

locationIdstring | string[]Required
contextSharedContext

Returns​

Promise<void>

PromisePromise<void>Required

deleteReservationItemsByLineItem​

**deleteReservationItemsByLineItem**(lineItemId, context?): Promise&#60;void&#62;

Parameters​

lineItemIdstring | string[]Required
contextSharedContext

Returns​

Promise<void>

PromisePromise<void>Required

listInventoryItems​

**listInventoryItems**(selector, config?, context?): Promise&#60;[[InventoryItemDTO](/references/services/types/InventoryItemDTO)[], number]&#62;

Parameters​

Returns​

Promise<[InventoryItemDTO[], number]>

PromisePromise<[InventoryItemDTO[], number]>Required

listInventoryLevels​

**listInventoryLevels**(selector, config?, context?): Promise&#60;[[InventoryLevelDTO](/references/services/types/InventoryLevelDTO)[], number]&#62;

Parameters​

Returns​

Promise<[InventoryLevelDTO[], number]>

PromisePromise<[InventoryLevelDTO[], number]>Required

listReservationItems​

**listReservationItems**(selector, config?, context?): Promise&#60;[[ReservationItemDTO](/references/services/types/ReservationItemDTO)[], number]&#62;

Parameters​

Returns​

Promise<[ReservationItemDTO[], number]>

PromisePromise<[ReservationItemDTO[], number]>Required

restoreInventoryItem​

**restoreInventoryItem**(inventoryItemId, context?): Promise&#60;void&#62;

Parameters​

inventoryItemIdstring | string[]Required
contextSharedContext

Returns​

Promise<void>

PromisePromise<void>Required

retrieveAvailableQuantity​

**retrieveAvailableQuantity**(inventoryItemId, locationIds, context?): Promise&#60;number&#62;

Parameters​

inventoryItemIdstringRequired
locationIdsstring[]Required
contextSharedContext

Returns​

Promise<number>

PromisePromise<number>Required

retrieveInventoryItem​

**retrieveInventoryItem**(inventoryItemId, config?, context?): Promise&#60;[InventoryItemDTO](/references/services/types/InventoryItemDTO)&#62;

Parameters​

inventoryItemIdstringRequired
configFindConfig<InventoryItemDTO>
contextSharedContext

Returns​

Promise<InventoryItemDTO>

PromisePromise<InventoryItemDTO>Required

retrieveInventoryLevel​

**retrieveInventoryLevel**(inventoryItemId, locationId, context?): Promise&#60;[InventoryLevelDTO](/references/services/types/InventoryLevelDTO)&#62;

Parameters​

inventoryItemIdstringRequired
locationIdstringRequired
contextSharedContext

Returns​

Promise<InventoryLevelDTO>

PromisePromise<InventoryLevelDTO>Required

retrieveReservationItem​

**retrieveReservationItem**(reservationId, context?): Promise&#60;[ReservationItemDTO](/references/services/types/ReservationItemDTO)&#62;

Parameters​

reservationIdstringRequired
contextSharedContext

Returns​

Promise<ReservationItemDTO>

PromisePromise<ReservationItemDTO>Required

retrieveReservedQuantity​

**retrieveReservedQuantity**(inventoryItemId, locationIds, context?): Promise&#60;number&#62;

Parameters​

inventoryItemIdstringRequired
locationIdsstring[]Required
contextSharedContext

Returns​

Promise<number>

PromisePromise<number>Required

retrieveStockedQuantity​

**retrieveStockedQuantity**(inventoryItemId, locationIds, context?): Promise&#60;number&#62;

Parameters​

inventoryItemIdstringRequired
locationIdsstring[]Required
contextSharedContext

Returns​

Promise<number>

PromisePromise<number>Required

updateInventoryItem​

**updateInventoryItem**(inventoryItemId, input, context?): Promise&#60;[InventoryItemDTO](/references/services/types/InventoryItemDTO)&#62;

Parameters​

inventoryItemIdstringRequired
inputCreateInventoryItemInputRequired
contextSharedContext

Returns​

Promise<InventoryItemDTO>

PromisePromise<InventoryItemDTO>Required

updateInventoryLevel​

**updateInventoryLevel**(inventoryItemId, locationId, update, context?): Promise&#60;[InventoryLevelDTO](/references/services/types/InventoryLevelDTO)&#62;

Parameters​

inventoryItemIdstringRequired
locationIdstringRequired
updateUpdateInventoryLevelInputRequired
contextSharedContext

Returns​

Promise<InventoryLevelDTO>

PromisePromise<InventoryLevelDTO>Required

updateInventoryLevels​

**updateInventoryLevels**(updates, context?): Promise&#60;[InventoryLevelDTO](/references/services/types/InventoryLevelDTO)[]&#62;

Parameters​

updates&#123; inventory_item_id: string ; location_id: string &#125; & UpdateInventoryLevelInput[]Required
contextSharedContext

Returns​

Promise<InventoryLevelDTO[]>

PromisePromise<InventoryLevelDTO[]>Required

updateReservationItem​

**updateReservationItem**(reservationItemId, input, context?): Promise&#60;[ReservationItemDTO](/references/services/types/ReservationItemDTO)&#62;

Parameters​

reservationItemIdstringRequired
inputUpdateReservationItemInputRequired
contextSharedContext

Returns​

Promise<ReservationItemDTO>

PromisePromise<ReservationItemDTO>Required
Was this section helpful?
© 2023 Medusa, Inc. All rights reserved.