Skip to content

List 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

perPage
integer

Number of Bundles to return per page

direction
string
Allowed values: asc desc

Direction of ordering

orderBy
string
Allowed values: bundleName dataAmount duration autostart roamingEnabled

Name of column to order by

description
string

Wildcard search for description

group
string

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

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

region
string
Allowed values: Africa Antarctica Asia Europe Global Middle East North America Oceania LATAM

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

Responses

200

Success message

Array<object>
object
name

Bundle Name

string
description

Bundle Description

string
groups

Bundle Groups

Array<string>
countries
Array<object>
object
name

Country name

string
region

Country region

string
iso

Country iso

string
dataAmount

Data Amount (MB)

integer
duration

Duration

integer
speed

Bundle speed

Array<string>
autostart

If the bundle auto starts

boolean
unlimited

If the bundle is unlimited

boolean
roamingEnabled
Array<object>
object
name

Country name

string
region

Country region

string
iso

Country iso

string
price

Bundle price in the organisation currency

integer

400

Bad Request - returned when request format is not accepted

object
message

Status of api functions which do not return data

string

403

Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the eSIM is not accessible by the user

object
message

Status of api functions which do not return data

string

500

Server Error

object
message

Status of api functions which do not return data

string