Sign in
Ecommerce: Sales channels

Create a sales channel

Create a sales channel for a store. A "custom" channel is headless: build your own frontend and keep your catalog, orders, shipping and payments in sync through the Ecommerce API. A "quick-link" channel is a hosted one-page store whose handle is auto-generated.

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' | 'quick-link' required

Sales channel type. "custom" is a headless channel: it requires a name and takes an optional public url. "quick-link" is a one-page store whose handle is auto-generated; it supports neither name nor url.

namestring

Merchant-facing custom name. Required for custom channels; not supported for quick-link.

urlstring nullable

Optional public url for the channel. Custom channels only; not supported for quick-link.

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"
  }
}

Changes

Changed in 4 of the 92 revisions of this API.15

  • b94885e042b83See the full diff
    • ○

      api operation id ecommerce_createCustomSalesChannelV1 removed and replaced with ecommerce_createASalesChannelV1

      api-operation-id-removed

    • ○

      the request property became optional

      request-property-became-optional

    • ○

      added the new quick-link enum value to the request property

      request-property-enum-value-added

  • 64006e65f2201See the full diff
    • ○

      api operation id ecommerce_createACustomSalesChannelV1 removed and replaced with ecommerce_createCustomSalesChannelV1

      api-operation-id-removed

  • 4e80123a0ad51See the full diff
    • ○

      endpoint added

      endpoint-added

  • d05574986eb11See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 124 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog