Vocom eSim icon

Vocom eSim

Communicate with Vocom APIs
Join our community

Actions3

Overview

This node integrates with the Vocom API to manage eSIM-related operations, specifically focusing on creating orders for eSIM plans. The "Create Order" operation allows users to submit a new order based on a specified plan ID, quantity, and an external order reference (such as a WooCommerce Order ID). This is useful in scenarios where automated provisioning of eSIMs is needed after a customer places an order in an e-commerce system.

Practical examples:

  • Automatically create an eSIM order when a customer completes a purchase on an online store.
  • Batch process multiple eSIM orders by feeding the node with different plan IDs and quantities.
  • Integrate with inventory checks and eSIM URL retrieval in a workflow to fully automate eSIM lifecycle management.

Properties

Name Meaning
Plan ID The unique identifier of the Vocom eSIM plan to order.
Quantity The number of eSIM units requested in this order.
OrderRef ID External order reference ID, e.g., a WooCommerce Order ID, used to link the order externally.

Output

The node outputs JSON data representing the response from the Vocom API after attempting to create the order. This typically includes details about the created order such as confirmation status, order identifiers, or error messages if the creation failed.

If the API returns binary data (not indicated here), it would be summarized accordingly, but this node primarily deals with JSON responses.

Dependencies

  • Requires an API key credential for authenticating with the Vocom API.
  • The node makes HTTP POST requests to Vocom endpoints:
    • /esim/v1/createOrder for creating orders.
  • Proper configuration of the API credential within n8n is necessary for successful communication.

Troubleshooting

  • Common issues:

    • Invalid or missing Plan ID can cause the API to reject the order creation.
    • Incorrect or missing OrderRef ID might lead to difficulties tracking orders externally.
    • Network or authentication errors if the API key is invalid or expired.

  • Error messages:

    • Errors returned from the API are passed through in the output JSON under an error field.
    • If the node is set to continue on failure, errors for individual items will not stop the entire execution but will be included in the output for review.

  • Resolutions:

    • Verify that the Plan ID corresponds to a valid plan in the Vocom system.
    • Ensure the OrderRef ID matches your external order tracking system.
    • Check API credentials and network connectivity.

Links and References

Discussion