All Release Notes

Approval Rules can now be extended with Custom Fields

29 October 2024
Composable Commerce
HTTP API
Enhancement
B2BOrdersGraphQL

You can now extend the ApprovalRule resource with Custom Fields. This enhancement allows you to store custom data within your Approval Rule to better meet specific business requirements.

Changes:

  • [API] Added optional custom field to the ApprovalRule type.
  • [API] Added Set Custom Type and Set CustomField update actions to Approval Rules.
  • [API] Added approval-rule to CustomFieldReferenceValue enum.
  • [API] Added approval-rule to ResourceTypeId enum.
  • [GraphQL API] Added the following types to the GraphQL schema: SetApprovalRuleCustomField, SetApprovalRuleCustomType.
  • [GraphQL API] Changed the ApprovalRuleUpdateAction type:
    • Input field setCustomField was added to ApprovalRuleUpdateAction type
    • Input field setCustomType was added to ApprovalRuleUpdateAction type
  • [GraphQL API] Changed the ApprovalRule type:
    • Added the custom field to the ApprovalRule type.

The following changes were introduced in terms of GraphQL SDL:

extend type ApprovalRule {
custom: CustomFieldsType
}
extend input ApprovalRuleUpdateAction {
setCustomField: SetApprovalRuleCustomField
setCustomType: SetApprovalRuleCustomType
}
input SetApprovalRuleCustomField {
name: String!
value: String
}
input SetApprovalRuleCustomType {
fields: [CustomFieldInput!]
type: ResourceIdentifierInput
typeKey: String
typeId: String
}