logo
API docs by Redocly

UNITE Partner API (1.0.0)

Download OpenAPI specification:Download

E-mail: tech.support@simlocal.com URL: https://www.simlocal.com/ License: Sim Local 1.0 Terms of Service

This is a Sim Local UNITE Partner API OpenAPI specification.

eSIM

eSIM specific operations

Fulfilment Completed Webhook

Webhook callback when fulfilment has been completed. Please contact you Sim Local contact to configure webhooks in the UNITE platform for you.

Authorizations:
ApiKey
Request Body schema: application/json
order_id
required
string

order id.

status
required
string
Enum: "CREATED" "CONFIRMED" "PROCESSING" "PURCHASED" "COMPLETED" "PROCESSING_WAITING_NETWORK_ACTIVATION" "FAILED" "REFUNDED" "CANCELLED"

Order Status

Responses

Request samples

Content type
application/json
{
  • "order_id": "00278971-4108-4e50-ac1b-dfd14cc194f4",
  • "status": "COMPLETED"
}

Get Destinations

Get a list of Destinations that UNITE platform supports

Authorizations:
oauth2
header Parameters
Accept-Language
string

Language code for field translation. If you have not set the header, we assume the default value (en). If you pass a list of languages, only first is taken into consideration.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get Product Offerings

Get esim product offerings available with ability to filter per country. Only available offerings are returned.

Authorizations:
oauth2
query Parameters
destination
string

Specify Destination alias to return only product offering available in that destination. If not provided then product offerings for all destinations will be returned.

header Parameters
Accept-Language
string

Language code for field translation. If you have not set the header, we assume the default value (en). If you pass a list of languages, only first is taken into consideration.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Order

Create a new UNITE Order with a single order item.

Authorizations:
oauth2
query Parameters
activate
boolean

Default true. If set to false, you have to call activate order when you want to activate the sim

Request Body schema: application/json
required
object (order_item_request)

This object contains information about a UNITE order item to be created.

external_reference
string

Optional unique ID you can pass with order, and search created order with this external_reference

object
object
locale
required
string

Local code code used for order responses. Based on ISO 639-1 codes (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)

contact_name
string

Optional user contact name

contact_email
string

Optional user that gets email notifications about order creation and fulfillment

Responses

Request samples

Content type
application/json
{
  • "item": {
    },
  • "external_reference": "51f9fb09-a4a6-460b-8c46-42e254f5fbd1",
  • "payment_details": {
    },
  • "kyc_details": {
    },
  • "locale": "en",
  • "contact_name": "Tom",
  • "contact_email": "tom@mycompany.com"
}

Response samples

Content type
application/json
{
  • "id": "00278971-4108-4e50-ac1b-dfd14cc194f4",
  • "order_no": "7RGjBa",
  • "external_reference": "51f9fb09-a4a6-460b-8c46-42e254f5fbd1",
  • "status": "REFUNDED",
  • "item": {
    },
  • "payment_details": {
    },
  • "kyc_details": {
    },
  • "locale": "en",
  • "contact_name": "Tom",
  • "contact_email": "tom@mycompany.com"
}

Search Order by Order external_reference

Return the order with the given external_reference

Authorizations:
oauth2
query Parameters
external_reference
required
string
Example: external_reference=51f9fb09-a4a6-460b-8c46-42e254f5fbd1

given reference, ie. 00278971-4108-4e50-ac1b-dfd14cc194f4

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "totalPages": 1,
  • "totalElements": 1,
  • "pageable": {
    },
  • "last": true,
  • "total_pages": 1,
  • "sort": {
    },
  • "first": true,
  • "number_of_elements": 1,
  • "empty": false
}

Get Order by Order id

Return the order with the given id

Authorizations:
oauth2
path Parameters
order_id
required
string

generated orderId, ie. 00278971-4108-4e50-ac1b-dfd14cc194f4

Responses

Response samples

Content type
application/json
{
  • "id": "00278971-4108-4e50-ac1b-dfd14cc194f4",
  • "order_no": "7RGjBa",
  • "external_reference": "51f9fb09-a4a6-460b-8c46-42e254f5fbd1",
  • "status": "REFUNDED",
  • "item": {
    },
  • "payment_details": {
    },
  • "kyc_details": {
    },
  • "locale": "en",
  • "contact_name": "Tom",
  • "contact_email": "tom@mycompany.com"
}

Activate the Order

Activate an existing order that has not been activated yet. This will activate eSIM with network operator. Activation is an async call. Once activation is done webhook call is done vie Fulfilment completed event notification.

Authorizations:
oauth2
path Parameters
order_id
required
string

order_id, ie. 00278971-4108-4e50-ac1b-dfd14cc194f4

Responses

Response samples

Content type
application/json
{
  • "id": "00278971-4108-4e50-ac1b-dfd14cc194f4",
  • "order_no": "7RGjBa",
  • "external_reference": "51f9fb09-a4a6-460b-8c46-42e254f5fbd1",
  • "status": "REFUNDED",
  • "item": {
    },
  • "payment_details": {
    },
  • "kyc_details": {
    },
  • "locale": "en",
  • "contact_name": "Tom",
  • "contact_email": "tom@mycompany.com"
}

Get Cancel Reasons

Get a list of cancel reasons, that UNITE platform supports

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
[
  • "FAULTY_SIM",
  • "PHONE_IS_LOCKED",
  • "WRONG_PRODUCT_SELECTED",
  • "BUNDLE_DID_NOT_APPLY",
  • "NO_SERVICE",
  • "CUSTOMER_CHANGED_MIND",
  • "OTHER"
]

Cancel the Order

Cancel an existing order that has not been activated yet. Post activation orders can only be cancelled via customer care.

Authorizations:
oauth2
path Parameters
order_id
required
string

orderId, ie. 00278971-4108-4e50-ac1b-dfd14cc194f4

Request Body schema: application/json
reason
string

Cancel reason, must be one of options returned by Get Cancel Reasons.

Responses

Request samples

Content type
application/json
{
  • "reason": "OTHER"
}

Response samples

Content type
application/json
{
  • "id": "00278971-4108-4e50-ac1b-dfd14cc194f4",
  • "order_no": "7RGjBa",
  • "external_reference": "51f9fb09-a4a6-460b-8c46-42e254f5fbd1",
  • "status": "REFUNDED",
  • "item": {
    },
  • "payment_details": {
    },
  • "kyc_details": {
    },
  • "locale": "en",
  • "contact_name": "Tom",
  • "contact_email": "tom@mycompany.com"
}