Skip to main content
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 '
{
  "channelType": "sales_channel",
  "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": [
    {}
  ]
}
'
{
  "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,
    "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
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.joinluminous.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
channelType
enum<string>
required
Available options:
sales_channel,
fulfillment_channel,
end_to_end_channel
​
label
string
required

Must be unique among active/disabled channels.

​
description
string | null
​
warehouseGroupId
integer | null

Required for sales_channel. Required for fulfillment/e2e unless dropship with dropshipInventoryNotTracked: true.

​
isCustomerSpecific
boolean | null
​
tagIds
integer[]
​
pullOrdersFromOms
boolean | null

Sales/e2e channels.

​
pullOrderAppIntegrationAccountId
integer

Required when pullOrdersFromOms is true.

​
pullOrderOmsStoreId
string

Required when pullOrdersFromOms is true and the integration app requires a store ID.

​
pullOrdersFromOmsOptions
object
​
pushOrdersToOms
boolean | null

Fulfillment/e2e channels.

​
pushOrderAppIntegrationAccountId
integer

Required when pushOrdersToOms is true.

​
pushOrderOmsStoreId
string
​
pushStocksToOms
boolean | null
​
pushStocksAppIntegrationAccountId
integer | null
​
pushCostsToOms
boolean | null
​
isDropship
boolean | null
​
dropshipSupplierId
integer | null
​
dropshipInventoryNotTracked
boolean | null
​
integrationProducts
object[]

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: 500

Response

Created

​
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.