BigCommerce · Schema

CreateChannelReq

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
config_meta object
external_id object
is_listable_from_ui object
is_visible object
status object
name object
type object
platform object
View JSON Schema on GitHub

JSON Schema

bigcommerce-createchannelreq-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateChannelReq",
  "title": "CreateChannelReq",
  "type": "object",
  "properties": {
    "config_meta": {
      "$ref": "#/components/schemas/ChannelConfigMeta"
    },
    "external_id": {
      "$ref": "#/components/schemas/ExternalId"
    },
    "is_listable_from_ui": {
      "$ref": "#/components/schemas/IsListableFromUI"
    },
    "is_visible": {
      "$ref": "#/components/schemas/IsVisible"
    },
    "status": {
      "$ref": "#/components/schemas/ChannelStatus"
    },
    "name": {
      "$ref": "#/components/schemas/ChannelName"
    },
    "type": {
      "$ref": "#/components/schemas/ChannelType"
    },
    "platform": {
      "$ref": "#/components/schemas/ChannelPlatform"
    }
  },
  "required": [
    "name",
    "type",
    "platform"
  ],
  "x-internal": false,
  "x-examples": {
    "example-1": {
      "config_meta": {
        "app": {
          "id": 0,
          "sections": [
            {
              "title": "\"Settings\"",
              "query_path": "string"
            }
          ]
        }
      },
      "external_id": "string",
      "is_listable_from_ui": true,
      "is_visible": true,
      "status": "active",
      "name": "string",
      "type": "pos",
      "platform": "string"
    }
  }
}