Everything the account's app books one consignment by

GET /carrier-accounts/{carrierAccountId}/consignments/{consignmentId}

Everything the account's app books one consignment by: the ship-to the order states (the address version it pinned, never the customer's current one; null once the person was erased), the site it leaves from (absent address until the site is given one), the cartons (the packer's, or one weighing the lines' SKU weights when every one is known), each line with its weight and customs (the tariff code for the destination, the country of origin, the price of one) and the buyer's shipping method.

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. what a shipping app books a consignment by, read under its own account; a person reads the parcel on its 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/cns_01a159c0-d0e0-71f1-8c03-d7e8f90a1b2c' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"

JavaScript (fetch)

const response = await fetch("https://fulfillment.getmanifold.io/carrier-accounts/car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d/consignments/cns_01a159c0-d0e0-71f1-8c03-d7e8f90a1b2c", {
  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

{
  "orderId": "ord_01a159a0-cfd0-70e1-9bf2-a4b5c6d7e8f9",
  "orderNumber": "SO-01045",
  "orderReference": "WEB-31002",
  "currency": "AUD",
  "shipmentId": "shp_01a159a0-cfd0-70e1-9bf2-c6d7e8f90a1b",
  "shipmentNumber": "SH-01063",
  "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"
  },
  "shippingMethod": {
    "title": "Standard",
    "code": "STD"
  },
  "shipTo": {
    "address": {
      "firstName": "Priya",
      "lastName": "Raman",
      "company": "Harbour Ceramics",
      "address1": "14 Kiln Street",
      "city": "Fremantle",
      "province": "Western Australia",
      "provinceCode": "WA",
      "country": "Australia",
      "countryCode": "AU",
      "zip": "6160"
    }
  },
  "shipFrom": {
    "locationId": "loc_01a0f6b0-1100-7e51-8f62-7a8b9cadbec4",
    "name": "Main",
    "address": {
      "company": "Saltbush Homewares",
      "address1": "3 Quarry Road",
      "city": "Bibra Lake",
      "province": "Western Australia",
      "provinceCode": "WA",
      "countryCode": "AU",
      "zip": "6163"
    }
  },
  "cartons": [
    {
      "packaging": "carton",
      "boxId": "box_01a0f6b4-3e10-7aa1-8c24-2c3d4e5f6071",
      "weightGrams": 1700,
      "size": {
        "lengthMm": 260,
        "widthMm": 210,
        "heightMm": 120
      }
    }
  ],
  "lines": [
    {
      "lineId": "lin_01a159a0-cfd0-70e1-9bf2-b5c6d7e8f90a",
      "sku": "MUG-SPECKLE",
      "name": "Speckled stoneware mug",
      "quantity": 4,
      "unitPriceCents": 2400,
      "weightGrams": 380
    }
  ]
}

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

Refusal	What it means	What to do
`CarrierAccountNotFound` carrierAccountId	No such record in this organization.	Check the id in the path or the body.
`FulfillmentOrderNotFound` orderId	No such record in this organization.	Check the id in the path or the body.
`ConsignmentNotFound` consignmentId	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.

`502`

Refusal	What it means	What to do
`InventoryUnavailable` reason	The inventory service did not answer, so nothing changed.	Try again shortly.
`CrmUnavailable` reason	Customer records could not be read, so nothing changed.	Try again shortly.

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