Skip to main content
PUT
Update 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
label
string
description
string | null
warehouseGroupId
integer | null
isCustomerSpecific
boolean | null
tagIds
integer[]
pullOrdersFromOms
boolean | null
pullOrderAppIntegrationAccountId
integer
pullOrderOmsStoreId
string
pullOrdersFromOmsOptions
object
pushOrdersToOms
boolean | null
pushOrderAppIntegrationAccountId
integer
pushOrderOmsStoreId
string
pushStocksToOms
boolean | null
pushStocksAppIntegrationAccountId
integer | null
pushCostsToOms
boolean | null
isDropship
boolean | null
dropshipSupplierId
integer | null
dropshipInventoryNotTracked
boolean | null

Response

Updated

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.