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
customHeaders
Record<string, any>RequiredDefault: `{}`
Returns
ResponsePromise
<AdminStockLocationsRes
>
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
id
stringRequiredcustomHeaders
Record<string, any>RequiredDefault: `{}`
Returns
ResponsePromise
<DeleteResponse
>
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
customHeaders
Record<string, any>RequiredDefault: `{}`
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
itemId
stringRequiredcustomHeaders
Record<string, any>RequiredDefault: `{}`
Returns
ResponsePromise
<AdminStockLocationsRes
>
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
stockLocationId
stringRequiredcustomHeaders
Record<string, any>RequiredDefault: `{}`
Returns
ResponsePromise
<AdminStockLocationsRes
>
the updated medusa Stock Location
Description
updates a Stock Location