Create Replacement Order

Configure the CreateReplacementOrder project action to automatically create a replacement order from a linked return.

Overview

The Create Replacement Order action creates a new replacement order directly from the return order form linked to the project. It determines which line items to replace, creates a cart, validates it, and immediately converts it to an order.

Use this when you want the replacement order placed automatically as part of a project workflow step, without requiring the agent to manually create it.

Key behaviours:

  • Line items and quantities are derived from the return order form — no manual selection required
  • The replacement order is linked back to the original order via ReplacementOrderIds
  • The project ID is attached to both the replacement order and the original order
  • A log entry is added to the project on success

Identifier

PropertyValue
KeyCreateReplacementOrder
GroupProject Actions

Configuration

No properties are required. The action resolves the linked order and return form automatically.

{
  "name": "CreateReplacementOrder",
  "active": true
}

All Available Options

PropertyRequiredTypeDescription
nameYesstringMust be CreateReplacementOrder
StopOnErrorNobooleanCancel the workflow if the order creation fails
TranslateKeyNostringTranslation key shown in the UI action log

Requirements

  • The project must be linked to an order via a claim
  • The return order form must have line items with a return quantity set
  • Cart validation must pass before the order is placed

Error Handling

ConditionResultContinues Workflow?
Replacement order created successfullySuccessYes
No linked order foundErrorYes
Cart validation failedErrorYes
No returnable line items foundNo result (silent)Yes

On this page