Skip to main content
GET
/
channels
/
{channelId}
Get channel
curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/channels/{channelId} \
  --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
  }
}

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.

Path Parameters

channelId
integer
required

Response

Successful response

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.