Skip to main content

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

NameType
salesChannelIdstring
payloadAdminPostSalesChannelsChannelProductsBatchReq
customHeadersRecord<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

NameType
payloadAdminPostSalesChannelsReq
customHeadersRecord<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

NameType
salesChannelIdstring
customHeadersRecord<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

NameType
query?AdminGetSalesChannelsParams
customHeadersRecord<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

NameType
salesChannelIdstring
payloadAdminDeleteSalesChannelsChannelProductsBatchReq
customHeadersRecord<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

NameType
salesChannelIdstring
customHeadersRecord<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

NameType
salesChannelIdstring
payloadAdminPostSalesChannelsSalesChannelReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminSalesChannelsRes>

the updated medusa sales channel

Defined in

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

Was this page helpful?