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, for the Inventory - Check operation, it allows users to verify the availability of a specified quantity of eSIM plans identified by a Plan ID. This is useful in scenarios where you want to confirm stock before proceeding with orders or provisioning.

Practical examples:

  • Before creating an order for eSIMs, check if the requested quantity is available.
  • Automate inventory validation in workflows that manage eSIM distribution.

Properties

Name Meaning
Plan ID The unique identifier of the Vocom eSIM plan to check inventory for.
Quantity The number of eSIM units requested to check availability for.

Output

The output is a JSON array containing the response from the Vocom API's inventory check endpoint. Each item corresponds to an input item and includes details about the inventory status for the requested Plan ID and quantity.

The exact structure depends on the API response but typically includes fields indicating availability, quantities, and possibly error messages if the check fails.

No binary data is output by this operation.

Dependencies

  • Requires an active connection to the Vocom API via an API key credential configured in n8n.
  • The node makes HTTP POST requests to the /esim/v1/inventoryCheck endpoint of the Vocom API.

Troubleshooting

  • Common issues:

    • Invalid or missing Plan ID can cause the API to reject the request.
    • Requesting a quantity larger than available stock will likely return an error or indicate insufficient inventory.
    • Network or authentication errors if the API key is invalid or not set up correctly.

  • Error messages:

    • Errors returned from the API are captured and included in the output as an error field when "Continue On Fail" is enabled.
    • Typical errors include authorization failures, invalid parameters, or server errors.

  • Resolution tips:

    • Verify the Plan ID is correct and exists in the Vocom system.
    • Ensure the quantity is a positive integer and within expected limits.
    • Confirm API credentials are properly configured in n8n.
    • Enable "Continue On Fail" to handle errors gracefully in workflows.

Links and References

Discussion