Replace the organization's pipeline; an omitted field takes its default

PUT /workflow

A step may not be manual when the step before it is automatic — pick: "auto" with pack: "manual" is refused with 400. Appends fulfillment.workflow-configured. Idempotent by content: the event is a last-write-wins snapshot of the whole pipeline, and an identical one appends nothing. allocation chooses where stock is drawn from: single-site-preferred (the default) ships the order from the first site in the routing order that can fill it, else per-site; per-site draws each line from the sites in that order. routing.order: rank (default, the priority list then site ranks), nearest (distance to the ship-to, rank breaking ties) or stable. quoteMode: draft-orders refuses issuing, sending and linking quotes (QuotesDisabled). requireCustomer (default true) refuses an order or a placed quote without a customer (CustomerRequired). Orders already created keep the pipeline they were created under.

Access

Requires settings:write.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

Retries

Idempotent by content: the event is a last-write-wins snapshot of the whole pipeline, and an identical one appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

fulfillment.workflow-configured

What a fact is: Facts and the journal.

AI agent tool

Agents call this as fulfillment_set_workflow (Fulfillment: Set workflow), in the fulfillment toolset.

Connecting an agent: AI agents.

Example

From Order to cash, step 1: Make every step manual.

curl

curl -X PUT 'https://fulfillment.getmanifold.io/workflow' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "pick": "manual",
  "pack": "manual",
  "ship": "manual",
  "invoice": "manual",
  "shortfall": "split",
  "paymentTerms": "on-account"
}'

JavaScript (fetch)

const response = await fetch("https://fulfillment.getmanifold.io/workflow", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "pick": "manual",
    "pack": "manual",
    "ship": "manual",
    "invoice": "manual",
    "shortfall": "split",
    "paymentTerms": "on-account"
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Request body · application/json

{
  "pick": "manual",
  "pack": "manual",
  "ship": "manual",
  "invoice": "manual",
  "shortfall": "split",
  "paymentTerms": "on-account"
}

Response · 200 · application/json

{
  "paymentTerms": "on-account",
  "pick": "manual",
  "pack": "manual",
  "ship": "manual",
  "invoice": "manual",
  "shortfall": "split"
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: fulfillment-manager.openapi.json. Base URL https://fulfillment.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

`401`

Refusal	What it means	What to do
`Unauthorized` reason	The token is missing, expired or not one Manifold issued.	Get a fresh token and send the call again.
`TokenAlreadyUsed` tokenId	A single-use app token was already spent.	Mint a new token for this call.

`402`

Refusal	What it means	What to do
`SubscriptionRequired` status	The organization's subscription has lapsed, so writes are refused.	An owner settles billing. Reads still work meanwhile.

`403`

Refusal	What it means	What to do
`TenantRequired` userId	The token names no organization.	Choose the organization, then get a new token.
`ScopeRequired` required	The token's roles do not grant the scope this call needs.	Ask an owner or admin for a role that grants it.

`409`

Refusal	What it means	What to do
`MirroredFromSource` source	This area is fed by your source system until the organization goes live.	Make the change in the source system, or go live first.

`503`

Refusal	What it means	What to do
`RequestLogUnavailable` tokenId, reason	The service could not record the request, so it did nothing.	Send the same request again shortly.

How refusals work everywhere: Errors.

Used in

Order to cash, step 1: Make every step manual
Selling stock you do not have yet, step 1: Hold short orders rather than splitting them
Pack parcels into your boxes, step 1: Pack by hand