Overview

Introduction

The Aeolian Storefront API is the public interface for building custom storefronts. Authenticated with a publishable key, it is safe to call from client code to read your public store data and run shopper-facing storefront operations such as cart creation.

Base URL

https://api.getaeolian.com/v1

The API is organized around REST. It has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Make all API requests over HTTPS. Requests without a valid API key fail with 401 (see Authentication). The API is versioned in the URL path; the current version is v1 (see Versioning).

Every field is always present in responses; values that don't apply are returned as null rather than omitted, so the response shape never changes.

Invalid or out-of-range parameters are rejected rather than coerced. Requesting a limit above the maximum returns an error envelope rather than clamping to the max, so you always get exactly what you asked for or a clear error (see Errors).

Reads are cached for up to a minute, so a change to your data can take that long to appear in responses (see Caching).