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 manage shipping and logistics operations. Specifically, the "Find Order" operation allows users to retrieve detailed information about a specific order by its unique identifier. This is useful in scenarios where you need to track the status, details, or history of an order within your shipping workflow.

Practical examples include:

  • Fetching order details to display shipment status in a customer service dashboard.
  • Automating follow-up actions based on order status (e.g., triggering notifications when an order is found).
  • Integrating order data into other systems for reporting or analytics.

Properties

Name Meaning
Request Details Informational notice related to the request; does not require input.
Order ID The unique numeric identifier of the order to find. Must be between 1 and 9007199254740991.
Filter Optional filter to specify which subset of order data to retrieve. Options are: None, General, Price, Carrier.

Output

The output contains JSON data representing the found order's details as returned by the Shipentegra API. The structure includes all relevant order information such as identifiers, status, pricing, carrier details, and other metadata depending on the selected filter.

If binary data is returned (not indicated explicitly here), it would typically represent documents or labels related to the order, but this operation primarily returns JSON order data.

Dependencies

  • Requires an API key credential for authenticating with the Shipentegra API.
  • The node uses the base URL https://publicapi.shipentegra.com/v1.
  • Proper configuration of the API authentication token and optional language preference is necessary.

Troubleshooting

  • Order Not Found: If the specified Order ID does not exist, the API may return an error or empty result. Verify the Order ID is correct.
  • Invalid Order ID: Providing a non-numeric or out-of-range Order ID will cause validation errors.
  • Authentication Errors: Ensure the API key credential is valid and has appropriate permissions.
  • Filter Misuse: Using an unsupported filter value might lead to incomplete or no data returned.

Links and References

Discussion