Fulfillment Manager API · shelf

FEFO-ordered pick suggestions for a SKU from the registry fold

GET /shelf/{sku}

FEFO-ordered pick suggestions for a SKU from the registry fold: soonest expiry first, ties broken by receipt time, never-expiring stock last; expired units are flagged, not hidden.

Materialized from purchasing receipts, minus the units a shipment has already picked or dispatched, plus the identified sellable units a refund put back — so what this returns is exactly what an operator may still claim, and no two parcels can be picked against the same one. locationId narrows it to one site: a parcel ships from one shelf, so a pick against it may only name units that are there (units whose site is unknown — a return, a receipt that named none — are offered at every site, because nothing rules them out).

Access

Requires stock:read or allocations:read.

Any one of these scopes is enough.

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

AI agent tool

Agents call this as fulfillment_shelf_view (Fulfillment: Shelf view), in the parcels toolset. It only reads.

Connecting an agent: AI agents.

Example

curl
curl -X GET 'https://fulfillment.getmanifold.io/shelf/KETTLE-COPPER?locationId=loc_01a0f6b0-1100-7e51-8f62-7a8b9cadbec4' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"
JavaScript (fetch)
const response = await fetch("https://fulfillment.getmanifold.io/shelf/KETTLE-COPPER?locationId=loc_01a0f6b0-1100-7e51-8f62-7a8b9cadbec4", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}` },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();
Response · 200 · application/json
[
  {
    "unit": {
      "sku": "KETTLE-COPPER",
      "quantity": 1,
      "serial": "KC-24-0187",
      "receivedAt": "2026-10-02T01:40:00.000Z",
      "poId": "po_01a0f6b1-4b10-7e61-8f72-0a1b2c3d4e5f",
      "receiptId": "rcpt_01a0f6b1-5c20-7f71-9a83-1b2c3d4e5f60",
      "locationId": "loc_01a0f6b0-1100-7e51-8f62-7a8b9cadbec4"
    },
    "expired": false
  },
  {
    "unit": {
      "sku": "KETTLE-COPPER",
      "quantity": 1,
      "serial": "KC-24-0188",
      "receivedAt": "2026-10-02T01:40:00.000Z",
      "poId": "po_01a0f6b1-4b10-7e61-8f72-0a1b2c3d4e5f",
      "receiptId": "rcpt_01a0f6b1-5c20-7f71-9a83-1b2c3d4e5f60",
      "locationId": "loc_01a0f6b0-1100-7e51-8f62-7a8b9cadbec4"
    },
    "expired": false
  }
]

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.

503

RefusalWhat it meansWhat to do
RequestLogUnavailable tokenId, reason The service could not record the request, so it did nothing.Try again shortly.

How refusals work everywhere: Errors.

Used in