Class: AdminSalesChannelsResource
Hierarchy
defaultCopy to Clipboard↳
AdminSalesChannelsResourceCopy to Clipboard
Methods
addProducts
▸ addProducts(salesChannelIdCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminSalesChannelsResCopy to Clipboard>
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_channelsCopy to Clipboard in your medusa backend project.
DescriptionCopy to Clipboard
Add products to a sales channel
Parameters
| Name | Type |
|---|---|
salesChannelIdCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostSalesChannelsChannelProductsBatchReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminSalesChannelsResCopy to Clipboard>
a medusa sales channel
Defined in
medusa-js/src/resources/admin/sales-channels.ts:116
create
▸ create(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminSalesChannelsResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
payloadCopy to Clipboard | AdminPostSalesChannelsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminSalesChannelsResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/sales-channels.ts:34
delete
▸ delete(salesChannelIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
Delete a sales channel
This feature is under development and may change in the future.
To use this feature please enable featureflag sales_channelsCopy to Clipboard in your medusa backend project.
DescriptionCopy to Clipboard
gets a sales channel
Parameters
| Name | Type |
|---|---|
salesChannelIdCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
an deletion result
Defined in
medusa-js/src/resources/admin/sales-channels.ts:85
list
▸ list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminSalesChannelsListResCopy to Clipboard>
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_channelsCopy to Clipboard in your medusa backend project.
DescriptionCopy to Clipboard
Retrieve a list of sales channels
Parameters
| Name | Type |
|---|---|
query?Copy to Clipboard | AdminGetSalesChannelsParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminSalesChannelsListResCopy to Clipboard>
the list of sales channel as well as the pagination properties
Defined in
medusa-js/src/resources/admin/sales-channels.ts:64
removeProducts
▸ removeProducts(salesChannelIdCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminSalesChannelsResCopy to Clipboard>
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_channelsCopy to Clipboard in your medusa backend project.
DescriptionCopy to Clipboard
Remove products from a sales channel
Parameters
| Name | Type |
|---|---|
salesChannelIdCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminDeleteSalesChannelsChannelProductsBatchReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminSalesChannelsResCopy to Clipboard>
a medusa sales channel
Defined in
medusa-js/src/resources/admin/sales-channels.ts:100
retrieve
▸ retrieve(salesChannelIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminSalesChannelsResCopy to Clipboard>
retrieve a sales channel
This feature is under development and may change in the future.
To use this feature please enable featureflag sales_channelsCopy to Clipboard in your medusa backend project.
DescriptionCopy to Clipboard
gets a sales channel
Parameters
| Name | Type |
|---|---|
salesChannelIdCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminSalesChannelsResCopy to Clipboard>
a medusa sales channel
Defined in
medusa-js/src/resources/admin/sales-channels.ts:22
update
▸ update(salesChannelIdCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminSalesChannelsResCopy to Clipboard>
update a sales channel
This feature is under development and may change in the future.
To use this feature please enable featureflag sales_channelsCopy to Clipboard in your medusa backend project.
DescriptionCopy to Clipboard
updates a sales channel
Parameters
| Name | Type |
|---|---|
salesChannelIdCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostSalesChannelsSalesChannelReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminSalesChannelsResCopy to Clipboard>
the updated medusa sales channel