@commercengine/storefront-sdk 0.3.7 → 0.3.9

package/dist/index.d.ts

@@ -8,6 +8,17 @@ import { HelpersClient } from "./lib/helper";
 import { CustomerClient } from "./lib/customer";
 import { TokenStorage, MemoryTokenStorage, BrowserTokenStorage, CookieTokenStorage } from "./lib/middleware";
 import { type UserInfo } from "./lib/jwt-utils";
+/**
+ * Supported default headers that can be set at the SDK level
+ * Only includes headers that are actually supported by API endpoints
+ */
+export interface SupportedDefaultHeaders {
+    /**
+     * Customer group ID used for pricing, promotions, and subscription rates
+     * If not provided, the API will use default pricing
+     */
+    customer_group_id?: string;
+}
 /**
  * SDK initialization options
  */
@@ -58,6 +69,12 @@ export interface StorefrontSDKOptions {
      * Callback when tokens are cleared (logout/error)
      */
     onTokensCleared?: () => void;
+    /**
+     * Default headers to include with API requests
+     * These can be overridden at the method level
+     * Only supports headers that are actually available in the API
+     */
+    defaultHeaders?: SupportedDefaultHeaders;
 }
 /**
  * Main SDK class for the Storefront API
@@ -166,6 +183,18 @@ export declare class StorefrontSDK {
      * @returns Customer group ID or null if no token, invalid token, or user has no customer group
      */
     getCustomerGroupId(): Promise<string | null>;
+    /**
+     * Set default headers for all clients
+     *
+     * @param headers - Default headers to set (only supported headers allowed)
+     */
+    setDefaultHeaders(headers: SupportedDefaultHeaders): void;
+    /**
+     * Get current default headers
+     *
+     * @returns Current default headers
+     */
+    getDefaultHeaders(): SupportedDefaultHeaders | undefined;
 }
 export default StorefrontSDK;
 export { StorefrontAPIClient, AuthClient, CartClient, CatalogClient, CustomerClient, HelpersClient, ShippingClient, OrderClient, };

package/dist/index.js

@@ -58,6 +58,7 @@ export class StorefrontSDK {
             tokenStorage: options.tokenStorage,
             onTokensUpdated: options.onTokensUpdated,
             onTokensCleared: options.onTokensCleared,
+            defaultHeaders: options.defaultHeaders,
         };
         this.catalog = new CatalogClient(config);
         this.cart = new CartClient(config);
@@ -198,6 +199,30 @@ export class StorefrontSDK {
         const userInfo = await this.getUserInfo();
         return userInfo?.customerGroupId || null;
     }
+    /**
+     * Set default headers for all clients
+     *
+     * @param headers - Default headers to set (only supported headers allowed)
+     */
+    setDefaultHeaders(headers) {
+        // Update config for all clients
+        const newConfig = { ...this.catalog["config"], defaultHeaders: headers };
+        this.catalog["config"] = newConfig;
+        this.cart["config"] = newConfig;
+        this.auth["config"] = newConfig;
+        this.customer["config"] = newConfig;
+        this.helpers["config"] = newConfig;
+        this.shipping["config"] = newConfig;
+        this.order["config"] = newConfig;
+    }
+    /**
+     * Get current default headers
+     *
+     * @returns Current default headers
+     */
+    getDefaultHeaders() {
+        return this.catalog["config"].defaultHeaders;
+    }
 }
 // Export the main SDK class
 export default StorefrontSDK;

package/dist/lib/cart.d.ts

@@ -149,15 +149,15 @@ export declare class CartClient extends StorefrontAPIClient {
     /**
      * Get all available coupons
      *
-     * @param customerGroupId - The ID of the customer group
+     * @param headers - Optional header parameters (customer_group_id, etc.)
      * @returns Promise with all available coupons
      */
-    getAvailableCoupons(headers: ListCouponsHeaderParams): Promise<ApiResult<ListCouponsContent>>;
+    getAvailableCoupons(headers?: ListCouponsHeaderParams): Promise<ApiResult<ListCouponsContent>>;
     /**
      * Get all available promotions
      *
-     * @param customerGroupId - The ID of the customer group
+     * @param headers - Optional header parameters (customer_group_id, etc.)
      * @returns Promise with all available promotions
      */
-    getAvailablePromotions(headers: ListPromotionsHeaderParams): Promise<ApiResult<ListPromotionsContent>>;
+    getAvailablePromotions(headers?: ListPromotionsHeaderParams): Promise<ApiResult<ListPromotionsContent>>;
 }

package/dist/lib/cart.js

@@ -274,23 +274,29 @@ export class CartClient extends StorefrontAPIClient {
     /**
      * Get all available coupons
      *
-     * @param customerGroupId - The ID of the customer group
+     * @param headers - Optional header parameters (customer_group_id, etc.)
      * @returns Promise with all available coupons
      */
     async getAvailableCoupons(headers) {
+        const mergedHeaders = this.mergeHeaders(headers);
         return this.executeRequest(() => this.client.GET("/carts/available-coupons", {
-            headers: headers,
+            params: {
+                header: mergedHeaders,
+            },
         }));
     }
     /**
      * Get all available promotions
      *
-     * @param customerGroupId - The ID of the customer group
+     * @param headers - Optional header parameters (customer_group_id, etc.)
      * @returns Promise with all available promotions
      */
     async getAvailablePromotions(headers) {
+        const mergedHeaders = this.mergeHeaders(headers);
         return this.executeRequest(() => this.client.GET("/carts/available-promotions", {
-            headers: headers,
+            params: {
+                header: mergedHeaders,
+            },
         }));
     }
 }

package/dist/lib/catalog.d.ts

@@ -1,5 +1,5 @@
 import { StorefrontAPIClient } from "./client";
-import type { ApiResult, GetProductDetailContent, GetProductDetailPathParams, GetProductDetailQuery, GetVariantDetailContent, GetVariantDetailQuery, GetVariantDetailPathParams, ListProductsContent, ListProductsQuery, ListProductVariantsContent, ListProductVariantsPathParams, ListProductVariantsQuery, ListCategoriesQuery, ListCategoriesContent, ListProductReviewsQuery, ListProductReviewsPathParams, ListProductReviewsContent, CreateProductReviewPathParams, CreateProductReviewFormData, CreateProductReviewResponse, SearchProductsBody, SearchProductsContent, ListSkusQuery, ListSkusContent, ListCrosssellProductsContent, ListCrosssellProductsQuery, ListUpsellProductsQuery, ListUpsellProductsContent, ListSimilarProductsQuery, ListSimilarProductsContent } from "../types/storefront-api-types";
+import type { ApiResult, GetProductDetailContent, GetProductDetailPathParams, GetProductDetailHeaderParams, GetVariantDetailContent, GetVariantDetailPathParams, GetVariantDetailHeaderParams, ListProductsContent, ListProductsQuery, ListProductsHeaderParams, ListProductVariantsContent, ListProductVariantsPathParams, ListProductVariantsHeaderParams, ListCategoriesQuery, ListCategoriesContent, ListProductReviewsQuery, ListProductReviewsPathParams, ListProductReviewsContent, CreateProductReviewPathParams, CreateProductReviewFormData, CreateProductReviewResponse, SearchProductsBody, SearchProductsContent, ListSkusQuery, ListSkusContent, ListSkusHeaderParams, ListCrosssellProductsContent, ListCrosssellProductsQuery, ListCrosssellProductsHeaderParams, ListUpsellProductsQuery, ListUpsellProductsContent, ListUpsellProductsHeaderParams, ListSimilarProductsQuery, ListSimilarProductsContent, ListSimilarProductsHeaderParams } from "../types/storefront-api-types";
 /**
  * Client for interacting with catalog endpoints
  */
@@ -8,41 +8,42 @@ export declare class CatalogClient extends StorefrontAPIClient {
      * List all products
      *
      * @param options - Optional query parameters
+     * @param headers - Optional header parameters (customer_group_id, etc.)
      * @returns Promise with products and pagination info
      */
-    listProducts(options?: ListProductsQuery): Promise<ApiResult<ListProductsContent>>;
+    listProducts(options?: ListProductsQuery, headers?: ListProductsHeaderParams): Promise<ApiResult<ListProductsContent>>;
     /**
      * List all skus
      *
      * @param options - Optional query parameters
+     * @param headers - Optional header parameters (customer_group_id, etc.)
      * @returns Promise with skus and pagination info
      */
-    listSkus(options?: ListSkusQuery): Promise<ApiResult<ListSkusContent>>;
+    listSkus(options?: ListSkusQuery, headers?: ListSkusHeaderParams): Promise<ApiResult<ListSkusContent>>;
     /**
      * Get details for a specific product
      *
-     * @param productId - The ID of the product
-     * @param options - Optional query parameters
+     * @param pathParams - The path parameters (product ID or slug)
+     * @param headers - Optional header parameters (customer_group_id, etc.)
      * @returns Promise with product details
      */
-    getProductDetail(pathParams: GetProductDetailPathParams, queryParams?: GetProductDetailQuery): Promise<ApiResult<GetProductDetailContent>>;
+    getProductDetail(pathParams: GetProductDetailPathParams, headers?: GetProductDetailHeaderParams): Promise<ApiResult<GetProductDetailContent>>;
     /**
      * List variants for a specific product
      *
-     * @param productId - The ID of the product
-     * @param options - Optional query parameters
+     * @param pathParams - The path parameters (product ID)
+     * @param headers - Optional header parameters (customer_group_id, etc.)
      * @returns Promise with variants
      */
-    listProductVariants(pathParams: ListProductVariantsPathParams, queryParams?: ListProductVariantsQuery): Promise<ApiResult<ListProductVariantsContent>>;
+    listProductVariants(pathParams: ListProductVariantsPathParams, headers?: ListProductVariantsHeaderParams): Promise<ApiResult<ListProductVariantsContent>>;
     /**
      * Get details for a specific variant
      *
-     * @param productId - The ID of the product
-     * @param variantId - The ID of the variant
-     * @param options - Optional query parameters
+     * @param pathParams - The path parameters (product ID and variant ID)
+     * @param headers - Optional header parameters (customer_group_id, etc.)
      * @returns Promise with variant details
      */
-    getVariantDetail(pathParams: GetVariantDetailPathParams, queryParams?: GetVariantDetailQuery): Promise<ApiResult<GetVariantDetailContent>>;
+    getVariantDetail(pathParams: GetVariantDetailPathParams, headers?: GetVariantDetailHeaderParams): Promise<ApiResult<GetVariantDetailContent>>;
     /**
      * List all categories
      *
@@ -53,16 +54,16 @@ export declare class CatalogClient extends StorefrontAPIClient {
     /**
      * List reviews for a specific product
      *
-     * @param productId - The ID of the product
-     * @param options - Optional query parameters
+     * @param pathParams - The path parameters (product ID)
+     * @param queryParams - Optional query parameters
      * @returns Promise with reviews and pagination info
      */
     listProductReviews(pathParams: ListProductReviewsPathParams, queryParams?: ListProductReviewsQuery): Promise<ApiResult<ListProductReviewsContent>>;
     /**
      * Create a review for a specific product
      *
-     * @param productId - The ID of the product
-     * @param reviewData - The review data
+     * @param pathParams - The path parameters (product ID)
+     * @param formData - The review data
      * @returns Promise that resolves when the review is created
      */
     createProductReview(pathParams: CreateProductReviewPathParams, formData: CreateProductReviewFormData): Promise<ApiResult<CreateProductReviewResponse>>;
@@ -74,24 +75,27 @@ export declare class CatalogClient extends StorefrontAPIClient {
      */
     searchProducts(searchData: SearchProductsBody): Promise<ApiResult<SearchProductsContent>>;
     /**
-     * Retrieve cross-sell recommendations for a specific product
+     * List cross-sell products
      *
      * @param options - Optional query parameters
-     * @returns Promise with cross-sell recommendations with pagination
+     * @param headers - Optional header parameters (customer_group_id, etc.)
+     * @returns Promise with cross-sell products
      */
-    listCrossSellProducts(options?: ListCrosssellProductsQuery): Promise<ApiResult<ListCrosssellProductsContent>>;
+    listCrossSellProducts(options?: ListCrosssellProductsQuery, headers?: ListCrosssellProductsHeaderParams): Promise<ApiResult<ListCrosssellProductsContent>>;
     /**
-     * Retrieve up-sell recommendations for a specific product
+     * List up-sell products
      *
      * @param options - Optional query parameters
-     * @returns Promise with up-sell recommendations with pagination
+     * @param headers - Optional header parameters (customer_group_id, etc.)
+     * @returns Promise with up-sell products
      */
-    listUpSellProducts(options?: ListUpsellProductsQuery): Promise<ApiResult<ListUpsellProductsContent>>;
+    listUpSellProducts(options?: ListUpsellProductsQuery, headers?: ListUpsellProductsHeaderParams): Promise<ApiResult<ListUpsellProductsContent>>;
     /**
-     * Retrieve related products for a specific product
+     * List similar products
      *
      * @param options - Optional query parameters
-     * @returns Promise with related products with pagination
+     * @param headers - Optional header parameters (customer_group_id, etc.)
+     * @returns Promise with similar products
      */
-    listSimilarProducts(options?: ListSimilarProductsQuery): Promise<ApiResult<ListSimilarProductsContent>>;
+    listSimilarProducts(options?: ListSimilarProductsQuery, headers?: ListSimilarProductsHeaderParams): Promise<ApiResult<ListSimilarProductsContent>>;
 }

package/dist/lib/catalog.js

@@ -7,67 +7,79 @@ export class CatalogClient extends StorefrontAPIClient {
      * List all products
      *
      * @param options - Optional query parameters
+     * @param headers - Optional header parameters (customer_group_id, etc.)
      * @returns Promise with products and pagination info
      */
-    async listProducts(options) {
-        return this.executeRequest(() => this.client.GET('/catalog/products', {
-            params: { query: options },
+    async listProducts(options, headers) {
+        const mergedHeaders = this.mergeHeaders(headers);
+        return this.executeRequest(() => this.client.GET("/catalog/products", {
+            params: {
+                query: options,
+                header: mergedHeaders,
+            },
         }));
     }
     /**
      * List all skus
      *
      * @param options - Optional query parameters
+     * @param headers - Optional header parameters (customer_group_id, etc.)
      * @returns Promise with skus and pagination info
      */
-    async listSkus(options) {
-        return this.executeRequest(() => this.client.GET('/catalog/skus', {
-            params: { query: options },
+    async listSkus(options, headers) {
+        const mergedHeaders = this.mergeHeaders(headers);
+        return this.executeRequest(() => this.client.GET("/catalog/skus", {
+            params: {
+                query: options,
+                header: mergedHeaders,
+            },
         }));
     }
     /**
      * Get details for a specific product
      *
-     * @param productId - The ID of the product
-     * @param options - Optional query parameters
+     * @param pathParams - The path parameters (product ID or slug)
+     * @param headers - Optional header parameters (customer_group_id, etc.)
      * @returns Promise with product details
      */
-    async getProductDetail(pathParams, queryParams) {
-        return this.executeRequest(() => this.client.GET('/catalog/products/{product_id}', {
+    async getProductDetail(pathParams, headers) {
+        const mergedHeaders = this.mergeHeaders(headers);
+        return this.executeRequest(() => this.client.GET("/catalog/products/{product_id_or_slug}", {
             params: {
                 path: pathParams,
-                query: queryParams,
+                header: mergedHeaders,
             },
         }));
     }
     /**
      * List variants for a specific product
      *
-     * @param productId - The ID of the product
-     * @param options - Optional query parameters
+     * @param pathParams - The path parameters (product ID)
+     * @param headers - Optional header parameters (customer_group_id, etc.)
      * @returns Promise with variants
      */
-    async listProductVariants(pathParams, queryParams) {
+    async listProductVariants(pathParams, headers) {
+        const mergedHeaders = this.mergeHeaders(headers);
         return this.executeRequest(() => this.client.GET("/catalog/products/{product_id}/variants", {
             params: {
                 path: pathParams,
-                query: queryParams,
+                header: mergedHeaders,
             },
         }));
     }
     /**
      * Get details for a specific variant
      *
-     * @param productId - The ID of the product
-     * @param variantId - The ID of the variant
-     * @param options - Optional query parameters
+     * @param pathParams - The path parameters (product ID and variant ID)
+     * @param headers - Optional header parameters (customer_group_id, etc.)
      * @returns Promise with variant details
      */
-    async getVariantDetail(pathParams, queryParams) {
+    async getVariantDetail(pathParams, headers) {
+        const mergedHeaders = this.mergeHeaders(headers);
         return this.executeRequest(() => this.client.GET("/catalog/products/{product_id}/variants/{variant_id}", {
             params: {
                 path: pathParams,
-                query: queryParams,
+                header: mergedHeaders,
             },
         }));
     }
@@ -85,8 +97,8 @@ export class CatalogClient extends StorefrontAPIClient {
     /**
      * List reviews for a specific product
      *
-     * @param productId - The ID of the product
-     * @param options - Optional query parameters
+     * @param pathParams - The path parameters (product ID)
+     * @param queryParams - Optional query parameters
      * @returns Promise with reviews and pagination info
      */
     async listProductReviews(pathParams, queryParams) {
@@ -100,8 +112,8 @@ export class CatalogClient extends StorefrontAPIClient {
     /**
      * Create a review for a specific product
      *
-     * @param productId - The ID of the product
-     * @param reviewData - The review data
+     * @param pathParams - The path parameters (product ID)
+     * @param formData - The review data
      * @returns Promise that resolves when the review is created
      */
     async createProductReview(pathParams, formData) {
@@ -125,7 +137,7 @@ export class CatalogClient extends StorefrontAPIClient {
                     }
                 }
                 return fd;
-            }
+            },
         }));
     }
     /**
@@ -140,41 +152,50 @@ export class CatalogClient extends StorefrontAPIClient {
         }));
     }
     /**
-     * Retrieve cross-sell recommendations for a specific product
+     * List cross-sell products
      *
      * @param options - Optional query parameters
-     * @returns Promise with cross-sell recommendations with pagination
+     * @param headers - Optional header parameters (customer_group_id, etc.)
+     * @returns Promise with cross-sell products
      */
-    async listCrossSellProducts(options) {
+    async listCrossSellProducts(options, headers) {
+        const mergedHeaders = this.mergeHeaders(headers);
         return this.executeRequest(() => this.client.GET("/catalog/products/cross-sell", {
             params: {
                 query: options,
+                header: mergedHeaders,
             },
         }));
     }
     /**
-     * Retrieve up-sell recommendations for a specific product
+     * List up-sell products
      *
      * @param options - Optional query parameters
-     * @returns Promise with up-sell recommendations with pagination
+     * @param headers - Optional header parameters (customer_group_id, etc.)
+     * @returns Promise with up-sell products
      */
-    async listUpSellProducts(options) {
+    async listUpSellProducts(options, headers) {
+        const mergedHeaders = this.mergeHeaders(headers);
         return this.executeRequest(() => this.client.GET("/catalog/products/up-sell", {
             params: {
                 query: options,
+                header: mergedHeaders,
             },
         }));
     }
     /**
-     * Retrieve related products for a specific product
+     * List similar products
      *
      * @param options - Optional query parameters
-     * @returns Promise with related products with pagination
+     * @param headers - Optional header parameters (customer_group_id, etc.)
+     * @returns Promise with similar products
      */
-    async listSimilarProducts(options) {
+    async listSimilarProducts(options, headers) {
+        const mergedHeaders = this.mergeHeaders(headers);
         return this.executeRequest(() => this.client.GET("/catalog/products/similar", {
             params: {
                 query: options,
+                header: mergedHeaders,
             },
         }));
     }

package/dist/lib/client.d.ts

@@ -22,6 +22,7 @@ export declare class StorefrontAPIClient {
     protected client: ReturnType<typeof createClient<paths>>;
     protected config: StorefrontSDKOptions;
     private readonly baseUrl;
+    private initializationPromise;
     /**
      * Create a new StorefrontAPIClient
      *
@@ -97,4 +98,16 @@ export declare class StorefrontAPIClient {
         error?: ApiErrorResponse;
         response: Response;
     }>): Promise<ApiResult<T>>;
+    /**
+     * Initialize tokens in storage (private helper method)
+     */
+    private initializeTokens;
+    /**
+     * Merge default headers with method-level headers
+     * Method-level headers take precedence over default headers
+     *
+     * @param methodHeaders - Headers passed to the specific method call
+     * @returns Merged headers object
+     */
+    protected mergeHeaders<T extends Record<string, any> = Record<string, any>>(methodHeaders?: T): T;
 }

package/dist/lib/client.js

@@ -22,6 +22,7 @@ export class StorefrontAPIClient {
     client;
     config;
     baseUrl;
+    initializationPromise = null;
     /**
      * Create a new StorefrontAPIClient
      *
@@ -46,17 +47,9 @@ export class StorefrontAPIClient {
             this.client.use(authMiddleware);
             // If initial tokens were provided, store them in tokenStorage
             if (this.config.accessToken) {
-                this.config.tokenStorage.setAccessToken(this.config.accessToken).catch(error => {
-                    console.warn('Failed to set initial access token in storage:', error);
-                });
-                // Clear the manual token since we're using storage
+                this.initializationPromise = this.initializeTokens(this.config.accessToken, this.config.refreshToken);
+                // Clear the manual tokens since we're using storage
                 this.config.accessToken = undefined;
-            }
-            if (this.config.refreshToken) {
-                this.config.tokenStorage.setRefreshToken(this.config.refreshToken).catch(error => {
-                    console.warn('Failed to set initial refresh token in storage:', error);
-                });
-                // Clear the manual refresh token since we're using storage
                 this.config.refreshToken = undefined;
             }
         }
@@ -100,14 +93,14 @@ export class StorefrontAPIClient {
                 const timeoutId = setTimeout(() => controller.abort(), this.config.timeout);
                 // Merge with existing signal if present
                 if (request.signal) {
-                    request.signal.addEventListener('abort', () => controller.abort());
+                    request.signal.addEventListener("abort", () => controller.abort());
                 }
                 // Create new request with timeout signal
                 const newRequest = new Request(request, {
                     signal: controller.signal,
                 });
                 // Clean up timeout when request completes
-                controller.signal.addEventListener('abort', () => clearTimeout(timeoutId));
+                controller.signal.addEventListener("abort", () => clearTimeout(timeoutId));
                 return newRequest;
             },
         });
@@ -149,6 +142,10 @@ export class StorefrontAPIClient {
      * @returns The Authorization header value or empty string if no token is set
      */
     async getAuthorizationHeader() {
+        // Wait for initialization to complete if using token storage
+        if (this.config.tokenStorage && this.initializationPromise) {
+            await this.initializationPromise;
+        }
         if (this.config.tokenStorage) {
             const token = await this.config.tokenStorage.getAccessToken();
             return token ? `Bearer ${token}` : "";
@@ -236,11 +233,60 @@ export class StorefrontAPIClient {
                 data: null,
                 error: {
                     success: false,
-                    code: 'NETWORK_ERROR',
-                    message: 'Network error occurred',
+                    code: "NETWORK_ERROR",
+                    message: "Network error occurred",
                     error: err,
                 },
             };
         }
     }
+    /**
+     * Initialize tokens in storage (private helper method)
+     */
+    async initializeTokens(accessToken, refreshToken) {
+        try {
+            if (this.config.tokenStorage) {
+                await this.config.tokenStorage.setAccessToken(accessToken);
+                if (refreshToken) {
+                    await this.config.tokenStorage.setRefreshToken(refreshToken);
+                }
+            }
+        }
+        catch (error) {
+            console.warn("Failed to initialize tokens in storage:", error);
+        }
+    }
+    /**
+     * Merge default headers with method-level headers
+     * Method-level headers take precedence over default headers
+     *
+     * @param methodHeaders - Headers passed to the specific method call
+     * @returns Merged headers object
+     */
+    mergeHeaders(methodHeaders) {
+        if (!this.config.defaultHeaders && !methodHeaders) {
+            return {};
+        }
+        // Start with default headers, but only include supported ones
+        const merged = {};
+        // Add default headers if they exist
+        if (this.config.defaultHeaders) {
+            if (this.config.defaultHeaders.customer_group_id !== undefined) {
+                merged.customer_group_id =
+                    this.config.defaultHeaders.customer_group_id;
+            }
+            // Future: Add other supported headers here as they become available
+        }
+        if (methodHeaders) {
+            // Method headers override default headers
+            Object.assign(merged, methodHeaders);
+        }
+        // Remove undefined values
+        Object.keys(merged).forEach((key) => {
+            if (merged[key] === undefined) {
+                delete merged[key];
+            }
+        });
+        return merged;
+    }
 }

package/dist/types/storefront-api-types.d.ts

@@ -15,21 +15,23 @@ export type ApiErrorResponse = {
 export type ListProductsResponse = paths['/catalog/products']['get']['responses'][200]['content']['application/json'];
 export type ListProductsContent = ListProductsResponse['content'];
 export type ListProductsQuery = paths['/catalog/products']['get']['parameters']['query'];
+export type ListProductsHeaderParams = paths['/catalog/products']['get']['parameters']['header'];
 export type ListSkusResponse = paths['/catalog/skus']['get']['responses'][200]['content']['application/json'];
 export type ListSkusContent = ListSkusResponse['content'];
 export type ListSkusQuery = paths['/catalog/skus']['get']['parameters']['query'];
-export type GetProductDetailResponse = paths['/catalog/products/{product_id}']['get']['responses'][200]['content']['application/json'];
+export type ListSkusHeaderParams = paths['/catalog/skus']['get']['parameters']['header'];
+export type GetProductDetailResponse = paths['/catalog/products/{product_id_or_slug}']['get']['responses'][200]['content']['application/json'];
 export type GetProductDetailContent = GetProductDetailResponse['content'];
-export type GetProductDetailQuery = paths['/catalog/products/{product_id}']['get']['parameters']['query'];
-export type GetProductDetailPathParams = paths['/catalog/products/{product_id}']['get']['parameters']['path'];
+export type GetProductDetailPathParams = paths['/catalog/products/{product_id_or_slug}']['get']['parameters']['path'];
+export type GetProductDetailHeaderParams = paths['/catalog/products/{product_id_or_slug}']['get']['parameters']['header'];
 export type ListProductVariantsResponse = paths['/catalog/products/{product_id}/variants']['get']['responses'][200]['content']['application/json'];
 export type ListProductVariantsContent = ListProductVariantsResponse['content'];
-export type ListProductVariantsQuery = paths['/catalog/products/{product_id}/variants']['get']['parameters']['query'];
 export type ListProductVariantsPathParams = paths['/catalog/products/{product_id}/variants']['get']['parameters']['path'];
+export type ListProductVariantsHeaderParams = paths['/catalog/products/{product_id}/variants']['get']['parameters']['header'];
 export type GetVariantDetailResponse = paths['/catalog/products/{product_id}/variants/{variant_id}']['get']['responses'][200]['content']['application/json'];
 export type GetVariantDetailContent = GetVariantDetailResponse['content'];
-export type GetVariantDetailQuery = paths['/catalog/products/{product_id}/variants/{variant_id}']['get']['parameters']['query'];
 export type GetVariantDetailPathParams = paths['/catalog/products/{product_id}/variants/{variant_id}']['get']['parameters']['path'];
+export type GetVariantDetailHeaderParams = paths['/catalog/products/{product_id}/variants/{variant_id}']['get']['parameters']['header'];
 export type ListCategoriesResponse = paths['/catalog/categories']['get']['responses'][200]['content']['application/json'];
 export type ListCategoriesContent = ListCategoriesResponse['content'];
 export type ListCategoriesQuery = paths['/catalog/categories']['get']['parameters']['query'];
@@ -43,12 +45,15 @@ export type CreateProductReviewFormData = NonNullable<paths['/catalog/products/{
 export type ListSimilarProductsResponse = paths['/catalog/products/similar']['get']['responses'][200]['content']['application/json'];
 export type ListSimilarProductsContent = ListSimilarProductsResponse['content'];
 export type ListSimilarProductsQuery = paths['/catalog/products/similar']['get']['parameters']['query'];
+export type ListSimilarProductsHeaderParams = paths['/catalog/products/similar']['get']['parameters']['header'];
 export type ListUpsellProductsResponse = paths['/catalog/products/up-sell']['get']['responses'][200]['content']['application/json'];
 export type ListUpsellProductsContent = ListUpsellProductsResponse['content'];
 export type ListUpsellProductsQuery = paths['/catalog/products/up-sell']['get']['parameters']['query'];
+export type ListUpsellProductsHeaderParams = paths['/catalog/products/up-sell']['get']['parameters']['header'];
 export type ListCrosssellProductsResponse = paths['/catalog/products/cross-sell']['get']['responses'][200]['content']['application/json'];
 export type ListCrosssellProductsContent = ListCrosssellProductsResponse['content'];
 export type ListCrosssellProductsQuery = paths['/catalog/products/cross-sell']['get']['parameters']['query'];
+export type ListCrosssellProductsHeaderParams = paths['/catalog/products/cross-sell']['get']['parameters']['header'];
 export type SearchProductsResponse = paths['/catalog/products/search']['post']['responses'][200]['content']['application/json'];
 export type SearchProductsContent = SearchProductsResponse['content'];
 export type SearchProductsBody = NonNullable<paths['/catalog/products/search']['post']['requestBody']>['content']['application/json'];
@@ -151,6 +156,8 @@ export type DeleteAddressResponse = paths['/customers/{user_id}/addresses/{addre
 export type DeleteAddressPathParams = paths['/customers/{user_id}/addresses/{address_id}']['delete']['parameters']['path'];
 export type ListKycDocumentResponse = paths['/store/kyc-document']['get']['responses'][200]['content']['application/json'];
 export type ListKycDocumentContent = ListKycDocumentResponse['content'];
+export type GetConfigResponse = paths['/store/config']['get']['responses'][200]['content']['application/json'];
+export type GetConfigContent = GetConfigResponse['content'];
 export type ListDocumentsResponse = paths['/customers/{id}/documents']['get']['responses'][200]['content']['application/json'];
 export type ListDocumentsContent = ListDocumentsResponse['content'];
 export type ListDocumentsPathParams = paths['/customers/{id}/documents']['get']['parameters']['path'];

package/dist/types/storefront.d.ts

@@ -44,7 +44,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/catalog/products/{product_id}": {
+    "/catalog/products/{product_id_or_slug}": {
         parameters: {
             query?: never;
             header?: never;
@@ -53,7 +53,7 @@ export interface paths {
         };
         /**
          * Retrieve a product detail
-         * @description Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Commerce Engine will return the corresponding product information.
+         * @description Retrieves the details of an existing product. Supply either the unique product ID or the unique slug, and Commerce Engine will return the corresponding product information.
          */
         get: operations["get-product-detail"];
         put?: never;
@@ -663,6 +663,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/store/config": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Retrieve store config
+         * @description Retrieve store config detail
+         */
+        get: operations["get-config"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/customers/{id}/documents": {
         parameters: {
             query?: never;
@@ -1848,6 +1868,7 @@ export interface components {
             readonly has_variant: boolean;
             tags: string[] | null;
             category_ids: string[];
+            categories: components["schemas"]["Category"][];
             /** Format: double */
             reviews_rating_sum: number;
             reviews_count: number;
@@ -2337,10 +2358,9 @@ export interface components {
             readonly email?: string;
             /**
              * @description Reviews with approved status will be displayed.
-             * @default pending
              * @enum {string}
              */
-            readonly status: "approved" | "rejected" | "archived" | "pending";
+            readonly status?: "approved";
             /** @default false */
             is_featured: boolean;
             tags?: string[];
@@ -4272,6 +4292,73 @@ export interface components {
             /** @enum {unknown} */
             verification_type?: "auto" | "manual";
         };
+        /** StoreConfig */
+        StoreConfig: {
+            /** @default false */
+            is_kyc_enabled: boolean;
+            /** @default false */
+            is_customer_group_enabled: boolean;
+            brand: components["schemas"]["Brand"];
+            currency: components["schemas"]["Currency"];
+            readonly customer_groups: components["schemas"]["CustomerGroup"][];
+            readonly kyc_documents: components["schemas"]["KycDocumentConfig"][];
+            measurement: components["schemas"]["MeasurementUnit"];
+            terms_of_service: components["schemas"]["StoreTemplate"];
+            refund_policy: components["schemas"]["StoreTemplate"];
+        };
+        /** StoreTemplate */
+        StoreTemplate: {
+            readonly id: string;
+            name: string;
+            /** @description to be used in email subject or notification heading if provided. */
+            content_title: string | null;
+            /** @enum {unknown} */
+            content_type: "html" | "markdown" | "plaintext";
+            content: string;
+        };
+        /** KycDocumentConfig */
+        KycDocumentConfig: {
+            readonly id: string;
+            /** @enum {unknown} */
+            document_type: "gst" | "pan" | "other";
+            title: string;
+            description: string | null;
+            /** @default true */
+            active: boolean;
+            is_mandatory: boolean;
+            is_attachment_required: boolean;
+            /** @enum {unknown} */
+            verification_type: "auto" | "manual";
+        };
+        /** CustomerGroup */
+        CustomerGroup: {
+            readonly id: string;
+            name: string;
+            description: string | null;
+            /** @description first record will be treated as default if not changed. */
+            is_default: boolean;
+            /** @default true */
+            active: boolean;
+        };
+        /** Brand */
+        Brand: {
+            /** @description brand name. it will be used in emails and other communications. */
+            name: string;
+            readonly logo_url: string;
+            /** @description json object having key - value pair.
+             *
+             *     example - {"facebook": "www.facebook.com/commecengine"} */
+            social_media_links: {
+                [key: string]: string;
+            };
+        };
+        /** MeasurementUnit */
+        MeasurementUnit: {
+            /** @enum {unknown} */
+            weight?: "gm";
+            /** @enum {unknown} */
+            dimension?: "cm";
+        };
         /** GstinDetail */
         GstinDetail: {
             id?: string;
@@ -4453,6 +4540,8 @@ export interface components {
         sortingParam: string;
         /** @description search keyword */
         searchKeyword: string;
+        /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+        CustomerGroupId: string;
     };
     requestBodies: never;
     headers: never;
@@ -4469,12 +4558,15 @@ export interface operations {
                 limit?: components["parameters"]["pageLimitParam"];
                 /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
                 sort_by?: components["parameters"]["sortingParam"];
-                /** @description filter products by categories */
+                /** @description filter products by categories ids */
                 category_id?: string[];
-                /** @description use this param only if different pricing is configured as per customer group */
-                customer_group_id?: string;
+                /** @description filter products by categories slugs */
+                category_slug?: string[];
+            };
+            header?: {
+                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                customer_group_id?: components["parameters"]["CustomerGroupId"];
             };
-            header?: never;
             path?: never;
             cookie?: never;
         };
@@ -4511,12 +4603,13 @@ export interface operations {
                 sort_by?: components["parameters"]["sortingParam"];
                 /** @description filter sku by categories */
                 category_id?: string[];
-                /** @description use this param only if different pricing is configured as per customer group */
-                customer_group_id?: string;
                 /** @description array of sku */
                 sku?: string[];
             };
-            header?: never;
+            header?: {
+                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                customer_group_id?: components["parameters"]["CustomerGroupId"];
+            };
             path?: never;
             cookie?: never;
         };
@@ -4544,14 +4637,14 @@ export interface operations {
     };
     "get-product-detail": {
         parameters: {
-            query?: {
-                /** @description use this param only if different pricing is configured as per customer group */
-                customer_group_id?: string;
+            query?: never;
+            header?: {
+                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                customer_group_id?: components["parameters"]["CustomerGroupId"];
             };
-            header?: never;
             path: {
-                /** @description id of a particular product */
-                product_id: string;
+                /** @description The unique identifier of the product. Can be either the product ID or the slug. */
+                product_id_or_slug: string;
             };
             cookie?: never;
         };
@@ -4578,11 +4671,11 @@ export interface operations {
     };
     "list-product-variants": {
         parameters: {
-            query?: {
-                /** @description use this param only if different pricing is configured as per customer group */
-                customer_group_id?: string;
+            query?: never;
+            header?: {
+                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                customer_group_id?: components["parameters"]["CustomerGroupId"];
             };
-            header?: never;
             path: {
                 /** @description ID of a particular product */
                 product_id: string;
@@ -4612,11 +4705,11 @@ export interface operations {
     };
     "get-variant-detail": {
         parameters: {
-            query?: {
-                /** @description use this param only if different pricing is configured as per customer group */
-                customer_group_id?: string;
+            query?: never;
+            header?: {
+                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                customer_group_id?: components["parameters"]["CustomerGroupId"];
             };
-            header?: never;
             path: {
                 /** @description product id */
                 product_id: string;
@@ -4649,7 +4742,7 @@ export interface operations {
     "list-categories": {
         parameters: {
             query?: {
-                /** @description To return child categories */
+                /** @description To return child categories using category id. */
                 parent_category_id?: string;
                 /** @description return child categories up to nesting level */
                 nested_level?: number;
@@ -4657,6 +4750,8 @@ export interface operations {
                 search?: components["parameters"]["searchKeyword"];
                 /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
                 sort_by?: components["parameters"]["sortingParam"];
+                /** @description To return child categories using category slug */
+                parent_category_slug?: string;
             };
             header?: never;
             path?: never;
@@ -4774,7 +4869,10 @@ export interface operations {
                 /** @description json to sort records */
                 sort_by?: string;
             };
-            header?: never;
+            header?: {
+                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                customer_group_id?: components["parameters"]["CustomerGroupId"];
+            };
             path?: never;
             cookie?: never;
         };
@@ -4812,7 +4910,10 @@ export interface operations {
                 /** @description json to sort records */
                 sort_by?: string;
             };
-            header?: never;
+            header?: {
+                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                customer_group_id?: components["parameters"]["CustomerGroupId"];
+            };
             path?: never;
             cookie?: never;
         };
@@ -4851,7 +4952,10 @@ export interface operations {
                 /** @description json to sort records */
                 sort_by?: string;
             };
-            header?: never;
+            header?: {
+                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                customer_group_id?: components["parameters"]["CustomerGroupId"];
+            };
             path?: never;
             cookie?: never;
         };
@@ -5989,6 +6093,35 @@ export interface operations {
             404: components["responses"]["NotFound"];
         };
     };
+    "get-config": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        message?: string;
+                        success?: boolean;
+                        content?: {
+                            store_config?: components["schemas"]["StoreConfig"];
+                        };
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+        };
+    };
     "list-documents": {
         parameters: {
             query?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercengine/storefront-sdk",
-  "version": "0.3.7",
+  "version": "0.3.9",
   "description": "TypeScript SDK for the Storefront API",
   "type": "module",
   "main": "dist/index.js",