Inventory Settings

List all warehouses.

get/configs/warehouses

Request

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

Query parameters

page_sizenumber

Results per page

pagenumber

Current page

order_direction'DESC' | 'ASC'

Sort results ascending or descending

Response

Paginated list of warehouses.

namestring nullable

Display name.

descriptionstring nullable

Long-form description.

referencestring

Auto generated reference of the document.

phonestring nullable

Phone number.

emailstring email nullable

Email address.

addr_line1string nullable

Address line 1.

addr_line2string nullable

Address line 2.

addr_citystring nullable

City.

addr_postcodestring nullable

Postcode / ZIP code.

addr_countrystring nullable

Country.

statusstring nullable

Warehouse status.

idnumber

ID.

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.