v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-03269339953.6 KB
Ecommerce: Sales channels

Create custom sales channel

Create a custom sales channel for a store. Build your own frontend and keep your catalog, orders, shipping and payments in sync through the Ecommerce API.

post/api/ecommerce/v1/stores/{store_id}/sales-channels

Path parameters

store_idstring required
Example:store_01J8Z5F8W9K8M4A7B3C2D1E0FG

The ID of the store to create the sales channel for.

Request body

type'custom' required

Sales channel type. Only "custom" channels can be created via the API.

namestring required

Merchant-facing custom name shown in the sales channels list.

urlstring nullable

Optional public address where the custom sales channel lives.

Example request

{
  "type": "custom",
  "name": "Vintagio Onepager",
  "url": "https://www.bestshirt.vintagio.com"
}

Response

Created response

Example response

{
  "sales_channel": {
    "id": "scha_01J8Z5F8W9K8M4A7B3C2D1E0FG",
    "type": "custom",
    "is_active": true,
    "name": "Vintagio Onepager",
    "domain": "https://www.bestshirt.vintagio.com"
  }
}