Skip to main content

Provisioning Templates

Early Availability

The Order Templates API allows organizations to retrieve the list of their eSIM provisioning templates, including all associated products and service configurations. This API is particularly useful for reviewing available templates before placing a new subscription order, ensuring that the correct products and features are selected.

List All Templates​

Send an HTTP GET request to get complete list of all templates associated with the organization.

GET  https://api.1global.com/enterprise/order-templates

Ensure the request includes the following headers:

For more details on setting up the headers, refer to Making Your First Request.

Example Response Body

{
    "order_templates": [
            {
                "id": "otpl_0122246786464646444444GGGG",
                "type": "activate_subscription",
                "products": [
                    {
                        "_embedded": {
                            "product_offering": {
                                "id": "prdoff_0122246786464646444444GGGG",
                                "type": "plan",
                                "name": "Europe Plan Monthly fee"
                            }
                        }
                    }
                ]
    ]
}

After retrieving the list of templates, identify the 'template_id' which always starting with the prefix 'otpl' (in this example, has the value 'otpl_0122246786464646444444GGGG') that matches the provisioning requirements. This value can then be passed to the Orders API to create a new subscription. For detailed steps on creating a subscription order, refer to the Add New Subscription recipe.

Get Order Templates​

The Get Order Template endpoint returns detailed product and service configurations for a specific template_id which must be obtained from the List Templates endpoint.

GET  https://api.1global.com/enterprise/order-templates/{template_Id}

Replace template_ID with the template_ID received from the initial response (e.g., otpl_0122246786464646444444GGGG).

Example Response

{
    "order_templates": [
            {
                "id": "otpl_0122246786464646444444GGGG",
                "type": "activate_subscription",
                "products": [
                    {
                        "_embedded": {
                            "product_offering": {
                                "id": "prdoff_0122246786464646444444GGGG",
                                "type": "plan",
                                "name": "Europe Plan Monthly fee"
                            }
                        }
                    }
                ]
    ]
}