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: string | null;
            /**
             * @description json object having key - value pair.
             *
             *     example - {"facebook": "www.facebook.com/commecengine"}
             */
            social_media_links: {
                [key: string]: string;
            };
        };
        /** Business */
}

OpenAPI Schema

json
{
  "title": "Brand",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/Brand",
    "description": "API reference for the Brand schema"
  },
  "required": [
    "name",
    "logo_url",
    "social_media_links"
  ],
  "properties": {
    "name": {
      "description": "brand name. it will be used in emails and other communications.",
      "type": "string"
    },
    "logo_url": {
      "type": [
        "string",
        "null"
      ]
    },
    "social_media_links": {
      "description": "json object having key - value pair.\r\n\r\nexample - {\"facebook\": \"www.facebook.com/commecengine\"}",
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: