sevDesk icon

sevDesk

Consume the sevDesk API
Join our community

Actions98

Overview

This node integrates with the sevDesk API to update existing orders. It allows users to modify order details such as contact information, order date, status, and individual order positions (items). This is useful in scenarios where an order needs correction or updating after creation, for example, changing the delivery address, updating quantities or prices of items, or adjusting the order status.

Practical examples:

  • Updating the status of an order from "Draft" to "Delivered" once shipment occurs.
  • Modifying the quantity or price of specific items in an order before invoicing.
  • Changing the contact person or address associated with an order.

Properties

Name Meaning
Order ID The unique identifier of the order to update.
Order A collection of fields representing the order's details to update:
- Address: The shipping or billing address for the order.
- Contact ID: The identifier of the contact associated with the order (required).
- Contact Person ID: The identifier of the contact person related to the order.
- Foot Text: Custom text to appear at the bottom of the order document.
- Head Text: Custom text to appear at the top of the order document.
- Header: Header text for the order document.
- Order Date: The date when the order was placed (required).
- Order ID: Internal order identifier (optional, may be used for reference).
- Order Number: The number assigned to the order.
- Status: The current status of the order. Options include Draft, Delivered, Billed, Accepted, Declined, Finished.
Order Positions A collection of one or more order positions (line items) to update, each containing:
- Discount: Discount applied to the position (number).
- Part ID: Identifier of the part/product associated with this position.
- Position Number: The sequence number of the position in the order.
- Price: Price per unit for the position.
- Quantity: Number of units for the position.

Output

The node outputs JSON data representing the updated order object returned by the sevDesk API. This typically includes all updated fields of the order, reflecting the changes made.

If errors occur during execution, the output will contain an error message in JSON format under the error field.

No binary data output is produced by this node.

Dependencies

  • Requires a valid API key credential for authenticating with the sevDesk API.
  • The node uses the base URL https://my.sevdesk.de/api/ combined with the configured API version.
  • Environment configuration validation is performed before execution to ensure necessary environment variables are set.

Troubleshooting

  • Common issues:

    • Missing or invalid Order ID will cause the update operation to fail.
    • Providing incomplete required fields such as Contact ID or Order Date may result in validation errors.
    • Incorrect status values outside the predefined options will be rejected.
    • Network or authentication failures due to invalid API credentials.

  • Error messages:

    • Errors returned from the API will be included in the output JSON under the error property.
    • Validation schema initialization failure is logged to the console but does not stop node execution.

  • Resolutions:

    • Ensure all required fields are provided and correctly formatted.
    • Verify API credentials and network connectivity.
    • Use the provided status options exactly as listed.

Links and References

Discussion