Contractors.es icon

Contractors.es

Interact with Contractors.es API

Actions995

Warehouse Api → Post Api Assets Warehouses Search

AI-generated

Summary

Search for warehouses using the Contractors.es API with optional filters, pagination, sorting, and trash state parameters.

Inputs

  • With Trashed — Boolean flag to include trashed warehouses in the search results (defaults to false).
  • Only Trashed — Boolean flag to return only trashed warehouses (defaults to false).
  • Page — Page number for paginated search results (defaults to 1).
  • Limit — Maximum number of results per page (defaults to 20).
  • Filters — JSON object defining specific filter criteria for the warehouse search.
  • Sort — JSON object specifying sorting criteria for the search results.

Output shape

a list of warehouse records matching the search criteria

Supports pagination via 'page' and 'limit' query parameters; filters and sort criteria are sent in the request body as JSON; trash state can be controlled using 'With Trashed' and 'Only Trashed' query parameters.

Examples

Example 1: Search warehouses with active state and sort by name ascending

Set 'Filters' with JSON like {"state":"active"}, 'Sort' with JSON like {"name":"asc"}, leave trash flags false, set 'Page' and 'Limit' as desired.

Links

Discussion