oneentry 1.0.159 → 1.0.161

package/esm/orders/ordersInterfaces.d.ts

@@ -0,0 +1,763 @@
+import type { IError, ILocalizeInfo } from '../base/utils.js';
+/**
+ * @interface IOrdersApi
+ * @description Represents the API for managing orders in the order storage.
+ */
+interface IOrdersApi {
+    /**
+     * Getting all the order storage objects.
+     * @handleName getAllOrdersStorage
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Optional parameter for pagination. Default: 0.
+     * @param {number} [limit] - Optional parameter for pagination. Default: 30.
+     * @returns {Promise<IOrdersEntity[] | IError>} Returns an array of order storage objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all the order storage objects. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    getAllOrdersStorage(langCode?: string, offset?: number, limit?: number): Promise<IOrdersEntity[] | IError>;
+    /**
+     * Getting all orders from the orders storage object created by the user.
+     * @handleName getAllOrdersByMarker
+     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Offset parameter. Default: 0.
+     * @param {number} [limit] - Limit parameter. Default: 30.
+     * @returns {Promise<IOrdersByMarkerEntity | IError>} Returns an object with the orders.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all orders from the orders storage object created by the user. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    getAllOrdersByMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IOrdersByMarkerEntity | IError>;
+    /**
+     * Retrieve one order storage object by marker.
+     * @handleName getOrdersStorageByMarker
+     * @param {string} marker - Marker of the order object. Example: "order_storage_1".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IOrdersEntity | IError>} Return object of order information.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method retrieves one order storage object by marker. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    getOrdersStorageByMarker(marker: string, langCode?: string): Promise<IOrdersEntity | IError>;
+    /**
+     * Getting a single order from the order storage object created by the user.
+     * @handleName getOrderByMarkerAndId
+     * @param {string} marker - The text identifier of the order storage object. Example: "order_storage_1".
+     * @param {number} id - ID of the order object. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IOrderByMarkerEntity | IError>} Returns an object with the order.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets a single order from the order storage object created by the user. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    getOrderByMarkerAndId(marker: string, id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
+    /**
+     * Creation of an order in the order storage.
+     * @handleName createOrder
+     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
+     * @param {IOrderData} body - Object for creating an order.
+     * @example
+        {
+          "formIdentifier": "bar-orders-form",
+          "paymentAccountIdentifier": "usd-payment",
+          "formData": {
+            "marker": "name_1",
+            "value": "Name",
+            "type": "string"
+          },
+          "products": [
+            {
+            "productId": 1,
+            "quantity": 2
+            }
+          ]
+        }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IBaseOrdersEntity | IError>} Returns an object with the created order.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    createOrder(marker: string, body: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
+    /**
+     * Changing an order in the orders storage
+     * @handleName updateOrderByMarkerAndId
+     * @param {string} marker - The text identifier of the order storage object. Example: "order_storage_1".
+     * @param {number} id - ID of the order object. Example: 12345.
+     * @param {IOrderData} body - Object for updating an order.
+     * @example
+        {
+          "formIdentifier": "bar-orders-form",
+          "paymentAccountIdentifier": "usd-payment",
+          "formData": {
+            "marker": "name_1",
+            "value": "Name",
+            "type": "string"
+          },
+          "products": [
+            {
+            "productId": 1,
+            "quantity": 2
+            }
+          ],
+          "currency": "USD"
+        }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IBaseOrdersEntity | IError>} Returns an object with the updated order.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    updateOrderByMarkerAndId(marker: string, id: number, body: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
+    /**
+     * Preview order calculation with discounts and coupons (without saving).
+     * @handleName previewOrder
+     * @param {ICreateOrderPreview} body - Order preview body.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IOrderPreviewResponse | IError>} Returns an object with the order preview.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization ???.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    previewOrder(body: ICreateOrderPreview, langCode?: string): Promise<IOrderPreviewResponse | IError>;
+    /**
+     * Get all orders statuses by Storage marker
+     * @handleName getAllStatusesByStorageMarker
+     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Offset parameter. Default: 0.
+     * @param {number} [limit] - Limit parameter. Default: 30.
+     * @returns {Promise<IOrderStatus[] | IError>} Returns an object with the orders statuses.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    getAllStatusesByStorageMarker(marker: string, langCode: string, offset?: number, limit?: number): Promise<IOrderStatus[] | IError>;
+    /**
+     * Get all refund requests for an order.
+     * @handleName getOrderRefunds
+     * @param {number} id - Order id.
+     * @returns {Promise<IRefundRequest[] | IError>} Returns array of refund requests.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    getRefunds(id: number): Promise<IRefundRequest[] | IError>;
+    /**
+     * Create a refund request for an order.
+     * @handleName createRefundRequest
+     * @param {number} id - Order id.
+     * @param {ICreateRefundRequest} body - Refund request body.
+     * @returns {Promise<boolean | IError>} Returns true if the refund request was created successfully.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    createRefundRequest(id: number, body: ICreateRefundRequest): Promise<boolean | IError>;
+    /**
+     * Cancel a refund request for an order.
+     * @handleName cancelRefundRequest
+     * @param {number} id - Order id.
+     * @returns {Promise<boolean | IError>} Returns order entity.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    cancelRefundRequest(id: number): Promise<boolean | IError>;
+    /**
+     * Semantic (vector) search for the current user's orders.
+     * @handleName getOrdersByVectorSearch
+     * @param {IOrdersVectorSearch} body - Vector search body. Example: `{ queryText: "winter jacket" }`.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {Promise<IOrdersByMarkerEntity | IError>} Returns an object with an array of found orders and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    getOrdersByVectorSearch(body: IOrdersVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IOrdersByMarkerEntity | IError>;
+}
+/**
+ * Body for semantic (vector) order search.
+ * @interface IOrdersVectorSearch
+ * @property {string} queryText - Natural-language search query. Example: "winter jacket".
+ * @property {number} [vectorDistanceThreshold] - Override of the cosine distance threshold (0..2). Example: 0.3.
+ * @property {number} [maxHits] - Top-K candidates fetched before pagination. Default: 100. Max: 500. Example: 10.
+ * @property {boolean} [debug] - When true, each returned item gets a `distance` field. Example: false.
+ * @description Body for the orders vector/search endpoint.
+ */
+interface IOrdersVectorSearch {
+    queryText: string;
+    vectorDistanceThreshold?: number;
+    maxHits?: number;
+    debug?: boolean;
+}
+/**
+ * Interface for the orders storage object.
+ * @interface IOrdersByMarkerEntity
+ * @property {IOrderByMarkerEntity[]} items - Array of order storage objects.
+ * @example
+    [
+      {
+        "id": 55,
+        "storageId": 1,
+        "createdDate": "2025-03-22T21:12:42.371Z",
+        "statusIdentifier": "inProgress",
+        "formIdentifier": "orderForm",
+        "formData": [
+          {
+          "marker": "order_name",
+          "value": "Ivan",
+          "type": "string"
+          }
+        ],
+        "attributeSetIdentifier": "order_form",
+        "totalSum": "300.00",
+        "currency": "",
+        "paymentAccountIdentifier": "cash",
+        "paymentAccountLocalizeInfos": {
+          "title": "Cash"
+        },
+        "products": [
+          {
+          "id": 2957,
+          "title": "Cosmo",
+          "sku": null,
+          "previewImage": null,
+          "price": 150,
+          "quantity": 2
+          }
+        ],
+        "isCompleted": false
+      }
+    ]
+ * @property {number} total - Total number of found records. Example: 100.
+ * @description Represents a response from the order storage by marker.
+ */
+interface IOrdersByMarkerEntity {
+    total: number;
+    items: IOrderByMarkerEntity[];
+}
+/**
+ * Interface representing a picture entity.
+ * @interface IPicture
+ * @property {string} filename - The name of the file. Example: "image.jpg".
+ * @property {string} downloadLink - The URL link to download the picture. Example: "https://example.com/image.jpg".
+ * @property {number} size - The size of the picture in bytes. Example: 102400.
+ * @property {string} previewLink - The URL link to preview the picture. Example: "https://example.com/image-preview.jpg".
+ * @description This interface defines the structure for a picture entity, including its filename, download link, size, and preview link.
+ */
+interface IPicture {
+    filename: string;
+    downloadLink: string;
+    size: number;
+    previewLink: string;
+}
+/**
+ * Interface representing a product in an order.
+ * @interface IOrderProducts
+ * @property {number} id - Product id. Example: 2957.
+ * @property {number} quantity - Product quantity. Example: 1.
+ * @property {string} title - Product title. Example: "Cosmo".
+ * @property {string | null} sku - Product sku. Example: "SKU".
+ * @property {IPicture | null} previewImage - Product previewImage.
+ * @example
+    {
+      "filename": "image.jpg",
+      "downloadLink": "https://example.com/image.jpg",
+      "size": 102400,
+      "previewLink": "https://example.com/image-preview.jpg"
+    }
+ * @property {number} price - Product price. Example: 150.
+ * @property {boolean} isGift - Whether the product is a gift. Example: false.
+ * @description Represents a product in an order.
+ */
+interface IOrderProducts {
+    id: number;
+    quantity: number;
+    title: string;
+    sku: string | null;
+    previewImage: IPicture | null;
+    price: number;
+    isGift: boolean;
+}
+/**
+ * Interface representing form data for orders.
+ * @interface IOrdersFormData
+ * @property {string} marker - Marker of form field. Example: "name_1".
+ * @property {string} type - Type of value. Example: "string".
+ * @property {string} value - Value. Example: "Name".
+ * @description Represents a form data for orders.
+ */
+interface IOrdersFormData {
+    marker: string;
+    type: string;
+    value: unknown;
+}
+/**
+ * Interface representing product data in an order.
+ * @interface IOrderProductData
+ * @property {number} productId - Product identifier. Example: 1.
+ * @property {number} quantity - Quantity of the product. Example: 2.
+ * @property {string} [signedPrice] - The signed price of the product is obtained along with the product data when `signPrice` is set. Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...".
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/#Fixed-product-price-signedPrice Fixed product price} documentation.
+ * @description Represents a product data in an order.
+ */
+interface IOrderProductData {
+    productId: number;
+    quantity: number;
+    signedPrice?: string;
+}
+/**
+ * Interface representing product data in an order.
+ * @interface IOrderProductsData
+ * @property {number} productId - Product identifier. Example: 1.
+ * @property {number} quantity - Quantity of the product. Example: 2.
+ * @description Represents a product data in an order.
+ */
+interface IOrderProductsData {
+    productId: number;
+    quantity: number;
+}
+/**
+ * Interface representing an order storage object.
+ * @interface IBaseOrdersEntity
+ * @property {number} id - Object identifier. Example: 1.
+ * @property {string} formIdentifier - Text identifier of the form. Example: "bar-orders-form".
+ * @property {string} paymentAccountIdentifier - Text identifier of the order payment. Example: "payment-1".
+ * @property {IOrdersFormData[]} formData - Data submitted by the form linked to the order store.
+ * @example
+    [
+      {
+        "marker": "name_1",
+        "value": "Name",
+        "type": "string"
+      }
+    ]
+ * @property {IOrderProductsData[]} products - Array of products added to order.
+ * @example
+    [
+      {
+        "id": 2957,
+        "title": "Cosmo",
+        "sku": null,
+        "previewImage": null,
+        "price": 150,
+        "quantity": 2
+      }
+    ]
+ * @property {string} currency - Currency used to pay for the order. Example: "USD".
+ * @property {number} totalSum - Total order amount. Example: 150.
+ * @property {string} [createdDate] - Order creation date. Example: "2023-10-01T12:00:00Z".
+ * @property {string} [statusIdentifier] - Text identifier of order status object (if not set, default status will be assigned). Example: "status-1".
+ * @property {ILocalizeInfo} [statusLocalizeInfos] - Localized status name assigned to the created/updated order.
+ * @property {string} [couponCode] -
+ * @property {string[]} [additionalDiscountsMarkers] -
+ * @property {IOrderDiscountConfig} [discountConfig] - Resolved discount configuration applied to the order.
+ * @property {number} [bonusAmount] - Bonus amount applied to the order.
+ * @property {number} [bonusApplied] - Bonus applied to the order.
+ * @property {number} [totalDue] - Total due after bonuses.
+ */
+interface IBaseOrdersEntity {
+    id: number;
+    formIdentifier: string;
+    paymentAccountIdentifier: string;
+    formData: IOrdersFormData[];
+    products: IOrderProductsData[];
+    currency: string;
+    totalSum: number;
+    createdDate?: string;
+    statusIdentifier?: string;
+    statusLocalizeInfos?: ILocalizeInfo;
+    couponCode?: string;
+    additionalDiscountsMarkers?: string[];
+    discountConfig?: IOrderDiscountConfig;
+    bonusAmount?: number;
+    bonusApplied?: number;
+    totalDue?: number;
+}
+/**
+ * @interface IOrderDiscountBonus
+ * @property {number} availableBalance - User bonus balance available at the moment of calculation. Example: 0.
+ * @property {number} bonusApplied - Bonus amount actually applied to this order. Example: 0.
+ * @property {number} maxBonusDiscount - Maximum bonus amount allowed to be spent on this order. Example: 0.
+ * @property {number | null} minBonusAmount - Minimum bonus balance required to use bonuses, or null if no threshold. Example: null.
+ * @property {number | null} minOrderAmountForBonus - Minimum order total required to apply bonuses, or null if no threshold. Example: null.
+ * @description Bonus subsection of the order discount configuration.
+ */
+interface IOrderDiscountBonus {
+    availableBalance: number;
+    bonusApplied: number;
+    maxBonusDiscount: number;
+    minBonusAmount: number | null;
+    minOrderAmountForBonus: number | null;
+}
+/**
+ * @interface IOrderDiscountSettings
+ * @property {boolean} allowGiftStacking - Whether multiple gift discounts can be combined. Example: false.
+ * @property {boolean} allowStacking - Whether multiple non-gift discounts can be combined. Example: false.
+ * @property {number | null} maxDiscountValue - Hard cap on total discount value, or null if uncapped. Example: null.
+ * @property {string} [giftRefundPolicy] - Refund policy applied to gift products (present on newer orders). Example: "refund".
+ * @property {number | null} [maxBonusPaymentPercent] - Maximum share of the order payable with bonuses, or null if uncapped (present on newer orders).
+ * @property {number | null} [minBonusAmount] - Minimum bonus amount required to apply bonuses, or null when not configured (present on newer orders).
+ * @property {number | null} [minOrderAmountForBonus] - Minimum order amount required to earn/spend bonuses, or null when not configured (present on newer orders).
+ * @description Stacking and cap settings for the order discount engine.
+ */
+interface IOrderDiscountSettings {
+    allowGiftStacking: boolean;
+    allowStacking: boolean;
+    maxDiscountValue: number | null;
+    giftRefundPolicy?: string;
+    maxBonusPaymentPercent?: number | null;
+    minBonusAmount?: number | null;
+    minOrderAmountForBonus?: number | null;
+}
+/**
+ * @interface IOrderDiscountConfig
+ * @property {IOrderDiscountBonus | null} [bonus] - Bonus calculation result, null when bonuses are not used, or omitted entirely when the order has no bonus context.
+ * @property {unknown | null} coupon - Resolved coupon, or null when no coupon is applied.
+ * @property {unknown[]} orderDiscounts - Order-level discounts that were matched and applied.
+ * @property {unknown[]} productDiscounts - Product-level discounts that were matched and applied.
+ * @property {IOrderDiscountSettings} settings - Stacking and cap settings used during calculation.
+ * @property {string[]} [additionalDiscountsMarkers] - Markers of extra discounts requested by the client (omitted in preview responses).
+ * @property {number} [bonusApplied] - Bonus amount applied to the order (omitted in preview responses). Example: 0.
+ * @property {string[]} [excludedGiftProductIds] - Product ids excluded from gift selection (omitted in preview responses).
+ * @property {number} [totalDue] - Total amount due after discounts and bonuses (omitted in preview responses). Example: 300.
+ * @property {number} [totalRaw] - Total amount before discounts (omitted in preview responses). Example: 300.
+ * @property {number} [totalSumWithDiscount] - Total amount after discounts but before bonuses (omitted in preview responses). Example: 300.
+ * @description Resolved discount configuration returned alongside an order or order preview. Preview responses include only the calculation inputs (bonus, coupon, orderDiscounts, productDiscounts, settings); created/updated orders also carry the totals and applied markers.
+ */
+interface IOrderDiscountConfig {
+    bonus?: IOrderDiscountBonus | null;
+    coupon: unknown | null;
+    orderDiscounts: unknown[];
+    productDiscounts: unknown[];
+    settings: IOrderDiscountSettings;
+    additionalDiscountsMarkers?: string[];
+    bonusApplied?: number;
+    excludedGiftProductIds?: string[];
+    totalDue?: number;
+    totalRaw?: number;
+    totalSumWithDiscount?: number;
+}
+/**
+ * Interface representing a response from the order storage.
+ * @interface IBaseOrdersEntityResponse
+ * @property {IBaseOrdersEntity[]} items - Array of order storage objects.
+ * @example
+    [
+      {
+        "id": 2957,
+        "title": "Cosmo",
+        "sku": null,
+        "previewImage": null,
+        "price": 150,
+        "quantity": 2
+      }
+    ]
+ * @property {string | number} total - Total number of found records. Example: 100.
+ * @description Represents a response from the order storage.
+ */
+interface IBaseOrdersEntityResponse {
+    items: IBaseOrdersEntity[];
+    total: string | number;
+}
+/**
+ * Interface representing an order storage object.
+ * @interface IOrdersEntity
+ * @property {number} id - Object identifier. Example: 1.
+ * @property {ILocalizeInfo} localizeInfos - Name considering localization.
+ * @example
+    {
+      "title": "Cash"
+    }
+ * @property {number | null} position - Position in orders storage. Example: 1.
+ * @property {string} identifier - Textual identifier for the record field. Example: "order_storage_1".
+ * @property {string} formIdentifier - Textual identifier for the form used by the order storage. Example: "bar-orders-form".
+ * @property {number | null} generalTypeId - Type identifier. Example: 1.
+ * @property {IPaymentAccountIdentifiers[]} paymentAccountIdentifiers - Array of textual identifiers of payment accounts used by the order storage.
+ * @example
+    [
+      {
+        "identifier": "payment-1"
+      }
+    ]
+ * @description Represents an order storage object.
+ */
+interface IOrdersEntity {
+    id: number;
+    localizeInfos: ILocalizeInfo;
+    position: number | null;
+    identifier: string | null;
+    formIdentifier: string | null;
+    generalTypeId: number | null;
+    paymentAccountIdentifiers: IPaymentAccountIdentifiers[];
+}
+/**
+ * Interface representing an identifier for a payment account used in an order.
+ * @interface IPaymentAccountIdentifiers
+ * @property {string} identifier - Textual identifier of the payment account. Example: "payment-1".
+ * @description Represents an identifier for a payment account used in an order.
+ */
+interface IPaymentAccountIdentifiers {
+    identifier: string;
+}
+/**
+ * Interface representing the data required to create or update an order in the order storage.
+ * @interface IOrderData
+ * @property {string} formIdentifier - Text identifier of the form object linked to the order repository. Example: "bar-orders-form".
+ * @property {string} paymentAccountIdentifier - Text identifier of the payment object linked to the order repository. Example: "payment-1".
+ * @property {IOrdersFormData | IOrdersFormData[]} formData - Form data linked to the order repository.
+ * @example
+    [
+      {
+        "marker": "name_1",
+        "value": "Name",
+        "type": "string"
+      }
+    ]
+ * @property {IOrderProductData[]} products - An array of ordered products. Example: [].
+ * @property {string} [couponCode] - Coupon code.
+ * @property {string[]} [additionalDiscountsMarkers] - Array of additional discount markers.
+ * @property {number} [bonusAmount] - Bonus amount to apply.
+ * @description Represents the data required to create or update an order in the order storage.
+ */
+interface IOrderData {
+    formIdentifier: string;
+    paymentAccountIdentifier: string;
+    formData: IOrdersFormData | IOrdersFormData[];
+    products: IOrderProductData[];
+    couponCode?: string;
+    additionalDiscountsMarkers?: string[];
+    bonusAmount?: number;
+}
+/**
+ * @interface IOrderSplitStage
+ * @property {string} marker - Stage marker. Example: "stage-1".
+ * @property {string | null} sessionId - Payment session identifier for the stage, or null when not yet started. Example: null.
+ * @property {number} productId - Identifier of the product covered by the stage. Example: 1.
+ * @property {string} title - Stage title. Example: "Deposit".
+ * @property {number} value - Stage amount. Example: 100.
+ * @property {string} status - Stage status. Example: "pending".
+ * @description A single stage of a split (staged) order payment.
+ */
+interface IOrderSplitStage {
+    marker: string;
+    sessionId: string | null;
+    productId: number;
+    title: string;
+    value: number;
+    status: string;
+}
+/**
+ * @interface IOrderSplit
+ * @property {boolean} completed - Whether all split stages are completed. Example: false.
+ * @property {boolean} partial - Whether the split is partially paid. Example: false.
+ * @property {IOrderSplitStage[]} stages - Ordered list of split payment stages.
+ * @description Split (staged) payment configuration of an order; returned by the by-id order endpoint.
+ */
+interface IOrderSplit {
+    completed: boolean;
+    partial: boolean;
+    stages: IOrderSplitStage[];
+}
+/**
+ * Interface representing an order product data.
+ * @interface IOrderByMarkerEntity
+ * @property {number} id - Object identifier. Example: 125.
+ * @property {number} storageId - Identifier of the order storage object. Example: 1.
+ * @property {string} createdDate - Date when the order was created. Example: "2023-10-01T12:00:00Z".
+ * @property {string} [statusIdentifier] - Text identifier of the order status. Example: "order-status-1".
+ * @property {string} [formIdentifier] - Text identifier of the form. Example: "bar-orders-form".
+ * @property {IOrdersFormData[]} formData - Data submitted by the form linked to the order store.
+ * @example
+    [
+      {
+        "marker": "order_name",
+        "value": "Ivan",
+        "type": "string"
+      }
+    ]
+ * @property {string | null} [attributeSetIdentifier] - Text identifier of the attribute set. Example: "attribute-set-1".
+ * @property {string} totalSum - Total order amount. Example: "100.00".
+ * @property {string} [totalSumRaw] - Raw total order amount with full precision. Example: "100.00".
+ * @property {string} currency - Currency used to pay for the order. Example: "USD".
+ * @property {string | null} [paymentAccountIdentifier] - Textual identifier for the order payment. Example: "payment-1".
+ * @property {ILocalizeInfo} [paymentAccountLocalizeInfos] - Payment account name considering localization.
+ * @example
+  {
+    "title": "Cash"
+  }
+ * @property {IOrderProducts[]} products - Array of products added to order.
+ * @example
+    [
+      {
+        "id": 1,
+        "name": "Product 1",
+        "quantity": 2
+      }
+    ]
+ * @property {string | null} paymentUrl - Payment link. Example: "https://example.com/pay/123".
+ * @property {boolean | null} isCompleted - Indicates that the order has been completed. Example: true.
+ * @property {boolean | null} [isPartial] - Indicates that the order is partially paid; null on older orders where it was not tracked. Example: false.
+ * @property {string} [paymentStrategy] - Payment strategy of the order. Example: "once".
+ * @property {ILocalizeInfo} [statusLocalizeInfos] - Localized status name.
+ * @property {string | null} [fulfillmentStatusIdentifier] - Text identifier of the fulfillment (delivery) status; null while no fulfillment status is assigned. Example: "shipped".
+ * @property {ILocalizeInfo | null} [fulfillmentStatusLocalizeInfos] - Localized fulfillment status name; null while no fulfillment status is assigned.
+ * @property {string | null} [paymentStatusIdentifier] - Text identifier of the payment status; null while no payment status is assigned. Example: "inProgress-payment".
+ * @property {ILocalizeInfo | null} [paymentStatusLocalizeInfos] - Localized payment status name; null while no payment status is assigned.
+ * @property {IOrderDiscountConfig | null} [discountConfig] - Resolved discount configuration applied to the order (orderDiscounts, productDiscounts, coupon, settings, bonus, totals); null on older orders without a resolved discount config.
+ * @property {IOrderSplit} [split] - Split (staged) payment configuration; present on the by-id order endpoint.
+ * @description Represents an order storage object created by the user.
+ */
+interface IOrderByMarkerEntity {
+    id: number;
+    storageId: number;
+    createdDate: string;
+    statusIdentifier?: string;
+    formIdentifier?: string;
+    formData: IOrdersFormData[];
+    attributeSetIdentifier?: string;
+    totalSum: string;
+    totalSumRaw?: string;
+    currency: string;
+    paymentAccountIdentifier?: string;
+    paymentAccountLocalizeInfos?: ILocalizeInfo;
+    paymentUrl: string | null;
+    products: IOrderProducts[];
+    isCompleted: boolean | null;
+    isPartial?: boolean | null;
+    paymentStrategy?: string;
+    statusLocalizeInfos?: ILocalizeInfo;
+    fulfillmentStatusIdentifier?: string | null;
+    fulfillmentStatusLocalizeInfos?: ILocalizeInfo | null;
+    paymentStatusIdentifier?: string | null;
+    paymentStatusLocalizeInfos?: ILocalizeInfo | null;
+    discountConfig?: IOrderDiscountConfig | null;
+    split?: IOrderSplit;
+}
+/**
+ * Interface representing an order status object.
+ * @interface IOrderStatus
+ * @property {number} [id] - Status identifier. Example: 1.
+ * @property {ILocalizeInfo} [localizeInfos] - Localized information for the status.
+ * @property {string} [identifier] - Text identifier of the status. Example: "inProgress-payment".
+ * @property {number} [position] - Position of the status. Example: 1.
+ * @property {boolean} [isUsed] - Whether the status is in use. Example: true.
+ * @property {boolean} [isDefault] - Whether the status is the default status. Example: true.
+ * @property {string} [axis] - Status axis (pipeline) the status belongs to. Example: "payment".
+ * @property {boolean} [isCancelFinal] - Whether the status is a final cancellation status. Example: false.
+ * @property {boolean} [isFinalSuccess] - Whether the status is a final successful status. Example: true.
+ * @property {boolean} [isMapped] - Whether the status is mapped to its axis. Example: true.
+ */
+interface IOrderStatus {
+    id?: number;
+    localizeInfos?: ILocalizeInfo;
+    identifier?: string;
+    position?: number;
+    isUsed?: boolean;
+    isDefault?: boolean;
+    axis?: string;
+    isCancelFinal?: boolean;
+    isFinalSuccess?: boolean;
+    isMapped?: boolean;
+}
+/**
+ * Interface representing a product in an order preview.
+ * @interface IPreviewOrderProduct
+ * @property {number} [productId] - Product identifier. Example: 1.
+ * @property {number} [quantity] - Quantity of the product. Example: 2.
+ */
+interface IPreviewOrderProduct {
+    productId?: number;
+    quantity?: number;
+}
+/**
+ * Interface representing the body for order preview calculation.
+ * @interface ICreateOrderPreview
+ * @property {IPreviewOrderProduct[]} [products] - Array of products to preview.
+ * @property {string} [couponCode] - Coupon code to apply.
+ * @property {string[]} [additionalDiscountsMarkers] - Array of additional discount markers.
+ * @property {number} [bonusAmount] - Bonus amount to apply.
+ */
+interface ICreateOrderPreview {
+    products?: IPreviewOrderProduct[];
+    couponCode?: string;
+    additionalDiscountsMarkers?: string[];
+    bonusAmount?: number;
+}
+/**
+ * @interface IOrderPreviewItem
+ * @property {number} id - Product identifier. Example: 2954.
+ * @property {number} price - Product unit price before discounts. Example: 51.
+ * @property {number} quantity - Quantity of the product. Example: 1.
+ * @property {number | null} discountPrice - Unit price after discounts, or null when no discount applies. Example: null.
+ * @property {boolean} isGift - Whether the product is delivered as a gift. Example: false.
+ * @description A single line item in the order preview response.
+ */
+interface IOrderPreviewItem {
+    id: number;
+    price: number;
+    quantity: number;
+    discountPrice: number | null;
+    isGift: boolean;
+}
+/**
+ * Interface representing the response from an order preview calculation.
+ * @interface IOrderPreviewResponse
+ * @property {number} totalSum - Total order amount before discounts. Example: 300.
+ * @property {number} totalSumWithDiscount - Total order amount after discounts. Example: 250.
+ * @property {IOrderDiscountConfig} discountConfig - Discount configuration applied to the order.
+ * @property {string} currency - Currency of the order. Example: "USD".
+ * @property {IOrderPreviewItem[]} orderPreview - Array of order preview items.
+ * @property {number} bonusApplied - Bonus applied to the order.
+ * @property {number} totalDue - Total due after bonuses.
+ */
+interface IOrderPreviewResponse {
+    totalSum: number;
+    totalSumWithDiscount: number;
+    discountConfig: IOrderDiscountConfig;
+    currency: string;
+    orderPreview: IOrderPreviewItem[];
+    bonusApplied: number;
+    totalDue: number;
+}
+/**
+ * @interface IRefundRequest
+ * @property {number} id - Refund request id.
+ * @property {string} createdDate - Creation date.
+ * @property {string} status - Refund status.
+ * @property {number} amount - Refund amount.
+ * @property {string} note - Refund note.
+ * @property {Record<string, IRefundProduct>} products - Map of product id to refund details.
+ * @property {number} orderId - Order id.
+ * @property {number} orderStorageId - Order storage id.
+ * @property {number} userId - User id.
+ * @property {unknown} orderStorage - Order storage data.
+ * @property {unknown} user - User data.
+ */
+interface IRefundRequest {
+    id: number;
+    createdDate: string;
+    status: string;
+    amount: number;
+    note: string;
+    products: Record<string, IRefundProduct>;
+    orderId: number;
+    orderStorageId: number;
+    userId: number;
+    orderStorage: unknown;
+    user: unknown;
+}
+/**
+ * @interface IRefundProduct
+ * @description Refund details for a single product.
+ * @property {number} quantity - Quantity of the product to refund. Example: 1.
+ */
+interface IRefundProduct {
+    quantity: number;
+}
+/**
+ * @interface ICreateRefundRequest
+ * @description Body for creating a refund request.
+ * @property {Record<string, IRefundProduct>} products - Map of product id to refund details. Example: `{ "146": { "quantity": 1 } }`.
+ * @property {string} [note] - Optional note for the refund request. Example: "test".
+ */
+interface ICreateRefundRequest {
+    products: Record<string, IRefundProduct>;
+    note?: string;
+}
+export type { IBaseOrdersEntity, IBaseOrdersEntityResponse, ICreateOrderPreview, ICreateRefundRequest, IOrderByMarkerEntity, IOrderData, IOrderDiscountBonus, IOrderDiscountConfig, IOrderDiscountSettings, IOrderPreviewItem, IOrderPreviewResponse, IOrderProductData, IOrderProducts, IOrdersApi, IOrdersByMarkerEntity, IOrdersEntity, IOrdersFormData, IOrderSplit, IOrderSplitStage, IOrderStatus, IOrdersVectorSearch, IPaymentAccountIdentifiers, IPicture, IPreviewOrderProduct, IRefundProduct, IRefundRequest, };