daea35fe73
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
5.1 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: AdminStockLocationsResource
Hierarchy
-
default↳
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
| Name | Type |
|---|---|
payload |
AdminPostStockLocationsReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminStockLocationsRes>
a medusa Stock Location
Description
gets a medusa Stock Location
Defined in
packages/medusa-js/src/resources/admin/stock-locations.ts:21
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
| Name | Type |
|---|---|
id |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<DeleteResponse>
Description
deletes a Stock Location
Defined in
packages/medusa-js/src/resources/admin/stock-locations.ts:66
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
| Name | Type |
|---|---|
query? |
AdminGetStockLocationsParams |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminStockLocationsListRes>
the list of Stock Locations as well as the pagination properties
Description
Retrieve a list of Stock Locations
Defined in
packages/medusa-js/src/resources/admin/stock-locations.ts:81
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
| Name | Type |
|---|---|
itemId |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminStockLocationsRes>
a medusa Stock Location
Description
gets a medusa Stock Location
Defined in
packages/medusa-js/src/resources/admin/stock-locations.ts:36
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
| Name | Type |
|---|---|
stockLocationId |
string |
payload |
AdminPostStockLocationsLocationReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminStockLocationsRes>
the updated medusa Stock Location
Description
updates a Stock Location
Defined in
packages/medusa-js/src/resources/admin/stock-locations.ts:51