Concepts

A description of HTTP headers used. This applies to GraphQL API and JSON API.

Lana uses JSON Web Tokens (JWT) for authentication. The authentication process uses a hybrid state model. Client-side state is stored in the JWT itself, including session information, expiration date, and other utility information. The system keeps another portion of the state server-side, enabling specific actions to occur without requiring JWT token invalidation. For example, a staff member's privileges can be altered or suspended with immediate effect, regardless of the validity of their JWT.

Overview of Pagination Methods The Lana API supports three pagination methods: Offset-based pagination : Specify a numerical offset to start retrieving data from a particular item.

Lana employs unique identifiers for numerous objects. These identifiers are obfuscated using a simple algorithm. Although this obfuscation isn't meant to be cryptographically secure, it effectively conceals numerical or sequential identifiers that should not be depended upon.

Permission Bit Endpoint(s) activities.read activitiesPage ai.modify aiAutocomplete , aiEdit analytics.export analyticsReportExport

Explorer is a purpose-built GraphQL IDE designed to simplify the development and testing of Lana GraphQL queries.

Global Limits Parameter Value Active Subscriptions Per Customer 200 Addresses Per Customer 10 Answers Per Question

The Lana API supports idempotency for mutation requests. Idempotency becomes beneficial when there's a need to retry failed requests, ensuring the same operation is not performed multiple times. For example, an operation might have already been executed, but your client didn't receive a response. Leveraging idempotency lets you resend the same request multiple times, yet the API will only execute the operation once.

A typical bulk get API endpoint includes an ids input argument, which is an array of identifiers. By default, the Lana API returns items in the same order as their identifiers in the

General Webhooks notify your app when specific events occur in Lana, eliminating the need to continuously poll the API. When set up, webhooks send either all or selected events to an HTTP endpoint in the form of a JSON payload. The general format of a message is as follows:

The Commerce API is structured around a clear hierarchy, guiding you from user creation through organization setup, shop configuration, data population, automation, and analytics.