Geins Developers

Learn how to build with Geins using our APIs and SDKs.

Getting started

Developer documentation
Everything you need to build with Geins
Getting started
Get up and running with Geins in minutes
API playground
Interactive API testing and exploration
MCP server
Use the MCP server to get agentic assistance for your Geins projects

Open source

Geins Studio
The comprehensive admin interface for your commerce platform
TypeScript SDK
The easy way to build on your favorite framework
Geins Checkout
Open-source checkout solution for Geins e-commerce backend
Next.js Commerce x Geins
High-performance, server-rendered Next
Nuxt starter
Production-ready PWA storefront template for building commerce applications with Nuxt

Webhooks

Introduction
Real-time event notifications for your application
Entities and Actions
Complete reference of webhook entities and supported actions in Geins Management API
Placeholders
Placeholders allow you to customize webhook URLs and payloads with dynamic values
API Reference
The Webhook API provides endpoints for creating, retrieving, updating, and deleting webhooks
Mailchimp example
This guide demonstrates how to set up a webhook to send an email with mailchimp on various events an order can go through in Geins
Slack example
This guide demonstrates how to set up a webhook to send a notification to a Slack channel on various events an order can go through in Geins

Guides

Authentication flow
Learn about the authentication flow using Geins
Create widget
How to create widgets in Geins CMS using the Create widget function in Merchant Center
Sitemaps
A guide to sitemaps and their usage

How to

Activate promo code on cart
Learn how to activate promo codes on carts using Geins Merchant API
Add custom data to cart
Learn how to add custom data to carts using Geins Merchant API
Add product to cart
Add products to an existing cart using Geins Merchant API
Build product listing
Build a product listing page (PLP) with facets and pagination using Geins Merchant API
Bulk update sale prices
Reset sale prices from a previous promotion and apply new sale prices across markets using the bulk update prices API
Change user password
Change user passwords securely using Geins Auth Service's signature-based flow

Merchant API

Merchant API
The Merchant API is a GraphQL API that allows you to build any type of commerce application
Queries
Brands
Get all brands
Categories
Get all categories
Category
Gets a category with the specified ID
Channel
Gets a channel with the specified ID

Management API

Getting started
Geins Management API is a RESTful api that powers your applications and helps you manage your Geins services
BalanceType
Get user balance types
Gets all available balance types
Brand
Get brand
Gets a specific brand by id
Create brand