ValidateReturnQty
Changed on:
30 Nov 2023
Overview
The rule provides the foundation to validate that the return request is valid.
| Plugin Name | Order Reference Module |
|---|---|
| Namespace | [[account.id]].order |
The Order Reference Module is the foundation for order-related implementations. It provides reference workflows for click & collect, home delivery and mixed baskets and those needed to build your own. Extensible by design, use this Module as a base to build a solution to your customers' needs.
UI Description
Provides the foundation to validate that the return request is valid. When a return is initiated for an existing order, a return entity is created and the rule validates if ReturnOrder can be processed based on order item qty passed in event attributes.
Accepts
- ORDER
Actions
- This rule produces createReturn mutation.
Rule parameters
This rule does not identify any input parameters.
Event attributes
Parameter | Description | Data Type | Required? |
returnItems | The list of return items | Array list | Required |
Exceptions
This rule will throw an IllegalArgumentException
- if the property is not provided
`accountId/entityId` - if the order is not found or invalid
- if a return item is invalid
All generated exceptions will be wrapped with RubixException: 422
Configuration example
1{
2 "name": "<ACCOUNTID>.order.ValidateReturnQty",
3 "props": {}
4}Language: json
Version History
v1.0.0
refers to plugin
