HIPE icon

HIPE

Interact with HIPE API

corrugatedMaterialComposition → Get Many

AI-generated

Summary

Retrieve multiple corrugated material composition records, optionally filtered by corrugated material ID or flute ID, with control over pagination and sorting.

Inputs

  • Return All — Boolean to decide whether to return all available results or limit the output.
  • Limit — Maximum number of results to return if not returning all.
  • Page — Page number of results to fetch, starting from 1, when not returning all.
  • Filters — Optional filters to narrow down results by specific corrugated material ID or flute ID.
  • Sort — Optional sorting options including sorting by creation date and order (ascending or descending).

Output shape

a list of corrugated material composition items

Supports pagination through 'Limit' and 'Page' inputs unless 'Return All' is enabled. Returned data includes multiple records matching the filtering and sorting criteria if specified.

Examples

Example 1: Retrieve all corrugated material compositions without limit

Set 'Return All' to true, no limit or page parameters needed.

Example 2: Retrieve first 50 corrugated material compositions sorted by creation date descending

Set 'Return All' to false, 'Limit' to 50, 'Page' to 1, 'Sort By' to 'Created At', and 'Sort Order' to 'Descending'.

Example 3: Retrieve corrugated material compositions filtered by a specific flute ID

Specify the 'Flute ID' under 'Filters' collection; adjust pagination and sorting as needed.

Links

Discussion