Skip to content

brando:externalSystemId

A Brando Property Defined in the Brando® vocabulary.

Thing > Intangible > Multiple types :: externalSystemId (brando:Brand, brando:Context, brando:Policy, brando:Campaign, brando:AutomationRule, brando:ProductItem)

Canonical URL: https://brandoschema.com/properties/externalSystemId Check for open issues.

Description

System-specific identifier for the corresponding object in an external tool or platform (for example a brand record, workspace, guideline set, ad account, product record, or project ID).

brando:externalSystemId is used by Brand OS plugins and integrations to bind Brando nodes (such as brando:Brand, brando:Context, brando:Policy, brando:Campaign, brando:AutomationRule, or brando:ProductItem) to concrete entities in systems like retail product catalogues, CMSs, DAMs, ad platforms, design tools, or internal marketing systems.

This property does not need to be globally unique on its own; values are typically scoped to a specific system. A common pattern is to use a simple prefix convention:

systemKey:nativeId

Examples:

  • retail-catalog:12345 – product ID in a retail catalogue
  • ad-platform:act_987654321 – advertising account ID
  • design-tool:file_ABC123 – design file ID
  • cms:brand_001 – brand node in a CMS
  • pim:SKU-8888 – product identifier in a PIM

If a node participates in multiple systems, brando:externalSystemId may be repeated with one value per system.

For linking to the external application itself (rather than an object identifier within it), use brando:externalSystem pointing to a schema:SoftwareApplication node.

Values expected to be one of these types

  • Text
  • List of Text values

Used on these types

Example (JSON-LD)

{
  "@context": {
    "schema": "https://schema.org/",
    "brando": "https://brandoschema.com/"
  },
  "@id": "https://brandoschema.com/brand/example",
  "@type": "brando:Brand",
  "schema:name": "Example Brand",
  "brando:externalSystem": {
    "@id": "https://apps.example.com/brand-os",
    "@type": "schema:SoftwareApplication",
    "schema:name": "Brand Management Platform"
  },
  "brando:externalSystemId": [
    "brand-platform:workspace_abc123",
    "cms:brand_001"
  ]
}

Example (YAML)

@context:
  schema: https://schema.org/
  brando: https://brandoschema.com/

@id: https://brandoschema.com/brand/example
@type: brando:Brand
schema:name: Example Brand

brando:externalSystem:
  '@id': https://apps.example.com/brand-os
  '@type': schema:SoftwareApplication
  schema:name: Brand Management Platform

brando:externalSystemId:
  - "brand-platform:workspace_abc123"
  - "cms:brand_001"

Acknowledgements

This element is based on the work of Advanced Analytica. Many Type and Property definitions are inspired by extensive analysis of brand guidelines, governance systems, and AI content-safety practices.