Update channel
curl --request PUT \
--url https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"description": "<string>",
"warehouseGroupId": 123,
"isCustomerSpecific": true,
"tagIds": [
123
],
"pullOrdersFromOms": true,
"pullOrderAppIntegrationAccountId": 123,
"pullOrderOmsStoreId": "<string>",
"pullOrdersFromOmsOptions": {},
"pushOrdersToOms": true,
"pushOrderAppIntegrationAccountId": 123,
"pushOrderOmsStoreId": "<string>",
"pushOrderIntegrationMappingId": 123,
"pushStocksToOms": true,
"pushStocksAppIntegrationAccountId": 123,
"pushCostsToOms": true,
"isDropship": true,
"dropshipSupplierId": 123,
"dropshipInventoryNotTracked": true,
"stockPushMaxQuantity": 1,
"stockPushBufferQuantity": 1
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}"
payload = {
"label": "<string>",
"description": "<string>",
"warehouseGroupId": 123,
"isCustomerSpecific": True,
"tagIds": [123],
"pullOrdersFromOms": True,
"pullOrderAppIntegrationAccountId": 123,
"pullOrderOmsStoreId": "<string>",
"pullOrdersFromOmsOptions": {},
"pushOrdersToOms": True,
"pushOrderAppIntegrationAccountId": 123,
"pushOrderOmsStoreId": "<string>",
"pushOrderIntegrationMappingId": 123,
"pushStocksToOms": True,
"pushStocksAppIntegrationAccountId": 123,
"pushCostsToOms": True,
"isDropship": True,
"dropshipSupplierId": 123,
"dropshipInventoryNotTracked": True,
"stockPushMaxQuantity": 1,
"stockPushBufferQuantity": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: '<string>',
description: '<string>',
warehouseGroupId: 123,
isCustomerSpecific: true,
tagIds: [123],
pullOrdersFromOms: true,
pullOrderAppIntegrationAccountId: 123,
pullOrderOmsStoreId: '<string>',
pullOrdersFromOmsOptions: {},
pushOrdersToOms: true,
pushOrderAppIntegrationAccountId: 123,
pushOrderOmsStoreId: '<string>',
pushOrderIntegrationMappingId: 123,
pushStocksToOms: true,
pushStocksAppIntegrationAccountId: 123,
pushCostsToOms: true,
isDropship: true,
dropshipSupplierId: 123,
dropshipInventoryNotTracked: true,
stockPushMaxQuantity: 1,
stockPushBufferQuantity: 1
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'label' => '<string>',
'description' => '<string>',
'warehouseGroupId' => 123,
'isCustomerSpecific' => true,
'tagIds' => [
123
],
'pullOrdersFromOms' => true,
'pullOrderAppIntegrationAccountId' => 123,
'pullOrderOmsStoreId' => '<string>',
'pullOrdersFromOmsOptions' => [
],
'pushOrdersToOms' => true,
'pushOrderAppIntegrationAccountId' => 123,
'pushOrderOmsStoreId' => '<string>',
'pushOrderIntegrationMappingId' => 123,
'pushStocksToOms' => true,
'pushStocksAppIntegrationAccountId' => 123,
'pushCostsToOms' => true,
'isDropship' => true,
'dropshipSupplierId' => 123,
'dropshipInventoryNotTracked' => true,
'stockPushMaxQuantity' => 1,
'stockPushBufferQuantity' => 1
]),
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}"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"warehouseGroupId\": 123,\n \"isCustomerSpecific\": true,\n \"tagIds\": [\n 123\n ],\n \"pullOrdersFromOms\": true,\n \"pullOrderAppIntegrationAccountId\": 123,\n \"pullOrderOmsStoreId\": \"<string>\",\n \"pullOrdersFromOmsOptions\": {},\n \"pushOrdersToOms\": true,\n \"pushOrderAppIntegrationAccountId\": 123,\n \"pushOrderOmsStoreId\": \"<string>\",\n \"pushOrderIntegrationMappingId\": 123,\n \"pushStocksToOms\": true,\n \"pushStocksAppIntegrationAccountId\": 123,\n \"pushCostsToOms\": true,\n \"isDropship\": true,\n \"dropshipSupplierId\": 123,\n \"dropshipInventoryNotTracked\": true,\n \"stockPushMaxQuantity\": 1,\n \"stockPushBufferQuantity\": 1\n}")
req, _ := http.NewRequest("PUT", 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.put("https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"warehouseGroupId\": 123,\n \"isCustomerSpecific\": true,\n \"tagIds\": [\n 123\n ],\n \"pullOrdersFromOms\": true,\n \"pullOrderAppIntegrationAccountId\": 123,\n \"pullOrderOmsStoreId\": \"<string>\",\n \"pullOrdersFromOmsOptions\": {},\n \"pushOrdersToOms\": true,\n \"pushOrderAppIntegrationAccountId\": 123,\n \"pushOrderOmsStoreId\": \"<string>\",\n \"pushOrderIntegrationMappingId\": 123,\n \"pushStocksToOms\": true,\n \"pushStocksAppIntegrationAccountId\": 123,\n \"pushCostsToOms\": true,\n \"isDropship\": true,\n \"dropshipSupplierId\": 123,\n \"dropshipInventoryNotTracked\": true,\n \"stockPushMaxQuantity\": 1,\n \"stockPushBufferQuantity\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"warehouseGroupId\": 123,\n \"isCustomerSpecific\": true,\n \"tagIds\": [\n 123\n ],\n \"pullOrdersFromOms\": true,\n \"pullOrderAppIntegrationAccountId\": 123,\n \"pullOrderOmsStoreId\": \"<string>\",\n \"pullOrdersFromOmsOptions\": {},\n \"pushOrdersToOms\": true,\n \"pushOrderAppIntegrationAccountId\": 123,\n \"pushOrderOmsStoreId\": \"<string>\",\n \"pushOrderIntegrationMappingId\": 123,\n \"pushStocksToOms\": true,\n \"pushStocksAppIntegrationAccountId\": 123,\n \"pushCostsToOms\": true,\n \"isDropship\": true,\n \"dropshipSupplierId\": 123,\n \"dropshipInventoryNotTracked\": true,\n \"stockPushMaxQuantity\": 1,\n \"stockPushBufferQuantity\": 1\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"uuid": "<string>",
"label": "<string>",
"description": "<string>",
"channelType": "sales_channel",
"apiLocked": true,
"warehouseGroupId": 123,
"warehouseGroup": {},
"storeType": "<string>",
"enabled": true,
"status": 123,
"isPOSChannel": true,
"isCustomerSpecific": true,
"pullOrdersFromOms": true,
"getProductsEnabled": true,
"pushInventoryEnabled": true,
"includeIncomingStocksEnabled": true,
"includeDraftProductsEnabled": 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>",
"stockPushMaxQuantity": 123,
"stockPushBufferQuantity": 123,
"stockPushBufferType": "fixed",
"filters": {},
"restrictions": {},
"credentials": {},
"fees": {},
"createdAt": 123,
"updatedAt": 123,
"createdBy": 123,
"updatedBy": 123
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Channels
Update channel
Update an existing channel. Validator uses merge / PATCH semantics — omitted keys are preserved.
channelType cannot be changed once set (sending it returns 422).
Returns 403 when the channel has apiLocked: true. Unlock via internal admin (PATCH /api/v2/admin/channels/{id}/lock with apiLocked: false) or the UI before retrying.
PUT
/
channels
/
{channelId}
Update channel
curl --request PUT \
--url https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"description": "<string>",
"warehouseGroupId": 123,
"isCustomerSpecific": true,
"tagIds": [
123
],
"pullOrdersFromOms": true,
"pullOrderAppIntegrationAccountId": 123,
"pullOrderOmsStoreId": "<string>",
"pullOrdersFromOmsOptions": {},
"pushOrdersToOms": true,
"pushOrderAppIntegrationAccountId": 123,
"pushOrderOmsStoreId": "<string>",
"pushOrderIntegrationMappingId": 123,
"pushStocksToOms": true,
"pushStocksAppIntegrationAccountId": 123,
"pushCostsToOms": true,
"isDropship": true,
"dropshipSupplierId": 123,
"dropshipInventoryNotTracked": true,
"stockPushMaxQuantity": 1,
"stockPushBufferQuantity": 1
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}"
payload = {
"label": "<string>",
"description": "<string>",
"warehouseGroupId": 123,
"isCustomerSpecific": True,
"tagIds": [123],
"pullOrdersFromOms": True,
"pullOrderAppIntegrationAccountId": 123,
"pullOrderOmsStoreId": "<string>",
"pullOrdersFromOmsOptions": {},
"pushOrdersToOms": True,
"pushOrderAppIntegrationAccountId": 123,
"pushOrderOmsStoreId": "<string>",
"pushOrderIntegrationMappingId": 123,
"pushStocksToOms": True,
"pushStocksAppIntegrationAccountId": 123,
"pushCostsToOms": True,
"isDropship": True,
"dropshipSupplierId": 123,
"dropshipInventoryNotTracked": True,
"stockPushMaxQuantity": 1,
"stockPushBufferQuantity": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: '<string>',
description: '<string>',
warehouseGroupId: 123,
isCustomerSpecific: true,
tagIds: [123],
pullOrdersFromOms: true,
pullOrderAppIntegrationAccountId: 123,
pullOrderOmsStoreId: '<string>',
pullOrdersFromOmsOptions: {},
pushOrdersToOms: true,
pushOrderAppIntegrationAccountId: 123,
pushOrderOmsStoreId: '<string>',
pushOrderIntegrationMappingId: 123,
pushStocksToOms: true,
pushStocksAppIntegrationAccountId: 123,
pushCostsToOms: true,
isDropship: true,
dropshipSupplierId: 123,
dropshipInventoryNotTracked: true,
stockPushMaxQuantity: 1,
stockPushBufferQuantity: 1
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'label' => '<string>',
'description' => '<string>',
'warehouseGroupId' => 123,
'isCustomerSpecific' => true,
'tagIds' => [
123
],
'pullOrdersFromOms' => true,
'pullOrderAppIntegrationAccountId' => 123,
'pullOrderOmsStoreId' => '<string>',
'pullOrdersFromOmsOptions' => [
],
'pushOrdersToOms' => true,
'pushOrderAppIntegrationAccountId' => 123,
'pushOrderOmsStoreId' => '<string>',
'pushOrderIntegrationMappingId' => 123,
'pushStocksToOms' => true,
'pushStocksAppIntegrationAccountId' => 123,
'pushCostsToOms' => true,
'isDropship' => true,
'dropshipSupplierId' => 123,
'dropshipInventoryNotTracked' => true,
'stockPushMaxQuantity' => 1,
'stockPushBufferQuantity' => 1
]),
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}"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"warehouseGroupId\": 123,\n \"isCustomerSpecific\": true,\n \"tagIds\": [\n 123\n ],\n \"pullOrdersFromOms\": true,\n \"pullOrderAppIntegrationAccountId\": 123,\n \"pullOrderOmsStoreId\": \"<string>\",\n \"pullOrdersFromOmsOptions\": {},\n \"pushOrdersToOms\": true,\n \"pushOrderAppIntegrationAccountId\": 123,\n \"pushOrderOmsStoreId\": \"<string>\",\n \"pushOrderIntegrationMappingId\": 123,\n \"pushStocksToOms\": true,\n \"pushStocksAppIntegrationAccountId\": 123,\n \"pushCostsToOms\": true,\n \"isDropship\": true,\n \"dropshipSupplierId\": 123,\n \"dropshipInventoryNotTracked\": true,\n \"stockPushMaxQuantity\": 1,\n \"stockPushBufferQuantity\": 1\n}")
req, _ := http.NewRequest("PUT", 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.put("https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"warehouseGroupId\": 123,\n \"isCustomerSpecific\": true,\n \"tagIds\": [\n 123\n ],\n \"pullOrdersFromOms\": true,\n \"pullOrderAppIntegrationAccountId\": 123,\n \"pullOrderOmsStoreId\": \"<string>\",\n \"pullOrdersFromOmsOptions\": {},\n \"pushOrdersToOms\": true,\n \"pushOrderAppIntegrationAccountId\": 123,\n \"pushOrderOmsStoreId\": \"<string>\",\n \"pushOrderIntegrationMappingId\": 123,\n \"pushStocksToOms\": true,\n \"pushStocksAppIntegrationAccountId\": 123,\n \"pushCostsToOms\": true,\n \"isDropship\": true,\n \"dropshipSupplierId\": 123,\n \"dropshipInventoryNotTracked\": true,\n \"stockPushMaxQuantity\": 1,\n \"stockPushBufferQuantity\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"warehouseGroupId\": 123,\n \"isCustomerSpecific\": true,\n \"tagIds\": [\n 123\n ],\n \"pullOrdersFromOms\": true,\n \"pullOrderAppIntegrationAccountId\": 123,\n \"pullOrderOmsStoreId\": \"<string>\",\n \"pullOrdersFromOmsOptions\": {},\n \"pushOrdersToOms\": true,\n \"pushOrderAppIntegrationAccountId\": 123,\n \"pushOrderOmsStoreId\": \"<string>\",\n \"pushOrderIntegrationMappingId\": 123,\n \"pushStocksToOms\": true,\n \"pushStocksAppIntegrationAccountId\": 123,\n \"pushCostsToOms\": true,\n \"isDropship\": true,\n \"dropshipSupplierId\": 123,\n \"dropshipInventoryNotTracked\": true,\n \"stockPushMaxQuantity\": 1,\n \"stockPushBufferQuantity\": 1\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"uuid": "<string>",
"label": "<string>",
"description": "<string>",
"channelType": "sales_channel",
"apiLocked": true,
"warehouseGroupId": 123,
"warehouseGroup": {},
"storeType": "<string>",
"enabled": true,
"status": 123,
"isPOSChannel": true,
"isCustomerSpecific": true,
"pullOrdersFromOms": true,
"getProductsEnabled": true,
"pushInventoryEnabled": true,
"includeIncomingStocksEnabled": true,
"includeDraftProductsEnabled": 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>",
"stockPushMaxQuantity": 123,
"stockPushBufferQuantity": 123,
"stockPushBufferType": "fixed",
"filters": {},
"restrictions": {},
"credentials": {},
"fees": {},
"createdAt": 123,
"updatedAt": 123,
"createdBy": 123,
"updatedBy": 123
}
}{
"message": "<string>"
}{
"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
application/json
Attach this integration_mappings.id as the channel's PUSH_ORDERS mapping. Omitted keys are preserved (PATCH semantics).
Channel-wide cap on the quantity pushed to the channel for any product. Omit to leave unchanged; null clears it.
Required range:
x >= 0Channel-wide buffer held back from the pushed quantity. Interpreted per stockPushBufferType. Omit to leave unchanged; null clears it.
Required range:
x >= 0How stockPushBufferQuantity is applied — a fixed unit count or a percentage of available stock. Omit to leave unchanged; null clears it.
Available options:
fixed, percent Response
Updated
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