How a sales channel's checkout shows the carriers' rates

GET /channels/{channelId}/rate-rules

How a sales channel's checkout shows the carriers' rates: the markup (percentBp, fixedCents, rounding), the allow list of services, whether they collapse to the cheapest and/or fastest and under what titles, renames, free shipping over a cart total, the fallback flat rate, transit days per service for carriers that give no ETA, and when parcels leave (dispatch: handling days, a cut-off and the time zone they count in).

A channel never configured answers pass-through rules: every rate, at the carrier's price. Appends nothing: a read of the rules.

Access

Requires shipping:read.

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

AI agent tool

Agents call this as fulfillment_get_rate_rules (Fulfillment: Get rate rules), in the parcels toolset. It only reads.

Connecting an agent: AI agents.

Example

curl

curl -X GET 'https://fulfillment.getmanifold.io/channels/chn_01a0f6b5-5030-7cc1-8e46-4e5f60718293/rate-rules' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"

JavaScript (fetch)

const response = await fetch("https://fulfillment.getmanifold.io/channels/chn_01a0f6b5-5030-7cc1-8e46-4e5f60718293/rate-rules", {
  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

{
  "channelId": "chn_01a0f6b5-5030-7cc1-8e46-4e5f60718293",
  "adjust": {
    "percentBp": 1000,
    "rounding": "up-to-99",
    "fixedCents": 0
  },
  "allow": [
    {
      "carrierAccountId": "car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d",
      "serviceCode": "7E55"
    },
    {
      "carrierAccountId": "car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d",
      "serviceCode": "7J55"
    }
  ],
  "collapse": "none",
  "renames": [
    {
      "ref": {
        "carrierAccountId": "car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d",
        "serviceCode": "7E55"
      },
      "title": "Standard shipping"
    },
    {
      "ref": {
        "carrierAccountId": "car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d",
        "serviceCode": "7J55"
      },
      "title": "Express shipping"
    }
  ],
  "free": {
    "overCents": 15000,
    "applies": "cheapest"
  },
  "fallback": {
    "title": "Standard shipping",
    "priceCents": 1500
  },
  "dispatch": {
    "handlingDays": 1,
    "cutoff": "14:00",
    "timeZone": "Australia/Perth"
  },
  "transit": []
}

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.

`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.	Try again shortly.

How refusals work everywhere: Errors.