Sign in

v51

OpenAPI 3.0.0raw.githubusercontent.com2026-08-01267339950.6 KB
Ecommerce: Sales channels

Update sales channel

Update a custom sales channel. The merchant-facing name and the public url (returned as the channel domain) can be changed. Pass null to clear a value.

patch/api/ecommerce/v1/stores/{store_id}/sales-channels/{sales_channel_id}

Path parameters

store_idstring required
Example:store_01J8Z5F8W9K8M4A7B3C2D1E0FG

The ID of the store that owns the sales channel.

sales_channel_idstring required
Example:scha_01J8Z5F8W9K8M4A7B3C2D1E0FG

The ID of the sales channel to update.

Request body

namestring nullable

Merchant-facing custom name shown in the sales channels list. Pass null to clear it.

urlstring nullable

Public address where the custom sales channel lives. Pass null to clear it.

Example request

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

Response

Success response

Example response

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