List catalogue

GET

/catalogue

• eSIMGo API

List all Bundles available to your Organisation for ordering.

Bundle names can be used with the /orders endpoint to place an order.

Authorizations

• apiKeyAuth
• apiKeyQueryAuth

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

filter

string

Value to filter by

filterBy

string

Allowed values: bundleName

Name of column to filter by

Responses

200

Success message

Array<object>

object

name

Bundle Name

string

description

Bundle Description

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

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