Skip to content
eSIM Go Developer Docs

Get Bundle catalogue

GET
/catalogue

List all Bundles available to your Organisation for ordering. Bundle names can be used with the /orders endpoint to place an order.

Authorizations

Parameters

Query Parameters

page
string

Page of Bundles to return

Example
<string>
perPage
integer

Number of Bundles to return per page

Example
50
direction
string

Direction of ordering

Example
asc
orderBy
string

Name of column to order by

Example
duration
description
string

Wildcard search for description

Example
<string>
group
string

Filter by Bundle Group (exact value) e.g. Standard eSIM Bundles

Example
<string>
countries
string

Comma-separated list of country ISO codes to filter by. This will search for Bundles that include at least one of the countries as their base country. e.g. GB, US

Example
<string>
region
string

This will return Bundles that have a base country in the specified region. e.g. Europe

Example
Antarctica

Responses

200

OK

object
Example
[
  {
    "name": "<string>",
    "description": "<string>",
    "groups": [
      "<string>",
      "<string>"
    ],
    "countries": [
      {
        "name": "<string>",
        "region": "<string>",
        "iso": "<string>"
      },
      {
        "name": "<string>",
        "region": "<string>",
        "iso": "<string>"
      }
    ],
    "dataAmount": "<integer>",
    "duration": "<integer>",
    "speed": [
      "<string>",
      "<string>"
    ],
    "autostart": "<boolean>",
    "unlimited": "<boolean>",
    "roamingEnabled": [
      {
        "name": "<string>",
        "region": "<string>",
        "iso": "<string>"
      },
      {
        "name": "<string>",
        "region": "<string>",
        "iso": "<string>"
      }
    ],
    "price": "<integer>"
  },
  {
    "name": "<string>",
    "description": "<string>",
    "groups": [
      "<string>",
      "<string>"
    ],
    "countries": [
      {
        "name": "<string>",
        "region": "<string>",
        "iso": "<string>"
      },
      {
        "name": "<string>",
        "region": "<string>",
        "iso": "<string>"
      }
    ],
    "dataAmount": "<integer>",
    "duration": "<integer>",
    "speed": [
      "<string>",
      "<string>"
    ],
    "autostart": "<boolean>",
    "unlimited": "<boolean>",
    "roamingEnabled": [
      {
        "name": "<string>",
        "region": "<string>",
        "iso": "<string>"
      },
      {
        "name": "<string>",
        "region": "<string>",
        "iso": "<string>"
      }
    ],
    "price": "<integer>"
  }
]

400

Bad Request

object
Example
{
  "message": "<string>"
}

403

Forbidden

object
Example
{
  "message": "<string>"
}

500

Internal Server Error

object
Example
{
  "message": "<string>"
}