Skip to main content

Tag

Introduction

The Tag entity defines reusable labels that can be applied to various entities throughout the system (orders, commodities, contacts, inventory items). Tags enable flexible categorization, filtering, and organization of business data without modifying entity schemas.

Entity Structure

Properties

Property NameTypeRequiredDescription
TagIdintYesPrimary key
NamestringYesTag name (e.g., "urgent", "fragile", "high-value")
Colorstring?NoHex color code for UI display (e.g., "#FF5733")
OrganizationIdintYesOrganization owning this tag
Descriptionstring?NoOptional tag description
CreatedDateTimeYesCreation timestamp
CreatedBystringYesUser who created the tag
LastModifiedDateTimeYesLast modification timestamp
LastModifiedBystringYesUser who last modified

Relationships

RelationshipTypeDescription
OrderTagsICollection<OrderTag>Junction to orders using this tag
CommodityTagsICollection<CommodityTag>Junction to commodities using this tag
InventoryItemTagsICollection<InventoryItemTag>Junction to inventory items using this tag
OrganizationOrganizationParent organization

Usage

Tags are typically applied when creating or updating entities:

# Create order with tags
- task: Order/Create@1
name: createOrder
inputs:
organizationId: ${organizationId}
order:
orderNumber: "ORD-001"
tags:
- "urgent"
- "high-priority"
- "temperature-controlled"