Fulfillment Manager API · shipping

Hand over the day's parcels

POST /carrier-accounts/{carrierAccountId}/manifests

Hand over the day's parcels: every consignment booked with the account and on no manifest yet, for its app to lodge with the carrier (it hears manifest.requested).

locationId narrows the handover to the parcels leaving one site (a parcel naming no site is any site's), so a station sharing the account with another site hands over only its own. 409 NothingToManifest when none waits. Appends fulfillment.manifest-requested. Idempotent on reference: the manifest's id is derived from the account, the site and it, so a retry answers the manifest it made and appends nothing.

Access

Requires shipping:write.

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

Retries

Idempotent on reference: the manifest's id is derived from the account, the site and it, so a retry answers the manifest it made and appends nothing.

A retry with the same key answers 200, with what the first call recorded.

Why every write carries a key: Idempotency and retries.

Facts appended

  • fulfillment.manifest-requested

What a fact is: Facts and the journal.

AI agent tool

Agents call this as fulfillment_request_manifest (Fulfillment: Request manifest), in the parcels toolset.

Connecting an agent: AI agents.

Example

curl
curl -X POST 'https://fulfillment.getmanifold.io/carrier-accounts/car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d/manifests' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "reference": "manifest-2026-10-20"
}'
JavaScript (fetch)
const response = await fetch("https://fulfillment.getmanifold.io/carrier-accounts/car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d/manifests", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "reference": "manifest-2026-10-20"
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();
Request body · application/json
{
  "reference": "manifest-2026-10-20"
}
Response · 200 · application/json
{
  "id": "mnf_38e2db9b-2871-629c-51a1-cb5a2a5d8198",
  "carrierAccountId": "car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d",
  "reference": "manifest-2026-10-20",
  "status": "requested",
  "consignments": [
    {
      "orderId": "ord_01a159a0-cfd0-70e1-9bf2-a4b5c6d7e8f9",
      "consignmentId": "cns_01a159c0-d0e0-71f1-8c03-d7e8f90a1b2c"
    }
  ],
  "requestedAt": "2026-10-20T07:30:04.512Z",
  "updatedAt": "2026-10-20T07:30:04.512Z"
}

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

RefusalWhat it meansWhat 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

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

403

RefusalWhat it meansWhat 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.

404

RefusalWhat it meansWhat to do
CarrierAccountNotFound carrierAccountId No such record in this organization.Check the id in the path or the body.
ManifestNotFound manifestId No such record in this organization.Check the id in the path or the body.

409

RefusalWhat it meansWhat to do
CarrierAccountDisconnected carrierAccountId The carrier account is disconnected.Reconnect it first.
NothingToManifest carrierAccountId No bookings wait to go on a manifest.Nothing 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

RefusalWhat it meansWhat to do
RequestLogUnavailable tokenId, reason The service could not record the request, so it did nothing.Send the same request again, with the same key.

How refusals work everywhere: Errors.