Fulfillment Manager API · lineProperties

Replace the organization's line item properties

PUT /line-item-properties

Replace the organization's line item properties, whole, each definition keyed by its caller-minted lip_ id.

Leaving one out is 409 LinePropertyRemoved: archive it, since orders name it. A name starting with _ is never shown to customers. A line written in Manifold is then held to them (400 LineAttributeInvalid, 409 LineAttributeRequired when placed); a channel's lines are kept as sent. Appends fulfillment.line-properties-configured. Idempotent by content: the properties as they already stand append nothing.

Access

Requires settings:write.

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

Retries

Idempotent by content: the properties as they already stand append nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

fulfillment.line-properties-configured

What a fact is: Facts and the journal.

AI agent tool

Agents call this as fulfillment_set_line_properties (Fulfillment: Set line properties), in the imports toolset.

Connecting an agent: AI agents.

Example

curl

curl -X PUT 'https://fulfillment.getmanifold.io/line-item-properties' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "allowOther": true,
  "definitions": [
    {
      "id": "lip_0192f3a0-6c1e-7a10-8b2c-3d4e5f607181",
      "name": "Engraving",
      "type": "text",
      "options": [],
      "required": true,
      "maxLength": 24,
      "helpText": "Up to 24 characters, engraved as typed",
      "appliesTo": {
        "tags": [
          "engravable"
        ],
        "productIds": [],
        "skus": []
      },
      "customerVisible": true,
      "archived": false
    },
    {
      "id": "lip_0192f3a0-6c1e-7a10-8b2c-3d4e5f607182",
      "name": "Gift wrap",
      "type": "select",
      "options": [
        "None",
        "Kraft",
        "Gold foil"
      ],
      "required": false,
      "appliesTo": {
        "tags": [],
        "productIds": [],
        "skus": []
      },
      "customerVisible": true,
      "archived": false
    },
    {
      "id": "lip_0192f3a0-6c1e-7a10-8b2c-3d4e5f607183",
      "name": "_Batch",
      "type": "text",
      "options": [],
      "required": false,
      "appliesTo": {
        "tags": [],
        "productIds": [],
        "skus": []
      },
      "customerVisible": false,
      "archived": false
    }
  ]
}'

JavaScript (fetch)

const response = await fetch("https://fulfillment.getmanifold.io/line-item-properties", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "allowOther": true,
    "definitions": [
      {
        "id": "lip_0192f3a0-6c1e-7a10-8b2c-3d4e5f607181",
        "name": "Engraving",
        "type": "text",
        "options": [],
        "required": true,
        "maxLength": 24,
        "helpText": "Up to 24 characters, engraved as typed",
        "appliesTo": {
          "tags": [
            "engravable"
          ],
          "productIds": [],
          "skus": []
        },
        "customerVisible": true,
        "archived": false
      },
      {
        "id": "lip_0192f3a0-6c1e-7a10-8b2c-3d4e5f607182",
        "name": "Gift wrap",
        "type": "select",
        "options": [
          "None",
          "Kraft",
          "Gold foil"
        ],
        "required": false,
        "appliesTo": {
          "tags": [],
          "productIds": [],
          "skus": []
        },
        "customerVisible": true,
        "archived": false
      },
      {
        "id": "lip_0192f3a0-6c1e-7a10-8b2c-3d4e5f607183",
        "name": "_Batch",
        "type": "text",
        "options": [],
        "required": false,
        "appliesTo": {
          "tags": [],
          "productIds": [],
          "skus": []
        },
        "customerVisible": false,
        "archived": false
      }
    ]
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Request body · application/json

{
  "allowOther": true,
  "definitions": [
    {
      "id": "lip_0192f3a0-6c1e-7a10-8b2c-3d4e5f607181",
      "name": "Engraving",
      "type": "text",
      "options": [],
      "required": true,
      "maxLength": 24,
      "helpText": "Up to 24 characters, engraved as typed",
      "appliesTo": {
        "tags": [
          "engravable"
        ],
        "productIds": [],
        "skus": []
      },
      "customerVisible": true,
      "archived": false
    },
    {
      "id": "lip_0192f3a0-6c1e-7a10-8b2c-3d4e5f607182",
      "name": "Gift wrap",
      "type": "select",
      "options": [
        "None",
        "Kraft",
        "Gold foil"
      ],
      "required": false,
      "appliesTo": {
        "tags": [],
        "productIds": [],
        "skus": []
      },
      "customerVisible": true,
      "archived": false
    },
    {
      "id": "lip_0192f3a0-6c1e-7a10-8b2c-3d4e5f607183",
      "name": "_Batch",
      "type": "text",
      "options": [],
      "required": false,
      "appliesTo": {
        "tags": [],
        "productIds": [],
        "skus": []
      },
      "customerVisible": false,
      "archived": false
    }
  ]
}

Response · 200 · application/json

{
  "allowOther": true,
  "definitions": [
    {
      "id": "lip_0192f3a0-6c1e-7a10-8b2c-3d4e5f607181",
      "name": "Engraving",
      "type": "text",
      "options": [],
      "required": true,
      "maxLength": 24,
      "helpText": "Up to 24 characters, engraved as typed",
      "appliesTo": {
        "tags": [
          "engravable"
        ],
        "productIds": [],
        "skus": []
      },
      "customerVisible": true,
      "archived": false
    },
    {
      "id": "lip_0192f3a0-6c1e-7a10-8b2c-3d4e5f607182",
      "name": "Gift wrap",
      "type": "select",
      "options": [
        "None",
        "Kraft",
        "Gold foil"
      ],
      "required": false,
      "appliesTo": {
        "tags": [],
        "productIds": [],
        "skus": []
      },
      "customerVisible": true,
      "archived": false
    },
    {
      "id": "lip_0192f3a0-6c1e-7a10-8b2c-3d4e5f607183",
      "name": "_Batch",
      "type": "text",
      "options": [],
      "required": false,
      "appliesTo": {
        "tags": [],
        "productIds": [],
        "skus": []
      },
      "customerVisible": false,
      "archived": 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`

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
`LinePropertyRemoved` propertyId, name	The request was refused, and nothing changed.	Nothing changed. Read the record, then decide.
`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.