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 Orders" operation allows users to search for orders within their Shipentegra account based on various criteria such as page number, limit per page, order status, order number, and store ID.

This operation is beneficial in scenarios where users need to retrieve a list of orders for processing, tracking, or reporting purposes. For example, an e-commerce platform could use this node to fetch recent orders that require shipment or to monitor order statuses in bulk.

Properties

Name Meaning
Page The page number of results to retrieve (minimum value: 1).
Limit The maximum number of orders to return per page (between 20 and 100).
Status Filter orders by their status. Options include: None (no filter), 0, 1, 2, 3, 4, 5.
Order Number Filter orders by a specific order number (string).
Store ID Filter orders by a specific store identifier (number).

Output

The output contains JSON data representing the list of orders matching the specified filters. Each order object typically includes details such as order identifiers, status, associated store, and other relevant metadata provided by the Shipentegra API.

If the node supports binary data output (not explicitly shown here), it would generally represent files like shipping labels or documents related to orders, but for the "Find Orders" operation, the output is primarily JSON-based order data.

Dependencies

  • Requires an API key credential for authenticating with the Shipentegra API.
  • The base URL for API requests is https://publicapi.shipentegra.com/v1.
  • The node expects JSON content-type headers and supports localization via an optional language setting in credentials.

Troubleshooting

  • Common Issues:

    • Invalid or missing API authentication token can cause authorization errors.
    • Providing out-of-range values for pagination (e.g., page < 1 or limit outside 20-100) may result in request failures.
    • Filtering by non-existent order numbers or store IDs will return empty results.
  • Error Messages:

    • Authorization errors usually indicate issues with the API key; verify the credential configuration.
    • Validation errors may occur if input properties do not meet expected constraints (e.g., invalid status code).
    • Network or API downtime can cause request timeouts or connection errors.

Links and References

Discussion