Shipentegra API icon

Shipentegra API

Shipentegra provides a versatile integration for easily managing shipping and logistics operations.

Overview

The node integrates with the Shipentegra API to update the status of one or more orders. This operation is useful in logistics and shipping workflows where order statuses need to be programmatically changed based on shipment progress, cancellations, or other business rules. For example, after a package is shipped, this node can update the order status to reflect that it is "in transit" or "delivered," enabling automated tracking and notifications.

Properties

Name Meaning
Order IDs A collection of one or more numeric order IDs identifying the orders whose status will be updated. Each ID must be a positive integer.
Status The new status to assign to the specified orders. Options are: None (no change), 1, 2, 3, or 4. These numeric values correspond to predefined status codes within Shipentegra's system.

Output

The node outputs JSON data representing the response from the Shipentegra API after attempting to update the order statuses. This typically includes confirmation of the update, any errors encountered per order, and possibly the updated order details. The output does not include binary data.

Dependencies

  • Requires an API key credential for authenticating with the Shipentegra API.
  • The node communicates with the Shipentegra public API endpoint at https://publicapi.shipentegra.com/v1.
  • Proper configuration of the API key and optional language preference in credentials is necessary.

Troubleshooting

  • Invalid Order IDs: If provided order IDs do not exist or are invalid, the API may return errors. Ensure all order IDs are correct and active.
  • Unauthorized Access: Missing or incorrect API authentication will cause authorization errors. Verify that the API key credential is correctly set up.
  • Invalid Status Value: Providing a status value outside the allowed options (empty, 1, 2, 3, 4) may result in validation errors. Use only the supported status codes.
  • API Rate Limits or Downtime: Network issues or API rate limits might cause request failures. Check network connectivity and Shipentegra service status if errors persist.

Links and References

Discussion