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 a SE-UPS shipping label. It is designed for logistics and e-commerce workflows where users need to generate UPS labels for shipments, including detailed customs and shipment information. Typical use cases include automating label creation for orders in online stores or warehouses, managing declared items for customs, and specifying sender details.

For example, an e-commerce platform can use this node to automatically generate UPS shipping labels when an order is ready to be shipped, including all necessary customs declarations and shipment metadata.

Properties

Name Meaning
Special Service A string field to specify 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 number related to the shipment (context-specific).
Verpackg Boolean flag indicating packaging status or type (true/false).
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 number for VAT purposes.
Currency Currency code for declared prices. Options include a comprehensive list of ISO currency codes such as EUR, USD, GBP, JPY, etc., plus "None" for no currency specified.
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 information 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 creating the SE-UPS label. This typically includes label details such as tracking numbers, label URLs or encoded label data, shipment confirmation, and any relevant metadata returned by the API.

If the API returns binary data for the label (e.g., PDF or image), it would be included as binary output, representing the actual shipping label file to be printed or stored.

Dependencies

  • Requires an API key credential for authenticating with the Shipentegra API.
  • The node uses the Shipentegra public API endpoint at https://publicapi.shipentegra.com/v1.
  • Proper configuration of the API key and possibly language preference in credentials is needed.
  • Network access to the Shipentegra API must be available.

Troubleshooting

  • Common issues:

    • Missing or invalid API key will cause authentication failures.
    • Invalid or incomplete shipment data (e.g., missing required fields like sender name or city) may result in validation errors.
    • Incorrect currency codes or item details might cause the API to reject the request.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • Authentication errors usually indicate issues with the provided API key; verify and update credentials.
    • Validation errors from the API will specify which fields are incorrect or missing; ensure all required properties are correctly filled.
    • Rate limiting or server errors from the API should be retried after some delay or checked with Shipentegra support.

Links and References

Discussion