fa7c94b4cc
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
6.8 KiB
Class: AdminSalesChannelsResource
Hierarchy
-
default↳
AdminSalesChannelsResource
Methods
addProducts
▸ addProducts(salesChannelId, payload, customHeaders?): ResponsePromise<AdminSalesChannelsRes>
Add products to a sales channel
This feature is under development and may change in the future.
To use this feature please enable featureflag sales_channels in your medusa backend project.
Description
Add products to a sales channel
Parameters
| Name | Type |
|---|---|
salesChannelId |
string |
payload |
AdminPostSalesChannelsChannelProductsBatchReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminSalesChannelsRes>
a medusa sales channel
Defined in
medusa-js/src/resources/admin/sales-channels.ts:116
create
▸ create(payload, customHeaders?): ResponsePromise<AdminSalesChannelsRes>
Parameters
| Name | Type |
|---|---|
payload |
AdminPostSalesChannelsReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminSalesChannelsRes>
Defined in
medusa-js/src/resources/admin/sales-channels.ts:34
delete
▸ delete(salesChannelId, customHeaders?): ResponsePromise<DeleteResponse>
Delete a sales channel
This feature is under development and may change in the future.
To use this feature please enable featureflag sales_channels in your medusa backend project.
Description
gets a sales channel
Parameters
| Name | Type |
|---|---|
salesChannelId |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<DeleteResponse>
an deletion result
Defined in
medusa-js/src/resources/admin/sales-channels.ts:85
list
▸ list(query?, customHeaders?): ResponsePromise<AdminSalesChannelsListRes>
Retrieve a list of sales channels
This feature is under development and may change in the future.
To use this feature please enable featureflag sales_channels in your medusa backend project.
Description
Retrieve a list of sales channels
Parameters
| Name | Type |
|---|---|
query? |
AdminGetSalesChannelsParams |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminSalesChannelsListRes>
the list of sales channel as well as the pagination properties
Defined in
medusa-js/src/resources/admin/sales-channels.ts:64
removeProducts
▸ removeProducts(salesChannelId, payload, customHeaders?): ResponsePromise<AdminSalesChannelsRes>
Remove products from a sales channel
This feature is under development and may change in the future.
To use this feature please enable featureflag sales_channels in your medusa backend project.
Description
Remove products from a sales channel
Parameters
| Name | Type |
|---|---|
salesChannelId |
string |
payload |
AdminDeleteSalesChannelsChannelProductsBatchReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminSalesChannelsRes>
a medusa sales channel
Defined in
medusa-js/src/resources/admin/sales-channels.ts:100
retrieve
▸ retrieve(salesChannelId, customHeaders?): ResponsePromise<AdminSalesChannelsRes>
retrieve a sales channel
This feature is under development and may change in the future.
To use this feature please enable featureflag sales_channels in your medusa backend project.
Description
gets a sales channel
Parameters
| Name | Type |
|---|---|
salesChannelId |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminSalesChannelsRes>
a medusa sales channel
Defined in
medusa-js/src/resources/admin/sales-channels.ts:22
update
▸ update(salesChannelId, payload, customHeaders?): ResponsePromise<AdminSalesChannelsRes>
update a sales channel
This feature is under development and may change in the future.
To use this feature please enable featureflag sales_channels in your medusa backend project.
Description
updates a sales channel
Parameters
| Name | Type |
|---|---|
salesChannelId |
string |
payload |
AdminPostSalesChannelsSalesChannelReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminSalesChannelsRes>
the updated medusa sales channel