Skip to content

Channel ​

Type: schema

Description ​

A store's sales channel: a storefront (web, app or point of sale) or a marketplace the store sells on. Credentials are masked; a marketplace channel's seller account comes in the seller.account.* events.

TypeScript Definition ​

typescript
Channel: {{
            id: string;
            name: string;
            description: null | string;
            /**
             * @description `web`, `app` or `pos` for a storefront channel; the marketplace's type (`internal` or `external`) for a marketplace channel.
             * @enum {string}
             */
            channel_type: "web" | "app" | "pos" | "internal" | "external";
            /**
             * @description `storefront`, or `marketplace`: the channel sells the store's products on a marketplace.
             * @enum {string}
             */
            kind: "storefront" | "marketplace";
            is_default: boolean;
            /** @description Whether the channel is on. A channel on an internal marketplace starts off and is turned on when the marketplace approves the seller. */
            active: boolean;
            is_production_setup_completed: boolean;
            is_sandbox_setup_completed: boolean;
            created_at: string;
            modified_at: string;
            store_id: string;
            store_name: string;
            /** @description An `app` channel's platform; storefront channels only. */
            app_platform?: string | null;
            /** @description A `pos` channel's vendor; storefront channels only. */
            pos_vendor?: string | null;
            /** @description The storefront's domain; storefront channels only. */
            domain?: string | null;
            /** @description The marketplace a marketplace channel sells on; `null` for a storefront channel. */
            marketplace_id: null | string;
            /** @description The channel's account id at an external marketplace; marketplace channels only. */
            external_id?: string | null;
            /** @description The channel's credentials for the marketplace, masked. */
            production_credentials?: {
                [key: string]: string;
            } | null;
            /** @description As `production_credentials`, for the marketplace's sandbox. */
            sandbox_credentials?: {
                [key: string]: string;
            } | null;
        };
        /** ChildCategory */
}

OpenAPI Schema ​

json
{
  "title": "Channel",
  "description": "A store's sales channel: a storefront (web, app or point of sale) or a marketplace the store sells on. Credentials are masked; a marketplace channel's seller account comes in the `seller.account.*` events.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/Channel",
    "description": "API reference for the Channel schema"
  },
  "required": [
    "active",
    "channel_type",
    "created_at",
    "description",
    "id",
    "is_default",
    "is_production_setup_completed",
    "is_sandbox_setup_completed",
    "kind",
    "marketplace_id",
    "modified_at",
    "name",
    "store_id",
    "store_name"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": [
        "null",
        "string"
      ]
    },
    "channel_type": {
      "description": "`web`, `app` or `pos` for a storefront channel; the marketplace's type (`internal` or `external`) for a marketplace channel.",
      "type": "string",
      "enum": [
        "web",
        "app",
        "pos",
        "internal",
        "external"
      ]
    },
    "kind": {
      "description": "`storefront`, or `marketplace`: the channel sells the store's products on a marketplace.",
      "type": "string",
      "enum": [
        "storefront",
        "marketplace"
      ]
    },
    "is_default": {
      "type": "boolean"
    },
    "active": {
      "description": "Whether the channel is on. A channel on an internal marketplace starts off and is turned on when the marketplace approves the seller.",
      "type": "boolean"
    },
    "is_production_setup_completed": {
      "type": "boolean"
    },
    "is_sandbox_setup_completed": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string"
    },
    "modified_at": {
      "type": "string"
    },
    "store_id": {
      "type": "string"
    },
    "store_name": {
      "type": "string"
    },
    "app_platform": {
      "description": "An `app` channel's platform; storefront channels only.",
      "type": [
        "string",
        "null"
      ]
    },
    "pos_vendor": {
      "description": "A `pos` channel's vendor; storefront channels only.",
      "type": [
        "string",
        "null"
      ]
    },
    "domain": {
      "description": "The storefront's domain; storefront channels only.",
      "type": [
        "string",
        "null"
      ]
    },
    "marketplace_id": {
      "description": "The marketplace a marketplace channel sells on; `null` for a storefront channel.",
      "type": [
        "null",
        "string"
      ]
    },
    "external_id": {
      "description": "The channel's account id at an external marketplace; marketplace channels only.",
      "type": [
        "string",
        "null"
      ]
    },
    "production_credentials": {
      "description": "The channel's credentials for the marketplace, masked.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": "string"
      }
    },
    "sandbox_credentials": {
      "description": "As `production_credentials`, for the marketplace's sandbox.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": "string"
      }
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: