Mobile Services Guide
Step-by-step guide to ordering mobile services via API
Step 1: Identify the Customer
Use the Get List of Customers endpoint to retrieve the customer_id for the customer you want to provision a mobile service for.
Step 2: Get Mobile Plans
Use the Get Mobile Plans endpoint to retrieve available mobile plans and select the appropriate service_plan_id.
Step 3: Check SIM Availability
For physical SIM activations only. Use the Check SIM endpoint to validate that a SIM card is available for use. Skip this step for eSIM orders.
Step 4: Reserve a Mobile Number
Use the Reserve Mobile Number endpoint to reserve one or more mobile numbers for the new service. Skip this step for port orders.
Step 5: Get Data Pool
This step is optional. Only required if the service will participate in a data pool. Use the Get Data Pool List endpoint to retrieve the datapool_id.
Step 6: Submit Order
Submit the order using either the New Mobile Service endpoint (for new activations) or the Port Mobile Service endpoint (for port-in requests).
Step 7: Check Order Status
Wait several minutes after submitting the order, then use the Check Mobile Order endpoint to verify the order status and track progress.