Skip to main content

OrderTag

Introduction​

OrderTag is a junction entity that enables tagging of orders with custom labels for categorization, filtering, and organization. This many-to-many relationship allows multiple tags to be assigned to a single order and the same tag to be used across multiple orders.

Entity Structure​

Properties​

Property NameTypeRequiredDescription
OrderTagIdintYesPrimary key
OrderIdintYesForeign key to Order
TagIdintYesForeign key to Tag
CreatedDateTimeYesCreation timestamp
CreatedBystringYesUser who created the record
LastModifiedDateTimeYesLast modification timestamp
LastModifiedBystringYesUser who last modified

Relationships​

RelationshipTypeDescription
OrderOrderParent order
TagTagAssociated tag

YAML Configuration​

Tags are typically managed through Order methods:

# Create order with tags
- task: Order/Create@1
name: createOrder
inputs:
organizationId: ${organizationId}
order:
orderNumber: "ORD-2025-001"
orderType: OceanShipmentOrder
tags:
- "urgent"
- "fragile"
- "high-value"

Usage​

This junction entity is managed automatically when tags are assigned to orders. Tags enable:

  • Quick filtering of orders by category
  • Visual organization in dashboards
  • Workflow triggers based on tag presence
  • Reporting and analytics grouping