Fulfillment Manager API · shipping

One account's consignments for the app that keeps it

GET /carrier-accounts/{carrierAccountId}/consignments

One account's consignments for the app that keeps it, oldest request first, at most limit (default 100, capped at 500), narrowed by status: the catch-up behind the consignment-requested webhook, so a missed delivery is booked on the app's next sweep.

awaitingDelivery=true narrows to booked parcels its carrier has not yet called delivered — what a tracking sweep reads, so delivered parcels never fill the page. The listing pages by keyset: a full page carries next, and after=<next> reads on from it; a page without next is the end, and a sweep starts again from the oldest. Appends nothing: a read of the account's consignments.

Access

Requires shipping:read.

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

AI agent tool

No agent tool. a shipping app's catch-up over its own account; a person reads consignments on the order (fulfillment_get_order)

Connecting an agent: AI agents.

Example

curl
curl -X GET 'https://fulfillment.getmanifold.io/carrier-accounts/car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d/consignments?status=requested&limit=50' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"
JavaScript (fetch)
const response = await fetch("https://fulfillment.getmanifold.io/carrier-accounts/car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d/consignments?status=requested&limit=50", {
  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
{
  "items": [
    {
      "orderId": "ord_01a159a0-cfd0-70e1-9bf2-a4b5c6d7e8f9",
      "consignment": {
        "id": "cns_01a159c0-d0e0-71f1-8c03-d7e8f90a1b2c",
        "shipmentId": "shp_01a159a0-cfd0-70e1-9bf2-c6d7e8f90a1b",
        "carrierAccountId": "car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d",
        "attempt": 1,
        "status": "requested",
        "service": {
          "code": "7E55",
          "name": "Parcel Post",
          "carrier": "Australia Post"
        },
        "quoted": {
          "priceCents": 1395,
          "currency": "AUD"
        },
        "quote": {
          "quotedAt": "2026-10-20T06:53:02.415Z",
          "rates": [
            {
              "code": "car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d:7E55",
              "carrierAccountId": "car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d",
              "title": "Australia Post · Parcel Post",
              "service": {
                "code": "7E55",
                "name": "Parcel Post",
                "carrier": "Australia Post"
              },
              "priceCents": 1395,
              "currency": "AUD",
              "etaDays": {
                "min": 2,
                "max": 5
              }
            },
            {
              "code": "car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d:7J55",
              "carrierAccountId": "car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d",
              "title": "Australia Post · Express Post",
              "service": {
                "code": "7J55",
                "name": "Express Post",
                "carrier": "Australia Post"
              },
              "priceCents": 1980,
              "currency": "AUD",
              "etaDays": {
                "min": 1,
                "max": 2
              }
            }
          ],
          "unanswered": [],
          "estimated": false,
          "unweighed": []
        },
        "trackingHistory": [],
        "requestedAt": "2026-10-20T06:53:30.009Z",
        "updatedAt": "2026-10-20T06:53:30.009Z"
      }
    }
  ]
}

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
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

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

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.