AdminInventoryItemsResource

admin/inventory-item.AdminInventoryItemsResource

Methods

create

create(payload, query?, customHeaders?): ResponsePromise<AdminInventoryItemsRes>

Create an Inventory Item This feature is under development and may change in the future. To use this feature please install @medusajs/inventory

Parameters

payloadAdminPostInventoryItemsReqRequired

queryAdminPostInventoryItemsParams

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminInventoryItemsRes>

ResponsePromiseResponsePromise<AdminInventoryItemsRes>Required

the created Inventory Item

Description

creates an Inventory Item

---

createLocationLevel

createLocationLevel(inventoryItemId, payload, query?, customHeaders?): ResponsePromise<AdminInventoryItemsRes>

Create stock for an Inventory Item at a Stock Location This feature is under development and may change in the future. To use this feature please install @medusajs/inventory

Parameters

inventoryItemIdstringRequired

payloadAdminPostInventoryItemsItemLocationLevelsReqRequired

queryAdminGetInventoryItemsParams

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminInventoryItemsRes>

ResponsePromiseResponsePromise<AdminInventoryItemsRes>Required

the Inventory Item

Description

creates stock levle for an Inventory Item

---

delete

delete(inventoryItemId, customHeaders?): ResponsePromise<DeleteResponse>

Delete an Inventory Item This feature is under development and may change in the future. To use this feature please install @medusajs/inventory

Parameters

inventoryItemIdstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<DeleteResponse>

ResponsePromiseResponsePromise<DeleteResponse>Required

the deleted Inventory Item

Description

deletes an Inventory Item

---

deleteLocationLevel

deleteLocationLevel(inventoryItemId, locationId, query?, customHeaders?): ResponsePromise<AdminInventoryItemsRes>

Removes an Inventory Item from a Stock Location. This erases trace of any quantity currently at the location. This feature is under development and may change in the future. To use this feature please install @medusajs/inventory

Parameters

inventoryItemIdstringRequired

locationIdstringRequired

queryAdminGetInventoryItemsParams

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminInventoryItemsRes>

ResponsePromiseResponsePromise<AdminInventoryItemsRes>Required

the Inventory Item

Description

deletes a location level of an Inventory Item

---

list

list(query?, customHeaders?): ResponsePromise<AdminInventoryItemsListWithVariantsAndLocationLevelsRes>

Retrieve a list of Inventory Items This feature is under development and may change in the future. To use this feature please install @medusajs/inventory

Parameters

queryAdminGetInventoryItemsParams

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminInventoryItemsListWithVariantsAndLocationLevelsRes>

ResponsePromiseResponsePromise<AdminInventoryItemsListWithVariantsAndLocationLevelsRes>Required

the list of Inventory Items as well as the pagination properties

Description

Retrieve a list of Inventory Items

---

listLocationLevels

listLocationLevels(inventoryItemId, query?, customHeaders?): ResponsePromise<AdminInventoryItemsLocationLevelsRes>

Retrieve a list of Inventory Levels related to an Inventory Item across Stock Locations This feature is under development and may change in the future. To use this feature please install @medusajs/inventory

Parameters

inventoryItemIdstringRequired

queryAdminGetInventoryItemsItemLocationLevelsParams

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminInventoryItemsLocationLevelsRes>

ResponsePromiseResponsePromise<AdminInventoryItemsLocationLevelsRes>Required

the list of inventory levels related to an Inventory Item as well as the pagination properties

Description

Retrieve a list of location levels related to an Inventory Item

---

retrieve

retrieve(inventoryItemId, query?, customHeaders?): ResponsePromise<AdminInventoryItemsRes>

Retrieve an Inventory Item This feature is under development and may change in the future. To use this feature please install @medusajs/inventory

Parameters

inventoryItemIdstringRequired

queryAdminGetInventoryItemsItemParams

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminInventoryItemsRes>

ResponsePromiseResponsePromise<AdminInventoryItemsRes>Required

an Inventory Item

Description

gets an Inventory Item

---

update

update(inventoryItemId, payload, query?, customHeaders?): ResponsePromise<AdminInventoryItemsRes>

Update an Inventory Item This feature is under development and may change in the future. To use this feature please install @medusajs/inventory

Parameters

inventoryItemIdstringRequired

payloadAdminPostInventoryItemsInventoryItemReqRequired

queryAdminGetInventoryItemsItemParams

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminInventoryItemsRes>

ResponsePromiseResponsePromise<AdminInventoryItemsRes>Required

the updated Inventory Item

Description

updates an Inventory Item

---

updateLocationLevel

updateLocationLevel(inventoryItemId, locationId, payload, query?, customHeaders?): ResponsePromise<AdminInventoryItemsRes>

Update an Inventory Item's stock level at a Stock Location This feature is under development and may change in the future. To use this feature please install @medusajs/inventory

Parameters

inventoryItemIdstringRequired

locationIdstringRequired

payloadAdminPostInventoryItemsItemLocationLevelsLevelReqRequired

queryAdminGetInventoryItemsParams

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminInventoryItemsRes>

ResponsePromiseResponsePromise<AdminInventoryItemsRes>Required

the updated Inventory Item

Description

updates an Inventory Item