Skip to content

SalesChannel ​

Type: schema

TypeScript Definition ​

typescript
SalesChannel: {{
            id: string;
            name: $Read<string>;
            /** @enum {string} */
            kind?: "storefront" | "marketplace";
            active: $Read<boolean>;
            /** @description Observed values: `commercengine`, `web`, `pos`. */
            sales_channel_type?: $Read<string | null>;
            sales_channel_slug?: $Read<string | null>;
        };
        /**
         * SearchProduct
         * @description Payload for searching products.
         */
}

OpenAPI Schema ​

json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "readOnly": true
    },
    "kind": {
      "type": "string",
      "enum": [
        "storefront",
        "marketplace"
      ]
    },
    "active": {
      "type": "boolean",
      "readOnly": true
    },
    "sales_channel_type": {
      "description": "Observed values: `commercengine`, `web`, `pos`.",
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "sales_channel_slug": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    }
  },
  "required": [
    "id",
    "name",
    "active"
  ],
  "title": "SalesChannel"
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: