Skip to content

Brand ​

Type: schema

TypeScript Definition ​

typescript
Brand: {{
            /** @description brand name. it will be used in emails and other communications. */
            name?: string;
            logo_url?: $Read<string | null>;
            /** @description Media gallery file id for the brand logo. Omitted or `null` when no logo file is linked. */
            file_id?: string | null;
            /**
             * @description json object having key - value pair.
             *
             *     example - {"facebook": "www.facebook.com/commecengine"}
             */
            social_media_links?: {
                [key: string]: string;
            } | null;
        } & {
            [key: string]: unknown;
        };
        /** Business */
}

OpenAPI Schema ​

json
{
  "title": "Brand",
  "type": "object",
  "properties": {
    "name": {
      "description": "brand name. it will be used in emails and other communications.",
      "type": "string"
    },
    "logo_url": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "file_id": {
      "description": "Media gallery file id for the brand logo. Omitted or `null` when no logo file is linked.",
      "type": [
        "string",
        "null"
      ]
    },
    "social_media_links": {
      "description": "json object having key - value pair.\r\n\r\nexample - {\"facebook\": \"www.facebook.com/commecengine\"}",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "additionalProperties": true,
  "x-tags": [
    "Store"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: