Inventory API

REST endpoints for inventory in ServFlo: 16 operations with parameters, request and response fields, permissions and curl examples.

Base URL: https://app.servflo.ai/api. Every call needs Authorization: Bearer sfk_… (Authentication); {organizationId} ($ORGANIZATION_ID in the examples) is your business's id.

Operation	Endpoint	Risk
List stock locations	`GET /organizations/{organizationId}/inventory/locations`	`read`
Create a warehouse or truck	`POST /organizations/{organizationId}/inventory/locations`	`write`
Get a location with its stock	`GET /organizations/{organizationId}/inventory/locations/{locationId}`	`read`
Update a location	`PATCH /organizations/{organizationId}/inventory/locations/{locationId}`	`write`
Delete a location	`DELETE /organizations/{organizationId}/inventory/locations/{locationId}`	`sensitive`
List stock levels	`GET /organizations/{organizationId}/inventory/stock`	`read`
The stock ledger	`GET /organizations/{organizationId}/inventory/movements`	`read`
My truck's stock	`GET /organizations/{organizationId}/inventory/my-truck`	`read`
Set a reorder point	`PATCH /organizations/{organizationId}/inventory/levels`	`write`
Adjust stock	`POST /organizations/{organizationId}/inventory/adjustments`	`write`
Record a stock count	`POST /organizations/{organizationId}/inventory/counts`	`write`
Transfer stock between locations	`POST /organizations/{organizationId}/inventory/transfers`	`write`
Parts requests from technicians	`GET /organizations/{organizationId}/parts-requests`	`read`
A parts request	`GET /organizations/{organizationId}/parts-requests/{partsRequestId}`	`read`
Move a parts request along	`PATCH /organizations/{organizationId}/parts-requests/{partsRequestId}`	`write`
Fulfil a parts request from stock	`POST /organizations/{organizationId}/parts-requests/{partsRequestId}/fulfil`	`write`

List stock locations

GET /organizations/{organizationId}/inventory/locations

Warehouses and trucks with item, low-stock and negative counts (and stock value with costing.read). A technician sees only their own truck(s). Read-only.

Permission: inventory.read (Owner, Admin, Dispatcher, Technician (own truck), Member); risk read (OAuth scope servflo.read).


Permission	`inventory.read`
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`inventoryLocations_list` (toolset `pricebook`)

Parameters

Name	In	Type	Required	Description
`includeInactive`	query	boolean or enum	No

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/inventory/locations" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

An array of objects:

Field	Type	Description
`id`	string
`organizationId`	string
`kind`	enum	WAREHOUSE, or TRUCK (a technician's van, stocked from a warehouse). One of `WAREHOUSE`, `TRUCK`.
`name`	string
`technicianId`	string or null
`address`	string or null
`isDefault`	boolean
`active`	boolean
`createdAt`	string (date-time)
`updatedAt`	string (date-time)
`technician`	object or null
`technician.id`	string
`technician.name`	string
`technician.color`	string
`itemCount`	integer	Items with stock (or negative stock) here.
`lowCount`	integer	Items at or below their reorder point, or negative.
`negativeCount`	integer
`stockValueCents`	integer	Integer cents. Present only for roles with `costing.read`.

Create a warehouse or truck

POST /organizations/{organizationId}/inventory/locations

Adds a location. The first warehouse becomes the default. A TRUCK names its technician: material that technician uses on a job is drawn from it. Returns the location.


Permission	`inventory.manage` (Owner, Admin, Dispatcher)
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`inventoryLocations_create` (toolset `pricebook`)

Request body

Field	Type	Required	Description
`name`	string	Yes	Up to 200 characters.
`technicianId`	string or null	No	TRUCK only: the technician whose truck it is.
`address`	string or null	No	Up to 500 characters.
`isDefault`	boolean	No	WAREHOUSE only: material used on a job whose technician has no truck comes from here.
`active`	boolean	No	Retired locations (false) are hidden.
`kind`	enum	Yes	WAREHOUSE, or TRUCK (a technician's van, stocked from a warehouse). One of `WAREHOUSE`, `TRUCK`.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/inventory/locations" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Dana Whitfield","kind":"WAREHOUSE"}'

Response

201: the answer's fields

Field	Type	Description
`id`	string
`organizationId`	string
`kind`	enum	WAREHOUSE, or TRUCK (a technician's van, stocked from a warehouse). One of `WAREHOUSE`, `TRUCK`.
`name`	string
`technicianId`	string or null
`address`	string or null
`isDefault`	boolean
`active`	boolean
`createdAt`	string (date-time)
`updatedAt`	string (date-time)
`technician`	object or null
`technician.id`	string
`technician.name`	string
`technician.color`	string

Get a location with its stock

GET /organizations/{organizationId}/inventory/locations/{locationId}

One warehouse or truck with every stock level there (status, reorder point, suggested order). A technician gets 404 for any location but their own truck. Read-only.

Permission: inventory.read (Owner, Admin, Dispatcher, Technician (own truck), Member); risk read (OAuth scope servflo.read).


Permission	`inventory.read`
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`inventoryLocations_get` (toolset `pricebook`)

Parameters

Name	In	Type	Required	Description
`locationId`	path	string	Yes

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/inventory/locations/{locationId}" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`id`	string
`organizationId`	string
`kind`	enum	WAREHOUSE, or TRUCK (a technician's van, stocked from a warehouse). One of `WAREHOUSE`, `TRUCK`.
`name`	string
`technicianId`	string or null
`address`	string or null
`isDefault`	boolean
`active`	boolean
`createdAt`	string (date-time)
`updatedAt`	string (date-time)
`technician`	object or null
`technician.id`	string
`technician.name`	string
`technician.color`	string
`levels`	array of object
`levels[].id`	string
`levels[].organizationId`	string
`levels[].itemId`	string
`levels[].locationId`	string
`levels[].onHand`	number
`levels[].reorderPoint`	number or null
`levels[].reorderQty`	number or null
`levels[].updatedAt`	string (date-time)
`levels[].item`	object
`levels[].item.id`	string
`levels[].item.code`	string or null
`levels[].item.name`	string
`levels[].item.unit`	string
`levels[].item.kind`	string
`levels[].item.costCents`	integer	Integer cents. Present only for roles with `costing.read`.
`levels[].item.vendorId`	string or null
`levels[].item.vendor`	object or null
`levels[].item.categoryId`	string or null
`levels[].location`	object
`levels[].location.id`	string
`levels[].location.name`	string
`levels[].location.kind`	enum	WAREHOUSE, or TRUCK (a technician's van, stocked from a warehouse). One of `WAREHOUSE`, `TRUCK`.
`levels[].location.technician`	object or null
`levels[].status`	enum	NEGATIVE below zero (allowed, flagged), OUT at 0, LOW at or below the reorder point. One of `NEGATIVE`, `OUT`, `LOW`, `OK`.
`levels[].low`	boolean
`levels[].suggestedQuantity`	number	What to order when low: the reorder quantity, else enough to clear the point.
`levels[].stockValueCents`	integer	Integer cents. Present only for roles with `costing.read`.
`lowCount`	integer
`stockValueCents`	integer	Integer cents. Present only for roles with `costing.read`.

Update a location

PATCH /organizations/{organizationId}/inventory/locations/{locationId}

Renames, reassigns a truck's technician, makes a warehouse the default, or retires it (active: false). Returns it.


Permission	`inventory.manage` (Owner, Admin, Dispatcher)
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`inventoryLocations_update` (toolset `pricebook`)

Parameters

Name	In	Type	Required	Description
`locationId`	path	string	Yes

Request body

Field	Type	Required	Description
`name`	string	No	Up to 200 characters.
`technicianId`	string or null	No	TRUCK only: the technician whose truck it is.
`address`	string or null	No	Up to 500 characters.
`isDefault`	boolean	No	WAREHOUSE only: material used on a job whose technician has no truck comes from here.
`active`	boolean	No	Retired locations (false) are hidden.

Example

curl -X PATCH "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/inventory/locations/{locationId}" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Dana Whitfield","technicianId":"technician_id","address":"string"}'

Response

200: the answer's fields

Field	Type	Description
`id`	string
`organizationId`	string
`kind`	enum	WAREHOUSE, or TRUCK (a technician's van, stocked from a warehouse). One of `WAREHOUSE`, `TRUCK`.
`name`	string
`technicianId`	string or null
`address`	string or null
`isDefault`	boolean
`active`	boolean
`createdAt`	string (date-time)
`updatedAt`	string (date-time)
`technician`	object or null
`technician.id`	string
`technician.name`	string
`technician.color`	string

Delete a location

DELETE /organizations/{organizationId}/inventory/locations/{locationId}

Destructive: deletes a location that never held stock or received an order (409 otherwise: retire it with active: false, the ledger is kept).


Permission	`inventory.manage` (Owner, Admin, Dispatcher)
Risk	`sensitive`, OAuth scope `servflo.sensitive`. Sensitive: moves money, deletes, sends or shows something to a customer, or grants or revokes access.
MCP tool	`inventoryLocations_delete` (toolset `pricebook`)
Approval	Over MCP, this tool always waits for your approval in ServFlo. See Approvals.

Parameters

Name	In	Type	Required	Description
`locationId`	path	string	Yes

Example

curl -X DELETE "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/inventory/locations/{locationId}" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`ok`	true

List stock levels

GET /organizations/{organizationId}/inventory/stock

Stock per item and location, filtered by location, item or text; lowOnly is the Low stock view (at or below the reorder point, or negative). A technician sees only their truck. Paged with a total. Read-only.

Permission: inventory.read (Owner, Admin, Dispatcher, Technician (own truck), Member); risk read (OAuth scope servflo.read).


Permission	`inventory.read`
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`inventory_stock` (toolset `pricebook`)

Parameters

Name	In	Type	Required	Description
`locationId`	query	string	No
`itemId`	query	string	No
`query`	query	string	No	Free-text search over the list's names, numbers and contact details. Up to 200 characters.
`lowOnly`	query	boolean or enum	No
`limit`	query	integer	No	Page size, 1–200. Default `50`.
`offset`	query	integer	No	Rows to skip; the answer's `total` counts every match. Default `0`.

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/inventory/stock" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`items`	array of object
`items[].id`	string
`items[].organizationId`	string
`items[].itemId`	string
`items[].locationId`	string
`items[].onHand`	number
`items[].reorderPoint`	number or null
`items[].reorderQty`	number or null
`items[].updatedAt`	string (date-time)
`items[].item`	object
`items[].item.id`	string
`items[].item.code`	string or null
`items[].item.name`	string
`items[].item.unit`	string
`items[].item.kind`	string
`items[].item.costCents`	integer	Integer cents. Present only for roles with `costing.read`.
`items[].item.vendorId`	string or null
`items[].item.vendor`	object or null
`items[].item.categoryId`	string or null
`items[].location`	object
`items[].location.id`	string
`items[].location.name`	string
`items[].location.kind`	enum	WAREHOUSE, or TRUCK (a technician's van, stocked from a warehouse). One of `WAREHOUSE`, `TRUCK`.
`items[].location.technician`	object or null
`items[].status`	enum	NEGATIVE below zero (allowed, flagged), OUT at 0, LOW at or below the reorder point. One of `NEGATIVE`, `OUT`, `LOW`, `OK`.
`items[].low`	boolean
`items[].suggestedQuantity`	number	What to order when low: the reorder quantity, else enough to clear the point.
`items[].stockValueCents`	integer	Integer cents. Present only for roles with `costing.read`.
`total`	integer

The stock ledger

GET /organizations/{organizationId}/inventory/movements

Stock movements newest first, filtered by item, location, job, purchase order or kind; each with the signed quantity and the balance after. Append-only. A technician sees their own truck's. Read-only.

Permission: inventory.read (Owner, Admin, Dispatcher, Technician (own truck), Member); risk read (OAuth scope servflo.read).


Permission	`inventory.read`
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`inventory_movements` (toolset `pricebook`)

Parameters

Name	In	Type	Required	Description
`itemId`	query	string	No
`locationId`	query	string	No
`jobId`	query	string	No
`purchaseOrderId`	query	string	No
`kind`	query	enum	No	RECEIVE (purchase receipt), TRANSFER_OUT / TRANSFER_IN (the two halves of a transfer), USE (on a job), RETURN (back from a job), ADJUST (correction or count). One of `RECEIVE`, `TRANSFER_OUT`, `TRANSFER_IN`, `USE`, `RETURN`, `ADJUST`.
`limit`	query	integer	No	Page size, 1–200. Default `50`.
`offset`	query	integer	No	Rows to skip; the answer's `total` counts every match. Default `0`.

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/inventory/movements" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`items`	array of object
`items[].id`	string
`items[].itemId`	string
`items[].locationId`	string
`items[].kind`	enum	RECEIVE (purchase receipt), TRANSFER_OUT / TRANSFER_IN (the two halves of a transfer), USE (on a job), RETURN (back from a job), ADJUST (correction or count). One of `RECEIVE`, `TRANSFER_OUT`, `TRANSFER_IN`, `USE`, `RETURN`, `ADJUST`.
`items[].quantity`	number	Signed: positive into the location, negative out of it.
`items[].balanceAfter`	number	The location's on-hand after this movement.
`items[].costCents`	integer	Integer cents. Present only for roles with `costing.read`.
`items[].jobId`	string or null
`items[].purchaseOrderId`	string or null
`items[].transferId`	string or null
`items[].userId`	string or null
`items[].reason`	string or null
`items[].createdAt`	string (date-time)
`items[].item`	object
`items[].item.id`	string
`items[].item.code`	string or null
`items[].item.name`	string
`items[].item.unit`	string
`items[].location`	object
`items[].location.id`	string
`items[].location.name`	string
`items[].location.kind`	enum	WAREHOUSE, or TRUCK (a technician's van, stocked from a warehouse). One of `WAREHOUSE`, `TRUCK`.
`items[].job`	object or null
`items[].job.id`	string
`items[].job.identifier`	string
`items[].purchaseOrder`	object or null
`items[].purchaseOrder.id`	string
`items[].purchaseOrder.identifier`	string
`total`	integer

My truck's stock

GET /organizations/{organizationId}/inventory/my-truck

The caller's own truck(s) (the trucks of their linked technician) with every stock level; empty when they have none. Read-only.

Permission: inventory.read (Owner, Admin, Dispatcher, Technician (own truck), Member); risk read (OAuth scope servflo.read).


Permission	`inventory.read`
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`inventory_myTruck` (toolset `pricebook`)

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/inventory/my-truck" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

An array of objects:

Field	Type	Description
`id`	string
`organizationId`	string
`kind`	enum	WAREHOUSE, or TRUCK (a technician's van, stocked from a warehouse). One of `WAREHOUSE`, `TRUCK`.
`name`	string
`technicianId`	string or null
`address`	string or null
`isDefault`	boolean
`active`	boolean
`createdAt`	string (date-time)
`updatedAt`	string (date-time)
`technician`	object or null
`technician.id`	string
`technician.name`	string
`technician.color`	string
`levels`	array of object
`levels[].id`	string
`levels[].organizationId`	string
`levels[].itemId`	string
`levels[].locationId`	string
`levels[].onHand`	number
`levels[].reorderPoint`	number or null
`levels[].reorderQty`	number or null
`levels[].updatedAt`	string (date-time)
`levels[].item`	object
`levels[].item.id`	string
`levels[].item.code`	string or null
`levels[].item.name`	string
`levels[].item.unit`	string
`levels[].item.kind`	string
`levels[].item.costCents`	integer	Integer cents. Present only for roles with `costing.read`.
`levels[].item.vendorId`	string or null
`levels[].item.vendor`	object or null
`levels[].item.categoryId`	string or null
`levels[].location`	object
`levels[].location.id`	string
`levels[].location.name`	string
`levels[].location.kind`	enum	WAREHOUSE, or TRUCK (a technician's van, stocked from a warehouse). One of `WAREHOUSE`, `TRUCK`.
`levels[].location.technician`	object or null
`levels[].status`	enum	NEGATIVE below zero (allowed, flagged), OUT at 0, LOW at or below the reorder point. One of `NEGATIVE`, `OUT`, `LOW`, `OK`.
`levels[].low`	boolean
`levels[].suggestedQuantity`	number	What to order when low: the reorder quantity, else enough to clear the point.
`levels[].stockValueCents`	integer	Integer cents. Present only for roles with `costing.read`.
`lowCount`	integer
`stockValueCents`	integer	Integer cents. Present only for roles with `costing.read`.

Set a reorder point

PATCH /organizations/{organizationId}/inventory/levels

Sets the reorder point and reorder quantity of an item at a location (null clears them). Stock is not changed (use adjustments). Returns the level.


Permission	`inventory.manage` (Owner, Admin, Dispatcher)
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`inventory_setLevel` (toolset `pricebook`)

Request body

Field	Type	Required	Description
`itemId`	string	Yes	A MATERIAL or EQUIPMENT item (GET /pricebook/items).
`locationId`	string	Yes
`reorderPoint`	number or null	No	Low at or below this. 0–1000000.
`reorderQty`	number or null	No	How many to order. 0–1000000.

Example

curl -X PATCH "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/inventory/levels" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"itemId":"item_id","locationId":"location_id"}'

Response

200: the answer's fields

Field	Type	Description
`id`	string
`organizationId`	string
`itemId`	string
`locationId`	string
`onHand`	number
`reorderPoint`	number or null
`reorderQty`	number or null
`updatedAt`	string (date-time)
`item`	object
`item.id`	string
`item.code`	string or null
`item.name`	string
`item.unit`	string
`item.kind`	string
`item.costCents`	integer	Integer cents. Present only for roles with `costing.read`.
`item.vendorId`	string or null
`item.vendor`	object or null
`item.vendor.id`	string
`item.vendor.name`	string
`item.categoryId`	string or null
`location`	object
`location.id`	string
`location.name`	string
`location.kind`	enum	WAREHOUSE, or TRUCK (a technician's van, stocked from a warehouse). One of `WAREHOUSE`, `TRUCK`.
`location.technician`	object or null
`location.technician.id`	string
`location.technician.name`	string
`location.technician.color`	string
`status`	enum	NEGATIVE below zero (allowed, flagged), OUT at 0, LOW at or below the reorder point. One of `NEGATIVE`, `OUT`, `LOW`, `OK`.
`low`	boolean
`suggestedQuantity`	number	What to order when low: the reorder quantity, else enough to clear the point.
`stockValueCents`	integer	Integer cents. Present only for roles with `costing.read`.

Adjust stock

POST /organizations/{organizationId}/inventory/adjustments

Adds (positive) or removes (negative) stock at a location with a reason (damage, found, correction): an ADJUST movement in the ledger. Negative stock is allowed and flagged. Returns the movement and the new level.


Permission	`inventory.manage` (Owner, Admin, Dispatcher)
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`inventory_adjust` (toolset `pricebook`)

Request body

Field	Type	Required	Description
`itemId`	string	Yes
`locationId`	string	Yes
`quantity`	number	Yes	Units of the item; may be fractional. -1000000–1000000.
`reason`	string	Yes	Why (required). Up to 1000 characters.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/inventory/adjustments" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"itemId":"item_id","locationId":"location_id","quantity":1,"reason":"string"}'

Response

201: the answer's fields

Field	Type	Description
`movement`	object
`movement.id`	string
`movement.itemId`	string
`movement.locationId`	string
`movement.kind`	enum	RECEIVE (purchase receipt), TRANSFER_OUT / TRANSFER_IN (the two halves of a transfer), USE (on a job), RETURN (back from a job), ADJUST (correction or count). One of `RECEIVE`, `TRANSFER_OUT`, `TRANSFER_IN`, `USE`, `RETURN`, `ADJUST`.
`movement.quantity`	number	Signed: positive into the location, negative out of it.
`movement.balanceAfter`	number	The location's on-hand after this movement.
`movement.costCents`	integer	Integer cents. Present only for roles with `costing.read`.
`movement.jobId`	string or null
`movement.purchaseOrderId`	string or null
`movement.transferId`	string or null
`movement.userId`	string or null
`movement.reason`	string or null
`movement.createdAt`	string (date-time)
`level`	object
`level.itemId`	string
`level.locationId`	string
`level.onHand`	number
`negative`	boolean	The location is below zero now (allowed, flagged).

Record a stock count

POST /organizations/{organizationId}/inventory/counts

Sets each counted item at a location to what was counted (an ADJUST movement for each difference; unchanged items are not moved). Returns what changed.


Permission	`inventory.manage` (Owner, Admin, Dispatcher)
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`inventory_count` (toolset `pricebook`)

Request body

Field	Type	Required	Description
`locationId`	string	Yes
`counts`	array of object	Yes	Up to 1000 items.
`counts[].itemId`	string	Yes
`counts[].counted`	number	Yes	-1000000–1000000.
`reason`	string or null	No	Defaults to "Stock count". Up to 1000 characters.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/inventory/counts" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"locationId":"location_id","counts":[{"itemId":"item_id","counted":1}]}'

Response

201: the answer's fields

Field	Type	Description
`counted`	integer
`adjusted`	integer
`lines`	array of object
`lines[].itemId`	string
`lines[].before`	number
`lines[].counted`	number
`lines[].adjustment`	number

Transfer stock between locations

POST /organizations/{organizationId}/inventory/transfers

Moves stock from one location to another (a warehouse restocking a truck): a TRANSFER_OUT and a TRANSFER_IN per line, sharing a transferId, in one transaction. The source may go negative (flagged). Returns the new levels.


Permission	`inventory.manage` (Owner, Admin, Dispatcher)
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`inventory_transfer` (toolset `pricebook`)

Request body

Field	Type	Required	Description
`fromLocationId`	string	Yes
`toLocationId`	string	Yes
`lines`	array of object	Yes	Up to 500 items.
`lines[].itemId`	string	Yes
`lines[].quantity`	number	Yes	At most 1000000.
`reason`	string or null	No	Up to 1000 characters.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/inventory/transfers" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fromLocationId":"fromLocation_id","toLocationId":"toLocation_id","lines":[{"itemId":"item_id","quantity":1}]}'

Response

201: the answer's fields

Field	Type	Description
`transferId`	string
`lines`	array of object
`lines[].itemId`	string
`lines[].quantity`	number
`lines[].fromOnHand`	number
`lines[].toOnHand`	number

Parts requests from technicians

GET /organizations/{organizationId}/parts-requests

What technicians asked for from the app (PRQ-n), newest first: for a job or to restock their truck, with the lines, the technician, the job and the truck. open=true lists REQUESTED, ORDERED and READY. Read-only.


Permission	`inventory.manage` (Owner, Admin, Dispatcher)
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`partsRequests_list` (toolset `scheduling`)

Parameters

Name	In	Type	Required	Description
`status`	query	enum	No	One of `REQUESTED`, `ORDERED`, `READY`, `DONE`, `CANCELLED`.
`open`	query	boolean	No
`technicianId`	query	string	No

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/parts-requests" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

An array of objects:

Field	Type	Description
`id`	string	Parts request id.
`organizationId`	string
`identifier`	string	PRQ-n, unique per organization.
`kind`	enum	For a job, or to restock the truck. One of `JOB`, `RESTOCK`.
`status`	enum	REQUESTED → ORDERED (from a supplier) → READY (waiting for pickup) → DONE (on the truck), or CANCELLED. One of `REQUESTED`, `ORDERED`, `READY`, `DONE`, `CANCELLED`.
`technicianId`	string or null
`requestedByUserId`	string
`jobId`	string or null
`truckId`	string or null	The technician's truck (inventory location).
`neededBy`	string or null	YYYY-MM-DD
`note`	string or null
`officeNote`	string or null	The office's answer to the technician.
`statusChangedAt`	string (date-time)
`createdAt`	string (date-time)
`updatedAt`	string (date-time)
`technician`	object or null
`technician.id`	string	Technician id (GET /technicians).
`technician.name`	string
`technician.color`	string	Calendar colour, #rrggbb.
`job`	object or null
`job.id`	string
`job.identifier`	string	JOB-n
`job.customer`	object
`job.customer.name`	string
`truck`	object or null
`truck.id`	string
`truck.name`	string
`lines`	array of object
`lines[].id`	string
`lines[].itemId`	string or null	The pricebook item, when it is one.
`lines[].description`	string
`lines[].quantity`	number
`lines[].item`	object or null
`lines[].item.code`	string or null
`lines[].item.name`	string

A parts request

GET /organizations/{organizationId}/parts-requests/{partsRequestId}

One parts request with its lines. Read-only.


Permission	`inventory.manage` (Owner, Admin, Dispatcher)
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`partsRequests_get` (toolset `scheduling`)

Parameters

Name	In	Type	Required	Description
`partsRequestId`	path	string	Yes

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/parts-requests/{partsRequestId}" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`id`	string	Parts request id.
`organizationId`	string
`identifier`	string	PRQ-n, unique per organization.
`kind`	enum	For a job, or to restock the truck. One of `JOB`, `RESTOCK`.
`status`	enum	REQUESTED → ORDERED (from a supplier) → READY (waiting for pickup) → DONE (on the truck), or CANCELLED. One of `REQUESTED`, `ORDERED`, `READY`, `DONE`, `CANCELLED`.
`technicianId`	string or null
`requestedByUserId`	string
`jobId`	string or null
`truckId`	string or null	The technician's truck (inventory location).
`neededBy`	string or null	YYYY-MM-DD
`note`	string or null
`officeNote`	string or null	The office's answer to the technician.
`statusChangedAt`	string (date-time)
`createdAt`	string (date-time)
`updatedAt`	string (date-time)
`technician`	object or null
`technician.id`	string	Technician id (GET /technicians).
`technician.name`	string
`technician.color`	string	Calendar colour, #rrggbb.
`job`	object or null
`job.id`	string
`job.identifier`	string	JOB-n
`job.customer`	object
`job.customer.name`	string
`truck`	object or null
`truck.id`	string
`truck.name`	string
`lines`	array of object
`lines[].id`	string
`lines[].itemId`	string or null	The pricebook item, when it is one.
`lines[].description`	string
`lines[].quantity`	number
`lines[].item`	object or null
`lines[].item.code`	string or null
`lines[].item.name`	string

Move a parts request along

PATCH /organizations/{organizationId}/parts-requests/{partsRequestId}

Tells the technician: sets the status (REQUESTED → ORDERED → READY → DONE, or CANCELLED from any open status) and an optional officeNote ('At Ferguson, counter 2'); the technician's phone is told when it is ordered, ready or cancelled. 409 for a closed request.


Permission	`inventory.manage` (Owner, Admin, Dispatcher)
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`partsRequests_update` (toolset `scheduling`)

Parameters

Name	In	Type	Required	Description
`partsRequestId`	path	string	Yes

Request body

Field	Type	Required	Description
`status`	enum	Yes	One of `REQUESTED`, `ORDERED`, `READY`, `DONE`, `CANCELLED`.
`officeNote`	string or null	No	Up to 2000 characters.

Example

curl -X PATCH "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/parts-requests/{partsRequestId}" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"REQUESTED"}'

Response

200: the answer's fields

Field	Type	Description
`id`	string	Parts request id.
`organizationId`	string
`identifier`	string	PRQ-n, unique per organization.
`kind`	enum	For a job, or to restock the truck. One of `JOB`, `RESTOCK`.
`status`	enum	REQUESTED → ORDERED (from a supplier) → READY (waiting for pickup) → DONE (on the truck), or CANCELLED. One of `REQUESTED`, `ORDERED`, `READY`, `DONE`, `CANCELLED`.
`technicianId`	string or null
`requestedByUserId`	string
`jobId`	string or null
`truckId`	string or null	The technician's truck (inventory location).
`neededBy`	string or null	YYYY-MM-DD
`note`	string or null
`officeNote`	string or null	The office's answer to the technician.
`statusChangedAt`	string (date-time)
`createdAt`	string (date-time)
`updatedAt`	string (date-time)
`technician`	object or null
`technician.id`	string	Technician id (GET /technicians).
`technician.name`	string
`technician.color`	string	Calendar colour, #rrggbb.
`job`	object or null
`job.id`	string
`job.identifier`	string	JOB-n
`job.customer`	object
`job.customer.name`	string
`truck`	object or null
`truck.id`	string
`truck.name`	string
`lines`	array of object
`lines[].id`	string
`lines[].itemId`	string or null	The pricebook item, when it is one.
`lines[].description`	string
`lines[].quantity`	number
`lines[].item`	object or null
`lines[].item.code`	string or null
`lines[].item.name`	string

Fulfil a parts request from stock

POST /organizations/{organizationId}/parts-requests/{partsRequestId}/fulfil

Moves stock: transfers the request's pricebook lines from fromLocationId (a warehouse, GET /inventory/locations) onto the technician's truck as an ordinary transfer, then marks the request DONE. Lines without a pricebook item are left to the office. 400 when the technician has no truck or stock is short.


Permission	`inventory.manage` (Owner, Admin, Dispatcher)
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`partsRequests_fulfil` (toolset `scheduling`)

Parameters

Name	In	Type	Required	Description
`partsRequestId`	path	string	Yes

Request body

Field	Type	Required	Description
`fromLocationId`	string	Yes
`officeNote`	string or null	No	Up to 2000 characters.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/parts-requests/{partsRequestId}/fulfil" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fromLocationId":"fromLocation_id"}'

Response

200: the answer's fields

Field	Type	Description
`id`	string	Parts request id.
`organizationId`	string
`identifier`	string	PRQ-n, unique per organization.
`kind`	enum	For a job, or to restock the truck. One of `JOB`, `RESTOCK`.
`status`	enum	REQUESTED → ORDERED (from a supplier) → READY (waiting for pickup) → DONE (on the truck), or CANCELLED. One of `REQUESTED`, `ORDERED`, `READY`, `DONE`, `CANCELLED`.
`technicianId`	string or null
`requestedByUserId`	string
`jobId`	string or null
`truckId`	string or null	The technician's truck (inventory location).
`neededBy`	string or null	YYYY-MM-DD
`note`	string or null
`officeNote`	string or null	The office's answer to the technician.
`statusChangedAt`	string (date-time)
`createdAt`	string (date-time)
`updatedAt`	string (date-time)
`technician`	object or null
`technician.id`	string	Technician id (GET /technicians).
`technician.name`	string
`technician.color`	string	Calendar colour, #rrggbb.
`job`	object or null
`job.id`	string
`job.identifier`	string	JOB-n
`job.customer`	object
`job.customer.name`	string
`truck`	object or null
`truck.id`	string
`truck.name`	string
`lines`	array of object
`lines[].id`	string
`lines[].itemId`	string or null	The pricebook item, when it is one.
`lines[].description`	string
`lines[].quantity`	number
`lines[].item`	object or null
`lines[].item.code`	string or null
`lines[].item.name`	string

On this page