> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# FulfillmentAutomationDefinition

> A fulfillment automation's content as typed data: its steps and the edges between them. The same content as `script`.

**description** `String`

A note on the rule.

**edges** `[\[FulfillmentAutomationEdge!\]!](/docs/api-reference/v3/pagination)` *required*

How fulfillments move from the trigger through the steps.

**fields**

**from** `String!` *required*

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

**port** `String!` *required*

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

**to** `String!` *required*

The step it leads to.

**name** `String!` *required*

The rule's name.

**rulesVersion** `String!` *required*

The checker rules it's held to. A rule added in a later version only warns until you raise it.

**steps** `[\[FulfillmentAutomationStep!\]!](/docs/api-reference/v3/reference/shipping/fulfillment-automation-step)` *required*

The steps.

**fields**

**config** `[JSON!](/docs/api-reference/v3/reference/common/json)` *required*

The kind's settings, matching its `configJsonSchema` in `fulfillmentAutomationKinds`.

**id** `String!` *required*

The step's id, unique in the automation. Edges and diagnostics refer to it.

**kind** `String`

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

**kindVersion** `Int!` *required*

The version of the kind the config is written for.

**title** `String`

The step's name in the editor; null shows the kind's.

**type** `[FulfillmentAutomationStepType!](/docs/api-reference/v3/reference/shipping/fulfillment-automation-step-type)` *required*

What the step does.

**trigger** `[FulfillmentAutomationTrigger!](/docs/api-reference/v3/reference/shipping/fulfillment-automation-trigger)` *required*

What starts it. It can't change once saved.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.