Shipentegra API icon

Shipentegra API

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

Actions12

Overview

The node integrates with the Shipentegra API to create manual shipping orders. It allows users to specify detailed order and shipping information, including package dimensions, weight, shipping cost, currency, recipient address, and individual order items. This node is useful for logistics, e-commerce, or fulfillment workflows where automated creation of shipping orders is required.

Typical use cases include:

  • Automating shipment creation after an e-commerce sale.
  • Integrating with custom order management systems to push shipping data.
  • Managing multi-package shipments with detailed itemization.

Example: After receiving an order in your system, you can use this node to create a manual shipping order by specifying the package details, shipping cost, destination address, and items included in the shipment.

Properties

Name Meaning
Package Quantity Number of packages to ship (1 to 100,000).
Shipping Amount Cost of shipping (minimum 0.01).
Currency Currency code for the shipping amount. Supported ISO currency codes like USD, EUR, GBP, etc.
Description Description of the order (5 to 50 characters).
Weight (Kg) Total weight of the package(s) in kilograms.
Height (Cm) Package height in centimeters.
Width (Cm) Package width in centimeters.
Length (Cm) Package length in centimeters.
Reference 1 Optional reference field (up to 40 characters).
IOSS Number Optional IOSS number for tax purposes (up to 33 characters).
Number Optional order number or identifier (up to 128 characters).
Address Name Name for the shipping address record (1 to 80 characters).
Remember My Address Boolean flag indicating whether to save this address for future orders.
Shipping Address Detailed recipient shipping address including:
- Recipient Name (2-128 chars)
- Street Address (5-255 chars)
- Country (ISO country code)
- City (2-128 chars)
- State (optional, max 128 chars)
- Postal Code (1-20 chars)
- Email (optional, max 60 chars)
- Phone (optional, max 25 chars)
Order Items List of items in the order, each with:
- Name (3-512 chars)
- Quantity (1 to 100,000)
- Unit Price (min 0.01)
- SKU (optional, max 128 chars)
- GTIP code (optional)
- Image URL (optional, max 255 chars)

Output

The node outputs JSON data representing the created manual order as returned by the Shipentegra API. This typically includes order identifiers, status, and any relevant metadata confirming the successful creation of the order.

If the API supports binary data output (e.g., shipping labels), it would be included accordingly, but based on the provided information, the primary output is structured JSON data about the created order.

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 credentials and network access to the Shipentegra API is necessary.

Troubleshooting

  • Invalid or missing required fields: Ensure all mandatory properties such as shipping amount, currency, description, address name, shipping address, and order items are correctly filled.
  • Currency code errors: Use valid ISO currency codes supported by the API.
  • Address validation errors: Verify that the country code and postal code conform to expected formats.
  • API authentication failures: Confirm that the API key credential is correctly configured and has sufficient permissions.
  • Network issues: Check connectivity to the Shipentegra API endpoint.
  • Data limits exceeded: Respect maximum character lengths and numeric ranges specified for each property.

Common error messages will likely relate to validation failures or authentication issues; resolving them involves correcting input data or updating credentials.

Links and References

Discussion