Fulfillment Manager API · shipping
The account's app stores the carrier's manifest document for a manifest it lodged
POST /carrier-accounts/{carrierAccountId}/manifests/{manifestId}/document
The account's app stores the carrier's manifest document for a manifest it lodged: the body is the raw file — not multipart, not JSON — application/pdf, image/png or application/zpl in Content-Type, at most 10 MiB (413 LabelTooLarge), streamed into the private bucket and kept as the record of what was handed over (409 ManifestNotInState for a manifest not lodged).
reference in the query string keys the request log. Appends fulfillment.manifest-documented. Idempotent by state: a manifest keeps one document, so a retry is answered with it and stores nothing.
Access
Requires shipping:write.
How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.
Retries
Idempotent by state: a manifest keeps one document, so a retry is answered with it and stores nothing.
Why every write carries a key: Idempotency and retries.
Facts appended
fulfillment.manifest-documented
What a fact is: Facts and the journal.
AI agent tool
No agent tool. a raw file only a shipping app stores, for the manifest it lodged; a person opens it with fulfillment_open_manifest
Connecting an agent: AI agents.
Example
The manifest's bytes are the request body, sent as Content-Type: application/pdf.
curl -X POST 'https://fulfillment.getmanifold.io/carrier-accounts/car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d/manifests/mnf_38e2db9b-2871-629c-51a1-cb5a2a5d8198/document?reference=manifest-doc-AP-MAN-778120' \
-H "Authorization: Bearer $MANIFOLD_TOKEN" \
-H 'Content-Type: application/pdf' \
--data-binary @upload.pdfimport { openAsBlob } from "node:fs";
const response = await fetch("https://fulfillment.getmanifold.io/carrier-accounts/car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d/manifests/mnf_38e2db9b-2871-629c-51a1-cb5a2a5d8198/document?reference=manifest-doc-AP-MAN-778120", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/pdf" },
body: await openAsBlob("upload.pdf"),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();(the file upload.pdf, sent as application/pdf){
"id": "mnf_38e2db9b-2871-629c-51a1-cb5a2a5d8198",
"carrierAccountId": "car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d",
"reference": "manifest-2026-10-20",
"status": "lodged",
"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:11.903Z",
"externalId": "AP-MAN-778120",
"document": {
"contentType": "application/pdf",
"size": 61340,
"storedAt": "2026-10-20T07:30:11.903Z"
}
}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.
400
| Refusal | What it means | What to do |
|---|---|---|
LabelUnreadable reason | The file is not a PDF, PNG or ZPL document. | Send the file with its own Content-Type. |
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 |
|---|---|---|
NotACarrierApp reason | Only a carrier app may call this. | Call it with the carrier app's token. |
CarrierAccountNotYours carrierAccountId | This carrier account belongs to another app. | Call it with the app that keeps the account. |
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
| Refusal | What it means | What 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
| Refusal | What it means | What to do |
|---|---|---|
ManifestNotInState manifestId, status, expected | The manifest is not in a state this call accepts. | Read the record: its status says where it stands, and expected the states this call accepts. |
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. |
413
| Refusal | What it means | What to do |
|---|---|---|
LabelTooLarge limit, size | The file is over the size limit. limit gives it in bytes. | Send a smaller file. |
503
| Refusal | What it means | What to do |
|---|---|---|
LabelStoreUnavailable reason | File storage did not answer, so nothing was stored. | Send the same request again shortly. |
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.