Orders API
The Orders API simplifies subscription management by automating key operations such as provisioning new subscriptions, change existing SIMs to eSIMs, and updating subscription statuses. This reduces manual effort, enhances operational workflows, and provides real-time visibility into order progress.
Key Actions
Create Order
Send a HTTP request to 1GLOBAL to submit new orders for various subscription-related actions.
POST https://api.1global.com/enterprise/orders
Supported actions include:
-
Provision a New eSIM: Facilitates the onboarding process by provisioning new eSIMs, which are sent directly to the specified email addresses.
-
Replace a SIM: Enables the transition of an existing xSIM subscription to an eSIM. This is useful when employees upgrade to eSIM-compatible devices or require replacements.
-
Suspend Subscription: Temporarily deactivates a subscription for scenarios such as a lost or stolen device.
-
Resume Subscription: Reactivates a previously suspended subscription, restoring services without the need to open a ticket to 1GLOBAL support.
Monitor Order Status
Since the order creation process is asynchronous, this endpoint allows monitoring the progress and confirming the completion of orders. To retrieve the status of a specific order, send an HTTPS request using the unique order identifier provided during order creation.
GET https://api.1global.com//enterprise/orders/{orderId}
Orders are initially created with a pending
status. As the process progresses, the status updates according to the following table:
Status | Description |
---|---|
pending | Order successfully accepted and is being processed. |
completed | Order successfully fulfilled. |
canceled | Order could not be processed due to unforeseen issues. |
The provisioning actions usually require a few minutes to complete. However, it is possible that some requests could take longer, depending on resources availability.