HIPE icon

HIPE

Interact with HIPE API

corrugatedMaterial → Get Many

AI-generated

Summary

Retrieve multiple corrugated material records from the HIPE system with optional filtering, sorting, and pagination.

Inputs

  • Return All — Boolean flag to return all records without pagination.
  • Limit — Maximum number of corrugated material records to return when not returning all.
  • Page — Page number to retrieve when pagination is used (starts at 1).
  • Filters — Filters to narrow results; currently supports filtering by material name.
  • Sort — Sorting options specifying field ('Name' or 'Created At') and order ('Ascending' or 'Descending').

Output shape

a list of corrugated material records matching the filters and sort criteria

If 'Return All' is false, results are paginated with the specified page and limit; otherwise, all matching records are returned in one response.

Examples

Example 1: Fetch first 50 corrugated materials ordered by name ascending without filters.

Set Return All to false, Limit to 50, Page to 1, no Filters, Sort by Name ascending.

Example 2: Fetch all corrugated materials with names containing a specific string.

Set Return All to true, define a Name filter with the desired string, leave sorting as default.

Links

Discussion