mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node interacts with the mittwald mStudio API to list orders related to contracts. It allows users to retrieve a filtered and paginated list of contract orders based on various criteria such as status inclusion/exclusion and template names. This is useful in scenarios where you need to automate order management, reporting, or synchronization with other systems by fetching specific subsets of contract orders.

Practical examples:

  • Fetching the first 1000 contract orders that match certain statuses for batch processing.
  • Skipping a number of orders to paginate through large datasets.
  • Filtering orders by specific contract templates to focus on particular product lines or services.

Properties

Name Meaning
Limit Maximum number of orders to return in one request (default: 1000).
Skip Number of orders to skip before starting to collect the result set (default: 0).
Page Page number to retrieve, used for pagination (default: 1).
Includes Status JSON array specifying which order statuses to include in the results.
Excludes Status JSON array specifying which order statuses to exclude from the results.
Template Names JSON array of contract template names to filter the orders by (default: ["WH25-0001"]).

Output

The node outputs a JSON array of order objects matching the specified filters and pagination settings. Each item in the output corresponds to an individual contract order retrieved from the mittwald mStudio API.

If binary data were involved, it would typically represent attachments or documents related to orders, but this node focuses on JSON data representing order details.

Dependencies

  • Requires an API key credential for authenticating with the mittwald mStudio API.
  • The node uses the base URL https://api.mittwald.de for all requests.
  • No additional external dependencies beyond the API access are required.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing invalid JSON arrays for status filters or template names may lead to request errors.
    • Pagination parameters (limit, skip, page) set incorrectly might result in empty responses or repeated data.

  • Error messages:

    • Authentication errors usually indicate invalid or expired API keys; verify and update credentials.
    • Validation errors from the API may occur if query parameters are malformed; ensure JSON inputs are correctly formatted.
    • Rate limiting or server errors from the API should be handled by retrying after some delay.

Links and References

Discussion