ce-storefront

Summary

CE Storefront APIs: CE Storefront APIs

Commerce Engine Storefront APIs

Table of Contents

• ce-storefront
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Available Resources and Operations
  • Standalone functions
  • File uploads
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Authentication
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add ce-storefront

PNPM

pnpm add ce-storefront

Bun

bun add ce-storefront

Yarn

yarn add ce-storefront zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { CeStorefront } from "ce-storefront";

const ceStorefront = new CeStorefront({
  authorization: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await ceStorefront.catalog.products.list({
    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
  });

  // Handle the result
  console.log(result);
}

run();

Available Resources and Operations

analytics

• track - Track event

auth

• loginAnonymously - Anonymous user
• loginWithPhone - Login with phone
• loginWithEmail - Login with email
• loginWithWhatsapp - Login with whatsapp
• loginWithPassword - Login with password
• verifyOtp - Verify OTP
• registerWithPhone - Register with phone
• registerWithEmail - Register with email
• registerWithWhatsapp - Register with whatsapp
• registerWithPassword - Register with password
• refreshToken - Refresh access token
• generateOtp - Generate OTP
• verifyEmailPhone - Check verified email phone

auth.user

• get - Retrieve a user
• update - Update a user
• addProfileImage - Add profile image
• updateProfileImage - Update profile image
• deleteProfileImage - Delete profile image
• getProfileImage - Retrieve a profile image
• deactivateAccount - Deactivate account
• changePassword - Change password
• forgotPassword - Forgot password
• resetPassword - Reset password
• logout - Logout user

campaigns

campaigns.newsletter

• subscribe - Subscribe to newsletter

carts

• create - Create cart
• get - Retrieve cart details
• delete - Delete cart
• addItem - Add/delete cart item

catalog

catalog.categories

• list - List all categories

catalog.products

• list - List all products
• get - Retrieve a product
• getSimilar - Retrieve similar products
• getUpsells - Retrieve up-sell products
• getCrossSells - Retrieve cross-sell products

catalog.products.reviews

• list - List all product reviews
• create - Create product review

catalog.products.variants

• list - Retrieve product variants
• get - Retrieve variant detail

catalog.skus

• list - List all SKUs

checkout

• updateAddress - Update cart address
• applyCoupon - Apply coupon
• removeCoupon - Remove coupon
• redeemLoyaltyPoints - Redeem loyalty points
• removeLoyaltyPoints - Remove loyalty points
• useCreditBalance - Use credit balance
• removeCreditBalance - Remove credit balance
• redeemGiftCard - Redeem gift card

customers

customers.addresses

• list - Retrieve all addresses
• add - Add address
• get - Retrieve particular address
• update - Update particular address
• delete - Remove particular address

customers.loyalty

• get - Retrieve loyalty details
• listActivities - List all loyalty points activity

customers.reviews

• list - Retrieve all reviews

customersAPI

• getRecommendedProducts - List all recommended products
• postCustomers - Create customer
• getCustomersId - Retrieve customer detail
• putCustomersId - Update customer detail

offers

offers.coupons

• list - Retrieve all coupons

offers.promotions

• list - Retrieve all promotions

orders

• create - Create order
• list - Retrieve all orders
• get - Retrieve order detail
• cancel - Cancel order
• retryPayment - Retry payment

orders.payments

• list - Retrieve order payments

orders.refunds

• list - Retrieve order refunds

orders.shipments

• list - Retrieve order shipments

payments

• generateHash - Generate hash
• getMethods - Retrieve available payment methods

shipping

• checkPincodeServiceability - Check pincode serviceability

user

user.notificationPreferences

• get - Retrieve user notification preferences
• create - Create user notification preferences
• update - Update user notification preferences

utils

• getCountries - Retrieve all countries
• getStates - Retrieve country wise states
• getPincodes - Retrieve pincodes

wishlist

• get - Retrieve wishlist
• add - Add product to wishlist
• delete - Delete product from wishlist

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• analyticsTrack - Track event
• authGenerateOtp - Generate OTP
• authLoginAnonymously - Anonymous user
• authLoginWithEmail - Login with email
• authLoginWithPassword - Login with password
• authLoginWithPhone - Login with phone
• authLoginWithWhatsapp - Login with whatsapp
• authRefreshToken - Refresh access token
• authRegisterWithEmail - Register with email
• authRegisterWithPassword - Register with password
• authRegisterWithPhone - Register with phone
• authRegisterWithWhatsapp - Register with whatsapp
• authUserAddProfileImage - Add profile image
• authUserChangePassword - Change password
• authUserDeactivateAccount - Deactivate account
• authUserDeleteProfileImage - Delete profile image
• authUserForgotPassword - Forgot password
• authUserGet - Retrieve a user
• authUserGetProfileImage - Retrieve a profile image
• authUserLogout - Logout user
• authUserResetPassword - Reset password
• authUserUpdate - Update a user
• authUserUpdateProfileImage - Update profile image
• authVerifyEmailPhone - Check verified email phone
• authVerifyOtp - Verify OTP
• campaignsNewsletterSubscribe - Subscribe to newsletter
• cartsAddItem - Add/delete cart item
• cartsCreate - Create cart
• cartsDelete - Delete cart
• cartsGet - Retrieve cart details
• catalogCategoriesList - List all categories
• catalogProductsGet - Retrieve a product
• catalogProductsGetCrossSells - Retrieve cross-sell products
• catalogProductsGetSimilar - Retrieve similar products
• catalogProductsGetUpsells - Retrieve up-sell products
• catalogProductsList - List all products
• catalogProductsReviewsCreate - Create product review
• catalogProductsReviewsList - List all product reviews
• catalogProductsVariantsGet - Retrieve variant detail
• catalogProductsVariantsList - Retrieve product variants
• catalogSkusList - List all SKUs
• checkoutApplyCoupon - Apply coupon
• checkoutRedeemGiftCard - Redeem gift card
• checkoutRedeemLoyaltyPoints - Redeem loyalty points
• checkoutRemoveCoupon - Remove coupon
• checkoutRemoveCreditBalance - Remove credit balance
• checkoutRemoveLoyaltyPoints - Remove loyalty points
• checkoutUpdateAddress - Update cart address
• checkoutUseCreditBalance - Use credit balance
• customersAddressesAdd - Add address
• customersAddressesDelete - Remove particular address
• customersAddressesGet - Retrieve particular address
• customersAddressesList - Retrieve all addresses
• customersAddressesUpdate - Update particular address
• customersAPIGetCustomersId - Retrieve customer detail
• customersAPIGetRecommendedProducts - List all recommended products
• customersAPIPostCustomers - Create customer
• customersAPIPutCustomersId - Update customer detail
• customersLoyaltyGet - Retrieve loyalty details
• customersLoyaltyListActivities - List all loyalty points activity
• customersReviewsList - Retrieve all reviews
• offersCouponsList - Retrieve all coupons
• offersPromotionsList - Retrieve all promotions
• ordersCancel - Cancel order
• ordersCreate - Create order
• ordersGet - Retrieve order detail
• ordersList - Retrieve all orders
• ordersPaymentsList - Retrieve order payments
• ordersRefundsList - Retrieve order refunds
• ordersRetryPayment - Retry payment
• ordersShipmentsList - Retrieve order shipments
• paymentsGenerateHash - Generate hash
• paymentsGetMethods - Retrieve available payment methods
• shippingCheckPincodeServiceability - Check pincode serviceability
• userNotificationPreferencesCreate - Create user notification preferences
• userNotificationPreferencesGet - Retrieve user notification preferences
• userNotificationPreferencesUpdate - Update user notification preferences
• utilsGetCountries - Retrieve all countries
• utilsGetPincodes - Retrieve pincodes
• utilsGetStates - Retrieve country wise states
• wishlistAdd - Add product to wishlist
• wishlistDelete - Delete product from wishlist
• wishlistGet - Retrieve wishlist

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

• Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
• Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
• Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
• Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.

import { CeStorefront } from "ce-storefront";
import { openAsBlob } from "node:fs";

const ceStorefront = new CeStorefront({
  authorization: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await ceStorefront.auth.user.addProfileImage({
    id: "<id>",
    requestBody: {
      image: await openAsBlob("example.file"),
    },
  });

  // Handle the result
  console.log(result);
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { CeStorefront } from "ce-storefront";

const ceStorefront = new CeStorefront({
  authorization: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await ceStorefront.catalog.products.list({
    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  // Handle the result
  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { CeStorefront } from "ce-storefront";

const ceStorefront = new CeStorefront({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  authorization: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await ceStorefront.catalog.products.list({
    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
  });

  // Handle the result
  console.log(result);
}

run();

Error Handling

Some methods specify known errors which can be thrown. All the known errors are enumerated in the models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the list method may throw the following errors:

| Error Type | Status Code | Content Type | | ------------------- | ----------- | ---------------- | | errors.Unauthorized | 401 | application/json | | errors.NotFound | 404 | application/json | | errors.SDKError | 4XX, 5XX | */* |

If the method throws an error and it is not captured by the known errors, it will default to throwing a SDKError.

import { CeStorefront } from "ce-storefront";
import {
  NotFound,
  SDKValidationError,
  Unauthorized,
} from "ce-storefront/models/errors";

const ceStorefront = new CeStorefront({
  authorization: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  let result;
  try {
    result = await ceStorefront.catalog.products.list({
      sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
    });

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError): {
        // Pretty-print will provide a human-readable multi-line error message
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof Unauthorized): {
        // Handle err.data$: UnauthorizedData
        console.error(err);
        return;
      }
      case (err instanceof NotFound): {
        // Handle err.data$: NotFoundData
        console.error(err);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the models/errors/httpclienterrors.ts module:

| HTTP Client Error | Description | | ---------------------------------------------------- | ---------------------------------------------------- | | RequestAbortedError | HTTP request was aborted by the client | | RequestTimeoutError | HTTP request timed out due to an AbortSignal signal | | ConnectionError | HTTP client was unable to make a request to a server | | InvalidRequestError | Any input used to create a request is invalid | | UnexpectedClientError | Unrecognised or unexpected error |

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

| # | Server | Variables | Default values | | --- | ------------------------------------------------------------------- | ----------------- | -------------- | | 0 | https://staging.api.commercengine.io/api/v1/{store_id}/storefront | storeId: string | "x2yh61zw4k" | | 1 | https://prod.api.commercengine.io/api/v1/{store_id}/storefront | storeId: string | "x2yh61zw4k" |

If the selected server has variables, you may override their default values through the additional parameters made available in the SDK constructor.

Example

import { CeStorefront } from "ce-storefront";

const ceStorefront = new CeStorefront({
  serverIdx: 1,
  authorization: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await ceStorefront.catalog.products.list({
    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
  });

  // Handle the result
  console.log(result);
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { CeStorefront } from "ce-storefront";

const ceStorefront = new CeStorefront({
  serverURL:
    "https://staging.api.commercengine.io/api/v1/x2yh61zw4k/storefront",
  authorization: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await ceStorefront.catalog.products.list({
    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
  });

  // Handle the result
  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { CeStorefront } from "ce-storefront";
import { HTTPClient } from "ce-storefront/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new CeStorefront({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | --------------- | ---- | ----------- | | authorization | http | HTTP Bearer |

To authenticate with the API the authorization parameter must be set when initializing the SDK client instance. For example:

import { CeStorefront } from "ce-storefront";

const ceStorefront = new CeStorefront({
  authorization: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await ceStorefront.catalog.products.list({
    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
  });

  // Handle the result
  console.log(result);
}

run();

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import { CeStorefront } from "ce-storefront";

const ceStorefront = new CeStorefront();

async function run() {
  const result = await ceStorefront.auth.loginAnonymously({
    xApiKey: "<YOUR_API_KEY_HERE>",
  });

  // Handle the result
  console.log(result);
}

run();

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { CeStorefront } from "ce-storefront";

const sdk = new CeStorefront({ debugLogger: console });

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy