Warehouses

List all warehouses

This endpoint allows you to get all Warehouses.

get/stocks/warehouses

Request

  • Base URL: https://api.infraspeak.com/v3
  • URL: https://api.infraspeak.com/v3/stocks/warehouses
  • Auth: HTTP bearer

Query parameters

expand'operators'

A comma-separated list of related resources to include in the response data.

sort'code' | 'name' | 'address' | 'warehouse_id'

The field by which the warehouse results will be sorted.

order'asc' | 'desc'

The sorting direction to apply to the results.

searchTextstring

A general search term to filter warehouses. Enter keywords to search across warehouse code, name, and address. This parameter performs a partial match (using 'LIKE' internally) on these fields.

date_min_updated_atstring

Filter warehouses to include only those updated on or after the specified date and time.

date_max_updated_atstring

Filter warehouses to include only those updated on or before the specified date and time.

date_min_created_atstring

Filter warehouses to include only those created on or after the specified date and time.

date_max_created_atstring

Filter warehouses to include only those created on or before the specified date and time.

s_codestring

Search term to filter warehouses by their unique code. This parameter performs a partial match (using 'LIKE' internally) on the warehouse code.

s_namestring

Search term to filter warehouses by their descriptive name. This parameter performs a partial match (using 'LIKE' internally) on the warehouse name.

warehouse_managers_idsinteger[]

Filter warehouses by the IDs of their associated managers. Only warehouses that have at least one manager with an ID present in this list will be returned.

s_material_idstring

Filter warehouses to include only those that have ever stocked or currently hold the specified material ID.

limitinteger

The maximum number of records to return in a single response page. This parameter controls the size of the result set for pagination.

pageinteger

The specific page number of the results to retrieve.

Response

OK

includedobject[]

List of relationships to be included

Changes

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