@djust-b2b/djust-front-sdk 1.15.0 → 1.16.0

package/lib/services/product/index.d.ts

@@ -1,1800 +1,409 @@
-import { CreateProductReviewParameters, CreateProductReviewResponse, GetProductOffersParameters, GetProductOffersResponse, GetProductParameters, GetProductReviewsParameters, GetProductReviewsResponse, GetProductStatReviewsParameters, GetProductStatReviewsResponse, GetProductVariantAttributesParameters, GetProductVariantAttributesResponse, GetProductVariantOffersParameters, GetProductVariantOffersResponse, GetProductVariantSuppliersParameters, GetProductVariantSuppliersResponse, GetProductVariantsListParameters, GetProductVariantsListResponse, GetProductsListParameters, GetProductsListResponse, GetRelatedProductsParameters, GetRelatedProductsResponse, AutoCompleteSearchProductsParameters, SearchProductsResponse, UpdateProductReviewParameters, UpdateProductReviewResponse, GetProductPaginatedOffersParameters, GetProductPaginatedOffersResponse } from "./definitions";
+import { CreateProductReviewParameters, CreateProductReviewResponse, GetProductOffersParameters, GetProductOffersResponse, GetProductParameters, GetProductReviewsParameters, GetProductReviewsResponse, GetProductStatReviewsParameters, GetProductStatReviewsResponse, GetProductVariantAttributesParameters, GetProductVariantAttributesResponse, GetProductVariantOffersParameters, GetProductVariantOffersResponse, GetProductVariantSuppliersParameters, GetProductVariantSuppliersResponse, GetProductVariantsListParameters, GetProductVariantsListResponse, GetProductsListParameters, GetProductsListResponse, GetRelatedProductsParameters, AutoCompleteSearchProductsParameters, SearchProductsResponse, UpdateProductReviewParameters, UpdateProductReviewResponse, GetProductPaginatedOffersParameters, GetProductPaginatedOffersResponse } from "./definitions";
 /**
- * ## Search product with text expression for search and autocomplete
- * ### APICODE(PRODUCT 553)
- * @param {AutoCompleteSearchProductsParameters} params - Parameters for search product with text expression for search and autocomplete
- * #### locale - `string` | <strong style={{ color: 'red'}}>(required)</strong>
- * #### currency - `string` | <strong style={{ color: 'red'}}>(required)</strong>
- * #### input - `string`
- * #### pageable - `object`
- * #### aggregation - `string` (PRODUCT, VARIANT)
- * #### productTags - `string[]` | <strong style={{ color: 'red'}}>(optional)</strong>
- *
- * @returns {Promise<SearchProductsResponse>} - The response with the products
- *
- * @example
- * ###input
+ * 📄 Search products with a text expression for search and autocomplete.
+ *
+ * This function provides product search and autocomplete capabilities.
+ *
+ * 🛠 **Endpoint**: `GET /v2/shop/autocomplete`
+ *
+ * | Parameter       | Type         | Required | Description                                 |
+ * |-----------------|--------------|----------|---------------------------------------------|
+ * | `input`         | `string`     | ✅       | The text expression to search for.         |
+ * | `locale`        | `string`     | ✅       | The locale for the search.                 |
+ * | `currency`      | `string`     | ✅       | The currency for price formatting.         |
+ * | `pageable.page` | `number`     | ❌       | The page number to fetch (0-based index).  |
+ * | `pageable.size` | `number`     | ❌       | The number of items per page.              |
+ * | `aggregation`   | `boolean`    | ❌       | Whether to include aggregation data.       |
+ * | `productTags`   | `string[]`   | ❌       | Filters by product tags.                   |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `SearchProductsResponse` containing the matched products.
+ *
+ * 🛠 **Example usage**:
  * ```typescript
- * const response = await autoCompleteSearchProducts({
- *   input: 'test',
- *   locale: 'fr',
- *   currency: 'EUR',
- *   pageable: {
- *     page: 1,
- *     size: 10,
- *   },
- *   aggregation: 'PRODUCT',
- *   productTags: ['tag1', 'tag2'],
+ * const products = await autoCompleteSearchProducts({
+ *   input: 'laptop',
+ *   locale: 'en-US',
+ *   currency: 'USD',
+ *   pageable: { page: 0, size: 10 },
  * });
+ * console.log(products);
  * ```
- *
- * Reponse - <strong style={{ color: 'green' }}>200</strong> - OK
- * ```json
- * {
- *   "products": [
- *     {
- *       "attributes": [
- *         {
- *           "externalId": "string",
- *           "externalSource": "MIRAKL",
- *           "id": string,
- *           "names": {
- *             additionalProp1: "string",
- *             additionalProp2: "string",
- *             additionalProp3: "string",
- *            }
- *         }
- *       ],
- *       "offer": {
- *         "currency": "EUR",
- *         customFields: [
- *           {
- *             "externalId": "string",
- *             "id": string,
- *             "name": "string",
- *             "values": [ "string" ]
- *           }
- *         ],
- *         "externalId": "string",
- *         "id": "string",
- *         "leadTimeToShip": "string",
- *         "maxOrderQuantity": 1,
- *         "minOrderQuantity": 1,
- *         "minShippingPrice": 0,
- *         "minStockAlert": 0,
- *         "packingType": "BOX",
- *         "productUnit": "string",
- *         "quantityPerItem": 0,
- *         "stock": 5
- *       },
- *       "offerPrice": {
- *         "discountPerItem": 0,
- *         "discountUnitPrice": 0,
- *         "itemPerPack": 0,
- *         "id": "string",
- *         "price": 0,
- *         "externalId": "string",
- *         "itemPrice": 0,
- *         "offerPriceType": "PUBLIC",
- *         "unitPrice": 0,
- *         "unitPriceTTC": 0,
- *       },
- *       "product": {
- *          "brand": "string"
- *          "description": "string",
- *          "externalId": string,
- *          "id": "string",
- *          "mainPictureUrl": "string"
- *          "name": "string",
- *          "sku": "string",
- *          "tags": [
- *            {
- *              "id": "string",
- *              "name": "string"
- *            }
- *          ],
- *          "unit": {
- *              "id": "string",
- *              "type": "ITEM",
- *              "unit": "string"
- *          }
- *       },
- *       "supplier": {
- *          "externalId": "string",
- *          "id": "string",
- *          "name": "string"
- *       },
- *       "variant": {
- *          "description": "string",
- *          "ean": "string",
- *          "externalId": "string",
- *          "id": "string",
- *          "mpn": "string",
- *          "name": "string",
- *          "pictureUrls": [
- *            {
- *              "formatType": "string",
- *              "heightInPx": 0,
- *              "sizeType": "string",
- *              "url": "string",
- *              "widthInPx": 0,
- *              "main": true
- *             }
- *          ],
- *          "sku": "string"
- *       },
- *     }
- *   ]
- * }
- * ```
- *
  */
 export declare function autoCompleteSearchProducts({ input, locale, currency, pageable, aggregation, productTags, }: AutoCompleteSearchProductsParameters): Promise<SearchProductsResponse>;
 /**
- * ## Get product list with filtering and pagination
- * ### APICODE(PRODUCT 552)
- * @param {GetProductsListParameters} params - Parameters for retrieving the product list, with filters, pagination, and locale.
- * #### locale - `string` | <strong style={{ color: 'red'}}>(required)</strong>
- * #### filters - `object` | <strong style={{ color: 'red'}}>(required)</strong>
- * #### pageable - `object`
+ * 📄 Fetches a list of products with thumbnails, reviews, attributes, and best offers.
+ *
+ * 🛠 **Endpoint**: `GET /v2/shop/search`
+ *
+ * | Parameter       | Type         | Required | Description                                 |
+ * |-----------------|--------------|----------|---------------------------------------------|
+ * | `locale`        | `string`     | ✅       | The locale for product data.               |
+ * | `filters`       | `object`     | ❌       | Filters for narrowing down search results. |
+ * | `pageable.page` | `number`     | ❌       | The page number to fetch (0-based index).  |
+ * | `pageable.size` | `number`     | ❌       | The number of items per page.              |
  *
- * @returns {Promise<GetProductsListResponse>} - The response with the products
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetProductsListResponse` containing the products and their metadata.
  *
- * @example
- * ### Input
+ * 🛠 **Example usage**:
  * ```typescript
- * const response = await getProductsList({
- *   locale: 'fr',
- *   filters: {
- *     currency: 'EUR',
- *     categoryIds: ['category1', 'category2'],
- *     skus: ['sku1', 'sku2'],
- *     brand: ['brand1', 'brand2'],
- *     query: 'query',
- *     productTags: ['tag1', 'tag2'],
- *     aggregation: 'PRODUCT',
- *     attributes: ['attribute1', 'attribute2'],
- *     suppliers: ['supplier1', 'supplier2'],
- *     customFields: ['customField1', 'customField2'],
- *     offerUpdatedTime: '2024-12-11T10:28:21.123Z',
- *     productUpdatedTime: '2024-12-11T10:28:21.123Z'
- *   },
- *   pageable: {
- *     page: 1,
- *     size: 10,
- *     sort: ['price,asc']
- *   }
+ * const products = await getProductsList({
+ *   locale: 'en-US',
+ *   filters: { category: 'electronics' },
+ *   pageable: { page: 1, size: 20 },
  * });
- * ```
- *
- * ### Response - <strong style={{ color: 'green' }}>200</strong> - OK
- * ```json
- * {
- *   "facets": {
- *     "attributes": [
- *       {
- *         "id": "string",
- *         "name": "string",
- *         "values": ["string"]
- *       }
- *     ],
- *     "brands": [
- *       {
- *         "id": "string",
- *         "name": "string"
- *       }
- *     ],
- *     "customFields": [
- *       {
- *         "id": "string",
- *         "name": "string",
- *         "values": ["string"]
- *       }
- *     ],
- *     "productTags": [
- *       {
- *         "id": "string",
- *         "name": "string"
- *       }
- *     ],
- *     "suppliers": [
- *       {
- *         "externalId": "string",
- *         "id": "string",
- *         "name": "string"
- *       }
- *     ]
- *   },
- *   "products": {
- *     "content": [
- *       {
- *         "attributes": [
- *           {
- *             "externalId": "string",
- *             "externalSource": "MIRAKL",
- *             "id": "string",
- *             "names": {
- *               "additionalProp1": "string",
- *               "additionalProp2": "string",
- *               "additionalProp3": "string"
- *             }
- *           }
- *         ],
- *         "offer": {
- *           "currency": "USD",
- *           "customFields": [
- *             {
- *               "externalId": "string",
- *               "id": "string",
- *               "name": "string",
- *               "values": ["string"]
- *             }
- *           ],
- *           "externalId": "string",
- *           "id": "string",
- *           "leadTimeToShip": "string",
- *           "maxOrderQuantity": 0,
- *           "minOrderQuantity": 0,
- *           "minShippingPrice": 0,
- *           "minStockAlert": 0,
- *           "packingType": "BOX",
- *           "productUnit": "string",
- *           "quantityPerItem": 0,
- *           "stock": 0
- *         },
- *         "offerPrice": {
- *           "discountItemPrice": 0,
- *           "discountUnitPrice": 0,
- *           "externalId": "string",
- *           "id": "string",
- *           "itemPerPack": 0,
- *           "itemPrice": 0,
- *           "offerPriceType": "PUBLIC",
- *           "price": 0,
- *           "unitPrice": 0,
- *           "unitPriceTTC": 0
- *         },
- *         "product": {
- *           "brand": "string",
- *           "description": "string",
- *           "externalId": "string",
- *           "id": "string",
- *           "mainPictureUrl": "string",
- *           "name": "string",
- *           "sku": "string",
- *           "tags": [
- *             {
- *               "id": "string",
- *               "name": "string"
- *             }
- *           ],
- *           "unit": {
- *             "id": "string",
- *             "type": "ITEM",
- *             "unit": "string"
- *           }
- *         },
- *         "supplier": {
- *           "externalId": "string",
- *           "id": "string",
- *           "name": "string"
- *         },
- *         "variant": {
- *           "description": "string",
- *           "ean": "string",
- *           "externalId": "string",
- *           "id": "string",
- *           "mpn": "string",
- *           "name": "string",
- *           "pictureUrls": [
- *             {
- *               "formatType": "string",
- *               "heightInPx": 0,
- *               "main": true,
- *               "sizeType": "string",
- *               "url": "string",
- *               "widthInPx": 0
- *             }
- *           ],
- *           "sku": "string"
- *         }
- *       }
- *     ],
- *     "empty": true,
- *     "first": true,
- *     "last": true,
- *     "number": 0,
- *     "numberOfElements": 0,
- *     "pageable": {
- *       "offset": 0,
- *       "pageNumber": 0,
- *       "pageSize": 0,
- *       "paged": true,
- *       "sort": [
- *         {
- *           "ascending": true,
- *           "descending": true,
- *           "direction": "ASC",
- *           "ignoreCase": true,
- *           "nullHandling": "NATIVE",
- *           "property": "string"
- *         }
- *       ],
- *       "unpaged": true
- *     },
- *     "size": 0,
- *     "sort": [
- *       {
- *         "ascending": true,
- *         "descending": true,
- *         "direction": "ASC",
- *         "ignoreCase": true,
- *         "nullHandling": "NATIVE",
- *         "property": "string"
- *       }
- *     ],
- *     "totalElements": 0,
- *     "totalPages": 0
- *   }
- * }
+ * console.log(products);
  * ```
  */
 export declare function getProductsList({ locale, filters, pageable, }: GetProductsListParameters): Promise<GetProductsListResponse>;
 /**
- * ## Get paginated list of a product's variants
- * ### APICODE(PRODUCT 506)
- * @param {GetProductVariantsListParameters} params - Parameters for retrieving a product's variants, with pagination and locale.
- * #### productSku - `string` | <strong style={{ color: 'red'}}>(required)</strong>
- * #### locale - `string`
- * #### pageable - `object`
+ * 📄 Fetches product variants by product SKU.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/product-variants`
+ *
+ * | Parameter       | Type         | Required | Description                                |
+ * |-----------------|--------------|----------|--------------------------------------------|
+ * | `productSku`    | `string`     | ✅       | The SKU of the product.                   |
+ * | `locale`        | `string`     | ❌       | The locale for product variants.          |
+ * | `pageable.page` | `number`     | ❌       | The page number to fetch (0-based index). |
+ * | `pageable.size` | `number`     | ❌       | The number of items per page.             |
  *
- * @returns {Promise<GetProductVariantsListResponse>} - The response with the product variants
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetProductVariantsListResponse` containing the product variants.
  *
- * @example
- * ### Input
+ * 🛠 **Example usage**:
  * ```typescript
- * const response = await getProductVariantsList({
- *   productSku: 'product-sku-123',
- *   locale: 'fr',
- *   pageable: {
- *     page: 1,
- *     size: 10,
- *     sort: ['name,asc']
- *   }
+ * const variants = await getProductVariantsList({
+ *   productSku: 'sku123',
+ *   locale: 'en-US',
+ *   pageable: { page: 0, size: 10 },
  * });
- * ```
- *
- * ### Response - <strong style={{ color: 'green' }}>200</strong> - OK
- * ```json
- * {
- *   "content": [
- *     {
- *       "attributeValues": [
- *         {
- *           "attribute": {
- *             "externalId": "string",
- *             "id": "string",
- *             "name": {
- *               "additionalProp1": "string",
- *               "additionalProp2": "string",
- *               "additionalProp3": "string"
- *             },
- *             "type": "LONG_TEXT"
- *           },
- *           "value": {}
- *         }
- *       ],
- *       "description": "string",
- *       "ean": "string",
- *       "externalId": "string",
- *       "id": "string",
- *       "info": {
- *         "description": "string",
- *         "ean": "string",
- *         "mpn": "string",
- *         "name": "string",
- *         "sku": "string"
- *       },
- *       "mpn": "string",
- *       "name": "string",
- *       "productMediaInfoDTO": {
- *         "isMain": true,
- *         "urls": [
- *           {
- *             "formatType": "string",
- *             "heightInPx": 0,
- *             "sizeType": "string",
- *             "url": "string",
- *             "widthInPx": 0
- *           }
- *         ]
- *       },
- *       "productPictures": [
- *         {
- *           "isMain": true,
- *           "urls": [
- *             {
- *               "formatType": "string",
- *               "heightInPx": 0,
- *               "sizeType": "string",
- *               "url": "string",
- *               "widthInPx": 0
- *             }
- *           ]
- *         }
- *       ],
- *       "skuProduct": "string",
- *       "skuVariant": "string",
- *       "status": "NEW"
- *     }
- *   ],
- *   "empty": true,
- *   "first": true,
- *   "last": true,
- *   "number": 0,
- *   "numberOfElements": 0,
- *   "pageable": {
- *     "offset": 0,
- *     "pageNumber": 0,
- *     "pageSize": 0,
- *     "paged": true,
- *     "sort": [
- *       {
- *         "ascending": true,
- *         "descending": true,
- *         "direction": "ASC",
- *         "ignoreCase": true,
- *         "nullHandling": "NATIVE",
- *         "property": "string"
- *       }
- *     ],
- *     "unpaged": true
- *   },
- *   "size": 0,
- *   "sort": [
- *     {
- *       "ascending": true,
- *       "descending": true,
- *       "direction": "ASC",
- *       "ignoreCase": true,
- *       "nullHandling": "NATIVE",
- *       "property": "string"
- *     }
- *   ],
- *   "totalElements": 0,
- *   "totalPages": 0
- * }
+ * console.log(variants);
  * ```
  */
 export declare function getProductVariantsList({ productSku, locale, pageable, }: GetProductVariantsListParameters): Promise<GetProductVariantsListResponse>;
 /**
- * ## Get List of Offers for a Product Variant
- * ### APICODE(PRODUCT 508)
- * @param {GetProductVariantOffersParameters} params - Parameters for retrieving offers of a product variant.
- * #### productIdentifier - `string` | <strong style={{ color: 'red'}}>(required)</strong>
- * #### productIdType - `string` | <strong style={{ color: 'red'}}>(required)</strong> (e.g., "sku", "id", or "externalId")
- * #### currency - `string`
+ * 📄 Fetches offers for a specific product variant.
  *
- * @returns {Promise<GetProductVariantOffersResponse>} - The response with the product variant offers
+ * Retrieves the list of offers available for a product variant identified by SKU, ID, or external ID.
  *
- * @example
- * ### Input
- * ```typescript
- * const response = await getProductVariantOffers({
- *   productIdentifier: 'sku-12345',
+ * 🛠 **Endpoint**: `GET /v1/shop/product-variants/{productIdentifier}/offers`
+ *
+ * | Parameter             | Type        | Required   | Description                                                   |
+ * |-----------------------|-------------|------------|---------------------------------------------------------------|
+ * | `productIdentifier`   | `string`    | ✅         | Unique identifier for the product variant (e.g., SKU, ID).    |
+ * | `productIdType`       | `string`    | ✅         | The type of identifier: `"sku"`, `"id"`, or `"externalId"`.   |
+ * | `currency`            | `string`    | ✅         | Currency in which offers should be returned (e.g., `"USD"`).  |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetProductVariantOffersResponse>` containing a list of offers for the product variant.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const offers = await getProductVariantOffers({
+ *   productIdentifier: 'sku123',
  *   productIdType: 'sku',
- *   currency: 'EUR'
+ *   currency: 'USD',
  * });
+ *
+ * console.log(offers);
  * ```
  *
- * ### Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * **Example Response**:
  * ```json
- * [
- *   {
- *     "estimatedDeliveryDates": [
- *       {
- *         "code": "string",
- *         "deliveryTimeRange": {
- *           "earliestDeliveryDate": "2025-01-06T14:37:05.142Z",
- *           "latestDeliveryDate": "2025-01-06T14:37:05.142Z"
- *         },
- *         "label": "string",
- *         "shippingPriceUnit": 0,
- *         "shippingZone": {
- *           "code": "string",
- *           "label": "string"
- *         }
- *       }
- *     ],
- *     "offerInventory": {
- *       "brand": "string",
+ * {
+ *   "offers": [
+ *     {
+ *       "id": "offer1",
+ *       "price": 19.99,
  *       "currency": "USD",
- *       "customFieldValues": [
- *         {
- *           "customField": {
- *             "externalId": "string",
- *             "id": "string",
- *             "name": {
- *               "additionalProp1": "string",
- *               "additionalProp2": "string",
- *               "additionalProp3": "string"
- *             },
- *             "type": "LONG_TEXT"
- *           },
- *           "value": {}
- *         }
- *       ],
- *       "externalSource": "MIRAKL",
- *       "id": "string",
- *       "leadTimeToShip": 0,
- *       "maxOrderQuantity": 0,
- *       "minOrderQuantity": 0,
- *       "minShippingPrice": 0,
- *       "minShippingPriceAdditional": 0,
- *       "minShippingType": "string",
- *       "minShippingZone": "string",
- *       "minStockAlert": 0,
- *       "packingType": "BOX",
- *       "productUnit": "string",
- *       "quantityPerItem": 0,
- *       "status": "ACTIVE",
- *       "stock": 0,
- *       "variant": {
- *         "attributeValues": [
- *           {
- *             "attribute": {
- *               "externalId": "string",
- *               "id": "string",
- *               "name": {
- *                 "additionalProp1": "string",
- *                 "additionalProp2": "string",
- *                 "additionalProp3": "string"
- *               },
- *               "type": "LONG_TEXT"
- *             },
- *             "value": {}
- *           }
- *         ],
- *         "description": "string",
- *         "ean": "string",
- *         "externalId": "string",
- *         "id": "string",
- *         "info": {
- *           "description": "string",
- *           "ean": "string",
- *           "mpn": "string",
- *           "name": "string",
- *           "sku": "string"
- *         },
- *         "mpn": "string",
- *         "name": "string",
- *         "productMediaInfoDTO": {
- *           "isMain": true,
- *           "urls": [
- *             {
- *               "formatType": "string",
- *               "heightInPx": 0,
- *               "sizeType": "string",
- *               "url": "string",
- *               "widthInPx": 0
- *             }
- *           ]
- *         },
- *         "productPictures": [
- *           {
- *             "isMain": true,
- *             "urls": [
- *               {
- *                 "formatType": "string",
- *                 "heightInPx": 0,
- *                 "sizeType": "string",
- *                 "url": "string",
- *                 "widthInPx": 0
- *               }
- *             ]
- *           }
- *         ],
- *         "skuProduct": "string",
- *         "skuVariant": "string",
- *         "status": "NEW"
- *       }
+ *       "availability": "In Stock",
+ *       "seller": "Seller A"
  *     },
- *     "offerPrices": [
- *       {
- *         "customerAccountId": "string",
- *         "customerTagId": "string",
- *         "externalId": "string",
- *         "id": "string",
- *         "itemPerPack": 0,
- *         "offerPriceType": "PUBLIC",
- *         "priceRanges": [
- *           {
- *             "discountPrice": {
- *               "itemPrice": 0,
- *               "itemPriceTTC": 0,
- *               "unitPrice": 0,
- *               "unitPriceTTC": 0
- *             },
- *             "price": {
- *               "itemPrice": 0,
- *               "itemPriceTTC": 0,
- *               "unitPrice": 0,
- *               "unitPriceTTC": 0
- *             },
- *             "quantity": 0
- *           }
- *         ]
- *       }
- *     ],
- *     "supplier": {
- *       "customFieldValues": [
- *         {
- *           "customField": {
- *             "externalId": "string",
- *             "externalSource": "MIRAKL",
- *             "faceted": true,
- *             "id": "string",
- *             "indexable": true,
- *             "mandatory": true,
- *             "name": {
- *               "additionalProp1": "string",
- *               "additionalProp2": "string",
- *               "additionalProp3": "string"
- *             },
- *             "role": "PRODUCT_TAX_RATE",
- *             "sealedTarget": "string",
- *             "searchable": true,
- *             "sortable": true,
- *             "status": "ACTIVE"
- *           },
- *           "value": {}
- *         }
- *       ],
- *       "externalId": "string",
- *       "id": "string",
- *       "name": "string",
- *       "returnPolicy": "string",
- *       "supplierRating": "string"
+ *     {
+ *       "id": "offer2",
+ *       "price": 17.99,
+ *       "currency": "USD",
+ *       "availability": "Limited Stock",
+ *       "seller": "Seller B"
  *     }
- *   }
- * ]
+ *   ]
+ * }
  * ```
  */
 export declare function getProductVariantOffers({ productIdentifier, productIdType, currency, }: GetProductVariantOffersParameters): Promise<GetProductVariantOffersResponse>;
 /**
- * ## Get Suppliers of a Product Variant
- * ### APICODE(PRODUCT 507)
- * @param {GetProductVariantSuppliersParameters} params - Parameters for retrieving the suppliers of a product variant.
- * #### productVariantId - `string` | <strong style={{ color: 'red'}}>(required)</strong>
+ * 📄 Fetches suppliers associated with a product variant.
  *
- * @returns {Promise<GetProductVariantSuppliersResponse>} - The response with the product variant suppliers
+ * Retrieves a list of suppliers for a given product variant.
  *
- * @example
- * ### Input
- * ```typescript
- * const response = await getProductVariantSuppliers({
- *   productVariantId: 'variant-12345'
+ * 🛠 **Endpoint**: `GET /v1/shop/product-variants/{productVariantId}/suppliers`
+ *
+ * | Parameter             | Type                          | Required   | Description                                                   |
+ * |-----------------------|-------------------------------|------------|---------------------------------------------------------------|
+ * | `productVariantId`    | `string`                     | ✅         | ID of the product variant.                                    |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetProductVariantSuppliersResponse>` containing the list of suppliers.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const suppliers = await getProductVariantSuppliers({
+ *   productVariantId: 'variant123',
  * });
- * ```
  *
- * ### Response - <strong style={{ color: 'green' }}>200</strong> - OK
- * ```json
- * [
- *   {
- *     "additionalImageLink": [
- *       "string"
- *     ],
- *     "banner": "string",
- *     "createdAt": "2025-01-06T14:43:34.185Z",
- *     "customFieldValues": [
- *       {
- *         "customField": {
- *           "externalId": "string",
- *           "externalSource": "MIRAKL",
- *           "faceted": true,
- *           "id": "string",
- *           "indexable": true,
- *           "mandatory": true,
- *           "name": {
- *             "additionalProp1": "string",
- *             "additionalProp2": "string",
- *             "additionalProp3": "string"
- *           },
- *           "role": "PRODUCT_TAX_RATE",
- *           "sealedTarget": "string",
- *           "searchable": true,
- *           "sortable": true,
- *           "status": "ACTIVE"
- *         },
- *         "value": {}
- *       }
- *     ],
- *     "description": "string",
- *     "evaluationCount": 0,
- *     "externalId": "string",
- *     "externalSource": "MIRAKL",
- *     "id": "string",
- *     "isDefault": true,
- *     "logo": "string",
- *     "name": "string",
- *     "paymentDueDate": {
- *       "paymentDueDateDelay": 0,
- *       "paymentDueDateMode": "SIMPLE"
- *     },
- *     "returnPolicy": "string",
- *     "supplierRating": "string",
- *     "supplierStatus": "ACTIVE",
- *     "totalOffers": 0,
- *     "totalOrders": 0,
- *     "updatedAt": "2025-01-06T14:43:34.185Z"
- *   }
- * ]
+ * console.log(suppliers);
  * ```
  */
 export declare function getProductVariantSuppliers({ productVariantId, }: GetProductVariantSuppliersParameters): Promise<GetProductVariantSuppliersResponse>;
 /**
- * ## Get a Product by SKU, ID, or External ID
- * ### APICODE(PRODUCT 500)
- * @param {GetProductParameters} params - Parameters for retrieving a product.
- * #### productIdentifier - `string` | <strong style={{ color: 'red'}}>(required)</strong>
- * #### productIdType - `"sku" | "id" | "externalId"` | <strong style={{ color: 'red'}}>(required)</strong>
- * #### locale - `string`
+ * 📄 Fetches details for a specific product.
  *
- * @returns {Promise<Product>}
+ * Retrieves information about a product identified by SKU, ID, or external ID.
  *
- * @example
- * ### Input
- * ```typescript
- * const response = await getProduct({
- *   productIdentifier: "product-12345",
- *   productIdType: "sku",
- *   locale: "en-US"
+ * 🛠 **Endpoint**: `GET /v1/shop/products/{productIdentifier}`
+ *
+ * | Parameter             | Type        | Required   | Description                                                   |
+ * |-----------------------|-------------|------------|---------------------------------------------------------------|
+ * | `productIdentifier`   | `string`    | ✅         | Unique identifier for the product (e.g., SKU, ID).            |
+ * | `productIdType`       | `string`    | ✅         | The type of identifier: `"sku"`, `"id"`, or `"externalId"`.   |
+ * | `locale`              | `string`    | ✅         | Locale for the product details (e.g., `"en_US"`).             |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetProductsListResponse>` containing the product details.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const product = await getProduct({
+ *   productIdentifier: 'sku123',
+ *   productIdType: 'sku',
+ *   locale: 'en_US',
  * });
- * ```
  *
- * ### Response - <strong style={{ color: 'green' }}>200</strong> - OK
- * ```json
- * {
- *   "attributeValues": [
- *     {
- *       "attribute": {
- *         "externalId": "string",
- *         "id": "string",
- *         "name": {
- *           "additionalProp1": "string",
- *           "additionalProp2": "string",
- *           "additionalProp3": "string"
- *         },
- *         "type": "LONG_TEXT"
- *       },
- *       "value": {}
- *     }
- *   ],
- *   "classificationCategory": {
- *     "externalId": "string",
- *     "externalSource": "MIRAKL",
- *     "id": "string",
- *     "name": "string"
- *   },
- *   "externalId": "string",
- *   "externalSource": "MIRAKL",
- *   "id": "string",
- *   "info": {
- *     "brand": "string",
- *     "description": "string",
- *     "name": "string",
- *     "sku": "string",
- *     "unit": {
- *       "id": "string",
- *       "type": "ITEM",
- *       "unit": "string"
- *     }
- *   },
- *   "productPictures": [
- *     {
- *       "isMain": true,
- *       "urls": [
- *         {
- *           "formatType": "string",
- *           "heightInPx": 0,
- *           "sizeType": "string",
- *           "url": "string",
- *           "widthInPx": 0
- *         }
- *       ]
- *     }
- *   ],
- *   "productStatus": "NEW",
- *   "productUnit": {
- *     "id": "string",
- *     "type": "ITEM",
- *     "unit": "string"
- *   },
- *   "sku": "string",
- *   "tags": [
- *     {
- *       "id": "string",
- *       "name": "string"
- *     }
- *   ]
- * }
+ * console.log(product);
  * ```
  */
 export declare function getProduct({ productIdentifier, productIdType, locale, }: GetProductParameters): Promise<GetProductsListResponse>;
 /**
- * ## Get Offers of a Product by SKU, ID, or External ID
- * @deprecated This method is deprecated and replaced by APICODE(PRODUCT 509). Please update your implementation to use the new API.
- *
- * ### Deprecated Function
- * Fetches the list of offers for a given product based on its identifier.
- * ### APICODE(PRODUCT 502)
-
- * @param {GetProductOffersParameters} params - Parameters for retrieving product offers.
- * #### productIdentifier - `string` | <strong style={{ color: 'red'}}>required</strong>
- * #### productIdType - `"sku" | "id" | "externalId"` | <strong style={{ color: 'red'}}>required</strong>
- * #### locale - `string`
- * #### currency - `string`
- *
- * @returns {Promise<GetProductOffersResponse>} A promise that resolves to the response from the API.
- *
- * @example
- * ### Input
- * ```typescript
- * const response = await getProductOffers({
- *   productIdentifier: "product-12345",
- *   productIdType: "sku",
- *   locale: "en-US",
- *   currency: "USD"
- * });
- * ```
+ * 📄 Fetches product offers by SKU, ID, or external ID.
  *
- * ### Response - <strong style={{ color: 'green' }}>200</strong> - OK
- * ```json
- * [
- *   {
- *     "estimatedDeliveryDates": [
- *       {
- *         "code": "string",
- *         "deliveryTimeRange": {
- *           "earliestDeliveryDate": "2025-01-06T15:57:23.302Z",
- *           "latestDeliveryDate": "2025-01-06T15:57:23.302Z"
- *         },
- *         "label": "string",
- *         "shippingPriceUnit": 0,
- *         "shippingZone": {
- *           "code": "string",
- *           "label": "string"
- *         }
- *       }
- *     ],
- *     "offerInventory": {
- *       "brand": "string",
- *       "currency": "USD",
- *       "customFieldValues": [
- *         {
- *           "customField": {
- *             "externalId": "string",
- *             "id": "string",
- *             "name": {
- *               "additionalProp1": "string",
- *               "additionalProp2": "string",
- *               "additionalProp3": "string"
- *             },
- *             "type": "LONG_TEXT"
- *           },
- *           "value": {}
- *         }
- *       ],
- *       "externalSource": "MIRAKL",
- *       "id": "string",
- *       "leadTimeToShip": 0,
- *       "maxOrderQuantity": 0,
- *       "minOrderQuantity": 0,
- *       "minShippingPrice": 0,
- *       "minShippingPriceAdditional": 0,
- *       "minShippingType": "string",
- *       "minShippingZone": "string",
- *       "minStockAlert": 0,
- *       "packingType": "BOX",
- *       "productUnit": "string",
- *       "quantityPerItem": 0,
- *       "status": "ACTIVE",
- *       "stock": 0,
- *       "variant": {
- *         "attributeValues": [
- *           {
- *             "attribute": {
- *               "externalId": "string",
- *               "id": "string",
- *               "name": {
- *                 "additionalProp1": "string",
- *                 "additionalProp2": "string",
- *                 "additionalProp3": "string"
- *               },
- *               "type": "LONG_TEXT"
- *             },
- *             "value": {}
- *           }
- *         ],
- *         "description": "string",
- *         "ean": "string",
- *         "externalId": "string",
- *         "id": "string",
- *         "info": {
- *           "description": "string",
- *           "ean": "string",
- *           "mpn": "string",
- *           "name": "string",
- *           "sku": "string"
- *         },
- *         "mpn": "string",
- *         "name": "string",
- *         "productMediaInfoDTO": {
- *           "isMain": true,
- *           "urls": [
- *             {
- *               "formatType": "string",
- *               "heightInPx": 0,
- *               "sizeType": "string",
- *               "url": "string",
- *               "widthInPx": 0
- *             }
- *           ]
- *         },
- *         "productPictures": [
- *           {
- *             "isMain": true,
- *             "urls": [
- *               {
- *                 "formatType": "string",
- *                 "heightInPx": 0,
- *                 "sizeType": "string",
- *                 "url": "string",
- *                 "widthInPx": 0
- *               }
- *             ]
- *           }
- *         ],
- *         "skuProduct": "string",
- *         "skuVariant": "string",
- *         "status": "NEW"
- *       }
- *     },
- *     "offerPrices": [
- *       {
- *         "customerAccountId": "string",
- *         "customerTagId": "string",
- *         "externalId": "string",
- *         "id": "string",
- *         "itemPerPack": 0,
- *         "offerPriceType": "PUBLIC",
- *         "priceRanges": [
- *           {
- *             "discountPrice": {
- *               "itemPrice": 0,
- *               "itemPriceTTC": 0,
- *               "unitPrice": 0,
- *               "unitPriceTTC": 0
- *             },
- *             "price": {
- *               "itemPrice": 0,
- *               "itemPriceTTC": 0,
- *               "unitPrice": 0,
- *               "unitPriceTTC": 0
- *             },
- *             "quantity": 0
- *           }
- *         ]
- *       }
- *     ],
- *     "supplier": {
- *       "customFieldValues": [
- *         {
- *           "customField": {
- *             "externalId": "string",
- *             "externalSource": "MIRAKL",
- *             "faceted": true,
- *             "id": "string",
- *             "indexable": true,
- *             "mandatory": true,
- *             "name": {
- *               "additionalProp1": "string",
- *               "additionalProp2": "string",
- *               "additionalProp3": "string"
- *             },
- *             "role": "PRODUCT_TAX_RATE",
- *             "sealedTarget": "string",
- *             "searchable": true,
- *             "sortable": true,
- *             "status": "ACTIVE"
- *           },
- *           "value": {}
- *         }
- *       ],
- *       "externalId": "string",
- *       "id": "string",
- *       "name": "string",
- *       "returnPolicy": "string",
- *       "supplierRating": "string"
- *     }
- *   }
- * ]
- */
-export declare function getProductOffers({ productIdentifier, productIdType, locale, currency, }: GetProductOffersParameters): Promise<GetProductOffersResponse>;
-/**
- * ## Get Paginated Offers of a Product by SKU, ID, or External ID
- * ### APICODE(PRODUCT 509 - REPLACES PRODUCT 502)
- * @param {GetProductPaginatedOffersParameters} params - Parameters for retrieving paginated offers.
- * #### productIdentifier - `string` | <strong style={{ color: 'red' }}>(required)</strong>
- * #### productIdType - `string` | <strong style={{ color: 'red' }}>(required)</strong> (e.g., "sku", "id", or "externalId")
- * #### currency - `string`
- * #### locale - `string`
- * #### withoutPrices - `boolean`
- * #### pageable - `object`
- *
- * @returns {Promise<GetProductPaginatedOffersResponse>} - The response with paginated offers.
- *
- * @example
- * ### Input
+ * 🛠 **Endpoint**: `GET /v1/shop/products/{productIdentifier}/offers`
+ *
+ * | Parameter           | Type         | Required | Description                                     |
+ * |---------------------|--------------|----------|-------------------------------------------------|
+ * | `productIdentifier` | `string`     | ✅       | The unique identifier of the product.          |
+ * | `productIdType`     | `string`     | ✅       | The type of the identifier (`sku`, `id`, etc.).|
+ * | `currency`          | `string`     | ✅       | The currency for the offer details.            |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetProductVariantOffersResponse` containing the offers.
+ *
+ * 🛠 **Example usage**:
  * ```typescript
- * const response = await getProductPaginatedOffers({
- *   productIdentifier: 'sku-67890',
+ * const offers = await getProductVariantOffers({
+ *   productIdentifier: 'sku123',
  *   productIdType: 'sku',
  *   currency: 'USD',
- *   locale: 'en-US',
- *   withoutPrices: false,
- *   pageable: {
- *     page: 0,
- *     size: 10,
- *     sort: 'price,asc'
- *   }
  * });
- * ```
- *
- * ### Response - <strong style={{ color: 'green' }}>200</strong> - OK
- * ```json
- * {
- *   "content": [
- *     {
- *       "estimatedDeliveryDates": [
- *         {
- *           "code": "string",
- *           "deliveryTimeRange": {
- *             "earliestDeliveryDate": "2025-01-06T16:33:58.524Z",
- *             "latestDeliveryDate": "2025-01-06T16:33:58.525Z"
- *           },
- *           "label": "string",
- *           "shippingPriceUnit": 0,
- *           "shippingZone": {
- *             "code": "string",
- *             "label": "string"
- *           }
- *         }
- *       ],
- *       "offerInventory": {
- *         "brand": "string",
- *         "currency": "USD",
- *         "stock": 0,
- *         "variant": {
- *           "description": "string",
- *           "sku": "string",
- *           "name": "string"
- *         }
- *       },
- *       "offerPrices": [
- *         {
- *           "priceRanges": [
- *             {
- *               "price": {
- *                 "unitPrice": 100,
- *                 "itemPrice": 100
- *               },
- *               "quantity": 1
- *             }
- *           ]
- *         }
- *       ],
- *       "supplier": {
- *         "id": "string",
- *         "name": "string",
- *         "supplierRating": "5/5"
- *       }
- *     }
- *   ],
- *   "empty": false,
- *   "first": true,
- *   "last": false,
- *   "number": 0,
- *   "size": 10,
- *   "totalElements": 100,
- *   "totalPages": 10
- * }
+ * console.log(offers);
  * ```
  */
-export declare function getProductPaginatedOffers({ productIdentifier, productIdType, currency, locale, withoutPrices, pageable, }: GetProductPaginatedOffersParameters): Promise<GetProductPaginatedOffersResponse>;
+export declare function getProductOffers({ productIdentifier, productIdType, locale, currency, }: GetProductOffersParameters): Promise<GetProductOffersResponse>;
 /**
- * ## Get Related Products by SKU, ID, or External ID
- * ### APICODE(PRODUCT 503)
- * @param {GetRelatedProductsParameters} params - Parameters for retrieving related products.
- * #### productIdentifier - `string` | <strong style={{ color: 'red' }}>(required)</strong>
- * #### productIdType - `string` | <strong style={{ color: 'red' }}>(required)</strong> (e.g., "sku", "id", or "externalId")
- * #### locale - `string`
- * #### currency - `string
- * #### pageable - `object`
- *
- * @returns {Promise<GetRelatedProductsResponse>} - The response with related products.
- *
- * @example
- * ### Input
- * ```typescript
- * const response = await getRelatedProducts({
- *   productIdentifier: 'sku-12345',
+ * 📄 Fetches related products for a specific product.
+ *
+ * Retrieves a paginated list of related products identified by SKU, ID, or external ID.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/products/{productIdentifier}/related-products`
+ *
+ * | Parameter             | Type        | Required   | Description                                                   |
+ * |-----------------------|-------------|------------|---------------------------------------------------------------|
+ * | `productIdentifier`   | `string`    | ✅         | Unique identifier for the product (e.g., SKU, ID).            |
+ * | `productIdType`       | `string`    | ✅         | The type of identifier: `"sku"`, `"id"`, or `"externalId"`.   |
+ * | `locale`              | `string`    | ✅         | Locale for the related products (e.g., `"en_US"`).            |
+ * | `currency`            | `string`    | ✅         | Currency for the related products (e.g., `"USD"`).            |
+ * | `pageable`            | `object`    | ❌         | Pagination details: `page`, `size`, `sort`.                   |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetRelatedProductsParameters>` containing related products.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const relatedProducts = await getRelatedProducts({
+ *   productIdentifier: 'sku123',
  *   productIdType: 'sku',
- *   locale: 'fr-FR',
+ *   locale: 'en_US',
  *   currency: 'USD',
- *   pageable: {
- *     page: 0,
- *     size: 10,
- *     sort: 'name,asc'
- *   }
+ *   pageable: { page: 1, size: 10 },
  * });
- * ```
  *
- * ### Response - <strong style={{ color: 'green' }}>200</strong> - OK
- * ```json
- * {
- *   "aggregations": [
- *     {
- *       "buckets": [
- *         {
- *           "count": 0,
- *           "externalId": "string",
- *           "id": "string",
- *           "key": "string",
- *           "name": "string",
- *           "values": ["string"]
- *         }
- *       ],
- *       "type": "string"
- *     }
- *   ],
- *   "productThumbnails": {
- *     "content": [
- *       {
- *         "bestOffer": {
- *           "offerInventory": {
- *             "brand": "string",
- *             "currency": "USD",
- *             "stock": 10,
- *             "variant": {
- *               "description": "string",
- *               "sku": "string",
- *               "name": "string"
- *             }
- *           },
- *           "offerPrice": {
- *             "priceRanges": [
- *               {
- *                 "price": {
- *                   "unitPrice": 100,
- *                   "itemPrice": 100
- *                 },
- *                 "quantity": 1
- *               }
- *             ]
- *           }
- *         },
- *         "product": {
- *           "info": {
- *             "brand": "string",
- *             "name": "string",
- *             "sku": "string"
- *           },
- *           "productPictures": [
- *             {
- *               "urls": [
- *                 {
- *                   "url": "string",
- *                   "widthInPx": 100,
- *                   "heightInPx": 100
- *                 }
- *               ]
- *             }
- *           ]
- *         },
- *         "productReviewRatings": {
- *           "countRating": 10,
- *           "rating": 4.5
- *         }
- *       }
- *     ],
- *     "empty": false,
- *     "first": true,
- *     "last": false,
- *     "number": 0,
- *     "size": 10,
- *     "totalElements": 100,
- *     "totalPages": 10
- *   }
- * }
+ * console.log(relatedProducts);
  * ```
  */
-export declare function getRelatedProducts({ productIdentifier, productIdType, locale, currency, pageable, }: GetRelatedProductsParameters): Promise<GetRelatedProductsResponse>;
+export declare function getRelatedProducts({ productIdentifier, productIdType, locale, currency, pageable, }: GetRelatedProductsParameters): Promise<GetRelatedProductsParameters>;
 /**
- * ## Get Product Reviews by SKU, ID, or External ID
- * ### APICODE(PRODUCT 504)
- * @param {GetProductReviewsParameters} params - Parameters for retrieving product reviews.
- * #### productIdentifier - `string` | <strong style={{ color: 'red' }}>(required)</strong>
- * #### productIdType - `string` | <strong style={{ color: 'red' }}>(required)</strong> (e.g., "sku", "id", or "externalId")
+ * 📄 Fetches reviews for a specific product.
  *
- * @returns {Promise<GetProductReviewsResponse>} - The response with product reviews.
+ * Retrieves a list of reviews for a product identified by SKU, ID, or external ID.
  *
- * @example
- * ### Input
- * ```typescript
- * const response = await getProductReviews({
- *   productIdentifier: 'sku-12345',
+ * 🛠 **Endpoint**: `GET /v1/shop/products/{productIdentifier}/reviews`
+ *
+ * | Parameter             | Type        | Required   | Description                                                   |
+ * |-----------------------|-------------|------------|---------------------------------------------------------------|
+ * | `productIdentifier`   | `string`    | ✅         | Unique identifier for the product (e.g., SKU, ID).            |
+ * | `productIdType`       | `string`    | ✅         | The type of identifier: `"sku"`, `"id"`, or `"externalId"`.   |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetProductReviewsResponse>` containing the reviews.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const reviews = await getProductReviews({
+ *   productIdentifier: 'sku123',
  *   productIdType: 'sku',
  * });
- * ```
  *
- * ### Response - <strong style={{ color: 'green' }}>200</strong> - OK
- * ```json
- * [
- *   {
- *     "productReview": {
- *       "message": "string",
- *       "rating": 0
- *     },
- *     "user": {
- *       "customerUserId": "string",
- *       "email": "string",
- *       "firstName": "string",
- *       "lastName": "string"
- *     }
- *   }
- * ]
- * ```
- *
- * ### Response - <strong style={{ color: 'red' }}>404</strong> - Not Found
- * ```json
- * {
- *   "content": {},
- *   "errors": [
- *     {
- *       "cause": {
- *         "localizedMessage": "string",
- *         "message": "string",
- *         "stackTrace": [
- *           {
- *             "classLoaderName": "string",
- *             "className": "string",
- *             "fileName": "string",
- *             "lineNumber": 0,
- *             "methodName": "string",
- *             "moduleName": "string",
- *             "moduleVersion": "string",
- *             "nativeMethod": true
- *           }
- *         ]
- *       },
- *       "code": "string",
- *       "detail": "string",
- *       "localizedMessage": "string",
- *       "message": "string",
- *       "stackTrace": [
- *         {
- *           "classLoaderName": "string",
- *           "className": "string",
- *           "fileName": "string",
- *           "lineNumber": 0,
- *           "methodName": "string",
- *           "moduleName": "string",
- *           "moduleVersion": "string",
- *           "nativeMethod": true
- *         }
- *       ],
- *       "suppressed": [
- *         {
- *           "localizedMessage": "string",
- *           "message": "string",
- *           "stackTrace": [
- *             {
- *               "classLoaderName": "string",
- *               "className": "string",
- *               "fileName": "string",
- *               "lineNumber": 0,
- *               "methodName": "string",
- *               "moduleName": "string",
- *               "moduleVersion": "string",
- *               "nativeMethod": true
- *             }
- *           ]
- *         }
- *       ]
- *     }
- *   ],
- *   "warnings": [
- *     {
- *       "code": "string",
- *       "field": "string",
- *       "message": "string"
- *     }
- *   ]
- * }
+ * console.log(reviews);
  * ```
  */
 export declare function getProductReviews({ productIdentifier, productIdType, }: GetProductReviewsParameters): Promise<GetProductReviewsResponse>;
 /**
- * ## Get Stat Reviews of a Product by SKU, ID, or External ID
- * ### APICODE(PRODUCT 505)
- * @param {GetProductStatReviewsParameters} params - Parameters for retrieving statistical reviews of a product.
- * #### productIdentifier - `string` | <strong style={{ color: 'red' }}>(required)</strong>
- * #### productIdType - `string` | <strong style={{ color: 'red' }}>(required)</strong> (e.g., "sku", "id", or "externalId")
+ * 📄 Fetches statistical review data for a specific product.
  *
- * @returns {Promise<GetProductStatReviewsResponse>} - The response with statistical reviews.
+ * Retrieves aggregate review statistics for a product identified by SKU, ID, or external ID.
  *
- * @example
- * ### Input
- * ```typescript
- * const response = await getProductStatReviews({
- *   productIdentifier: 'sku-12345',
+ * 🛠 **Endpoint**: `GET /v1/shop/products/{productIdentifier}/stat-reviews`
+ *
+ * | Parameter             | Type        | Required   | Description                                                   |
+ * |-----------------------|-------------|------------|---------------------------------------------------------------|
+ * | `productIdentifier`   | `string`    | ✅         | Unique identifier for the product (e.g., SKU, ID).            |
+ * | `productIdType`       | `string`    | ✅         | The type of identifier: `"sku"`, `"id"`, or `"externalId"`.   |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetProductStatReviewsResponse>` containing review statistics.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const stats = await getProductStatReviews({
+ *   productIdentifier: 'sku123',
  *   productIdType: 'sku',
  * });
- * ```
- *
- * ### Response - <strong style={{ color: 'green' }}>200</strong> - OK
- * ```json
- * {
- *   "countRating": 0,
- *   "rating": 0
- * }
- * ```
  *
- * ### Response - <strong style={{ color: 'red' }}>404</strong> - Not Found
- * ```json
- * {
- *   "content": {},
- *   "errors": [
- *     {
- *       "cause": {
- *         "localizedMessage": "string",
- *         "message": "string",
- *         "stackTrace": [
- *           {
- *             "classLoaderName": "string",
- *             "className": "string",
- *             "fileName": "string",
- *             "lineNumber": 0,
- *             "methodName": "string",
- *             "moduleName": "string",
- *             "moduleVersion": "string",
- *             "nativeMethod": true
- *           }
- *         ]
- *       },
- *       "code": "string",
- *       "detail": "string",
- *       "localizedMessage": "string",
- *       "message": "string",
- *       "stackTrace": [
- *         {
- *           "classLoaderName": "string",
- *           "className": "string",
- *           "fileName": "string",
- *           "lineNumber": 0,
- *           "methodName": "string",
- *           "moduleName": "string",
- *           "moduleVersion": "string",
- *           "nativeMethod": true
- *         }
- *       ],
- *       "suppressed": [
- *         {
- *           "localizedMessage": "string",
- *           "message": "string",
- *           "stackTrace": [
- *             {
- *               "classLoaderName": "string",
- *               "className": "string",
- *               "fileName": "string",
- *               "lineNumber": 0,
- *               "methodName": "string",
- *               "moduleName": "string",
- *               "moduleVersion": "string",
- *               "nativeMethod": true
- *             }
- *           ]
- *         }
- *       ]
- *     }
- *   ],
- *   "warnings": [
- *     {
- *       "code": "string",
- *       "field": "string",
- *       "message": "string"
- *     }
- *   ]
- * }
+ * console.log(stats);
  * ```
  */
 export declare function getProductStatReviews({ productIdentifier, productIdType, }: GetProductStatReviewsParameters): Promise<GetProductStatReviewsResponse>;
 /**
- * ## Get Attributes of a Product Variant by SKU, ID, or External ID
- * ### APICODE(PRODUCT 501)
- * @param {GetProductVariantAttributesParameters} params - Parameters for retrieving attributes of a product variant.
- * #### productIdentifier - `string` | <strong style={{ color: 'red' }}>(required)</strong>
- * #### productIdType - `string` | <strong style={{ color: 'red' }}>(required)</strong> (e.g., "sku", "id", or "externalId")
- * #### locale - `string`
+ * 📄 Fetches attributes for a product variant.
  *
- * @returns {Promise<GetProductVariantAttributesResponse>} - The response with attributes of a product variant.
+ * Retrieves attributes for a product variant identified by SKU, ID, or external ID.
  *
- * @example
- * ### Input
- * ```typescript
- * const response = await getProductVariantAttributes({
- *   productIdentifier: 'sku-12345',
+ * 🛠 **Endpoint**: `GET /v1/shop/products/{productIdentifier}/variant-attributes`
+ *
+ * | Parameter             | Type        | Required   | Description                                                   |
+ * |-----------------------|-------------|------------|---------------------------------------------------------------|
+ * | `productIdentifier`   | `string`    | ✅         | Unique identifier for the product variant (e.g., SKU, ID).    |
+ * | `productIdType`       | `string`    | ✅         | The type of identifier: `"sku"`, `"id"`, or `"externalId"`.   |
+ * | `locale`              | `string`    | ✅         | Locale for the attributes (e.g., `"en_US"`).                  |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetProductVariantAttributesResponse>` containing variant attributes.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const attributes = await getProductVariantAttributes({
+ *   productIdentifier: 'sku123',
  *   productIdType: 'sku',
- *   locale: 'fr-FR',
+ *   locale: 'en_US',
  * });
- * ```
  *
- * ### Response - <strong style={{ color: 'green' }}>200</strong> - OK
- * ```json
- * [
- *   {
- *     "externalId": "string",
- *     "id": "string",
- *     "name": {
- *       "additionalProp1": "string",
- *       "additionalProp2": "string",
- *       "additionalProp3": "string"
- *     },
- *     "type": "LONG_TEXT",
- *     "values": [
- *       {}
- *     ]
- *   }
- * ]
- * ```
- *
- * ### Response - <strong style={{ color: 'red' }}>404</strong> - Not Found
- * ```json
- * {
- *   "content": {},
- *   "errors": [
- *     {
- *       "cause": {
- *         "localizedMessage": "string",
- *         "message": "string",
- *         "stackTrace": [
- *           {
- *             "classLoaderName": "string",
- *             "className": "string",
- *             "fileName": "string",
- *             "lineNumber": 0,
- *             "methodName": "string",
- *             "moduleName": "string",
- *             "moduleVersion": "string",
- *             "nativeMethod": true
- *           }
- *         ]
- *       },
- *       "code": "string",
- *       "detail": "string",
- *       "localizedMessage": "string",
- *       "message": "string",
- *       "stackTrace": [
- *         {
- *           "classLoaderName": "string",
- *           "className": "string",
- *           "fileName": "string",
- *           "lineNumber": 0,
- *           "methodName": "string",
- *           "moduleName": "string",
- *           "moduleVersion": "string",
- *           "nativeMethod": true
- *         }
- *       ],
- *       "suppressed": [
- *         {
- *           "localizedMessage": "string",
- *           "message": "string",
- *           "stackTrace": [
- *             {
- *               "classLoaderName": "string",
- *               "className": "string",
- *               "fileName": "string",
- *               "lineNumber": 0,
- *               "methodName": "string",
- *               "moduleName": "string",
- *               "moduleVersion": "string",
- *               "nativeMethod": true
- *             }
- *           ]
- *         }
- *       ]
- *     }
- *   ],
- *   "warnings": [
- *     {
- *       "code": "string",
- *       "field": "string",
- *       "message": "string"
- *     }
- *   ]
- * }
+ * console.log(attributes);
  * ```
  */
 export declare function getProductVariantAttributes({ productIdentifier, productIdType, locale, }: GetProductVariantAttributesParameters): Promise<GetProductVariantAttributesResponse>;
 /**
- * ## Create a Review for a Product
- * ### APICODE(PRODUCT 153)
- * @param {CreateProductReviewParameters} params - Parameters for creating a review for a product.
- * #### message - `string` | <strong style={{ color: 'red' }}>(required)</strong>
- * #### productSku - `string` | <strong style={{ color: 'red' }}>(required)</strong>
- * #### rating - `number` | <strong style={{ color: 'red' }}>(required)</strong>
+ * 📄 Creates a review for a product.
  *
- * @returns {Promise<CreateProductReviewResponse>} - The response with the created product review.
+ * Submits a review for a specific product based on its SKU.
  *
- * @example
- * ### Input
- * ```typescript
- * const response = await createProductReview({
+ * 🛠 **Endpoint**: `POST /v1/shop/reviews`
+ *
+ * | Parameter             | Type                          | Required   | Description                                                   |
+ * |-----------------------|-------------------------------|------------|---------------------------------------------------------------|
+ * | `message`             | `string`                     | ✅         | Review content.                                               |
+ * | `productSku`          | `string`                     | ✅         | SKU of the product to review.                                |
+ * | `rating`              | `number`                     | ✅         | Rating (e.g., 1 to 5).                                        |
+ *
+ * 📤 **Returns**:
+ * A `Promise<CreateProductReviewResponse>` indicating the result of the operation.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const review = await createProductReview({
  *   message: 'Great product!',
- *   productSku: 'sku-12345',
+ *   productSku: 'sku123',
  *   rating: 5,
  * });
- * ```
  *
- * ### Response - <strong style={{ color: 'green' }}>201</strong> - Created
- * ```json
- * {
- *   "productReview": {
- *     "message": "string",
- *     "rating": 0
- *   },
- *   "user": {
- *     "customerUserId": "string",
- *     "email": "string",
- *     "firstName": "string",
- *     "lastName": "string"
- *   }
- * }
- * ```
- *
- * ### Response - <strong style={{ color: 'red' }}>400</strong> - Bad Request
- * ```json
- * {
- *   "content": {},
- *   "errors": [
- *     {
- *       "cause": {
- *         "localizedMessage": "string",
- *         "message": "string",
- *         "stackTrace": [
- *           {
- *             "classLoaderName": "string",
- *             "className": "string",
- *             "fileName": "string",
- *             "lineNumber": 0,
- *             "methodName": "string",
- *             "moduleName": "string",
- *             "moduleVersion": "string",
- *             "nativeMethod": true
- *           }
- *         ]
- *       },
- *       "code": "string",
- *       "detail": "string",
- *       "localizedMessage": "string",
- *       "message": "string",
- *       "stackTrace": [
- *         {
- *           "classLoaderName": "string",
- *           "className": "string",
- *           "fileName": "string",
- *           "lineNumber": 0,
- *           "methodName": "string",
- *           "moduleName": "string",
- *           "moduleVersion": "string",
- *           "nativeMethod": true
- *         }
- *       ],
- *       "suppressed": [
- *         {
- *           "localizedMessage": "string",
- *           "message": "string",
- *           "stackTrace": [
- *             {
- *               "classLoaderName": "string",
- *               "className": "string",
- *               "fileName": "string",
- *               "lineNumber": 0,
- *               "methodName": "string",
- *               "moduleName": "string",
- *               "moduleVersion": "string",
- *               "nativeMethod": true
- *             }
- *           ]
- *         }
- *       ]
- *     }
- *   ],
- *   "warnings": [
- *     {
- *       "code": "string",
- *       "field": "string",
- *       "message": "string"
- *     }
- *   ]
- * }
+ * console.log(review);
  * ```
  */
 export declare function createProductReview({ message, productSku, rating, }: CreateProductReviewParameters): Promise<CreateProductReviewResponse>;
 /**
- * ## Update a Review for a Product
- * ### APICODE(PRODUCT 204)
- * @param {UpdateProductReviewParameters} params - Parameters for updating a product review.
- * #### productReviewId - `string` | <strong style={{ color: 'red' }}>(required)</strong>
- * #### message - `string` | <strong style={{ color: 'red' }}>(required)</strong>
- * #### rating - `number` | <strong style={{ color: 'red' }}>(required)</strong>
+ * 📄 Updates an existing review for a product.
  *
- * @returns {Promise<UpdateProductReviewResponse>} - The response for updating a product review.
+ * Modifies the content and/or rating of an existing review for a specific product.
  *
- * @example
- * ### Input
- * ```typescript
- * const response = await updateProductReview({
- *   productReviewId: 'review-12345',
- *   message: 'Updated review message!',
- *   rating: 5,
- * });
- * ```
+ * 🛠 **Endpoint**: `PUT /v1/shop/reviews/{productReviewId}`
  *
- * ### Response - <strong style={{ color: 'green' }}>200</strong> - OK
- * ```json
- * {
- *   "message": "string",
- *   "rating": 0
- * }
- * ```
+ * | Parameter             | Type                          | Required   | Description                                                   |
+ * |-----------------------|-------------------------------|------------|---------------------------------------------------------------|
+ * | `productReviewId`     | `string`                       | ✅         | ID of the review to update.                                   |
+ * | `message`             | `string`                       | ✅         | New review content.                                           |
+ * | `rating`              | `number`                       | ✅         | New rating (e.g., 1 to 5).                                     |
  *
- * ### Response - <strong style={{ color: 'red' }}>400</strong> - Bad Request
- * ```json
- * {
- *   "content": {},
- *   "errors": [
- *     {
- *       "cause": {
- *         "localizedMessage": "string",
- *         "message": "string",
- *         "stackTrace": [
- *           {
- *             "classLoaderName": "string",
- *             "className": "string",
- *             "fileName": "string",
- *             "lineNumber": 0,
- *             "methodName": "string",
- *             "moduleName": "string",
- *             "moduleVersion": "string",
- *             "nativeMethod": true
- *           }
- *         ]
- *       },
- *       "code": "string",
- *       "detail": "string",
- *       "localizedMessage": "string",
- *       "message": "string",
- *       "stackTrace": [
- *         {
- *           "classLoaderName": "string",
- *           "className": "string",
- *           "fileName": "string",
- *           "lineNumber": 0,
- *           "methodName": "string",
- *           "moduleName": "string",
- *           "moduleVersion": "string",
- *           "nativeMethod": true
- *         }
- *       ],
- *       "suppressed": [
- *         {
- *           "localizedMessage": "string",
- *           "message": "string",
- *           "stackTrace": [
- *             {
- *               "classLoaderName": "string",
- *               "className": "string",
- *               "fileName": "string",
- *               "lineNumber": 0,
- *               "methodName": "string",
- *               "moduleName": "string",
- *               "moduleVersion": "string",
- *               "nativeMethod": true
- *             }
- *           ]
- *         }
- *       ]
- *     }
- *   ],
- *   "warnings": [
- *     {
- *       "code": "string",
- *       "field": "string",
- *       "message": "string"
- *     }
- *   ]
- * }
- * ```
+ * 📤 **Returns**:
+ * A `Promise<UpdateProductReviewResponse>` indicating the result of the operation.
  *
- * ### Response - <strong style={{ color: 'red' }}>404</strong> - Not Found
- * ```json
- * {
- *   "content": {},
- *   "errors": [
- *     {
- *       "cause": {
- *         "localizedMessage": "string",
- *         "message": "string",
- *         "stackTrace": [
- *           {
- *             "classLoaderName": "string",
- *             "className": "string",
- *             "fileName": "string",
- *             "lineNumber": 0,
- *             "methodName": "string",
- *             "moduleName": "string",
- *             "moduleVersion": "string",
- *             "nativeMethod": true
- *           }
- *         ]
- *       },
- *       "code": "string",
- *       "detail": "string",
- *       "localizedMessage": "string",
- *       "message": "string",
- *       "stackTrace": [
- *         {
- *           "classLoaderName": "string",
- *           "className": "string",
- *           "fileName": "string",
- *           "lineNumber": 0,
- *           "methodName": "string",
- *           "moduleName": "string",
- *           "moduleVersion": "string",
- *           "nativeMethod": true
- *         }
- *       ],
- *       "suppressed": [
- *         {
- *           "localizedMessage": "string",
- *           "message": "string",
- *           "stackTrace": [
- *             {
- *               "classLoaderName": "string",
- *               "className": "string",
- *               "fileName": "string",
- *               "lineNumber": 0,
- *               "methodName": "string",
- *               "moduleName": "string",
- *               "moduleVersion": "string",
- *               "nativeMethod": true
- *             }
- *           ]
- *         }
- *       ]
- *     }
- *   ],
- *   "warnings": [
- *     {
- *       "code": "string",
- *       "field": "string",
- *       "message": "string"
- *     }
- *   ]
- * }
+ * 🛠 **Example usage**:
+ * ```ts
+ * const updatedReview = await updateProductReview({
+ *   productReviewId: 'review123',
+ *   message: 'Updated my thoughts, still a great product!',
+ *   rating: 4,
+ * });
+ *
+ * console.log(updatedReview);
  * ```
  */
 export declare function updateProductReview({ productReviewId, message, rating, }: UpdateProductReviewParameters): Promise<UpdateProductReviewResponse>;
+/**
+ * 📄 Fetches paginated offers for a product.
+ *
+ * Retrieves offers for a product identified by SKU, ID, or external ID, with pagination support.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/products/{productIdentifier}/paginated-offers`
+ *
+ * | Parameter             | Type        | Required   | Description                                                   |
+ * |-----------------------|-------------|------------|---------------------------------------------------------------|
+ * | `productIdentifier`   | `string`    | ✅         | Unique identifier for the product (e.g., SKU, ID).            |
+ * | `productIdType`       | `string`    | ✅         | The type of identifier: `"sku"`, `"id"`, or `"externalId"`.   |
+ * | `currency`            | `string`    | ✅         | Currency for the offers (e.g., `"USD"`).                      |
+ * | `locale`              | `string`    | ✅         | Locale for the offers (e.g., `"en_US"`).                      |
+ * | `withoutPrices`       | `boolean`   | ❌         | Whether to exclude prices from the response.                  |
+ * | `pageable`            | `object`    | ❌         | Pagination details: `page`, `size`, `sort`.                   |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetProductPaginatedOffersResponse>` containing paginated offers.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const offers = await getProductPaginatedOffers({
+ *   productIdentifier: 'sku123',
+ *   productIdType: 'sku',
+ *   currency: 'USD',
+ *   locale: 'en_US',
+ *   pageable: { page: 1, size
+ */
+export declare function getProductPaginatedOffers({ productIdentifier, productIdType, currency, locale, withoutPrices, pageable, }: GetProductPaginatedOffersParameters): Promise<GetProductPaginatedOffersResponse>;