VTEX · Schema

Available Sales Channel

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
isSelected boolean Flag defining if the sales channel (or [trade policy](https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV#master-data)) is selected or not.
id integer Sales Channel's ID.
name string Name of the Sales Channel.
View JSON Schema on GitHub

JSON Schema

vtex-availablesaleschannel-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AvailableSalesChannel",
  "title": "Available Sales Channel",
  "required": [
    "isSelected",
    "id",
    "name"
  ],
  "type": "object",
  "properties": {
    "isSelected": {
      "type": "boolean",
      "description": "Flag defining if the sales channel (or [trade policy](https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV#master-data)) is selected or not.",
      "default": true
    },
    "id": {
      "type": "integer",
      "description": "Sales Channel's ID.",
      "default": 1
    },
    "name": {
      "type": "string",
      "description": "Name of the Sales Channel.",
      "default": "Main Store"
    }
  },
  "example": {
    "isSelected": true,
    "id": 1,
    "name": "Loja Principal"
  }
}