Fulfillment Manager API · orders
Create (place) a sales order for a customer, or a draft quote with stage: "draft-quote"
POST /orders
The smallest order is a reference and one line: { "reference": "WEB-10231", "lines": [{ "sku": "WIDGET-BLUE", "quantity": 2 }] }. A draft quote may start with lines: []; an order needs one.
Lines. Each line is a SKU and a quantity. The same SKU may sit on several lines, told apart by attributes (name/value pairs, shown on the pick list) and, for a channel order, externalId. Each line gets a lin_ id; later calls (parcels, picks, invoices, refunds, repricing) name the line by it. A kit's line keeps its recipe as components: it is priced and invoiced as one line, while stock moves through each part. A SKU neither stocked nor a variant is 404 ItemNotFound. A SKU's order rules (orderRules: minQuantity, then steps) refuse a line with 422 QuantityBelowMinimum or QuantityNotInStep (reason says the rule); a channel's order is taken, the line flagged ruleBreach. attributes are held to the line item properties.
Prices. Lines are priced from a catalog: catalogId if you name one; else the catalogs of the company in customer, each SKU at the lowest price any of them lists; else the Default catalog. An unknown company is 404 CompanyNotFound (502 CrmUnavailable if unreadable). Catalogs mixing currencies, or a currency no named or company catalog uses, is 409 OrderCatalogCurrencyMismatch; an unknown or archived catalog 404 OrderCatalogNotFound. Send unitPriceCents to set a line's price; a price other than the list price is kept as a priceOverride with who set it and priceReason. Every line of an order needs a price (zero is a price): a line no catalog lists and with no unitPriceCents is 409 LineUnpriced. A draft quote may leave a line unpriced until it is issued or placed. A person may order only SKUs the order's catalogs list (409 SkuNotInCatalogs) unless they hold catalog-override:write; a line's catalogId then prices it from another catalog. Apps and system runs are not held to the list.
A line's discount (and charges' order discount) is discountCents or discountBps, a percentage kept as one as the line changes; an amount past the line's worth is 409 LineDiscountRefused. customerPo is the buyer's PO number, not a key.
Charges and tax. charges holds shipping and an order-level discount. Tax comes from the tax settings, each SKU's tax class and shipToCountry; no rate for a class that day is 409 TaxRateMissing. A channel sends the tax it charged (pricesIncludeTax, channelTax, shippingTax). money shows the tax, the total, payments, refunds and the balance. shippingRate (a POST /rates code + sealed) records the rate chosen, which the parcels book.
Customer. customer names who it is for by personId, companyId or both; salesRepId who sold it. While the organization's requireCustomer is on (the default), a person's order without one is 409 CustomerRequired; a draft quote, a channel app's order and a system run's are not held to it.
What it records. A draft quote appends only fulfillment.quote-created: no stock, no sale until placed (POST /orders/:orderId/place). An order appends fulfillment.order-created, holds stock (fulfillment.stock-allocated) and opens a parcel (fulfillment.shipment-created); an automatic pipeline also picks, packs, ships (fulfillment.dispatched per line) and invoices (fulfillment.invoice-issued). It keeps the pipeline and number (SO-00042) as they are now.
Channel orders. Only the channel's own app may send a channel source (403 ChannelSourceForbidden).
Access
Requires orders:write.
How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.
Retries
reference (your own order number, or the channel's) is required and is the idempotency key: a retry with the same reference is answered with the order it already opened and holds no stock again. 502 InventoryUnavailable: stock could not be read, nothing was made. 503 OrderCreationPending: the order is still being made; send the same request again and it is answered with the order once saved. A stock hold or dispatch refused part-way is not an error: the order stays open to allocate later, or the parcel packed to ship later.
A retry with the same key answers 201, with what the first call recorded.
Why every write carries a key: Idempotency and retries.
Facts appended
fulfillment.quote-createdfulfillment.order-createdfulfillment.stock-allocatedfulfillment.shipment-createdfulfillment.dispatchedfulfillment.invoice-issued
What a fact is: Facts and the journal.
AI agent tool
Agents call this as fulfillment_create_order (Fulfillment: Create order), in the fulfillment toolset.
Connecting an agent: AI agents.
Example
curl -X POST 'https://fulfillment.getmanifold.io/orders' \
-H "Authorization: Bearer $MANIFOLD_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"reference": "PO-7781",
"customer": {
"companyId": "cmp_01a1588a-1f02-7a3b-8c4d-5e6f7a8b9c0d",
"shippingAddressId": "cloc_01a1588a-1f02-7a3b-8c4d-6f7a8b9c0d1e",
"billingAddressId": "cloc_01a1588a-1f02-7a3b-8c4d-6f7a8b9c0d1e"
},
"lines": [
{
"sku": "MUG-SPECKLE",
"quantity": 4
},
{
"sku": "BOWL-SALT-L",
"quantity": 2
}
],
"shippingMethod": {
"title": "Standard",
"code": "STD"
}
}'const response = await fetch("https://fulfillment.getmanifold.io/orders", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify({
"reference": "PO-7781",
"customer": {
"companyId": "cmp_01a1588a-1f02-7a3b-8c4d-5e6f7a8b9c0d",
"shippingAddressId": "cloc_01a1588a-1f02-7a3b-8c4d-6f7a8b9c0d1e",
"billingAddressId": "cloc_01a1588a-1f02-7a3b-8c4d-6f7a8b9c0d1e"
},
"lines": [
{
"sku": "MUG-SPECKLE",
"quantity": 4
},
{
"sku": "BOWL-SALT-L",
"quantity": 2
}
],
"shippingMethod": {
"title": "Standard",
"code": "STD"
}
}),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();{
"reference": "PO-7781",
"customer": {
"companyId": "cmp_01a1588a-1f02-7a3b-8c4d-5e6f7a8b9c0d",
"shippingAddressId": "cloc_01a1588a-1f02-7a3b-8c4d-6f7a8b9c0d1e",
"billingAddressId": "cloc_01a1588a-1f02-7a3b-8c4d-6f7a8b9c0d1e"
},
"lines": [
{
"sku": "MUG-SPECKLE",
"quantity": 4
},
{
"sku": "BOWL-SALT-L",
"quantity": 2
}
],
"shippingMethod": {
"title": "Standard",
"code": "STD"
}
}{
"id": "ord_01a156d4-8704-7a21-8b32-4c5d6e7f8091",
"reference": "PO-7781",
"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-01042",
"serial": 1042,
"status": "open",
"lines": [
{
"id": "lin_01a156d4-8704-7a21-8b32-5d6e7f809102",
"sku": "MUG-SPECKLE",
"name": "Speckled stoneware mug",
"ordered": 4,
"removed": false,
"catalogId": "cat_01a15880-2a10-7b2c-8d3e-4f5a6b7c8d9e",
"discountCents": 0,
"allocated": 4,
"picked": 0,
"packed": 0,
"dispatched": 0,
"invoiced": 0,
"returned": 0,
"unitPriceCents": 2400,
"listPriceCents": 2400,
"inclusive": false,
"taxBasis": {
"_tag": "calculated",
"treatment": "domestic",
"country": "AU",
"parts": [
{
"class": "standard",
"rateBps": 1000,
"weight": 1
}
]
},
"orderDiscountCents": 0,
"tax": {
"inclusive": false,
"amountCents": 9600,
"entries": [
{
"class": "standard",
"treatment": "domestic",
"country": "AU",
"rateBps": 1000,
"netCents": 9600,
"taxCents": 960,
"source": "manifold"
}
],
"netCents": 9600,
"taxCents": 960,
"grossCents": 10560
}
},
{
"id": "lin_01a156d4-8704-7a21-8b32-7f8091021324",
"sku": "BOWL-SALT-L",
"name": "Salt-glaze serving bowl, large",
"ordered": 2,
"removed": false,
"catalogId": "cat_01a15880-2a10-7b2c-8d3e-4f5a6b7c8d9e",
"discountCents": 0,
"allocated": 2,
"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": 7600,
"entries": [
{
"class": "standard",
"treatment": "domestic",
"country": "AU",
"rateBps": 1000,
"netCents": 7600,
"taxCents": 760,
"source": "manifold"
}
],
"netCents": 7600,
"taxCents": 760,
"grossCents": 8360
}
}
],
"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": 4096,
"shipments": [
{
"id": "shp_01a156d4-8704-7a21-8b32-8091021324a5",
"number": "SH-01057",
"reference": "auto:ord_01a156d4-8704-7a21-8b32-4c5d6e7f8091:1",
"status": "pending",
"locationId": "loc_01a0f6b0-1100-7e51-8f62-7a8b9cadbec4",
"lines": [
{
"lineId": "lin_01a156d4-8704-7a21-8b32-5d6e7f809102",
"sku": "MUG-SPECKLE",
"quantity": 4
},
{
"lineId": "lin_01a156d4-8704-7a21-8b32-7f8091021324",
"sku": "BOWL-SALT-L",
"quantity": 2
}
],
"cartons": [],
"createdAt": "2026-10-20T01:02:11.204Z",
"updatedAt": "2026-10-20T01:02:11.204Z"
}
],
"invoices": [],
"refunds": [],
"payments": [],
"notes": [],
"edits": [],
"consignments": [],
"money": {
"subtotalCents": 17200,
"charges": {
"shippingCents": 0,
"shippingDiscountCents": 0,
"discountCents": 0
},
"discountCents": 0,
"tax": {
"netCents": 17200,
"taxCents": 1720,
"grossCents": 18920,
"breakdown": [
{
"class": "standard",
"treatment": "domestic",
"country": "AU",
"rateBps": 1000,
"exempt": false,
"taxableCents": 17200,
"taxCents": 1720
}
]
},
"totalCents": 18920,
"paidCents": 0,
"refundedCents": 0,
"balanceCents": 18920,
"refundOwedCents": 0,
"status": "unpaid"
},
"discounts": [],
"shortfalls": [],
"createdAt": "2026-10-20T01:02:11.204Z",
"updatedAt": "2026-10-20T01:02:11.204Z"
}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.
400
| Refusal | What it means | What to do |
|---|---|---|
ShippingRateInvalid reason | The request was refused. reason says why. | Fix the request. Sending it again unchanged gets the same answer. |
LineAttributeInvalid sku, name, reason | The request was refused. reason says why. | Fix the request. Sending it again unchanged gets the same answer. |
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 |
|---|---|---|
ChannelSourceForbidden channelId, reason | Only the app that provides a channel may send orders from it. | Send the order with source api, or from the channel's own app. |
CatalogNotOpenToRep catalogIds | The request was refused, and nothing changed. | The caller may not do this. Use a token whose roles allow it. |
SalesRepNotYours salesRepId | The request was refused, and nothing changed. | The caller may not do this. Use a token whose roles allow it. |
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 |
|---|---|---|
ItemNotFound sku | No such record in this organization. | Check the id in the path or the body. |
OrderCatalogNotFound catalogId | No such record in this organization. | Check the id in the path or the body. |
CompanyNotFound companyId | No such record in this organization. | Check the id in the path or the body. |
409
| Refusal | What it means | What to do |
|---|---|---|
OrderCatalogCurrencyMismatch catalogIds, currencies | The catalogs that would price the order use more than one currency, or not the one asked for. | Name one catalog, or send a currency it uses. |
LineUnpriced orderId, lineIds, skus | A line has no price, and every line of an order needs one. lineIds names them. | Send unitPriceCents for those lines, or list the SKUs in a catalog. |
LineDiscountRefused lineId, sku, discountCents, lineCents, reason | The request was refused. reason says why. | Nothing changed. Read the record, then decide. |
TaxRateMissing class, at | The organization charges tax on this class but has no rate for it on that day. | An owner adds a rate for the class in Settings › Tax. |
FulfillmentLocationInvalid locationId, reason | The request was refused. reason says why. | Nothing changed. Read the record, then decide. |
LineAttributeRequired sku, name | The request was refused, and nothing changed. | Nothing changed. Read the record, then decide. |
BelowMinimumMargin orderId, lines, approval, message | The request was refused, and nothing changed. | Nothing changed. Read the record, then decide. |
CustomerRequired orderId, message | The request was refused, and nothing changed. | Nothing changed. Read the record, then decide. |
SkuNotInCatalogs catalogIds, skus, message | 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. |
422
| Refusal | What it means | What to do |
|---|---|---|
QuantityBelowMinimum lineId, sku, quantity, minQuantity, reason | The request was refused. reason says why. | Fix the request. Sending it again unchanged gets the same answer. |
QuantityNotInStep lineId, sku, quantity, minQuantity, step, reason | The request was refused. reason says why. | Fix the request. Sending it again unchanged gets the same answer. |
502
| Refusal | What it means | What to do |
|---|---|---|
InventoryUnavailable reason | The inventory service did not answer, so nothing changed. | Send the same request again, with the same key. |
CrmUnavailable reason | Customer records could not be read, so nothing changed. | Send the same request again, with the same key. |
503
| Refusal | What it means | What to do |
|---|---|---|
OrderCreationPending orderId, reference, waitedMs | The order is still being made. The same request is answered with it once it is saved. | Send the same request again, with the same key. |
RequestLogUnavailable tokenId, reason | The service could not record the request, so it did nothing. | Send the same request again, with the same key. |
How refusals work everywhere: Errors.
Used in
- Running more than one location, step 14: Take an order — routed to one site
- Order to cash, step 3: Quote it
- Store credit and gift cards, step 8: Take an order
- Journal an additional cost on an order, step 6: Take an order
- Selling stock you do not have yet, step 3: Order more than there is
- What happens when you get it wrong, or send it twice, step 7: Take an order
- Pack parcels into your boxes, step 6: Take an order
- Share a quote your customer can accept, step 5: Draft the quote