Fulfillment Manager API

Quotes and sales orders: take an order, hold stock for it, pick, pack and ship it, take payment, invoice and refund.

Event-sourced fulfillment (dispatch) service. Owns the sales-order pipeline — draft? → order → allocate → pick → pack → ship → invoice, with a refund path back out — whose shape is configured per organization and snapshotted onto each order, so combining steps (pick+pack for a merchant with no warehouse, ship+invoice for one who invoices on despatch) is configuration rather than a different code path. For tracked SKUs the pick names exactly which serials/lot left the shelf, validated against the registry fold (purchasing receipts, minus what is picked or already dispatched, plus what came back on a refund). Ship authorisation is the cost of sales trigger for accounting. Quantity movements — reserve at allocation, dispatch at ship, return at refund — are commanded through the inventory service, the platform's source of truth for stock levels.

Base URL

https://fulfillment.getmanifold.io

Auth

A bearer token on every call. See the quickstart.

OpenAPI

fulfillment-manager.openapi.json

workflow

The organization's configurable order pipeline.

• GET /workflow The organization's order pipeline
• PUT /workflow Replace the organization's pipeline; an omitted field takes its default

lineProperties

The names an order line's personalisation may carry, and what each means.

• GET /line-item-properties The organization's line item properties
• PUT /line-item-properties Replace the organization's line item properties
• GET /line-item-properties/applicable Which live definitions apply to each of these SKUs

numbering

How orders, shipments, invoices, payments and refunds are numbered.

• GET /numbering The organization's document series
• PUT /numbering Replace the document numbering

orders

The order pipeline: create, confirm, allocate, ship in parcels, invoice, refund.

• GET /orders List fulfillment orders from the current read model
• POST /orders Create (place) a sales order for a customer, or a draft quote with stage: "draft-quote"
• GET /orders/count How many orders GET /orders would page through for the same personId / companyId
• GET /orders/tallies How an order list's tabs count
• GET /orders/defaults What a new order or quote of yours takes when it names nothing
• GET /orders/customer-summary A customer's lifetime value
• GET /orders/attention What in the order book needs a person today — the home dashboard's fulfilment summary
• GET /orders/board The warehouse floor as the operations board shows it
• GET /shipments/queue A pick-pack station's queue
• GET /shipments/dispatch The orders a station's dispatch tab reads
• GET /orders/{orderId} Fetch one sales order or quote by its ord_ id
• GET /orders/{orderId}/margins An order's or quote's margin
• POST /orders/margins The margins of an order still being typed
• GET /backorders A page of the organization's backorder queue
• POST /orders/{orderId}/quote Issue a draft quote to the customer
• POST /orders/{orderId}/reopen Take an issued quote back to draft to revise it
• POST /orders/{orderId}/place Place a quote — a draft or an issued one — as an order
• POST /orders/{orderId}/channel-placement Place a channel's quote as the order the channel made of it
• POST /orders/{orderId}/margin-approvals Ask a sales manager to approve issuing or placing a quote whose lines are below their…
• POST /orders/{orderId}/margin-approvals/{approvalId}/decide Approve or decline a rep's request to sell below the minimum margin
• POST /orders/{orderId}/links The signed link a customer opens one of the order's documents by
• POST /orders/{orderId}/links/{linkId}/revoke Revoke a customer link
• PUT /orders/{orderId}/lines/{lineId}/price Change one line's unit price while the quote is a draft
• POST /orders/{orderId}/cancel Withdraw an order
• POST /orders/{orderId}/allocate Run allocation again for an order waiting on stock
• POST /orders/{orderId}/lines/{lineId}/allocation Move a line's held stock to another site
• POST /orders/{orderId}/shipments Open a parcel over some of the order's allocated quantity
• POST /orders/{orderId}/shipments/{shipmentId}/pick Record what the operator physically took for this parcel
• POST /orders/{orderId}/shipments/{shipmentId}/pack Close the parcel for despatch, optionally with the cartons it went in
• POST /orders/{orderId}/shipments/{shipmentId}/ship Ship a parcel: the point its stock leaves the shelf and its cost becomes the cost of the…
• POST /orders/{orderId}/invoices Raise a sales invoice
• POST /orders/{orderId}/payments Record money received against the order
• POST /orders/{orderId}/collections Ask the sales channel an order came from to take the order's money through the channel's…
• POST /orders/{orderId}/collections/{collectionId}/answer The app providing the order's channel answers a collection it was asked for
• POST /orders/{orderId}/collections/{collectionId}/resolve A person settles a collection that needs checking
• POST /orders/{orderId}/costs Journal an additional cost on the order by hand
• POST /orders/{orderId}/costs/{costId}/reverse Reverse a cost on the order
• PUT /orders/{orderId}/payment-terms Change whether this order may ship before it is paid
• PUT /orders/{orderId}/sales-rep Re-attribute an order or a quote: set its sales rep, or null for none
• PUT /orders/{orderId}/customer-po Set, change or clear the buyer's PO number on an order or quote
• POST /orders/{orderId}/edits Edit an order in place
• POST /orders/{orderId}/notes Leave a note on the order's activity stream
• POST /orders/{orderId}/transcripts Keep a voice conversation's transcript on the order or quote it built
• POST /orders/{orderId}/transcripts/{sessionId}/link A five-minute link to one of the order's call transcripts
• POST /orders/{orderId}/refunds Refund money and, for lines marked restock, walk the stock movements backwards

shelf

The batch/serial/expiry registry's shelf view.

• GET /shelf/{sku} FEFO-ordered pick suggestions for a SKU from the registry fold

writeOffs

Stock write-offs: the damaged/expired/lost exit path.

• POST /write-offs Write off stock — damaged, expired or lost units leaving the platform

shipping

Carrier accounts and the consignments booked with them: labels, tracking, manifests, and the boxes parcels are packed in.

• GET /carrier-accounts The carrier accounts the organization books labels with
• PUT /carrier-accounts/{carrierAccountId} A shipping app connects the account it books with
• POST /carrier-accounts/{carrierAccountId}/disconnect Its app lets a carrier account go
• GET /carrier-accounts/{carrierAccountId}/consignments One account's consignments for the app that keeps it
• GET /carrier-accounts/{carrierAccountId}/consignments/{consignmentId} Everything the account's app books one consignment by
• POST /carrier-accounts/{carrierAccountId}/consignments/{consignmentId}/answer The app answers a requested consignment
• POST /carrier-accounts/{carrierAccountId}/consignments/{consignmentId}/tracking The app reports where a booked parcel has got to
• POST /carrier-accounts/{carrierAccountId}/consignments/{consignmentId}/label The account's app stores the label it booked
• POST /orders/{orderId}/consignments/{consignmentId}/label A link to print a consignment's label from
• POST /orders/{orderId}/shipments/{shipmentId}/consignments Put a packed parcel to a carrier account to book
• POST /orders/{orderId}/consignments/{consignmentId}/void Cancel a consignment
• POST /orders/{orderId}/consignments/{consignmentId}/payment Record what was paid to the carrier for a booked parcel
• GET /carrier-accounts/{carrierAccountId}/manifests One carrier account's manifests
• POST /carrier-accounts/{carrierAccountId}/manifests Hand over the day's parcels
• POST /carrier-accounts/{carrierAccountId}/manifests/{manifestId}/answer The account's app answers a manifest
• POST /carrier-accounts/{carrierAccountId}/manifests/{manifestId}/document The account's app stores the carrier's manifest document for a manifest it lodged
• POST /carrier-accounts/{carrierAccountId}/manifests/{manifestId}/document-link A link to open or print a manifest's carrier document from, signed for fifteen minutes
• GET /boxes The organization's box catalogue
• PUT /boxes/{boxId} Add a box to the catalogue
• POST /boxes/{boxId}/archive Archive a box: nothing more is packed into it
• GET /orders/{orderId}/shipments/{shipmentId}/packing The cartons a parcel would go out in

rates

Live rates: what a parcel would cost with each of the organization's carrier accounts.

• POST /rates Live rates from every carrier account with a quoteUrl, each coded <car_>:<service>
• GET /channels/{channelId}/rate-rules How a sales channel's checkout shows the carriers' rates
• PUT /channels/{channelId}/rate-rules Replace a sales channel's checkout rate rules, whole
• POST /channels/{channelId}/rates What a cart would cost to send

history

History: orders from before Manifold, kept for the record, mirrored while their source still works them.

• GET /historical-orders A page of the organization's historical orders
• GET /historical-orders/{orderId} One historical order as last recorded
• PUT /historical-orders/{orderId} Record an order from before Manifold as history
• POST /historical-orders/{orderId}/refunds Refund a historical order after go live
• POST /historical-orders/{orderId}/adoption Say an open mirrored order became a live order when the organization went live

payouts

Payouts: what payment providers sent the merchant, settling the orders' payments.

• POST /payouts Record a payment provider's payout as the provider reports it now
• GET /payouts A page of the organization's payouts
• GET /payouts/reconciliation How each payment provider's money stands
• GET /payouts/{payoutId} One payout as last reported

tenders

Store credit and gift cards: balances customers hold, spent and given back by an order's payments and refunds.

• GET /credit A customer's store credit
• POST /credit Give a person or a company store credit by hand
• POST /credit/{creditId}/reverse Take back credit given by hand
• GET /gift-cards A page of the organization's gift cards
• POST /gift-cards Issue a gift card by hand
• GET /gift-cards/{giftCardId} One gift card by id: its last four
• POST /gift-cards/{giftCardId}/disable Stop a gift card — lost
• POST /gift-cards/{giftCardId}/enable Let a disabled gift card be used again, with its balance as it stood
• POST /gift-cards/check What a gift card code is good for

customer

What a organization's customer reaches through a signed link: one document, and the quote's answer.

• GET /customer/{tenantId}/{token} The one document a customer link opens
• POST /customer/{tenantId}/{token}/viewed Record that the customer opened the link
• POST /customer/{tenantId}/{token}/accept The customer accepts the quote the link opens
• POST /customer/{tenantId}/{token}/decline The customer declines the quote the link opens

printing

Label printing: the printers at each site, and print jobs taken and reported by the site's print agent.

• GET /printers The organization's printers
• PUT /printers/{printerId} Add a printer to a site
• POST /printers/{printerId}/remove Remove a printer: nothing more is sent to it and it is the default for nothing
• POST /print-jobs Print a document at a site
• GET /print-jobs The newest print jobs
• GET /print-jobs/{jobId} One print job as it stands: queued, sent, printed or failed with the reason
• GET /print-agent/jobs The calling print agent's open jobs
• POST /print-jobs/{jobId}/claim Take a job to print it
• POST /print-jobs/{jobId}/outcome Say how a job went: printed

events

The fulfillment append-only event log.

• GET /events Replay committed fulfillment events at-or-after since
• GET /events/head The journal's position at a moment