External stock change reasons

Introduction

External stock change reasons represent user-defined reasons for stock movements within a facility. These reasons can optionally be included in stow line items to explain why a specific action was performed.

The fulfillmenttools platform does not process or react to external stock change reasons. They exist solely for user-defined purposes.

Working with external stock change reasons

External stock change reasons can be handled in one of two ways:

1. Managed externally

   • Reasons are not preconfigured in the platform.

   • Users can provide custom reasons directly when creating stow line items.

   • Note: Custom reasons provided externally are not validated by the platform.

2. Managed Within the Platform

   • Reasons are preconfigured via external stock change reasons REST API.

   • When creating stow line items, preconfigured reasons are linked by specifying either their id or tenantReasonId.

External stock change reasons REST API

To preconfigure an external stock change reason, POST an external stock change reason, providing:

• active: true or false (if set to false, the reason can no longer be linked in stowLineItems)

• optional customAttributes: can contain information of interest to connectors or services outside of the fulfillmenttools platform. The fulfillmenttools platform does not process or react on customAttributes.

• reasonLocalized: Localized reasons, see Localization

• optional tenantReasonId: External identifier. Can be used, e.g., to map reason codes from ERP systems