Approval Flows can now be extended with Custom Fields | HTTP API

Approval Flows can now be extended with Custom Fields

11 January 2024

Composable Commerce

HTTP API

Enhancement

B2BOrdersGraphQL

You can now extend the ApprovalFlow resource with Custom Fields. With this, you can add meta-information to your Approval Flow in case it is required for your business logic.

Changes:

[API] Added optional custom field to the ApprovalFlow type.
[API] Added Set Custom Type and Set CustomField update actions to Approval Flows.
[API] Added approval-flow to CustomFieldReferenceValue enum.
[API] Added approval-flow to ResourceTypeId enum.
[GraphQL API] Added the following types to the GraphQL schema: SetApprovalFlowCustomField, SetApprovalFlowCustomType.
[GraphQL API] Changed the ApprovalFlowUpdateAction type:
- Input field setCustomField was added to ApprovalFlowUpdateAction type
- Input field setCustomType was added to ApprovalFlowUpdateAction type
[GraphQL API] Changed the ApprovalFlow type:
- Added the custom field to the ApprovalFlow type.

The following changes were introduced in terms of GraphQL SDL:

extend type ApprovalFlow {
  custom: CustomFieldsType
}

extend input ApprovalFlowUpdateAction {
  setCustomField: SetApprovalFlowCustomField
  setCustomType: SetApprovalFlowCustomType
}

input SetApprovalFlowCustomField {
  name: String!
  value: String
}

input SetApprovalFlowCustomType {
  fields: [CustomFieldInput!]
  type: ResourceIdentifierInput
  typeKey: String
  typeId: String
}