AdminSalesChannelsResource

admin/sales-channels.AdminSalesChannelsResource

Methods

addLocation

addLocation(salesChannelId, payload, customHeaders?): ResponsePromise<AdminSalesChannelsRes>

Add a location 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.

Parameters

salesChannelIdstringRequired

payloadAdminPostSalesChannelsChannelStockLocationsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminSalesChannelsRes>

ResponsePromiseResponsePromise<AdminSalesChannelsRes>Required

the Medusa SalesChannel

Description

Add a stock location to a SalesChannel

---

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.

Parameters

salesChannelIdstringRequired

payloadAdminPostSalesChannelsChannelProductsBatchReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminSalesChannelsRes>

ResponsePromiseResponsePromise<AdminSalesChannelsRes>Required

a medusa sales channel

Description

Add products to a sales channel

---

create

create(payload, customHeaders?): ResponsePromise<AdminSalesChannelsRes>

Parameters

payloadAdminPostSalesChannelsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminSalesChannelsRes>

ResponsePromiseResponsePromise<AdminSalesChannelsRes>Required

---

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.

Parameters

salesChannelIdstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<DeleteResponse>

ResponsePromiseResponsePromise<DeleteResponse>Required

an deletion result

Description

gets a sales channel

---

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.

Parameters

queryAdminGetSalesChannelsParams

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminSalesChannelsListRes>

ResponsePromiseResponsePromise<AdminSalesChannelsListRes>Required

the list of sales channel as well as the pagination properties

Description

Retrieve a list of sales channels

---

removeLocation

removeLocation(salesChannelId, payload, customHeaders?): ResponsePromise<AdminSalesChannelsRes>

remove a location 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.

Parameters

salesChannelIdstringRequired

payloadAdminDeleteSalesChannelsChannelStockLocationsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminSalesChannelsRes>

ResponsePromiseResponsePromise<AdminSalesChannelsRes>Required

an deletion result

Description

Remove a stock location from a SalesChannel

---

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.

Parameters

salesChannelIdstringRequired

payloadAdminDeleteSalesChannelsChannelProductsBatchReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminSalesChannelsRes>

ResponsePromiseResponsePromise<AdminSalesChannelsRes>Required

a medusa sales channel

Description

Remove products from a sales channel

---

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.

Parameters

salesChannelIdstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminSalesChannelsRes>

ResponsePromiseResponsePromise<AdminSalesChannelsRes>Required

a medusa sales channel

Description

gets a sales channel

---

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.

Parameters

salesChannelIdstringRequired

payloadAdminPostSalesChannelsSalesChannelReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminSalesChannelsRes>

ResponsePromiseResponsePromise<AdminSalesChannelsRes>Required

the updated medusa sales channel

Description

updates a sales channel