Skip to main content
GET
/
channels
List channels
curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/channels \
  --header 'Authorization: Bearer <token>'
{
  "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
    }
  ],
  "meta": {},
  "links": {}
}

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.

Query Parameters

page
integer
Required range: x >= 1
limit
integer
default:15
Required range: 1 <= x <= 100
sortField
string
sortDirection
enum<string>
Available options:
asc,
desc
label
string

Substring match on channel label.

tagIds
integer[]

Channels that have at least one of the listed tag IDs.

status
integer
isPosChannel
boolean
isCustomerSpecific
boolean
isPushOrderToOms
boolean

When true, filters to channels that have a push-order integration mapping.

channelTypes
string

Comma-separated list of channel types (e.g. sales_channel,end_to_end_channel).

Response

Successful response

data
object[]
meta
object