Skip to main content

App SDK Overview

@saleor/app-sdk is a TypeScript-first npm library that serves as a foundation for every Saleor app. It includes helpers built for React and serverless functions, like AWS Lambda or Next.JS

You can find @saleor/app-sdk on npm and GitHub.

Installation​

Install @saleor/app-sdk by running the following command:

# Preferred - with pnpm
pnpm add @saleor/app-sdk

# With npm and yarn
npm i @saleor/app-sdk
yarn add @saleor/app-sdk

Platforms support​

Utilities for server-side operations support multiple platforms. Currently, we support:

  • Next.js (Pages)
  • Next.js (App Router)
  • AWS Lambda (Serverless functions)
  • FetchAPI (Deno, Cloudflare Workers, etc)

Versioning​

@saleor/app-sdk uses semver. We track its releases and changelogs on GitHub.

Hint: See migration from 0.x to 1.x for more information.

Requirements​

  • Saleor support: 3.20 and higher (it may work in older versions, but it's not guaranteed).
  • Next.js support: 14 and higher

Learn more​

If you are interested in building Saleor apps using @saleor/app-sdk, you may want to check out the following resources: