@djust-b2b/djust-front-sdk 1.28.0 → 1.29.0

package/lib/index.d.ts

@@ -21,6 +21,7 @@ export declare const DjustSDK: {
     updateCommercialOrderShippingInformation({ orderId, shippingAddressId, shippingType, }: import("./interfaces").UpdateCommercialOrderShippingInformationParameters): Promise<void>;
     updateCommercialOrderShippingType({ orderId, shippingType, }: import("./interfaces").UpdateCommercialOrderShippingTypeParameters): Promise<void>;
     deleteCommercialOrder(commercialOrderId: string): Promise<void>;
+    getCommercialOrderLines({ commercialOrderId, page, size, sort, supplierIds, productVariantIds, offerPriceIds, idType, locale, }: import("./interfaces").GetOrderCommercialLinesParameters): Promise<import("./interfaces").GetOrderCommercialLinesResponse>;
     updateCommercialOrderLines({ commercialOrderId, customFieldIdType, lineIdType, lineType, updateOrderCommercialLines, updateOrderLineIdType, updateOrderLineType, }: import("./interfaces").UpdateCommercialOrderLinesParameters): Promise<import("./interfaces").UpdateCommercialOrderLinesResponse>;
     deleteCommercialOrderLines({ commercialOrderId, body, }: import("./interfaces").DeleteCommercialOrderLinesParameters): Promise<import("./interfaces").DeleteCommercialOrderLinesResponse>;
     punchoutOciCommercialOrder({ tenantConfigurationKey, commercialOrderId, locale, }: import("./interfaces").PunchoutOciCommercialOrderParameters): Promise<any>;

package/lib/interfaces/models/order.d.ts

@@ -288,6 +288,36 @@ export interface PageOrderLogisticLineDto {
     totalElements: number;
     totalPages: number;
 }
+export interface PageOrderCommercialLinesDto {
+    content: OrderCommercialLineDto[];
+    empty: boolean;
+    first: boolean;
+    last: boolean;
+    number: number;
+    numberOfElements: number;
+    pageable: PageableObject;
+    size: number;
+    sort: Order[];
+    totalElements: number;
+    totalPages: number;
+}
+export interface OrderCommercialLineDto {
+    confirmedQuantity: number;
+    customFieldValues: OrderCommercialLineCustomFieldValuesDto[];
+    externalId: string;
+    externalSource: string;
+    id: string;
+    incidentDeclared: boolean;
+    offerInventorySnapshotDto: OrderCommercialLineOfferInventoryDto;
+    offerPriceSnapshotDto: OrderCommercialLineOfferPriceDto;
+    orderLogisticLinePriceDto: OrderLogisticLinePriceDto;
+    orderLogisticLineProductDto: OrderLogisticLineProductDto;
+    orderLogisticLineProductVariantDto: OrderLogisticLineProductVariantDto;
+    paymentStatus: string;
+    quantity: number;
+    quoteLineExternalId: string;
+    status: string;
+}
 export interface ShippingTypeInformationDto {
     code: string;
     earliestDays: number;
@@ -375,6 +405,40 @@ export interface ThreadCustomFiedValuesDto {
     };
     value: unknown;
 }
+export interface OrderCommercialLineCustomFieldValuesDto extends ThreadCustomFiedValuesDto {
+}
+export interface OrderCommercialLineOfferInventoryDto extends ThreadCustomFiedValuesDto {
+    currency: string;
+    customFieldValueSnapshots: OrderCommercialLineCustomFieldValuesDto[];
+    externalSource: string;
+    offerInventoryExternalId: string;
+    packingType: string;
+    productTaxCode: string;
+    productTaxRate: number;
+    quantityPerItem: number;
+    shippingTaxCode: string;
+    shippingTaxRate: number;
+}
+export interface OrderCommercialLineOfferPriceDto {
+    confirmedProductPriceWithoutTaxes: number;
+    itemPerPack: number;
+    offerPriceExternalId: string;
+    offerPriceType: string;
+    offerPriceTypeValue: string;
+    productPriceWithTaxes: number;
+    productPriceWithoutTaxes: number;
+    productTaxAmount: number;
+    shippingPriceWithTaxes: number;
+    shippingPriceWithoutTaxes: number;
+    shippingTaxAmount: number;
+    taxLegalNotice: string;
+    totalPriceWithTaxes: number;
+    totalPriceWithoutTaxes: number;
+    totalProductPriceWithTaxes: number;
+    totalProductPriceWithoutTaxes: number;
+    totalProductTaxAmount: number;
+    totalTaxAmount: number;
+}
 export interface RequestGetAccountingDocumentLinkbyID {
     orderLogisticId: string;
     docId: string;

package/lib/services/commercial-order/definitions.d.ts

@@ -1,6 +1,6 @@
 import { Channel, Currency, IdType } from "../../interfaces/models/common";
 import { CustomFieldValueRequest } from "../../interfaces/models/custom-field";
-import { BrowserInfo, CardInformationDto, OrderCommercialDto, OrderIdType, OrderLogisticDto, OrderOrigin, PageOrderCommercialDto, PaymentCardInfo, PreauthorizationDto, OfferToDelete, OrderLogisticLineUpdate, OrderLineType } from "../../interfaces/models/order";
+import { BrowserInfo, CardInformationDto, OrderCommercialDto, OrderIdType, OrderLogisticDto, OrderOrigin, PageOrderCommercialDto, PaymentCardInfo, PreauthorizationDto, OfferToDelete, OrderLogisticLineUpdate, OrderLineType, PageOrderCommercialLinesDto } from "../../interfaces/models/order";
 import { SingleWarningReportDto } from "../../interfaces/models/common";
 import { PaymentInfoRequest, PaymentOption, PaymentProvider } from "../../interfaces/models/payment";
 /**
@@ -10,6 +10,17 @@ export interface GetCommercialOrdersParameters {
     locale: string;
     nbPreviewLines?: number;
 }
+export interface GetOrderCommercialLinesParameters {
+    commercialOrderId: string;
+    page?: number;
+    size?: number;
+    sort?: string;
+    supplierIds?: string[];
+    productVariantIds?: string[];
+    offerPriceIds: string[];
+    idType?: IdType;
+    locale?: string;
+}
 export interface CreateCommercialOrderParameters {
     nbPreviewLines?: number;
     channel?: Channel;
@@ -109,6 +120,8 @@ export interface UpdateCommercialOrderLinesParameters {
 }
 export interface GetCommercialOrderResponse extends OrderCommercialDto {
 }
+export interface GetOrderCommercialLinesResponse extends PageOrderCommercialLinesDto {
+}
 export interface CreateCommercialOrderCardRegistrationResponse extends CardInformationDto {
 }
 export interface CreateCommercialOrderPreauthorizationResponse extends PreauthorizationDto {

package/lib/services/commercial-order/index.d.ts

@@ -1,4 +1,4 @@
-import { CreateCommercialOrderCardRegistrationParameters, CreateCommercialOrderCardRegistrationResponse, CreateCommercialOrderParameters, CreateCommercialOrderResponse, CreateCommercialOrderV2Parameters, CreateCommercialOrderV2Response, UpdateCommercialOrderParameters, DeleteCommercialOrderLinesParameters, DeleteCommercialOrderLinesResponse, UpdateCommercialOrderLinesParameters, UpdateCommercialOrderLinesResponse, CreateCommercialOrderPreauthorizationParameters, CreateCommercialOrderPreauthorizationResponse, GetCommercialOrderParameters, GetCommercialOrderPaymentPageUrlParameters, GetCommercialOrderResponse, GetCommercialOrdersParameters, GetCommercialOrdersResponse, SetCommercialOrderStatusAsCreatedParameters, SetCommercialOrderStatusAsOnHoldParameters, UpdateCommercialOrderBillingInformationParameters, UpdateCommercialOrderShippingAddressParameters, UpdateCommercialOrderShippingInformationParameters, UpdateCommercialOrderShippingTypeParameters, PunchoutOciCommercialOrderParameters } from "./definitions";
+import { CreateCommercialOrderCardRegistrationParameters, CreateCommercialOrderCardRegistrationResponse, CreateCommercialOrderParameters, CreateCommercialOrderResponse, CreateCommercialOrderV2Parameters, CreateCommercialOrderV2Response, UpdateCommercialOrderParameters, DeleteCommercialOrderLinesParameters, DeleteCommercialOrderLinesResponse, UpdateCommercialOrderLinesParameters, UpdateCommercialOrderLinesResponse, CreateCommercialOrderPreauthorizationParameters, CreateCommercialOrderPreauthorizationResponse, GetCommercialOrderParameters, GetCommercialOrderPaymentPageUrlParameters, GetCommercialOrderResponse, GetCommercialOrdersParameters, GetCommercialOrdersResponse, SetCommercialOrderStatusAsCreatedParameters, SetCommercialOrderStatusAsOnHoldParameters, UpdateCommercialOrderBillingInformationParameters, UpdateCommercialOrderShippingAddressParameters, UpdateCommercialOrderShippingInformationParameters, UpdateCommercialOrderShippingTypeParameters, GetOrderCommercialLinesParameters, GetOrderCommercialLinesResponse, PunchoutOciCommercialOrderParameters } from "./definitions";
 /**
  * COMMERCIAL ORDER ENDPOINT
  */
@@ -479,6 +479,45 @@ export declare function updateCommercialOrderShippingType({ orderId, shippingTyp
  * @returns {Promise<void>} A promise resolving when the commercial order is successfully deleted.
  */
 export declare function deleteCommercialOrder(commercialOrderId: string): Promise<void>;
+/**
+ * 🚚 Gets commercial order lines.
+ *
+ * This function retrieves the lines of a commercial order identified by the `commercialOrderId`.
+ * The `commercialOrderId` parameter is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/commercial-orders/${commercialOrderId}/lines` [ORDER-561]
+ *
+ * | Parameter           | Type               | Required  | Description                                                    |
+ * |---------------------|--------------------|-----------|----------------------------------------------------------------|
+ * | `commercialOrderId` | `string`           | ✅        | The ID of the commercial order whose lines are to be retrieved |
+ * | `page`              | `number`           | ❌        | The page number to retrieve                                    |
+ * | `size`              | `number`           | ❌        | The number of items per page                                   |
+ * | `sort`              | `string`           | ❌        | The sort to apply to the results                               |
+ * | `supplierIds`       | `string[]`         | ❌        | Filter by supplier IDs                                         |
+ * | `productVariantIds` | `string[]`         | ❌        | Filter by product variant IDs                                  |
+ * | `offerPriceIds`     | `string[]`         | ❌        | Filter by offer price IDs                                      |
+ * | `idType`            | `string`           | ❌        | The ID type to use                                             |
+ * | `locale`            | `string`           | ❌        | The locale for the response data                               |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetOrderCommercialLinesResponse` object containing the commercial order lines.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await getCommercialOrderLines({
+ *   commercialOrderId: "commercialOrder123",
+ *   page: 0,
+ *   size: 20,
+ *   sort: "createdAt,desc",
+ *   locale: "fr"
+ * });
+ * ```
+ *
+ * @param {GetOrderCommercialLinesParameters} params - The parameters for the request
+ * @throws {Error} If `commercialOrderId` is missing
+ * @returns {Promise<GetOrderCommercialLinesResponse>} A promise resolving to the response containing the commercial order lines
+ */
+export declare function getCommercialOrderLines({ commercialOrderId, page, size, sort, supplierIds, productVariantIds, offerPriceIds, idType, locale, }: GetOrderCommercialLinesParameters): Promise<GetOrderCommercialLinesResponse>;
 /**
  * 🚚 Update specific commercial order lines.
  *

package/lib/services/commercial-order/index.js

@@ -15,6 +15,7 @@ exports.updateCommercialOrderShippingAddress = updateCommercialOrderShippingAddr
 exports.updateCommercialOrderShippingInformation = updateCommercialOrderShippingInformation;
 exports.updateCommercialOrderShippingType = updateCommercialOrderShippingType;
 exports.deleteCommercialOrder = deleteCommercialOrder;
+exports.getCommercialOrderLines = getCommercialOrderLines;
 exports.updateCommercialOrderLines = updateCommercialOrderLines;
 exports.deleteCommercialOrderLines = deleteCommercialOrderLines;
 exports.punchoutOciCommercialOrder = punchoutOciCommercialOrder;
@@ -654,6 +655,62 @@ async function deleteCommercialOrder(commercialOrderId) {
         path: `/v2/shop/commercial-orders/${commercialOrderId}`,
     });
 }
+/**
+ * 🚚 Gets commercial order lines.
+ *
+ * This function retrieves the lines of a commercial order identified by the `commercialOrderId`.
+ * The `commercialOrderId` parameter is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/commercial-orders/${commercialOrderId}/lines` [ORDER-561]
+ *
+ * | Parameter           | Type               | Required  | Description                                                    |
+ * |---------------------|--------------------|-----------|----------------------------------------------------------------|
+ * | `commercialOrderId` | `string`           | ✅        | The ID of the commercial order whose lines are to be retrieved |
+ * | `page`              | `number`           | ❌        | The page number to retrieve                                    |
+ * | `size`              | `number`           | ❌        | The number of items per page                                   |
+ * | `sort`              | `string`           | ❌        | The sort to apply to the results                               |
+ * | `supplierIds`       | `string[]`         | ❌        | Filter by supplier IDs                                         |
+ * | `productVariantIds` | `string[]`         | ❌        | Filter by product variant IDs                                  |
+ * | `offerPriceIds`     | `string[]`         | ❌        | Filter by offer price IDs                                      |
+ * | `idType`            | `string`           | ❌        | The ID type to use                                             |
+ * | `locale`            | `string`           | ❌        | The locale for the response data                               |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetOrderCommercialLinesResponse` object containing the commercial order lines.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await getCommercialOrderLines({
+ *   commercialOrderId: "commercialOrder123",
+ *   page: 0,
+ *   size: 20,
+ *   sort: "createdAt,desc",
+ *   locale: "fr"
+ * });
+ * ```
+ *
+ * @param {GetOrderCommercialLinesParameters} params - The parameters for the request
+ * @throws {Error} If `commercialOrderId` is missing
+ * @returns {Promise<GetOrderCommercialLinesResponse>} A promise resolving to the response containing the commercial order lines
+ */
+async function getCommercialOrderLines({ commercialOrderId, page, size, sort, supplierIds, productVariantIds, offerPriceIds, idType, locale, }) {
+    (0, parameters_validation_1.required)({ commercialOrderId });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/v1/shop/commercial-orders/${commercialOrderId}/lines`,
+        params: {
+            page,
+            sort,
+            size,
+            supplierIds,
+            productVariantIds,
+            offerPriceIds,
+            idType,
+            locale,
+        },
+    });
+    return data;
+}
 /**
  * 🚚 Update specific commercial order lines.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@djust-b2b/djust-front-sdk",
-  "version": "1.28.0",
+  "version": "1.29.0",
   "description": "DJUST Front SDK is a versatile JavaScript Software Development Kit (SDK)",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",