Scope: sales:sales-channels.write https://api.alladdin.com/api/v2/sales-channels

Creates a new sales channel. Sales channels categorize your revenue streams — for example, Online Store, Retail, or Wholesale — so you can track performance by channel.
The response returns the new sales channel id.

Request body

object name string required

Display name for the sales channel

account_num integer required

Accounting account number

color string | null optional

Hex color code for UI display

Request

import requests

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

payload = {
    "name": "string",
    "account_num": 0,
    "color": "string"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

Responses

Response

{
  "id": "507f1f77bcf86cd799439011"
}

Success responses

201 Sales channel created application/json object id string

Error responses

400 Bad request application/json 401 Invalid or missing API key application/json 403 Insufficient permissions application/json 422 Validation error application/json

Next →Update a sales channel →