Skip to content

StoreConfigSalesChannel ​

Type: schema

Description ​

Sales channel summary embedded in StoreConfig warehouse listings.

TypeScript Definition ​

typescript
StoreConfigSalesChannel: {{
            id: string;
            name: $Read<string>;
            /** @enum {string} */
            kind?: "storefront" | "marketplace";
            active: $Read<boolean>;
        };
        /** StoreConfigServiceProvider */
}

OpenAPI Schema ​

json
{
  "title": "StoreConfigSalesChannel",
  "description": "Sales channel summary embedded in `StoreConfig` warehouse listings.",
  "type": "object",
  "required": [
    "id",
    "name",
    "active"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "readOnly": true
    },
    "kind": {
      "type": "string",
      "enum": [
        "storefront",
        "marketplace"
      ]
    },
    "active": {
      "type": "boolean",
      "readOnly": true
    }
  },
  "x-tags": [
    "Store"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: