fulfillmentAutomationCheck

Required scopes: shipping_read

Arguments

FulfillmentAutomationDefinitionInput!

required

The whole automation to check.

Show fields

String

A note on the rule.

[FulfillmentAutomationEdgeInput!]!

required

How fulfillments move from the trigger through the steps.

Show fields

String!

required

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

String!

required

The port: next, or a condition’s true or false.

String!

required

The step it leads to.

String!

required

The rule’s name.

String

The checker rules to hold it to, one of 2026-11. Omitted: the newest, 2026-11.

[FulfillmentAutomationStepInput!]!

required

The steps, at most 200.

Show fields

JSON!

required

The kind’s settings, matching its configJsonSchema in fulfillmentAutomationKinds.

String!

required

The step’s id, unique in the automation. Not "trigger" or "end".

String

The condition or action, such as ORDER_TAG or SET_PARCEL; omit for a code step.

String

The step’s name in the editor.

FulfillmentAutomationStepType!

required

What the step does.

FulfillmentAutomationTrigger!

required

What starts it. An existing automation’s trigger can’t change: create a new one instead.

Returns

[FulfillmentAutomationDiagnostic!]!

required

A problem found checking a fulfillment automation. diagnostics/<code> in fulfillmentAutomationCatalog explains it.

Show fields

String!

required

A stable code, such as FA0202.

Int

The edge it concerns, by its index in the definition’s edges; null when it isn’t about one edge.

String!

required

What’s wrong.

String!

required

The rules version the rule arrived in.

FulfillmentAutomationDiagnosticSeverity!

required

How much it matters.

String

The step it concerns; null for the whole automation.

Example

query {
  fulfillmentAutomationCheck(definition: { ... }) {
    code
    edgeIndex
    message
    rulesVersion
    severity
    stepId
  }
}

Getting Started

Guides

Reference

fulfillmentAutomationCheck

Arguments

Returns

Example

​Arguments

​Returns

​Example

Arguments

Returns

Example