Overview

Initialize a shopping cart for a selected eSIM package and travel dates. The returned cartKey is required to submit the purchase.

When to Use

• Start checkout - After the traveler selects a package and travel window
• Hold a package - Create a short-lived cart before collecting traveler details
• Multi-step flows - Separate package selection from payment/provisioning

What You Get

• Cart key - Opaque cartKey used by submit order

Key Features

• Date-bound: Requires startDate and endDate for the travel period
• Package-scoped: Uses packageId with either destinationCode (country plan) or regionId + externalPackageId (regional/global plan) from the catalog
• Exclusive modes: Sending both destinationCode and regionId, or externalPackageId with destinationCode, is rejected
• Idempotent submit later: Reuse the same cartKey safely when submitting

{
  "packageId": 1,
  "destinationCode": "MA",
  "regionId": 3,
  "externalPackageId": "eurolink-30days-5gb",
  "startDate": "2026-08-20",
  "endDate": "2026-08-27"
}

{
  "data": {
    "cartKey": "EXAMPLECARTKEY00000000000000001"
  }
}