@adobe/aio-commerce-sdk

Meta-package that re-exports Adobe Commerce SDK libraries for Adobe App Builder applications.

This package serves as a convenient entry point for accessing commonly used Adobe Commerce libraries in App Builder projects, similar to how @adobe/aio-sdk works for general App Builder development.

Installation

npm install @adobe/aio-commerce-sdk

Overview

The @adobe/aio-commerce-sdk is a meta-package that consolidates and re-exports the most commonly used Adobe Commerce libraries for App Builder applications. Rather than installing and importing multiple individual packages, you can use this single package to access all the essential Commerce functionality.

Current Libraries

The SDK currently includes:

• @adobe/aio-commerce-lib-auth: Authentication utilities for Adobe Commerce apps, supporting both IMS and Commerce integrations authentication.

• @adobe/aio-commerce-lib-core: Core utilities for the Adobe Commerce SDK.

• @adobe/aio-commerce-lib-api: A set of utilities to build HTTP/API clients for I/O Events and Adobe Commerce.

• @adobe/aio-commerce-lib-events: Event management utilities to interact with the Adobe I/O and Commerce Eventing APIs.

• @adobe/aio-commerce-lib-webhooks: Webhook management utilities to interact with the Adobe Commerce Webhooks API.

Usage

Import directly from a specific library sub-path:

import {
  assertImsAuthParams,
  getImsAuthProvider,
  assertIntegrationAuthParams,
  getIntegrationAuthProvider,
} from "@adobe/aio-commerce-sdk/auth"; // <-- This is like @adobe/aio-commerce-lib-auth

import { AdobeCommerceHttpClient } from "@adobe/aio-commerce-sdk/api"; // <-- This is like @adobe/aio-commerce-lib-api
import {
  createCommerceEventsApiClient,
  updateEventingConfiguration,
} from "@adobe/aio-commerce-sdk/events/commerce"; // <-- This is like @adobe/aio-commerce-lib-events/commerce
import {
  createCommerceWebhooksApiClient,
  subscribeWebhook,
} from "@adobe/aio-commerce-sdk/webhooks/api"; // <-- This is like @adobe/aio-commerce-lib-webhooks/api

// Validate and create IMS auth provider
assertImsAuthParams(params);
const imsAuth = getImsAuthProvider(params);

const commerceHttpClientConfig = {
  auth: imsAuth,
  config: {
    baseUrl: "https://na1-sandbox.api.commerce.adobe.com/{tenantId}/",
    flavor: "saas",
  },
};

const updateEventingConfigurationParams = {
  enabled: true,
  environmentId: "my-environment-id",
  instanceId: "my-instance-id",
  merchantId: "my-merchant-id",
  providerId: "my-provider-id",
  workspaceConfiguration: {
    // ...
  },
};

// Use the raw HTTP client
const commerceClient = new AdobeCommerceHttpClient(commerceHttpClientConfig);
await updateEventingConfiguration(
  commerceClient,
  updateEventingConfigurationParams,
);

// Or create an API client with a pre-bound HTTP client.
const commerceEventsClient = createCommerceEventsApiClient(
  commerceHttpClientConfig,
);

await commerceEventsClient.updateEventingConfiguration(
  updateEventingConfigurationParams,
);

// Create a webhooks API client
const commerceWebhooksClient = createCommerceWebhooksApiClient(
  commerceHttpClientConfig,
);

// Subscribe to a webhook
await commerceWebhooksClient.subscribeWebhook({
  webhook_method: "plugin.order.api.order_created",
  webhook_type: "after",
  batch_name: "default",
  hook_name: "order_created",
  url: "https://example.com/webhook",
  method: "POST",
});

Invoice view-button helpers are available from @adobe/aio-commerce-sdk/admin-ui/invoice-view-buttons. The matching useInvoiceViewButtonContext hook is available from @adobe/aio-commerce-sdk/admin-ui/web. See the Admin UI usage guide for iframe (view) and runtime action (worker) examples.

Credit memo view-button helpers are available from @adobe/aio-commerce-sdk/admin-ui/credit-memo-view-buttons. The matching useCreditMemoViewButtonContext hook is available from @adobe/aio-commerce-sdk/admin-ui/web. See the Admin UI usage guide for iframe (view) and runtime action (worker) examples.

Return (RMA) view-button helpers are available from @adobe/aio-commerce-sdk/admin-ui/rma-view-buttons. The matching useRmaViewButtonContext hook is available from @adobe/aio-commerce-sdk/admin-ui/web. See the Admin UI usage guide for iframe (view) and runtime action (worker) examples.

Benefits

• Simplified dependency management: Install one package instead of multiple individual libraries
• Consistent versioning: All included libraries are tested together for compatibility
• Better developer experience: Single import source for common Commerce functionality
• Tree-shaking support: Both import patterns support dead code elimination
• Type safety: Full TypeScript support with type definitions included

Contributing

This package is part of the Adobe Commerce SDK monorepo. See the Contributing Guide and Development Guide for development setup and guidelines.

Refer to this section of the development guide if you want to add your library to the SDK: Add it to the SDK (optional)