Sign in
api
sales-channels

Archive a sales channel

post/api/sales-channels/{id}/archive

Path parameters

idstring required

The ID of the sales channel.

Response

OK

_idstring required

The ID of the sales channel

sellerIdstring required

The ID of the seller of the sales channel

createdAtstring date-time

An ISO timestamp indicating when the sales channel was created

updatedAtstring date-time

An ISO timestamp indicating when the sales channel was updated

namestring required

The name of the sales channel

status'ACTIVE' | 'INACTIVE' required

The status of the object, whether it is active or not

type'POS' | 'DISTRIBUTOR' | 'INTERNAL_BOOKING' | 'WEB' | 'MARKETPLACE_APP' | 'KIOSK' required

The type of the sales channel

groupIdstring

The group of the sales channel

contractTypeIdsstring[]

The contract types that are available through this sales channel

ownerstring

The app owner id, if the channel was created by a marketplace app

Changes

No recorded changes to this endpoint across all 15 revisions of this API.