Generate External ID

Overview

The Generate External ID step creates a unique external identifier for the return. This ID can be used for integration with external systems that require their own reference numbers.

Identifier

Property	Value
Key	`GenerateExternalId`
Group	Enrichment

Configuration Properties

Property	Type	Required	Description
Provider	string	No	External ID provider name (stored with the ID)
Format	string	No	ID format pattern

Behavior

What It Does

Generates a unique identifier based on configured format
Stores the ID in the return's external IDs collection
Associates the provider name for identification

Prerequisites

Number sequence or ID generation logic must be configured
External ID provider name should be specified

Side Effects

Adds external ID to return
Increments ID sequence if applicable

Business Cases

When to Use

Creating references for ERP systems
Generating IDs for third-party integrations
When external systems need their own reference numbers
Multi-system synchronization

Example Scenarios

ERP Reference Generate external ID "ERP-RET-2024-001" with provider "ERP" for syncing to enterprise system.

Fulfillment System Generate external ID "WMS-RET-12345" with provider "Warehouse" for warehouse management system.

Sample Configuration

{
  "Name": "GenerateExternalId",
  "Active": true,
  "TranslateKey": "WorkflowStep_GenerateExternalId",
  "Properties": [
    { "Name": "Provider", "Value": "ERP" }
  ]
}

Error Handling

Condition	Result	Continues Workflow?
ID generated	Success	Yes
ID already exists for provider	Success (skipped)	Yes
Generation failed	Error	Depends on StopOnError

Ensure RMA - Different tracking number for customer-facing use
Export Order - Use external ID when exporting

Generate External ID

On this page