Shipentegra API icon

Shipentegra API

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

Overview

This node integrates with the Shipentegra API to create shipping labels specifically using the "Create Shipentegra Label" operation. It is designed for users who need to generate shipping labels programmatically as part of their logistics or e-commerce workflows. Typical use cases include automating label creation for orders, managing shipments across multiple stores, and handling customs declarations.

For example, an online store can use this node to automatically generate shipping labels when an order is placed, including detailed item information and sender address, streamlining the fulfillment process.

Properties

Name Meaning
Special Service A string specifying any special service required for the shipment.
Order ID Numeric identifier of the order associated with the shipment (minimum 1).
Store ID Numeric identifier of the store from which the shipment originates (minimum 1).
Number A string representing a custom number related to the shipment (e.g., tracking or reference number).
Verpackg Boolean flag indicating whether packaging is included or required.
Content Description of the shipment content as a string.
Weight Numeric weight of the shipment (minimum 0).
IOSS Number String representing the Import One-Stop Shop (IOSS) number for VAT purposes in EU shipments.
Currency Currency code for declared prices; options include standard ISO currency codes such as EUR, USD, GBP, etc., plus a "None" option.
Items Collection of declared items in the shipment. Each item includes:
- Item ID (number)
- Declared Quantity (number)
- Declared Price (number)
- GTIP (string, likely a customs tariff code)
Ship From Sender address details including:
- Name (required)
- Address 1 (required)
- Address 2 (optional)
- State (optional)
- City (required)
- Zip Code (optional)
- Phone (optional)

Output

The node outputs JSON data containing the response from the Shipentegra API after attempting to create the shipping label. This typically includes label details such as label URLs, tracking numbers, shipment status, and other metadata returned by the API.

If the API returns binary data (e.g., PDF or image of the label), it would be included in the output's binary field, representing the actual shipping label file ready for download or printing.

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 and accepts JSON responses.
  • Language preference for API responses can be set via credentials (defaulting to English).

Troubleshooting

  • Invalid or missing API credentials: Ensure that a valid API key or authentication token is configured in the node credentials.
  • Missing required fields: Required properties like Order ID, Store ID, and mandatory sender address fields must be provided; otherwise, the API may reject the request.
  • Incorrect data types or out-of-range values: Numeric fields have minimum and maximum constraints; violating these may cause errors.
  • API rate limits or connectivity issues: Network problems or exceeding API usage limits can result in failed requests.
  • Currency code not supported: Use one of the predefined currency options; unsupported codes will cause errors.
  • To resolve errors, verify all input parameters, check API credentials, and consult Shipentegra API documentation for error codes.

Links and References

Discussion