Replace the document numbering

PUT /numbering

Replace the document numbering: per series, a prefix (up to 12 of A-Z a-z 0-9 -) and the next serial.

A serial only moves forward — a value at or below a number already issued is clamped to the next free one, never applied, so a number never names two documents. Appends fulfillment.numbering-configured. Idempotent by content: a retry that says what already holds is acknowledged and appends nothing.

Access

Requires settings:write.

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

Retries

Idempotent by content: a retry that says what already holds is acknowledged and appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

fulfillment.numbering-configured

What a fact is: Facts and the journal.

AI agent tool

Agents call this as fulfillment_set_numbering (Fulfillment: Set numbering), in the fulfillment toolset.

Connecting an agent: AI agents.

Example

curl

curl -X PUT 'https://fulfillment.getmanifold.io/numbering' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "orders": {
    "prefix": "SO-",
    "next": 5001
  },
  "shipments": {
    "prefix": "SH-",
    "next": 5001
  },
  "invoices": {
    "prefix": "INV-",
    "next": 3001
  },
  "payments": {
    "prefix": "PAY-",
    "next": 3001
  },
  "refunds": {
    "prefix": "RF-",
    "next": 201
  }
}'

JavaScript (fetch)

const response = await fetch("https://fulfillment.getmanifold.io/numbering", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "orders": {
      "prefix": "SO-",
      "next": 5001
    },
    "shipments": {
      "prefix": "SH-",
      "next": 5001
    },
    "invoices": {
      "prefix": "INV-",
      "next": 3001
    },
    "payments": {
      "prefix": "PAY-",
      "next": 3001
    },
    "refunds": {
      "prefix": "RF-",
      "next": 201
    }
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Request body · application/json

{
  "orders": {
    "prefix": "SO-",
    "next": 5001
  },
  "shipments": {
    "prefix": "SH-",
    "next": 5001
  },
  "invoices": {
    "prefix": "INV-",
    "next": 3001
  },
  "payments": {
    "prefix": "PAY-",
    "next": 3001
  },
  "refunds": {
    "prefix": "RF-",
    "next": 201
  }
}

Response · 200 · application/json

{
  "orders": {
    "prefix": "SO-",
    "next": 5001
  },
  "shipments": {
    "prefix": "SH-",
    "next": 5001
  },
  "invoices": {
    "prefix": "INV-",
    "next": 3001
  },
  "payments": {
    "prefix": "PAY-",
    "next": 3001
  },
  "refunds": {
    "prefix": "RF-",
    "next": 201
  }
}

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.