Fulfillment Manager API · shipping

Many consignments' labels as one PDF to print in one go

POST /labels/batch

Many consignments' labels as one PDF to print in one go — a day's bookings, a carrier batch — in the order asked, at most 500 consignments: each stored PDF label's pages (a PNG label as a page of its own) merged server-side and kept under the organization's labels, behind a link signed for fifteen minutes.

A consignment with nothing to merge is listed in skipped with why (no label yet, expired, a ZPL label). Appends nothing: it reads labels already stored and keeps their merge only as a file, keyed by the consignments it holds. No idempotency key: asking again merges again and signs a fresh link.

Access

Requires shipping:read.

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

Retries

No idempotency key: asking again merges again and signs a fresh link.

Why every write carries a key: Idempotency and retries.

Facts appended

None. This call records nothing in a journal.

What a fact is: Facts and the journal.

AI agent tool

No agent tool. one PDF of many labels for a person to send to a printer from the bulk booking screen; an agent prints each parcel's label with fulfillment_print_label

Connecting an agent: AI agents.

Example

curl
curl -X POST 'https://fulfillment.getmanifold.io/labels/batch' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "consignments": [
    {
      "orderId": "ord_01a159a0-cfd0-70e1-9bf2-a4b5c6d7e8f9",
      "consignmentId": "cns_01a159c0-d0e0-71f1-8c03-d7e8f90a1b2c"
    }
  ]
}'
JavaScript (fetch)
const response = await fetch("https://fulfillment.getmanifold.io/labels/batch", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "consignments": [
      {
        "orderId": "ord_01a159a0-cfd0-70e1-9bf2-a4b5c6d7e8f9",
        "consignmentId": "cns_01a159c0-d0e0-71f1-8c03-d7e8f90a1b2c"
      }
    ]
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();
Request body · application/json
{
  "consignments": [
    {
      "orderId": "ord_01a159a0-cfd0-70e1-9bf2-a4b5c6d7e8f9",
      "consignmentId": "cns_01a159c0-d0e0-71f1-8c03-d7e8f90a1b2c"
    }
  ]
}
Response · 200 · application/json
{
  "url": "https://files.getmanifold.io/labels/org_01a1586e-f9f6-7a8b-9c7d-6e5f4a3b2c1d/batches/5f0c2a9e7b1d4c3a8e6f0b2d4a6c8e1f.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20261020T065400Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=5d1f0c9b7e3a4f2c8b6d0e1a9c7f3b5d2e8a4c6f0b1d3e5a7c9f2b4d6e8a0c1f",
  "expiresAt": "2026-10-20T07:09:00.000Z",
  "pages": 2,
  "skipped": []
}

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.

409

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

413

RefusalWhat it meansWhat to do
LabelTooLarge limit, size The file is over the size limit. limit gives it in bytes.Send a smaller file.

503

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