checkoutTreeCheck

Required scopes: checkout_read

Arguments

CheckoutTreeDefinitionInput!

required

The whole tree to check.

Show fields

[CheckoutTreeEdgeInput!]!

required

Its edges. A port leads to at most one step.

Show fields

String!

required

The step it leaves, or "trigger" for the start.

String!

required

next from the start; matching, nonMatching or an edge id from a segment; a treatment id (or, before the split is saved, its name) from a split.

String!

required

The step it leads to.

[CheckoutTreeStepInput!]!

required

Its steps.

Show fields

JSON!

required

The step’s settings, matching configJsonSchema on its steps/<type> page in checkoutTreeCatalog.

String!

required

The step’s id, unique in the tree. Keep a saved step’s id; a new step may use any word and gets an id when saved.

String

A name for the step.

CheckoutTreeStepType!

required

What the step does.

Returns

[CheckoutTreeDiagnostic!]!

required

A problem in a checkout tree.

Show fields

CheckoutTreeDiagnosticBlocks!

required

What it stops.

String!

required

A stable code, such as CT0105. Read diagnostics/<code> in checkoutTreeCatalog.

String!

required

What is wrong.

String

The step it is on; null for the tree as a whole.

Example

query {
  checkoutTreeCheck(definition: { ... }) {
    blocks
    code
    message
    stepId
  }
}

Getting Started

Guides

Reference

checkoutTreeCheck

Arguments

Returns

Example

​Arguments

​Returns

​Example

Arguments

Returns

Example