Changelog

v2.3

Changed

• Response for Get the status of a Bundle applied to an eSIM (as well as List Bundles applied to an eSIM) has been updated to include assignmentDateTime, assignmentReference and bundleStatus fields.
• Response for Process Orders will always return an iccids array of relevant ICCIDs (regardless of whether includeIccids is set as a query parameter).
• Response for Get history of an eSIM will return the alertType field.

v2.2

New

• eSIM Assignments endpoint added to allow eSIM data to be downloaded from multiple Order and Bundle Apply operations. Supported outputs are text/csv, application/json, application/zip. These can be requested using the Accept header. application/zip returns a ZIP file containing QR code images (in PNG format).
• Additional multi-filtering and sorting options. Operators have been added for filtering, such as gte:1.
  • Time and number fields support operators: eq, lt, lte, gt, gte. Default is eq.
  • String fields support operators: eq. Default is like or wildcard style search.
  • Updated endpoints:
    • List eSIMs assigned to you
    • Get all orders
    • Get your Organisation's inventory
    • List catalogue
    • Get history of an eSIM
• Bundle Apply operations will now create an order with bundleAssignment as the item type. These will be visible in the eSim Go Portal and allow you to easily download the eSIM data if new eSIMs were assigned:

  {
    "type": "bundleAssignment",
    "item": "9183265c-1234-1234-1234-388a21393138-0",
    "quantity": 0,
    "pricePerUnit": 0
  }
  

• Asynchronous Orders and Assignments. Any Order or Bundle Apply that includes more than 5 Bundles will be processed asynchronously. You can query processing orders using the Order endpoint:

  http GET https://api.esim-go.com/v2.2/orders X-API-Key:$KEY status==processing
  

Changed

• Response for List Bundles applied to an eSIM no longer includes finished (empty) Bundles. includeUsed=true query parameter is available to return to previous behaviour.
• Response for Process Orders will now returned an iccids array of relevant ICCIDs if includeIccids query parameter is set to true.

Deprecated

• QR codes and CSV data in favour of new eSIM Assignments endpoint. For backward compatibility /v2.2/esims/assignments/{reference} can be called to download data from a single reference.
• Single filtering and sorting options have been deprecated in favour for multi-filtering and sorting. Affected endpoints:
  • List eSIMs assigned to you
  • List catalogue
  • Get your Organisation's inventory

v2.1

New

• eSIM Apply endpoint added to enable users to receive a new eSIM with a Bundle pre-applied if no eSIM is provided in the request.
• Catalogue for getting information on available Bundles for purchasing as well as an Inventory endpoint for viewing your purchased Bundles.
• eSIM data download. QR codes and CSV data for eSIMs can now be downloaded in bulk formats.

Changed

• Response for List Bundles applied to an eSIM improved. Data is now returned as formatted date/time and integers.
• Response for Get the status of a Bundle applied to an eSIM improved. Data is now returned as formatted date/time and integers.

Removed

• Empty callTypeGroup removed from Usage Callback

Deprecated

• Apply Bundle replaced with eSIM Apply. New endpoint takes the target ICCID in the body, rather than the path. If no ICCID is provided, a new eSIM is assigned to you. ICCID is always returned.

v2.0

New

• Initial Release