API v2.3 / Store / 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 of Bundles to return
Number of Bundles to return per page
Direction of ordering
Name of column to order by
Wildcard search for description
Filter by Bundle Group (exact value) e.g. `Standard eSIM Bundles`
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`
This will return Bundles that have a base country in the specified region. e.g. `Europe`
Responses
200
Success message
object
Bundle Name
Bundle Description
Bundle Groups
object
Country name
Country region
Country iso
Data Amount (MB)
Duration
Bundle speed
If the bundle auto starts
If the bundle is unlimited
object
Country name
Country region
Country iso
Bundle price in the organisation currency
400
Bad Request - returned when request format is not accepted
object
Status of api functions which do not return data
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
Status of api functions which do not return data
500
Server Error
object
Status of api functions which do not return data