Revoke a customer link

POST /orders/{orderId}/links/{linkId}/revoke

Revoke a customer link: its token opens nothing from now, and the document's next link (POST /orders/:orderId/links) is a new one with a new token.

Appends fulfillment.customer-link-revoked. 404 CustomerLinkNotFound for a link that is not the order's. Idempotent by state: a link is revoked once, so a retried revoke answers the order as it stands and appends nothing.

Access

Requires orders:write.

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

Retries

Idempotent by state: a link is revoked once, so a retried revoke answers the order as it stands and appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

fulfillment.customer-link-revoked

What a fact is: Facts and the journal.

AI agent tool

No agent tool. ending a customer's link is a person's call, made from the order's page in the admin; an agent issues links, never ends one

Connecting an agent: AI agents.

Example

curl

curl -X POST 'https://fulfillment.getmanifold.io/orders/ord_01a15652-63f7-7a81-9b92-d8e9f0a1b2c3/links/cpl_01a15653-1a2b-7c3d-8e4f-5a6b7c8d9e0f/revoke' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"

JavaScript (fetch)

const response = await fetch("https://fulfillment.getmanifold.io/orders/ord_01a15652-63f7-7a81-9b92-d8e9f0a1b2c3/links/cpl_01a15653-1a2b-7c3d-8e4f-5a6b7c8d9e0f/revoke", {
  method: "POST",
  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

{
  "id": "ord_01a15652-63f7-7a81-9b92-d8e9f0a1b2c3",
  "reference": "QUOTE-HARBOUR-OCT",
  "source": {
    "kind": "api"
  },
  "customer": {
    "companyId": "cmp_01a1588a-1f02-7a3b-8c4d-5e6f7a8b9c0d",
    "shippingAddressId": "cloc_01a1588a-1f02-7a3b-8c4d-6f7a8b9c0d1e",
    "billingAddressId": "cloc_01a1588a-1f02-7a3b-8c4d-6f7a8b9c0d1e"
  },
  "party": {
    "companyId": "cmp_01a1588a-1f02-7a3b-8c4d-5e6f7a8b9c0d",
    "name": "Harbour Ceramics Pty Ltd",
    "paymentTermsDays": 30,
    "shipTo": {
      "id": "cloc_01a1588a-1f02-7a3b-8c4d-6f7a8b9c0d1e",
      "label": "Fremantle warehouse",
      "address": {
        "firstName": "Receiving",
        "lastName": "Dock",
        "company": "Harbour Ceramics",
        "address1": "14 Kiln Street",
        "city": "Fremantle",
        "province": "Western Australia",
        "provinceCode": "WA",
        "country": "Australia",
        "countryCode": "AU",
        "zip": "6160"
      }
    },
    "billTo": {
      "id": "cloc_01a1588a-1f02-7a3b-8c4d-6f7a8b9c0d1e",
      "label": "Fremantle warehouse",
      "address": {
        "company": "Harbour Ceramics Pty Ltd",
        "address1": "PO Box 412",
        "city": "Fremantle",
        "provinceCode": "WA",
        "countryCode": "AU",
        "zip": "6959"
      }
    }
  },
  "catalogIds": [
    "cat_01a15880-2a10-7b2c-8d3e-4f5a6b7c8d9e"
  ],
  "currency": "AUD",
  "fx": {
    "currency": "AUD",
    "home": "AUD",
    "rate": 1,
    "rateDate": "2026-10-20",
    "source": "same"
  },
  "convention": "exclusive",
  "shippingTaxBasis": {
    "_tag": "calculated",
    "treatment": "domestic",
    "country": "AU",
    "class": "follows-goods",
    "rateBps": 1000
  },
  "shippingMethod": {
    "title": "Standard",
    "code": "STD"
  },
  "number": "SO-01041",
  "serial": 1041,
  "status": "open",
  "quote": {
    "createdAt": "2026-10-19T22:40:02.551Z",
    "issuedAt": "2026-10-19T23:22:45.118Z",
    "validUntil": "2026-11-02T00:00:00.000Z",
    "placedAt": "2026-10-20T00:58:19.664Z"
  },
  "lines": [
    {
      "id": "lin_01a15652-63f7-7a81-9b92-e9f0a1b2c3d4",
      "sku": "MUG-SPECKLE",
      "name": "Speckled stoneware mug",
      "ordered": 48,
      "removed": false,
      "catalogId": "cat_01a15880-2a10-7b2c-8d3e-4f5a6b7c8d9e",
      "discountCents": 0,
      "allocated": 48,
      "picked": 0,
      "packed": 0,
      "dispatched": 0,
      "invoiced": 0,
      "returned": 0,
      "unitPriceCents": 2100,
      "listPriceCents": 2400,
      "priceOverride": {
        "fromCents": 2400,
        "by": {
          "_tag": "user",
          "id": "usr_01a15889-fa80-7b11-8c22-3d4e5f6a7b8c"
        },
        "at": "2026-10-19T22:41:15.090Z",
        "reason": "Trade price for 24 or more"
      },
      "inclusive": false,
      "taxBasis": {
        "_tag": "calculated",
        "treatment": "domestic",
        "country": "AU",
        "parts": [
          {
            "class": "standard",
            "rateBps": 1000,
            "weight": 1
          }
        ]
      },
      "orderDiscountCents": 0,
      "tax": {
        "inclusive": false,
        "amountCents": 100800,
        "entries": [
          {
            "class": "standard",
            "treatment": "domestic",
            "country": "AU",
            "rateBps": 1000,
            "netCents": 100800,
            "taxCents": 10080,
            "source": "manifold"
          }
        ],
        "netCents": 100800,
        "taxCents": 10080,
        "grossCents": 110880
      }
    },
    {
      "id": "lin_01a15652-63f7-7a81-9b92-f0a1b2c3d4e5",
      "sku": "BOWL-SALT-L",
      "name": "Salt-glaze serving bowl, large",
      "ordered": 6,
      "removed": false,
      "catalogId": "cat_01a15880-2a10-7b2c-8d3e-4f5a6b7c8d9e",
      "discountCents": 0,
      "allocated": 6,
      "picked": 0,
      "packed": 0,
      "dispatched": 0,
      "invoiced": 0,
      "returned": 0,
      "unitPriceCents": 3800,
      "listPriceCents": 3800,
      "inclusive": false,
      "taxBasis": {
        "_tag": "calculated",
        "treatment": "domestic",
        "country": "AU",
        "parts": [
          {
            "class": "standard",
            "rateBps": 1000,
            "weight": 1
          }
        ]
      },
      "orderDiscountCents": 0,
      "tax": {
        "inclusive": false,
        "amountCents": 22800,
        "entries": [
          {
            "class": "standard",
            "treatment": "domestic",
            "country": "AU",
            "rateBps": 1000,
            "netCents": 22800,
            "taxCents": 2280,
            "source": "manifold"
          }
        ],
        "netCents": 22800,
        "taxCents": 2280,
        "grossCents": 25080
      }
    }
  ],
  "workflow": {
    "paymentTerms": "on-account",
    "pick": "manual",
    "pack": "manual",
    "ship": "manual",
    "invoice": "manual",
    "shortfall": "wait",
    "allocation": "single-site-preferred",
    "routing": {
      "order": "rank",
      "decider": "manifold",
      "priority": []
    },
    "routingByCatalog": {}
  },
  "paymentTermsBy": "customer",
  "createdSequence": 4089,
  "shipments": [
    {
      "id": "shp_01a15060-7a80-7b91-8ca2-0a1b2c3d4e5f",
      "number": "SH-01056",
      "reference": "auto:ord_01a15652-63f7-7a81-9b92-d8e9f0a1b2c3:1",
      "status": "pending",
      "locationId": "loc_01a0f6b0-1100-7e51-8f62-7a8b9cadbec4",
      "lines": [
        {
          "lineId": "lin_01a15652-63f7-7a81-9b92-e9f0a1b2c3d4",
          "sku": "MUG-SPECKLE",
          "quantity": 48
        },
        {
          "lineId": "lin_01a15652-63f7-7a81-9b92-f0a1b2c3d4e5",
          "sku": "BOWL-SALT-L",
          "quantity": 6
        }
      ],
      "cartons": [],
      "createdAt": "2026-10-20T00:58:19.664Z",
      "updatedAt": "2026-10-20T00:58:19.664Z"
    }
  ],
  "invoices": [],
  "refunds": [],
  "payments": [],
  "notes": [],
  "edits": [],
  "consignments": [],
  "money": {
    "subtotalCents": 123600,
    "charges": {
      "shippingCents": 2500,
      "shippingDiscountCents": 0,
      "discountCents": 0
    },
    "discountCents": 0,
    "tax": {
      "netCents": 126100,
      "taxCents": 12610,
      "grossCents": 138710,
      "breakdown": [
        {
          "class": "standard",
          "treatment": "domestic",
          "country": "AU",
          "rateBps": 1000,
          "exempt": false,
          "taxableCents": 126100,
          "taxCents": 12610
        }
      ]
    },
    "shippingTax": {
      "inclusive": false,
      "amountCents": 2500,
      "entries": [
        {
          "class": "standard",
          "treatment": "domestic",
          "country": "AU",
          "rateBps": 1000,
          "netCents": 2500,
          "taxCents": 250,
          "source": "manifold"
        }
      ],
      "netCents": 2500,
      "taxCents": 250,
      "grossCents": 2750
    },
    "totalCents": 138710,
    "paidCents": 0,
    "refundedCents": 0,
    "balanceCents": 138710,
    "refundOwedCents": 0,
    "status": "unpaid"
  },
  "discounts": [],
  "shortfalls": [],
  "createdAt": "2026-10-19T22:40:02.551Z",
  "updatedAt": "2026-10-20T01:10:00.000Z",
  "links": [
    {
      "id": "cpl_01a15653-1a2b-7c3d-8e4f-5a6b7c8d9e0f",
      "document": {
        "kind": "quote"
      },
      "issuedAt": "2026-10-19T22:45:02.004Z",
      "issuedBy": {
        "_tag": "user",
        "id": "usr_01a15889-fa80-7b11-8c22-3d4e5f6a7b8c"
      },
      "viewedAt": "2026-10-19T23:02:44.310Z",
      "revokedAt": "2026-10-20T01:10:00.000Z"
    }
  ]
}

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`

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
`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
`FulfillmentOrderNotFound` orderId	No such record in this organization.	Check the id in the path or the body.
`CustomerLinkNotFound`	No such record in this organization.	Check the id in the path or the body.

`409`

Refusal	What it means	What 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`

Refusal	What it means	What to do
`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.

Used in

Share a quote your customer can accept, step 14: Revoke the quote's link