Order editing workflows now offer direct session access via mutation arguments and return fields

In API version 2025-10, we've enhanced order editing workflows, making them more flexible and improving traceability features. These updates expand mutation ID compatibility and add session details to return fields, making it easier to track and manage order editing sessions.

What's New

Direct order edit session access

Now, you can directly access order edit sessions through the id field on the OrderEditSession object, enhancing the tracking of changes throughout your order editing workflow.

Enhanced mutation ID flexibility

Order editing mutations now accept IDs from both CalculatedOrder and OrderEditSession objects. This enhancement provides greater flexibility in your application architecture by supporting different workflows based on session context.

Affected mutations:

• OrderEditAddCustomItem
• OrderEditAddLineItemDiscount
• OrderEditAddShippingLine
• OrderEditAddVariant
• OrderEditCommit
• OrderEditRemoveDiscount
• OrderEditRemoveShippingLine
• OrderEditRemoveLineItemDiscount
• OrderEditSetQuantity
• OrderEditUpdateDiscount
• OrderEditUpdateShippingLine

Expanded return fields

Order editing mutations now return an orderEditSession field, enabling you to use the session id in subsequent mutation calls for improved workflow continuity. This enhancement applies to all mutations listed above, plus:

• OrderEditBegin

These improvements provide a more flexible approach to managing order editing workflows while maintaining full traceability of session changes.