@scayle/storefront-core 8.8.0 → 8.10.0

package/dist/types/sapi/order.d.ts

@@ -1,116 +1,39 @@
-/**
- * This file was automatically generated by json-schema-to-typescript.
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and run json-schema-to-typescript to regenerate this file.
- */
-export type TimestampOfOrderConfirmation = string;
-export type ThisFieldRepresentsTheAdditionalFeesExcludingTheTaxes = number;
-export type ThisFieldRepresentsTheAdditionalFeesIncludingTheTaxes = number;
-export type TheIncludedVATAmount = number;
-export type TheIncludedVATRateInPercentAsIntegerRepresentation = number;
-export type ThisFieldRepresentsTheDiscountAmountIncludingTheTaxes = number;
-export type AbsoluteValueOfTheAppliedTax = number;
-/**
- * This price excludes taxes, but also includes all applicable reductions.
- */
-export type ItemPriceExcludingTaxes = number;
-/**
- * The price is calculated including taxes and all applicable reductions such as discounts for sale and campaigns (should a campaign key be provdided on the request).
- */
-export type ItemPriceIncludingTaxes = number;
-/**
- * The three character [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code that identifies the currency. The currency is defined on the configuration of the shop, and can be modified in the cloud panel.
- */
-export type CharacterCurrencyCode = string;
-export type UniqueIdentifierOfTheState = string;
-export type NameOfTheState = string;
-export type UniqueIdentifierOfTheState1 = string;
-export type NameOfTheState1 = string;
-export type UniqueIdentifierOfTheState2 = string;
-export type NameOfTheState2 = string;
-export type TimestampOfOrderInvoice = string;
-export type UniqueNumericIdentifierOfTheItem = number;
-/**
- * The number of deliverable items available in the warehouse for immediate shipping.
- */
-export type AvailableQuantityInTheWarehouse = number;
-/**
- * The three character [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code that identifies the currency. The currency is defined on the configuration of the shop, and can be modified in the cloud panel.
- */
-export type CharacterCurrencyCode1 = string;
-/**
- * Whether the return shipment got triggered manually. Is missing in case there is no return shipment.
- */
-export type TheReturnShipmentHasBeenTriggeredByCCI = boolean;
-export type UniqueIdentifierOfTheItem = string;
 /**
  * Items are grouped by package, depending on the item's supplier configuration. The `packageId` references an entry in the packages list with delivery estimates and expected carrier.
  */
 export type PackageReference = number;
-export type ThisFieldRepresentsTheDiscountAmountIncludingTheTaxes1 = number;
-export type AbsoluteValueOfTheAppliedTax1 = number;
-export type RelativeValueOfTheAppliedTax = number;
-export type UndiscountedItemPriceExcludingTaxes = number;
-export type UndiscountedItemPriceIncludingTaxes = number;
-/**
- * This price excludes taxes, but also includes all applicable reductions.
- */
-export type ItemPriceExcludingTaxes1 = number;
-/**
- * The price is calculated including taxes and all applicable reductions such as discounts for sale and campaigns (should a campaign key be provdided on the request).
- */
-export type ItemPriceIncludingTaxes1 = number;
-/**
- * the warehouse id where the item are being picking from.
- */
-export type PickingWarehouseId = null | number;
-/**
- * The package identification inside of the warehouse.
- */
-export type WarehousePackageReference = null | number;
-export type TimestampOfItemCreation = string;
-export type TimestampOfLastItemUpdate = string;
-/**
- * Basket and order items are matched to a package by cross-referencing the `item[].packageId`.
- */
-export type ReferenceByWhichThePackageIsIdentified = number;
-export type CarrierShippingTheItem = string;
-export type LatestExpectedDeliveryDate = string;
-export type EarliestExpectedDeliveryDate = string;
-export type ReturnIdentCodeOfTheItem = null | string;
-export type ShipmentKeyOfTheItem = string;
 /**
  * The distribution of items across packages is calculated based on the supplierId. Once shipments are processed, the packages may be updated to reflect the actual shipments.
  */
 export type ListOfPackages = {
-    id: ReferenceByWhichThePackageIsIdentified;
-    carrierKey: CarrierShippingTheItem;
+    /**
+     * Basket and order items are matched to a package by cross-referencing the `item[].packageId`.
+     */
+    id: number;
+    carrierKey: string;
     /**
      * The delivery dates are calculated based on the hour-to-hour estimates configured per supplier in the cloud panel. Once the order has been confirmed and shipments have been received, the calculation is based on the warehouse cut-off times and transport duration. If the carrier provides a delivery estimate, this is applied.
      */
     deliveryDate: {
-        maximum: LatestExpectedDeliveryDate;
-        minimum: EarliestExpectedDeliveryDate;
+        maximum: string;
+        minimum: string;
     };
     deliveryStatus: 'open' | 'shipment_pending' | 'delegation_pending' | 'shipment_completed' | 'cancellation_completed';
-    returnIdentCode?: ReturnIdentCodeOfTheItem;
-    shipmentKey?: ShipmentKeyOfTheItem;
+    returnIdentCode?: null | string;
+    shipmentKey?: string;
     tracking?: {
         id?: string;
         url?: string;
     };
 }[];
-export type WhetherThePaymentMethodIsAGiftCard = boolean;
-export type NumberOfInstallmentsChosenByTheCustomerForTheOrder = number;
-export type IfTrueTheCustomerElectedToHaveADelayInPaymentCapture = boolean;
-export type TimestampOfOrderCreation = string;
-export type TimestampOfLastOrderUpdate = string;
-export interface ThisFieldHoldsDetailsAboutTheIncludedVATTax {
-    amount: TheIncludedVATAmount;
-    rate: TheIncludedVATRateInPercentAsIntegerRepresentation;
-}
 /**
- * When an item cannot be shipped within the regular delivery timeframe, and the warehouse is already aware of this, prior to the customer placing the order (ie it is not an unintentionally delayed delivery). This is generally the case when the item is out of stock and: the warehouse is waiting for incoming returns to restock the item, the warehouse has ordered fresh stocks from the supplier/manufacturer and is waiting for these to be shipped to the warehouse.
+ * When an item cannot be shipped within the regular delivery timeframe,
+ * and the warehouse is already aware of this, prior to the customer placing the
+ * order (ie it is not an unintentionally delayed delivery).
+ * This is generally the case when the item is out of stock and:
+ * the warehouse is waiting for incoming returns to restock the item,
+ * the warehouse has ordered fresh stocks from the supplier/manufacturer and is
+ * waiting for these to be shipped to the warehouse.
  */
 export interface DeliveryForecastFromWarehouse {
     deliverable?: {
@@ -122,123 +45,68 @@ export interface DeliveryForecastFromWarehouse {
         [k: string]: unknown;
     };
 }
+export type OrderAddressRecipientGender = 'm' | 'f' | 'd';
+export type OrderAddressRecipientType = 'personal' | 'retail' | 'organization' | 'family';
+export interface OrderAddress {
+    id: number;
+    additional?: string;
+    city: string;
+    collectionPoint?: {
+        customerKey?: string;
+        description?: string;
+        key: string;
+        type: string;
+    };
+    countryCode: string;
+    houseNumber?: string;
+    isBillingAddress?: boolean;
+    isDefault: {
+        billing: boolean;
+        shipping: boolean;
+    };
+    isShippingAddress?: boolean;
+    recipient: {
+        firstName?: string;
+        gender?: OrderAddressRecipientGender;
+        lastName: string;
+        title?: string | null;
+        type: OrderAddressRecipientType;
+    };
+    referenceKey?: string;
+    street: string;
+    zipCode: string;
+    createdAt: string;
+    updatedAt: string;
+    state?: string;
+}
+export interface OrderForwardAddress {
+    additional?: string;
+    city?: string;
+    collectionPoint?: {
+        customerKey?: string;
+        description?: string;
+        key?: string;
+        type?: string;
+    };
+    countryCode?: string;
+    houseNumber?: string;
+    recipient?: {
+        firstName?: string;
+        gender?: OrderAddressRecipientGender;
+        lastName?: string;
+        title?: string | null;
+        type?: OrderAddressRecipientType;
+    };
+}
 export interface Order {
     /**
-     * This `id` can be applied as a parameter on the url to retrieve an individual order in the [Fetch Order by ID](#fetch-order-by-id) endpoint.
+     * The `id` can be applied as a parameter on the url to retrieve an individual order in the [Fetch Order by ID](#fetch-order-by-id) endpoint.
      */
     id: number;
     address?: {
-        billing: {
-            id: number;
-            /**
-             * Additional data pertaining to the address, such as `c/o AboutYou`.
-             */
-            additional?: string;
-            city: string;
-            /**
-             * A collection point is an alternate shipping address, which will hold the customer's packages until pickup. Examples for collection points are DHL Packstations, DHL Post Offices and Hermes Paketshops.
-             */
-            collectionPoint?: {
-                customerKey?: string;
-                description?: string;
-                key: string;
-                type: ('hermes_parcelshop' | 'dhl_packstation' | 'dhl_postoffice' | 'postsk_postoffice' | 'postsk_parcelbox' | 'gls_postoffice' | 'gls_packstation' | 'gls_parcelshop' | 'post_office' | 'postsi_postoffice' | 'postsi_packstation' | 'omniva_parcel_shop' | 'omniva_packstation' | 'offline-store' | 'fastwayie_packstation' | 'fastwayie_parcelshop' | 'generic' | 'packstation' | 'parcel_shop' | 'posteitaliane_packstation' | 'posteitaliane_parcelshop' | 'postifi_packstation' | 'postifi_parcelshop' | 'zasilcz_parcelshop' | 'zasilcz_packstation' | 'reba_packstation' | 'reba_parcel_shop') | string;
-            };
-            countryCode: string;
-            houseNumber?: string;
-            isBillingAddress?: boolean;
-            isDefault: {
-                billing: boolean;
-                shipping: boolean;
-            };
-            isShippingAddress?: boolean;
-            recipient: {
-                firstName?: string;
-                gender?: 'm' | 'f' | 'd';
-                lastName: string;
-                title?: null | string;
-                type: 'personal' | 'retail' | 'organization' | 'family';
-            };
-            /**
-             * External reference set by the client to integrate a 3rd party system
-             */
-            referenceKey?: string;
-            street: string;
-            zipCode: string;
-            createdAt: string;
-            updatedAt: string;
-            state?: string;
-        };
-        forward?: {
-            /**
-             * Additional data pertaining to the address, such as `c/o AboutYou`.
-             */
-            additional?: string;
-            city?: string;
-            /**
-             * A collection point is an alternate shipping address, which will hold the customer's packages until pickup. Examples for collection points are DHL Packstations, DHL Post Offices and Hermes Paketshops.
-             */
-            collectionPoint?: {
-                customerKey?: string;
-                description?: string;
-                key?: string;
-                type?: ('hermes_parcelshop' | 'dhl_packstation' | 'dhl_postoffice' | 'postsk_postoffice' | 'postsk_parcelbox' | 'gls_postoffice' | 'gls_packstation' | 'gls_parcelshop' | 'post_office' | 'postsi_postoffice' | 'postsi_packstation' | 'omniva_parcel_shop' | 'omniva_packstation' | 'offline-store' | 'fastwayie_packstation' | 'fastwayie_parcelshop' | 'generic' | 'packstation' | 'parcel_shop' | 'posteitaliane_packstation' | 'posteitaliane_parcelshop' | 'postifi_packstation' | 'postifi_parcelshop' | 'zasilcz_parcelshop' | 'zasilcz_packstation' | 'reba_packstation' | 'reba_parcel_shop') | string;
-            };
-            countryCode?: string;
-            houseNumber?: string;
-            recipient?: {
-                firstName?: string;
-                gender?: 'm' | 'f' | 'd';
-                lastName?: string;
-                title?: null | string;
-                type?: 'personal' | 'retail' | 'organization' | 'family';
-            };
-            street?: string;
-            zipCode?: string;
-            createdAt?: string;
-            updatedAt?: string;
-        };
-        shipping: {
-            id: number;
-            /**
-             * Additional data pertaining to the address, such as `c/o AboutYou`.
-             */
-            additional?: string;
-            city: string;
-            /**
-             * A collection point is an alternate shipping address, which will hold the customer's packages until pickup. Examples for collection points are DHL Packstations, DHL Post Offices and Hermes Paketshops.
-             */
-            collectionPoint?: {
-                customerKey?: string;
-                description?: string;
-                key: string;
-                type: ('hermes_parcelshop' | 'dhl_packstation' | 'dhl_postoffice' | 'postsk_postoffice' | 'postsk_parcelbox' | 'gls_postoffice' | 'gls_packstation' | 'gls_parcelshop' | 'post_office' | 'postsi_postoffice' | 'postsi_packstation' | 'omniva_parcel_shop' | 'omniva_packstation' | 'offline-store' | 'fastwayie_packstation' | 'fastwayie_parcelshop' | 'generic' | 'packstation' | 'parcel_shop' | 'posteitaliane_packstation' | 'posteitaliane_parcelshop' | 'postifi_packstation' | 'postifi_parcelshop' | 'zasilcz_parcelshop' | 'zasilcz_packstation' | 'reba_packstation' | 'reba_parcel_shop') | string;
-            };
-            countryCode: string;
-            houseNumber?: string;
-            isBillingAddress?: boolean;
-            isDefault: {
-                billing: boolean;
-                shipping: boolean;
-            };
-            isShippingAddress?: boolean;
-            recipient: {
-                firstName?: string;
-                gender?: 'm' | 'f' | 'd';
-                lastName: string;
-                title?: null | string;
-                type: 'personal' | 'retail' | 'organization' | 'family';
-            };
-            /**
-             * External reference set by the client to integrate a 3rd party system
-             */
-            referenceKey?: string;
-            street: string;
-            zipCode: string;
-            createdAt: string;
-            updatedAt: string;
-            state?: string;
-        };
+        billing: OrderAddress;
+        forward?: OrderForwardAddress;
+        shipping: OrderAddress;
     };
     /**
      * Reference to the basket attached to this order
@@ -248,7 +116,7 @@ export interface Order {
      * Reference to the campaign applied to this order
      */
     campaignKey?: string;
-    confirmedAt?: TimestampOfOrderConfirmation;
+    confirmedAt?: string;
     contacts?: {
         type?: string;
         value?: string;
@@ -262,14 +130,17 @@ export interface Order {
          */
         appliedFees?: {
             amount: {
-                withoutTax: ThisFieldRepresentsTheAdditionalFeesExcludingTheTaxes;
-                withTax: ThisFieldRepresentsTheAdditionalFeesIncludingTheTaxes;
+                withoutTax: number;
+                withTax: number;
             };
             category: 'payment' | 'delivery' | 'percentage_payment' | 'return';
             key: string;
             option?: string;
             tax?: {
-                vat: ThisFieldHoldsDetailsAboutTheIncludedVATTax;
+                vat: {
+                    amount: number;
+                    rate: number;
+                };
             };
         }[];
         /**
@@ -277,7 +148,7 @@ export interface Order {
          */
         appliedReductions?: {
             amount: {
-                absoluteWithTax: ThisFieldRepresentsTheDiscountAmountIncludingTheTaxes;
+                absoluteWithTax: number;
                 /**
                  * The `rate` is calculated on the basis of the reduction in relation to the `preDiscountPrice` price.
                  */
@@ -308,13 +179,19 @@ export interface Order {
              * List of all taxes applied in calculating the `price.withTax`
              */
             vat?: {
-                amount: AbsoluteValueOfTheAppliedTax;
+                amount: number;
             };
         };
-        withoutTax: ItemPriceExcludingTaxes;
-        withTax: ItemPriceIncludingTaxes;
+        /**
+         * This price excludes taxes, but also includes all applicable reductions.
+         */
+        withoutTax: number;
+        /**
+         * The price is calculated including taxes and all applicable reductions such as discounts for sale and campaigns (should a campaign key be provdided on the request).
+         */
+        withTax: number;
     };
-    currencyCode: CharacterCurrencyCode;
+    currencyCode: string;
     customData?: {
         score?: {
             [k: string]: unknown;
@@ -368,27 +245,33 @@ export interface Order {
     };
     detailedStatus: {
         billing: {
-            code: UniqueIdentifierOfTheState;
-            name: NameOfTheState;
+            code: string;
+            name: string;
             [k: string]: unknown;
         };
         order: {
-            code: UniqueIdentifierOfTheState1;
-            name: NameOfTheState1;
+            code: string;
+            name: string;
             [k: string]: unknown;
         };
         shipping: {
-            code: UniqueIdentifierOfTheState2;
-            name: NameOfTheState2;
+            code: string;
+            name: string;
             [k: string]: unknown;
         };
         [k: string]: unknown;
     };
-    invoicedAt?: TimestampOfOrderInvoice;
+    invoicedAt?: string;
     items?: {
-        id?: UniqueNumericIdentifierOfTheItem;
-        availableQuantity?: AvailableQuantityInTheWarehouse;
-        currency?: CharacterCurrencyCode1;
+        id?: string;
+        /**
+         * The number of deliverable items available in the warehouse for immediate shipping.
+         */
+        availableQuantity?: number;
+        /**
+         * The three character [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code that identifies the currency. The currency is defined on the configuration of the shop, and can be modified in the cloud panel.
+         */
+        currency?: string;
         /**
          * customData allows the tenant to attach data to an item. The data will remain attached to the item from the basket through the process of order creation and delegation and may be displayed to the customer during the order lifecycle.
          */
@@ -396,7 +279,10 @@ export interface Order {
             [k: string]: unknown;
         };
         deliveryForecast?: DeliveryForecastFromWarehouse;
-        isManuallyReturnedByCci?: TheReturnShipmentHasBeenTriggeredByCCI;
+        /**
+         * Whether the return shipment got triggered manually. Is missing in case there is no return shipment.
+         */
+        isManuallyReturnedByCci?: boolean;
         itemGroup?: null | {
             /**
              * Item group ID
@@ -411,7 +297,7 @@ export interface Order {
              */
             isRequired: boolean;
         };
-        key: UniqueIdentifierOfTheItem;
+        key: string;
         lowestPriorPrice?: null | {
             /**
              * Difference to the current price
@@ -439,7 +325,7 @@ export interface Order {
              */
             appliedReductions?: {
                 amount: {
-                    absoluteWithTax: ThisFieldRepresentsTheDiscountAmountIncludingTheTaxes1;
+                    absoluteWithTax: number;
                     /**
                      * The `rate` is calculated on the basis of the reduction in relation to the `preDiscountPrice` price.
                      */
@@ -461,14 +347,20 @@ export interface Order {
              */
             tax: {
                 [k: string]: {
-                    amount: AbsoluteValueOfTheAppliedTax1;
-                    rate: RelativeValueOfTheAppliedTax;
+                    amount: number;
+                    rate: number;
                 };
             };
-            undiscountedWithOutTax?: UndiscountedItemPriceExcludingTaxes;
-            undiscountedWithTax?: UndiscountedItemPriceIncludingTaxes;
-            withoutTax: ItemPriceExcludingTaxes1;
-            withTax: ItemPriceIncludingTaxes1;
+            undiscountedWithOutTax?: number;
+            undiscountedWithTax?: number;
+            /**
+             * This price excludes taxes, but also includes all applicable reductions.
+             */
+            withoutTax: number;
+            /**
+             * The price is calculated including taxes and all applicable reductions such as discounts for sale and campaigns (should a campaign key be provided on the request).
+             */
+            withTax: number;
         };
         product: {
             [k: string]: unknown;
@@ -481,10 +373,13 @@ export interface Order {
         variant: {
             [k: string]: unknown;
         };
-        warehouseId?: PickingWarehouseId;
-        warehousePackageGroupId?: WarehousePackageReference;
-        createdAt: TimestampOfItemCreation;
-        updatedAt: TimestampOfLastItemUpdate;
+        /**
+         * The warehouse id where the item are being picking from.
+         */
+        warehouseId?: null | number;
+        warehousePackageGroupId?: null | number;
+        createdAt: string;
+        updatedAt: string;
     }[];
     loyaltyCard?: {
         cardNumber?: string;
@@ -507,11 +402,11 @@ export interface Order {
             amount?: number;
             type?: 'annualInterest' | 'firstInstallment' | 'subsequentInstallments';
         }[];
-        isGiftCard?: WhetherThePaymentMethodIsAGiftCard;
+        isGiftCard?: boolean;
         key?: string;
         options?: {
-            countOfInstallments?: NumberOfInstallmentsChosenByTheCustomerForTheOrder;
-            hasPaybreak?: IfTrueTheCustomerElectedToHaveADelayInPaymentCapture;
+            countOfInstallments?: number;
+            hasPaybreak?: boolean;
         };
         transactionKey?: string;
     }[];
@@ -551,6 +446,6 @@ export interface Order {
         type: 'absolute' | 'relative';
         value: number;
     }[];
-    createdAt: TimestampOfOrderCreation;
-    updatedAt: TimestampOfLastOrderUpdate;
+    createdAt: string;
+    updatedAt: string;
 }

package/dist/types/sapi/product.d.ts

@@ -9,46 +9,98 @@ export type { AdvancedAttribute, AdvancedAttributes, Attributes, Product, Varian
 export type { ProductSortConfig, ProductsSearchEndpointParameters, ProductsSearchEndpointResponseData, } from '@scayle/storefront-api';
 export type { ProductWith, VariantWith, ProductSearchQuery };
 export type VariantId = number;
+/**
+ * Represents a set of fields within an Attribute Group.
+ * This is a two-dimensional array used for structured attribute data,
+ * particularly in Complex Attribute Groups which handle combinations of
+ * different attributes (e.g., material composition).
+ * Each inner array represents a group of fields, and each object within
+ * represents a single field with key-value pairs (string, number, null, or undefined values).
+ *
+ * Example: In a "Material Composition" attribute group,
+ * a `FieldSet` might represent "cotton" with fields like
+ * `"material name"`: `"cotton"`, `"percentage"`: `70`.
+ *
+ * @see https://scayle.dev/en/user-guide/settings/product-structure/attribute-groups#advanced-attribute-groups
+ */
 export type FieldSet = Array<Array<{
     [key: string]: string | number | null | undefined;
 }>>;
+/**
+ * Represents a hierarchical group of attributes, used for structured data
+ * like material composition. Contains a `fieldSet` for the current group's fields
+ * and a `groupSet` for nested groups, enabling complex structures.
+ * Values are managed in the SCAYLE Panel.
+ * Attribute Groups containing dates or numbers should not be translatable.
+ *
+ * Example:
+ *  - Simple: `"material: 70% cotton, 30% polyester"`
+ *  - Complex: `"inner material: 100% polyester, upper material: 70% cotton, 30% polyester"`
+ *
+ * @see https://scayle.dev/en/user-guide/settings/product-structure/attribute-groups#advanced-attribute-groups
+ */
 export declare type GroupSet = Array<{
     fieldSet: FieldSet;
     groupSet: GroupSet;
 }>;
+/**
+ * Represents a product color.
+ */
 export interface ProductColor {
     id: number;
     label: string;
     value: string;
 }
+/**
+ * Parameters for fetching a single product.
+ */
 export interface FetchProductParams {
     id: number;
+    /** Additional data to include with the product. */
     with?: ProductWith;
     pricePromotionKey?: string;
     includeSellableForFree?: boolean;
 }
+/**
+ * Parameters for fetching multiple products.
+ */
 export interface FetchProductsParams {
     ids: number[];
+    /** Additional data to include with the products. */
     with?: ProductWith;
     pricePromotionKey?: string;
     includeSellableForFree?: boolean;
 }
+/**
+ * Parameters for fetching multiple products by their IDs.
+ */
 export interface FetchProductsByIdsParams {
     ids: number[];
+    /** Additional data to include with the products. */
     with?: ProductWith;
     pricePromotionKey?: string;
 }
+/**
+ * Parameters for fetching multiple products by their reference keys.
+ */
 export interface FetchProductsByReferenceKeysParams {
+    /** The reference keys of the products to fetch. */
     referenceKeys: string[];
+    /** Additional data to include with the products. */
     with?: ProductWith;
     pricePromotionKey?: string;
 }
+/**
+ * Parameters for fetching products by category.
+ */
 export type FetchProductsByCategoryParams = {
+    /** Additional data to include with the products. */
     with?: ProductWith;
     cache?: CacheOptions;
     includedFilters?: Array<string>;
     perPage?: number;
     page?: number;
+    /** Search query parameters. */
     where?: {
         term?: ProductSearchQuery['term'];
         minPrice?: ProductSearchQuery['minPrice'];
@@ -57,11 +109,18 @@ export type FetchProductsByCategoryParams = {
         disableFuzziness?: ProductSearchQuery['disableFuzziness'];
         whitelistAttributes?: ProductSearchQuery['attributes'];
     };
+    /** Sort parameters. */
     sort?: FilterParams['sort'];
     pricePromotionKey?: string;
     includeSellableForFree?: boolean;
     includeSoldOut?: boolean;
+    /** OR filters operator. */
     orFiltersOperator?: ProductsSearchEndpointParameters['orFiltersOperator'];
+    /**
+     * Whether to track search analytics event.
+     *
+     * @see https://scayle.dev/en/developer-guide/products/search#search-analytics-and-tracking
+     */
     trackSearchAnalyticsEvent?: boolean;
 } & ({
     category?: string;
@@ -70,11 +129,20 @@ export type FetchProductsByCategoryParams = {
     categoryId: number;
     category?: undefined;
 });
+/**
+ * Response from fetching products by category.
+ */
 export interface FetchProductsByCategoryResponse {
+    /** The fetched products. */
     products: Product[];
+    /** Pagination information. */
     pagination: ProductsByIdsEndpointResponseData['pagination'];
 }
+/**
+ * Parameters for fetching the count of products.
+ */
 export type FetchProductsCountParams = {
+    /** Search query parameters. */
     where?: {
         term?: ProductSearchQuery['term'];
         minPrice?: ProductSearchQuery['minPrice'];
@@ -86,6 +154,7 @@ export type FetchProductsCountParams = {
     includedFilters?: Array<string>;
     includeSoldOut?: boolean;
     includeSellableForFree?: boolean;
+    /** OR filters operator. */
     orFiltersOperator?: ProductsSearchEndpointParameters['orFiltersOperator'];
 } & ({
     category?: string;
@@ -94,11 +163,27 @@ export type FetchProductsCountParams = {
     categoryId: number;
     category?: undefined;
 });
+/**
+ * Response from fetching the count of products.
+ */
 export interface FetchProductsCountResponse {
     count: number;
 }
+/**
+ * Represents a simplified view of a product sibling, used for displaying related products.
+ * Includes only ID, a representative image, and available colors.
+ * This simplified representation is used within the `getProductSiblings` function.
+ */
 export interface ProductSibling {
     id: number;
+    /**
+     * The URL of the product's bust image, front view.
+     * May be null if no suitable image is found.
+     */
     image: ProductImage | null;
+    /**
+     * An array of color values for the sibling product.
+     * May be an empty array if the specified color attribute is not found on the product.
+     */
     colors: Value[];
 }