Xentral icon

Xentral

Interact with Xentral ERP API

Actions196

Return → Get Many

AI-generated

Summary

Retrieve multiple return orders from Xentral with optional filters and pagination control.

Inputs

  • returnAll (required) — Indicates whether to retrieve all return orders (true) or up to a specified limit (false).
  • filters — Optional filters to narrow down results, including return order status and customer ID.
  • maxPages — Maximum number of API pages to fetch when returning all results; each page contains 50-150 records. Defaults to 1000 pages.
  • limit — Maximum number of return orders to retrieve when not returning all. Range is 1 to 100, defaulting to 50.

Output shape

a list of return order records

If 'returnAll' is true, results may include up to 'maxPages' API pages worth of records. If false, results are capped at 'limit' items. Each return order record includes standard and nested fields as returned by the Xentral API.

Examples

Example 1: Fetch all return orders with status 'released' for a specific customer, up to 1000 pages.

Set 'returnAll' to true, set 'filters.status' to 'released', and 'filters.customerId' to the target customer ID.

Example 2: Fetch up to 50 return orders regardless of status.

Set 'returnAll' to false and 'limit' to 50.

Links

Discussion