Skip to main content

Class: AdminSalesChannelsResource

Hierarchy

  • Copy to Clipboard

    Copy to Clipboard

Methods

addProducts

addProducts(Copy to Clipboard, Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy 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 Copy to Clipboard in your medusa backend project.

Copy to Clipboard

Add products to a sales channel

Parameters

NameType
Copy to ClipboardCopy to Clipboard
Copy to ClipboardCopy to Clipboard
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

a medusa sales channel

Defined in

medusa-js/src/resources/admin/sales-channels.ts:116


create

create(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Parameters

NameType
Copy to ClipboardCopy to Clipboard
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

Defined in

medusa-js/src/resources/admin/sales-channels.ts:34


delete

delete(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Delete a sales channel This feature is under development and may change in the future. To use this feature please enable featureflag Copy to Clipboard in your medusa backend project.

Copy to Clipboard

gets a sales channel

Parameters

NameType
Copy to ClipboardCopy to Clipboard
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

an deletion result

Defined in

medusa-js/src/resources/admin/sales-channels.ts:85


list

list(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy 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 Copy to Clipboard in your medusa backend project.

Copy to Clipboard

Retrieve a list of sales channels

Parameters

NameType
Copy to ClipboardCopy to Clipboard
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy 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(Copy to Clipboard, Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy 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 Copy to Clipboard in your medusa backend project.

Copy to Clipboard

Remove products from a sales channel

Parameters

NameType
Copy to ClipboardCopy to Clipboard
Copy to ClipboardCopy to Clipboard
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

a medusa sales channel

Defined in

medusa-js/src/resources/admin/sales-channels.ts:100


retrieve

retrieve(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

retrieve a sales channel This feature is under development and may change in the future. To use this feature please enable featureflag Copy to Clipboard in your medusa backend project.

Copy to Clipboard

gets a sales channel

Parameters

NameType
Copy to ClipboardCopy to Clipboard
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

a medusa sales channel

Defined in

medusa-js/src/resources/admin/sales-channels.ts:22


update

update(Copy to Clipboard, Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

update a sales channel This feature is under development and may change in the future. To use this feature please enable featureflag Copy to Clipboard in your medusa backend project.

Copy to Clipboard

updates a sales channel

Parameters

NameType
Copy to ClipboardCopy to Clipboard
Copy to ClipboardCopy to Clipboard
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

the updated medusa sales channel

Defined in

medusa-js/src/resources/admin/sales-channels.ts:48