curl --request PATCH \
--url https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}/lock \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"apiLocked": true
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}/lock"
payload = { "apiLocked": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({apiLocked: true})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}/lock', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}/lock",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'apiLocked' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}/lock"
payload := strings.NewReader("{\n \"apiLocked\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}/lock")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"apiLocked\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}/lock")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"apiLocked\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"uuid": "<string>",
"label": "<string>",
"description": "<string>",
"apiLocked": true,
"warehouseGroupId": 123,
"warehouseGroup": {},
"storeType": "<string>",
"enabled": true,
"status": 123,
"isPOSChannel": true,
"isCustomerSpecific": true,
"pullOrdersFromOms": true,
"getProductsEnabled": true,
"pushInventoryEnabled": true,
"includeIncomingStocksEnabled": true,
"pullStocksEnabled": true,
"pullShipmentsEnabled": true,
"pushIncomingStocksFromSupplierPurchaseOrderEnabled": true,
"pushStocksAppIntegrationAccountId": 123,
"channelIntegrationMapping": [
{}
],
"pullOrderIntegrationMapping": {},
"pushOrderIntegrationMapping": {},
"pushStockIntegrationMapping": {},
"pushCostIntegrationMapping": {},
"tags": [
{}
],
"metafields": [
{}
],
"isDropship": true,
"dropshipSupplierId": 123,
"dropshipPoDeliveryType": "<string>",
"dropshipPoDeliveryWarehouseId": 123,
"dropshipAutoCreatePo": true,
"dropshipAutoSendPo": true,
"dropshipInventoryNotTracked": true,
"autoPushOrderAfterMinutes": 123,
"autoPushMode": "<string>",
"filters": {},
"restrictions": {},
"credentials": {},
"fees": {},
"createdAt": 123,
"updatedAt": 123,
"createdBy": 123,
"updatedBy": 123
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Lock channel
Set apiLocked: true on a channel to block subsequent external API mutations (PUT, DELETE,
POST /channels/{id}/integration-products).
The external API can only lock — sending apiLocked: false returns 422 with a fixed message
("Channels can only be unlocked from the UI."). To unlock, use the internal admin endpoint
(PATCH /api/v2/admin/channels/{id}/lock with apiLocked: false) or the product UI.
curl --request PATCH \
--url https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}/lock \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"apiLocked": true
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}/lock"
payload = { "apiLocked": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({apiLocked: true})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}/lock', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}/lock",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'apiLocked' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}/lock"
payload := strings.NewReader("{\n \"apiLocked\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}/lock")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"apiLocked\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}/lock")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"apiLocked\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"uuid": "<string>",
"label": "<string>",
"description": "<string>",
"apiLocked": true,
"warehouseGroupId": 123,
"warehouseGroup": {},
"storeType": "<string>",
"enabled": true,
"status": 123,
"isPOSChannel": true,
"isCustomerSpecific": true,
"pullOrdersFromOms": true,
"getProductsEnabled": true,
"pushInventoryEnabled": true,
"includeIncomingStocksEnabled": true,
"pullStocksEnabled": true,
"pullShipmentsEnabled": true,
"pushIncomingStocksFromSupplierPurchaseOrderEnabled": true,
"pushStocksAppIntegrationAccountId": 123,
"channelIntegrationMapping": [
{}
],
"pullOrderIntegrationMapping": {},
"pushOrderIntegrationMapping": {},
"pushStockIntegrationMapping": {},
"pushCostIntegrationMapping": {},
"tags": [
{}
],
"metafields": [
{}
],
"isDropship": true,
"dropshipSupplierId": 123,
"dropshipPoDeliveryType": "<string>",
"dropshipPoDeliveryWarehouseId": 123,
"dropshipAutoCreatePo": true,
"dropshipAutoSendPo": true,
"dropshipInventoryNotTracked": true,
"autoPushOrderAfterMinutes": 123,
"autoPushMode": "<string>",
"filters": {},
"restrictions": {},
"credentials": {},
"fees": {},
"createdAt": 123,
"updatedAt": 123,
"createdBy": 123,
"updatedBy": 123
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
Body
Must be true. Sending false returns 422.
Response
Locked
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.
Show child attributes
Show child attributes