Getting a new eSIM - WIP

How to order an eSIM profile with a product via Connect and install it on a device.

1. Product Offering Discovery

The first step is to list all available product offerings . As an alternative, instead of calling the API for each individual sale, the partner can fetch and list all product offerings once a day, storing them locally in their system as a local product catalog. This catalog can then be refreshed daily to ensure it stays up to date.

2. Account and Subscriber setup

Before placing an order, the partner must ensure that an account and a subscriber exist in the system:

For new customers:

• Create an account via the Account API.

• Add a subscriber to the account using the Subscriber API.

For existing customers:

When submitting an order, use the existing account ID and subscriber ID that were previously created, instead of creating new ones.

3. Order Creation and Fulfiment

Create an Order

• Call the Create Order API to initiate a subscription activation.
• Provide the product offering, account ID, and subscriber ID previously created.

Order Processing

• The system validates the order and assigns an eSIM profile.
• An event subscription.sim_profile.ready_for_installation is triggered when the eSIM profile is ready for installation.

Order Completion or Failure

• If the order is successful, an order.completed event is received.
• If the order fails, an order.failed event is received. Order failures are uncommon and typically caused by unforeseen technical difficulties.