Skip to main content
Skip to main content

AdminStockLocationsResource

admin/stock-locations.AdminStockLocationsResource

Methods

create

create(payload, customHeaders?): ResponsePromise<AdminStockLocationsRes>

Create a Stock Location This feature is under development and may change in the future. To use this feature please install @medusajs/stock-location

Parameters

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminStockLocationsRes>

ResponsePromiseResponsePromise<AdminStockLocationsRes>Required
a medusa Stock Location

Description

gets a medusa Stock Location


delete

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

Delete a Stock Location This feature is under development and may change in the future. To use this feature please install @medusajs/stock-location

Parameters

idstringRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<DeleteResponse>

ResponsePromiseResponsePromise<DeleteResponse>Required

Description

deletes a Stock Location


list

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

Retrieve a list of Stock Locations This feature is under development and may change in the future. To use this feature please install @medusajs/stock-location

Parameters

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminStockLocationsListRes>

the list of Stock Locations as well as the pagination properties

Description

Retrieve a list of Stock Locations


retrieve

retrieve(itemId, customHeaders?): ResponsePromise<AdminStockLocationsRes>

Retrieve a Stock Location This feature is under development and may change in the future. To use this feature please install @medusajs/stock-location

Parameters

itemIdstringRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminStockLocationsRes>

ResponsePromiseResponsePromise<AdminStockLocationsRes>Required
a medusa Stock Location

Description

gets a medusa Stock Location


update

update(stockLocationId, payload, customHeaders?): ResponsePromise<AdminStockLocationsRes>

Update a Stock Location This feature is under development and may change in the future. To use this feature please install @medusajs/stock-location

Parameters

stockLocationIdstringRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminStockLocationsRes>

ResponsePromiseResponsePromise<AdminStockLocationsRes>Required
the updated medusa Stock Location

Description

updates a Stock Location

Was this section helpful?