Skip to main content
PATCH
Lock channel

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

channelId
integer
required

Body

application/json
apiLocked
boolean
required

Must be true. Sending false returns 422.

Response

Locked

data
object

A sales, fulfillment, or end-to-end channel. Channels carry per-OMS configuration (pull orders, push orders, push stocks, push costs) and an apiLocked flag — when locked, mutating operations through the external API return 403.