🎉 Ecommaps 2.0 is coming soon. Read more →
SDK & Packages
@ecommaps/client

@ecommaps/client

Official TypeScript SDK for Ecommaps storefront APIs.

Install

npm install @ecommaps/client

Runtime Requirements

  • Node.js 20+
  • ESM and CJS supported

Public API Surface

Store

  • store.retrieve()
  • store.menus.list()
  • store.menus.retrieve(handle)
  • store.pages.list()
  • store.pages.retrieve(slug)
  • store.blogs.list()
  • store.blogs.retrieve(slug)
  • store.coupons.validate(payload)

Products / Collections

  • products.list(params)
  • products.retrieve(slug)
  • products.search(query, params)
  • collections.list(params)
  • collections.retrieve(slug, limit, offset)

Cart / Orders / Auth

  • cart.create()
  • cart.retrieve(cartId)
  • cart.addItem(cartId, payload)
  • cart.updateItem(cartId, itemId, payload)
  • cart.removeItem(cartId, itemId)
  • orders.create(payload)
  • orders.list(params)
  • orders.track(orderNumber)
  • auth.signup(payload)
  • auth.login(payload)
  • auth.me(headers)
  • auth.addAddress(payload, options)

Example

import { ecommapsClient } from "@ecommaps/client";
 
const store = await ecommapsClient.store.retrieve();
const products = await ecommapsClient.products.list({ limit: 12 });

Error Handling

Use EcommapsAPIError for structured API failure handling.

Additional References

Integration Guide@ecommaps/storefront-kit