Create channel
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/channels \
--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>",
"pushStocksToOms": true,
"pushStocksAppIntegrationAccountId": 123,
"pushCostsToOms": true,
"isDropship": true,
"dropshipSupplierId": 123,
"dropshipInventoryNotTracked": true,
"integrationProducts": [
{}
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/channels"
payload = {
"label": "<string>",
"description": "<string>",
"warehouseGroupId": 123,
"isCustomerSpecific": True,
"tagIds": [123],
"pullOrdersFromOms": True,
"pullOrderAppIntegrationAccountId": 123,
"pullOrderOmsStoreId": "<string>",
"pullOrdersFromOmsOptions": {},
"pushOrdersToOms": True,
"pushOrderAppIntegrationAccountId": 123,
"pushOrderOmsStoreId": "<string>",
"pushStocksToOms": True,
"pushStocksAppIntegrationAccountId": 123,
"pushCostsToOms": True,
"isDropship": True,
"dropshipSupplierId": 123,
"dropshipInventoryNotTracked": True,
"integrationProducts": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
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>',
pushStocksToOms: true,
pushStocksAppIntegrationAccountId: 123,
pushCostsToOms: true,
isDropship: true,
dropshipSupplierId: 123,
dropshipInventoryNotTracked: true,
integrationProducts: [{}]
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/channels', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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>',
'pushStocksToOms' => true,
'pushStocksAppIntegrationAccountId' => 123,
'pushCostsToOms' => true,
'isDropship' => true,
'dropshipSupplierId' => 123,
'dropshipInventoryNotTracked' => true,
'integrationProducts' => [
[
]
]
]),
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"
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 \"pushStocksToOms\": true,\n \"pushStocksAppIntegrationAccountId\": 123,\n \"pushCostsToOms\": true,\n \"isDropship\": true,\n \"dropshipSupplierId\": 123,\n \"dropshipInventoryNotTracked\": true,\n \"integrationProducts\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://{companyName}.api.joinluminous.com/external/api/v1/channels")
.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 \"pushStocksToOms\": true,\n \"pushStocksAppIntegrationAccountId\": 123,\n \"pushCostsToOms\": true,\n \"isDropship\": true,\n \"dropshipSupplierId\": 123,\n \"dropshipInventoryNotTracked\": true,\n \"integrationProducts\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/channels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.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 \"pushStocksToOms\": true,\n \"pushStocksAppIntegrationAccountId\": 123,\n \"pushCostsToOms\": true,\n \"isDropship\": true,\n \"dropshipSupplierId\": 123,\n \"dropshipInventoryNotTracked\": true,\n \"integrationProducts\": [\n {}\n ]\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>"
}Channels
Create channel
Create a channel of any type (sales_channel, fulfillment_channel, end_to_end_channel). New channels are
created unlocked (apiLocked: false). Many fields are conditionally required based on channelType and
the OMS integrations enabled — see the description on each property.
POST
/
channels
Create channel
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/channels \
--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>",
"pushStocksToOms": true,
"pushStocksAppIntegrationAccountId": 123,
"pushCostsToOms": true,
"isDropship": true,
"dropshipSupplierId": 123,
"dropshipInventoryNotTracked": true,
"integrationProducts": [
{}
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/channels"
payload = {
"label": "<string>",
"description": "<string>",
"warehouseGroupId": 123,
"isCustomerSpecific": True,
"tagIds": [123],
"pullOrdersFromOms": True,
"pullOrderAppIntegrationAccountId": 123,
"pullOrderOmsStoreId": "<string>",
"pullOrdersFromOmsOptions": {},
"pushOrdersToOms": True,
"pushOrderAppIntegrationAccountId": 123,
"pushOrderOmsStoreId": "<string>",
"pushStocksToOms": True,
"pushStocksAppIntegrationAccountId": 123,
"pushCostsToOms": True,
"isDropship": True,
"dropshipSupplierId": 123,
"dropshipInventoryNotTracked": True,
"integrationProducts": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
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>',
pushStocksToOms: true,
pushStocksAppIntegrationAccountId: 123,
pushCostsToOms: true,
isDropship: true,
dropshipSupplierId: 123,
dropshipInventoryNotTracked: true,
integrationProducts: [{}]
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/channels', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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>',
'pushStocksToOms' => true,
'pushStocksAppIntegrationAccountId' => 123,
'pushCostsToOms' => true,
'isDropship' => true,
'dropshipSupplierId' => 123,
'dropshipInventoryNotTracked' => true,
'integrationProducts' => [
[
]
]
]),
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"
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 \"pushStocksToOms\": true,\n \"pushStocksAppIntegrationAccountId\": 123,\n \"pushCostsToOms\": true,\n \"isDropship\": true,\n \"dropshipSupplierId\": 123,\n \"dropshipInventoryNotTracked\": true,\n \"integrationProducts\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://{companyName}.api.joinluminous.com/external/api/v1/channels")
.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 \"pushStocksToOms\": true,\n \"pushStocksAppIntegrationAccountId\": 123,\n \"pushCostsToOms\": true,\n \"isDropship\": true,\n \"dropshipSupplierId\": 123,\n \"dropshipInventoryNotTracked\": true,\n \"integrationProducts\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/channels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.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 \"pushStocksToOms\": true,\n \"pushStocksAppIntegrationAccountId\": 123,\n \"pushCostsToOms\": true,\n \"isDropship\": true,\n \"dropshipSupplierId\": 123,\n \"dropshipInventoryNotTracked\": true,\n \"integrationProducts\": [\n {}\n ]\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>"
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Body
application/json
Available options:
sales_channel, fulfillment_channel, end_to_end_channel Must be unique among active/disabled channels.
Required for sales_channel. Required for fulfillment/e2e unless dropship with dropshipInventoryNotTracked: true.
Sales/e2e channels.
Required when pullOrdersFromOms is true.
Required when pullOrdersFromOms is true and the integration app requires a store ID.
Fulfillment/e2e channels.
Required when pushOrdersToOms is true.
Optional. Inline batch of channel SKU → Luminous SKU mappings to create alongside the channel,
equivalent to following up with POST /channels/{id}/integration-products.
Maximum array length:
500Response
Created
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
⌘I