avanta icon

avanta

Consume avanta API

Actions57

Servicecenter - Shipment → Get Many

AI-generated

Overview

This node operation retrieves multiple shipment records from the Servicecenter resource. It is useful for scenarios where you need to fetch a list of shipments, optionally including detailed position data, with control over the number of results returned and filtering capabilities. For example, it can be used to get all shipments for a logistics dashboard or to analyze shipment data with specific filters.

Use Case Examples

  1. Fetch all shipments with positions included for detailed tracking.
  2. Retrieve a limited number of shipments with a JSON filter applied to narrow down results.

Properties

Name Meaning
Request Options Options to control request behavior such as enabling debug mode, ignoring SSL certificate issues, and setting request timeout.
With Positions Whether to include detailed position information in the shipment response.
Return All Whether to return all shipment results or limit the number of results.
Limit Maximum number of shipment results to return if not returning all.
Filter Type of filter to apply to the shipment query, either none or JSON-based.
Filters (JSON) JSON string representing the filter criteria to apply when retrieving shipments.

Output

JSON

  • shipments - Array of shipment objects retrieved from the Servicecenter API.
  • positions - Optional detailed position data included with shipments if requested.
  • debugInfo - Debug information about the API request if debug mode is enabled.

Dependencies

  • An API key credential for authenticating with the Avanta API.

Troubleshooting

  • Ensure the API key credential is correctly configured and has permissions to access shipment data.
  • If SSL issues occur, consider enabling the option to ignore SSL certificate validation, but be aware of security risks.
  • Timeout errors may occur if the server is slow to respond; increase the timeout setting if needed.
  • Invalid JSON filter strings can cause errors; ensure the filter JSON is correctly formatted.

Links

Discussion