Scope: sales:sales-channels.read https://api.alladdin.com/api/v2/sales-channels/{salesChannelId}

Retrieves the details of a single sales channel by its unique identifier.
The response includes the channel name, color, accounting number, and archived status.

Parameters

Path parameters

salesChannelId string required

Sales Channel ID (24-char hex ObjectId)

Request

import requests

url = "https://api.alladdin.com/api/v2/sales-channels/{salesChannelId}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())

Responses

Response

{
  "id": "507f1f77bcf86cd799439011",
  "name": "Office Expenses",
  "color": "#FF5733",
  "account_num": 6290001,
  "archived": false,
  "description": "string"
}

Success responses

200 Sales channel found application/json object id string

Unique identifier of the accounting account

name string

Display name of the accounting account

color string

Hex color code used in the UI

account_num integer

Numeric accounting code from the chart of accounts

archived boolean

Whether the account is archived

description string | null

Description of the accounting account

Error responses

401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Sales channel not found application/json

← PreviousList all sales channels →

Next →Delete a sales channel →