Order approval GraphQL

Served by OrderApprovalModule on commercetools, OrderApprovalModule on medusa and OrderApprovalModule on sfcc.

Each operation has its own page with its arguments, an example and the engines that serve it. The types link to their fields on the order approval types page.

Operations

Operation	Description	Served by
`orderApprovalRuleCreate`Mutation	Create an order approval rule for a business unit.	commercetoolsmedusasfcc
`orderApprovalRuleDelete`Mutation	Deactivate an order approval rule; a rule is never removed	commercetoolsmedusasfcc
`orderApprovalRuleStatusUpdate`Mutation	Turn an order approval rule on or off	commercetoolsmedusasfcc
`orderApprovalRuleUpdate`Mutation	Change the fields of an order approval rule that are given, and leave the rest as they are.	commercetoolsmedusasfcc
`orderApprovalStatusUpdate`Mutation	Approve or reject an order approval flow.	commercetoolsmedusasfcc

Types

Type	Description
`CartApprovalRequirement`Object	What placing a cart now waits for.
`MoneyInput`Input object	An amount of money in a currency's minor units, e.g.
`OrderApproval`Object	An order awaiting or having completed approval
`OrderApprovalApprover`Object	A person who may approve, by name, for a notice to say who an order waits for
`OrderApprovalClause`Union	One condition on an order
`OrderApprovalClauseInput`Input object	One condition on an order.
`OrderApprovalComparisonOperatorType`Enum	How a clause compares a number or a value
`OrderApprovalCondition`Object	Which orders a rule applies to.
`OrderApprovalConditionInput`Input object	Which orders a rule applies to.
`OrderApprovalCustomFieldClause`Object	An order custom field compared with a value
`OrderApprovalCustomFieldClauseInput`Input object	An order custom field compared with a value.
`OrderApprovalDecision`Object	A recorded approval decision
`OrderApprovalError`Union
`OrderApprovalMatchType`Enum	Whether a condition needs every clause to hold or any one of them
`OrderApprovalQuantityClause`Object	A line's quantity compared with a number.
`OrderApprovalQuantityClauseInput`Input object	A line's quantity compared with a number.
`OrderApprovalRejection`Object	A recorded rejection decision
`OrderApprovalResponse`Object
`OrderApprovalResult`Object	Paginated approval queue with per-status counts
`OrderApprovalRoleGroup`Object	Any one of these roles approves for the group.
`OrderApprovalRoleGroupInput`Input object	Any one of these roles approves for the group.
`OrderApprovalRule`Object	A B2B order approval rule
`OrderApprovalRuleCreateInput`Input object	Input to create an order approval rule
`OrderApprovalRuleError`Union
`OrderApprovalRuleReference`Object	The approval rule an order meets, by the name a buyer is shown.
`OrderApprovalRuleResponse`Object
`OrderApprovalRuleResult`Object	Paginated result containing order approval rules
`OrderApprovalRuleStatusType`Enum	Whether an approval rule is currently in effect
`OrderApprovalRuleUpdateInput`Input object	Partial: only the fields given are changed.
`OrderApprovalSetOperatorType`Enum	Whether a clause holds for values in a list or outside it
`OrderApprovalShippingCountryClause`Object	Whether the order ships to one of these countries
`OrderApprovalShippingCountryClauseInput`Input object	Whether the order ships to one of these countries
`OrderApprovalSkuClause`Object	Whether the order has a line with one of these SKUs
`OrderApprovalSkuClauseInput`Input object	Whether the order has a line with one of these SKUs
`OrderApprovalStatusType`Enum	Status of an order approval flow
`OrderApprovalTier`Object	Tiers approve in order; within a tier, every group must approve.
`OrderApprovalTierInput`Input object	Tiers approve in order; within a tier, every group must approve.
`OrderApprovalTotalClause`Object	The order total compared with an amount.
`OrderApprovalTotalClauseInput`Input object	The order total compared with an amount, for orders in its currency

Fields on other types

This domain adds these fields to types that another domain defines.

`BusinessUnit`

Field	Type	Description
`orderApprovals`	`OrderApprovalResult!`	Approval queue for the business unit, optionally filtered by statusArguments: `status`, `page`, `pageSize`
`orderApprovalRule`	`OrderApprovalRule`	One approval rule of the business unit, or null when it has none by that idArguments: `id`
`orderApprovalRules`	`OrderApprovalRuleResult!`	Approval rules configured for the business unit, optionally by statusArguments: `status`, `page`, `pageSize`

`Cart`

Field	Type	Description
`approvalRequirement`	`CartApprovalRequirement`	What placing the cart now waits for. Null when it needs no approval, and for a cart that is not a business unit's.

`Order`

Field	Type	Description
`approval`	`OrderApproval`	Approval flow for this order, so its status can be shown wherever the order appears rather than by searching the queue and joining back. Null where the order needed no approval, and null where the caller may not see the flow -- visibility follows the caller's associate permissions, which commercetools decides.

`OrderPlaceResponse`

Field	Type	Description
`approval`	`OrderApproval`	Why an order that was just placed cannot be paid yet, when an approval flow is the reason. Read authoritatively rather than through the caller, so it is present even for someone who may not query the flow off the order itself. Absent where the order needed no approval, or where it did and has been decided.