Setup

​

Getting Started with Ollie Admin

Before you can start building custom checkouts, you need to set up your Organization and Store in Ollie Admin.

​

Initial Configuration Steps

​

1. Create Your Organization

Your Organization acts as the top-level container for all your stores and resources.

​

2. Set Up Your Store

Configure your store with:

• Store Name: Your brand or business unit identifier
• E-commerce Platform: Select your platform (VTEX, Shopify, etc.)
• Platform Store ID: Your store identifier in the e-commerce platform

​

3. Create Your First Version

Every store starts with a default Version. You can create additional versions for:

• A/B testing
• Different customer segments
• Seasonal campaigns
• Development environments

​

Getting Started with Create Ollie Shop

​

1. Install Ollie Shop

Create a new project using the create-ollie-shop CLI tool:

npx create-ollie-shop your-store

Replace your-store with your desired folder name. This command scaffolds a new Ollie Checkout project.

​

2. Enter Configuration Details

During setup, you’ll be prompted to provide some values. You can find these in Ollie Admin

• Store ID → Found on the Settings page
• VTEX Account Name → Same as Platform Store ID in Settings page
• Version ID → Found on the Versions page

These values are saved to ollie.json and can be updated later.

Example ollie.json Configuration

{
  "storeId": "1d9b00fd-5dc7-4521-a581-8a4c9643db7f",
  "versionId": "70008de6-416b-43ba-a0ea-093c02cd1fab",
  "platform": "vtex",
  "platformStoreId": "olliestore",
}

You can enhance the checkout behavior and appearance using optional ollie.json fields:

• sessionId: Inject an orderForm for debugging or previewing sessions
• props: Add flags or props to customize layout, features, or logic
• theme: Apply a custom theme to globally style your checkout

​

Next Steps

Once your store is configured, you’re ready to start development: