Inventory

Search inventory items.

Search inventory items by name or code.

get/inventory/search

Request

  • Base URL: https://api.floorworks.co.uk/api/v1
  • URL: https://api.floorworks.co.uk/api/v1/inventory/search
  • Auth: OAuth 2 (password, token URL https://api.floorworks.co.uk/api/v1/auth)

Query parameters

searchstring required

Search query string (matches name, code, or barcode).

srch_stock_type'PRODUCT' | 'SERVICE' | 'ASSET' | 'STANDARD'

Filter by stock type.

Response

Matching inventory items

trade_idinteger nullable

Trade / skill category ID.

stock_type'PRODUCT' | 'SERVICE' | 'ASSET' | 'STANDARD' nullable

Type of inventory item.

namestring nullable

Display name.

codestring nullable

Product SKU / code.

descriptionstring nullable

Long-form description.

product_statusinteger nullable

Product status ID.

description_statusinteger nullable

Visibility / publication status of the product description.

ratinginteger nullable

Product rating.

package_type_idinteger nullable

Packaging type ID.

unit_type_idinteger nullable

Unit of measure type ID.

category_idinteger nullable

Product category ID.

weightnumber float nullable

Weight of the item (kg).

unit_sizenumber float nullable

Size per unit.

active0 | 1 nullable

Whether the item is active (1 = active, 0 = inactive).

brand_idinteger nullable

Brand ID.

channelsstring nullable

Sales channels the product is listed on.

price_on_request0 | 1 nullable

Whether pricing requires a quote (1 = yes).

barcodestring nullable

Product barcode / EAN.

qty_thresholdnumber float nullable

Low stock alert threshold quantity.

qty_required_deliverynumber float nullable

Minimum quantity required for delivery.

locked_pricesboolean nullable

Whether prices are locked and cannot be overridden on orders.

free_delivery_thresholdnumber float nullable

Minimum order value for free delivery.

colorstring nullable

Hex colour code (e.g. #FF5733).

free_delivery0 | 1 nullable

Whether the item qualifies for free delivery (1 = yes).

dim_widthnumber float nullable

Width dimension.

dim_heightnumber float nullable

Height dimension.

dim_lengthnumber float nullable

Length dimension.

dim_unitsstring nullable

Unit of measurement for dimensions (e.g. mm, cm, in).

time_slotinteger nullable

Estimated duration of the survey slot in minutes.

time_slot_notificationnumber float nullable

Notification lead time for slot (minutes).

time_pre_workinteger nullable

Pre-work preparation time (minutes).

time_completioninteger nullable

Estimated completion time (minutes).

time_post_workinteger nullable

Post-work wrap-up time (minutes).

enable_price_per_unit0 | 1 nullable

Whether per-unit pricing is enabled (1 = yes).

idnumber

ID.

uuidstring uuid

UUID.

time_createdstring YYYY-MM-DD

Creation date

time_modifiedstring YYYY-MM-DD

Last modification date

Example response

[
  {
    "id": 12345,
    "time_created": "2025-08-17",
    "time_modified": "2025-08-18"
  }
]

Changes

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