Items

Creates a catalog item.

Requires ManageInventory and an Idempotency-Key header. Same as adding an item in the app: the item gets the organization's default "No Category" when categoryId is omitted, its Cost and Unit Price properties are created (0 unless cost / unitPrice are supplied, stored to 2 decimals) and the category's properties are copied onto it. An active item with the same name is refused with 409 (the rule the app's template builder applies). Creates no stock — follow up with POST /api/v1/items/{id}/stock/adjust. No webhook fires for a create. Permissions mirror the app exactly: the Items page creates items, sets price/cost and category under ManageInventory, so that is all this endpoint needs — except description, which in the app is edited only on the Item Templates page and so additionally requires ManageTemplates (403 otherwise; omit the field or grant the permission to the key). Example: { "name": "1/2\" PEX Coupling", "categoryId": 4, "unitPrice": 1.25, "cost": 0.40 }.

post/api/v1/items

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/items
  • Auth: HTTP bearer

Request body

namestring required

Display name; required, 1-100 characters. An active item with the same name is refused (409).

descriptionstring nullable

Optional free-text description, max 2000 characters.

categoryIdinteger nullable

Primary category id (see the item's categoryId on GET). Omit or null for the organization's default "No Category". Unknown or another organization's id → 422.

unitPricenumber double nullable

Starting selling price, 0 or more, stored to 2 decimals as the Unit Price property. Omit for 0.

costnumber double nullable

Starting purchase cost, 0 or more, stored to 2 decimals as the Cost property. Omit for 0.

Response

Created; body is the item exactly as GET /api/v1/items/{id} returns it, Location points at it.

propertiesobject

Every template property by name (includes Unit Price and Cost when set).

parentItemIdinteger nullable

Id of the parent template for variant children; null otherwise.

Changes

No recorded changes to this operation across all 1 revision of this API.