orderApprovalRuleStatusUpdate

Mutationin Order approval

Turn an order approval rule on or off

Arguments

Argument	Type	Description
`businessUnitId`	`ID!`
`id`	`ID!`
`version`	`String`	Expected optimistic-concurrency token, to fail the write if the rule changed meanwhile. Omit to update the current version; engines without versioning ignore it.
`status`	`OrderApprovalRuleStatusType!`

Returns

OrderApprovalRuleResponse!

Field	Type	Description
`orderApprovalRule`	`OrderApprovalRule`	The created or updated rule
`orderApprovalRuleErrors`	`[OrderApprovalRuleError!]`	Error details if the operation failed

Example

mutation OrderApprovalRuleStatusUpdate(
  $businessUnitId: ID!
  $id: ID!
  $version: String
  $status: OrderApprovalRuleStatusType!
) {
  orderApprovalRuleStatusUpdate(
    businessUnitId: $businessUnitId
    id: $id
    version: $version
    status: $status
  ) {
    orderApprovalRule {
      id
      version
      key
      name
      description
      status
      conditionEditable
      predicate
      requesterRoleKeys
    }
    orderApprovalRuleErrors {
      __typename
      ... on ValidationError {
        message
      }
    }
  }
}

{
  "businessUnitId": "id-1",
  "id": "id-1",
  "version": "Example",
  "status": "ACTIVE"
}

{
  "data": {
    "orderApprovalRuleStatusUpdate": {
      "orderApprovalRule": {
        "id": "id-1",
        "version": "Example",
        "key": "Example",
        "name": "Example",
        "description": "Example",
        "status": "ACTIVE",
        "conditionEditable": true,
        "predicate": "Example",
        "requesterRoleKeys": [
          "Example"
        ]
      },
      "orderApprovalRuleErrors": [
        {
          "__typename": "ValidationError",
          "message": "Example"
        }
      ]
    }
  }
}

The query selects the return type's fields two levels deep; pick the ones you need. The response shows its shape with placeholder values.

Served by

@evolve-framework/commercetools	Resolved
@evolve-framework/medusa	Resolved
@evolve-framework/sfcc	Resolved

Used by

The storefront packages that send it, in these GraphQL documents:

@evolve-storefront/feature-organization: OrderApprovalRuleStatusUpdate