@djust-b2b/djust-front-sdk 2.18.0 → 2.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.d.ts
CHANGED
|
@@ -74,6 +74,7 @@ export declare const DjustSDK: {
|
|
|
74
74
|
getLogisticOrderDocumentUrl({ orderId, documentId, }: import("./interfaces").GetLogisticOrderDocumentUrlParameters): Promise<string[]>;
|
|
75
75
|
getLogisticOrderLines({ orderId, page, size, sort, locale, }: import("./interfaces").GetLogisticOrderLinesParameters): Promise<import("./interfaces").GetLogisticOrderLinesResponse>;
|
|
76
76
|
updateOnHoldLogisticOrderLines({ orderId, lines, }: import("./interfaces").UpdateOnHoldLogisticOrderLinesParameters): Promise<import("./interfaces").UpdateOnHoldLogisticOrderLinesResponse>;
|
|
77
|
+
bulkUpdateLogisticOrderLinesCustomFields({ logisticOrderId, lines, }: import("./interfaces").BulkUpdateLogisticOrderLinesCustomFieldsParameters): Promise<import("./interfaces").BulkUpdateLogisticOrderLinesCustomFieldsResponse>;
|
|
77
78
|
updateLogisticOrderLineCustomFields({ orderId, lineId, locale, customFields, }: import("./interfaces").UpdateLogisticOrderLineCustomFieldsParameters): Promise<import("./interfaces").UpdateLogisticOrderLineCustomFieldsResponse>;
|
|
78
79
|
updateOnHoldLogisticOrderLine({ orderId, orderLineId, quantity, }: import("./interfaces").UpdateOnHoldLogisticOrderLineParameters): Promise<void>;
|
|
79
80
|
updateLogisticOrderShippingAddress({ orderId, shippingAddressId, }: import("./interfaces").UpdateLogisticOrderShippingAddressParameters): Promise<void>;
|
|
@@ -124,6 +124,25 @@ export interface UpdateOnHoldLogisticOrderLinesParameters {
|
|
|
124
124
|
orderId: string;
|
|
125
125
|
lines: OrderLogisticLineUpdate[];
|
|
126
126
|
}
|
|
127
|
+
/** ORDER-251 — one entry per logistic order line in the bulk PATCH body. */
|
|
128
|
+
export interface BulkUpdateLogisticOrderLinesCustomFieldsLineItem {
|
|
129
|
+
customFieldValues: CustomFieldValueRequest[];
|
|
130
|
+
logisticOrderLineId: string;
|
|
131
|
+
}
|
|
132
|
+
export interface BulkUpdateLogisticOrderLinesCustomFieldsParameters {
|
|
133
|
+
/** Logistic order reference (e.g. OL-2025-001234). Requires dj-client: ACCOUNT. */
|
|
134
|
+
logisticOrderId: string;
|
|
135
|
+
lines: BulkUpdateLogisticOrderLinesCustomFieldsLineItem[];
|
|
136
|
+
}
|
|
137
|
+
/** Per-line warning when bulk update runs in partial success mode (ORDER-251). */
|
|
138
|
+
export interface LogisticOrderLineBulkCustomFieldWarning {
|
|
139
|
+
code: string;
|
|
140
|
+
logisticOrderLineId: string;
|
|
141
|
+
message: string;
|
|
142
|
+
}
|
|
143
|
+
export interface BulkUpdateLogisticOrderLinesCustomFieldsResponse {
|
|
144
|
+
warnings: LogisticOrderLineBulkCustomFieldWarning[];
|
|
145
|
+
}
|
|
127
146
|
export interface UpdateLogisticOrderLineCustomFieldsParameters {
|
|
128
147
|
orderId: string;
|
|
129
148
|
lineId: string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AddLogisticOrderReviewParameters, AddLogisticOrderReviewResponse, ApproveLogisticOrderParameters, ApproveLogisticOrderResponse, CancelLogisticOrderParameters, CancelLogisticOrderResponse, ConfirmLogisticOrderReceptionParameters, ConfirmLogisticOrderReceptionResponse, CreateLogisticOrderParameters, CreateLogisticOrderThreadParameters, GetPaginatedLogisticOrdersParameters, GetPaginatedLogisticOrdersResponse, CreateLogisticOrderThreadResponse, DisapproveLogisticOrderParameters, DisapproveLogisticOrderResponse, GetLogisticOrderAccountingDocumentsParameters, GetLogisticOrderAccountingDocumentsResponse, GetLogisticOrderAccountingDocumentUrlParameters, GetLogisticOrderApproversParameters, GetLogisticOrderApproversResponse, GetLogisticOrderCustomFieldsParameters, GetLogisticOrderCustomFieldsResponse, GetLogisticOrderDocumentsParameters, GetLogisticOrderDocumentsResponse, GetLogisticOrderDocumentUrlParameters, GetLogisticOrderLineCustomFieldsParameters, GetLogisticOrderLineCustomFieldsResponse, GetLogisticOrderLinesParameters, GetLogisticOrderLinesResponse, GetLogisticOrderParameters, GetLogisticOrderResponse, GetLogisticOrderReviewParameters, GetLogisticOrderReviewResponse, GetLogisticOrderShippingAddressParameters, GetLogisticOrderShippingAddressResponse, GetLogisticOrdersParameters, GetLogisticOrdersResponse, GetThreadReasonTypesResponse, GetThreadSubReasonsParameters, GetThreadSubReasonsResponse, UpdateLogisticOrderBillingInformationParameters, UpdateLogisticOrderCustomFieldsParameters, UpdateLogisticOrderCustomFieldsResponse, UpdateLogisticOrderLineCustomFieldsParameters, UpdateLogisticOrderLineCustomFieldsResponse, UpdateLogisticOrderShippingAddressParameters, UpdateLogisticOrderShippingInformationParameters, UpdateLogisticOrderShippingTypeParameters, UpdateOnHoldLogisticOrderLineParameters, UpdateOnHoldLogisticOrderLinesParameters, UpdateOnHoldLogisticOrderLinesResponse, CreateLogisticOrderIncidentThreadsParams, CreateLogisticOrderIncidentThreadsResponse, GetLogisticOrderIncidentThreadParams, GetLogisticOrderIncidentThreadResponse, CreateLogisticOrderIncidentThreadMessagesParams, CreateLogisticOrderIncidentThreadMessagesResponse, UpdateLogisticOrderIncidentThreadMessageParams, GetLogisticOrderThreadsParams, GetLogisticOrderThreadsResponse, CreateLogisticOrderThreadParametersV2, CreateLogisticOrderThreadResponseV2, GetLogisticOrderThreadParams, GetLogisticOrderThreadResponse, CreateLogisticOrderThreadMessagesParams, CreateLogisticOrderThreadMessagesResponse, UpdateLogisticOrderThreadMessageParams } from "./definitions";
|
|
1
|
+
import { AddLogisticOrderReviewParameters, AddLogisticOrderReviewResponse, ApproveLogisticOrderParameters, ApproveLogisticOrderResponse, CancelLogisticOrderParameters, CancelLogisticOrderResponse, ConfirmLogisticOrderReceptionParameters, ConfirmLogisticOrderReceptionResponse, CreateLogisticOrderParameters, CreateLogisticOrderThreadParameters, GetPaginatedLogisticOrdersParameters, GetPaginatedLogisticOrdersResponse, CreateLogisticOrderThreadResponse, DisapproveLogisticOrderParameters, DisapproveLogisticOrderResponse, GetLogisticOrderAccountingDocumentsParameters, GetLogisticOrderAccountingDocumentsResponse, GetLogisticOrderAccountingDocumentUrlParameters, GetLogisticOrderApproversParameters, GetLogisticOrderApproversResponse, GetLogisticOrderCustomFieldsParameters, GetLogisticOrderCustomFieldsResponse, GetLogisticOrderDocumentsParameters, GetLogisticOrderDocumentsResponse, GetLogisticOrderDocumentUrlParameters, GetLogisticOrderLineCustomFieldsParameters, GetLogisticOrderLineCustomFieldsResponse, GetLogisticOrderLinesParameters, GetLogisticOrderLinesResponse, GetLogisticOrderParameters, GetLogisticOrderResponse, GetLogisticOrderReviewParameters, GetLogisticOrderReviewResponse, GetLogisticOrderShippingAddressParameters, GetLogisticOrderShippingAddressResponse, GetLogisticOrdersParameters, GetLogisticOrdersResponse, GetThreadReasonTypesResponse, GetThreadSubReasonsParameters, GetThreadSubReasonsResponse, UpdateLogisticOrderBillingInformationParameters, UpdateLogisticOrderCustomFieldsParameters, UpdateLogisticOrderCustomFieldsResponse, UpdateLogisticOrderLineCustomFieldsParameters, UpdateLogisticOrderLineCustomFieldsResponse, UpdateLogisticOrderShippingAddressParameters, UpdateLogisticOrderShippingInformationParameters, UpdateLogisticOrderShippingTypeParameters, UpdateOnHoldLogisticOrderLineParameters, UpdateOnHoldLogisticOrderLinesParameters, UpdateOnHoldLogisticOrderLinesResponse, BulkUpdateLogisticOrderLinesCustomFieldsParameters, BulkUpdateLogisticOrderLinesCustomFieldsResponse, CreateLogisticOrderIncidentThreadsParams, CreateLogisticOrderIncidentThreadsResponse, GetLogisticOrderIncidentThreadParams, GetLogisticOrderIncidentThreadResponse, CreateLogisticOrderIncidentThreadMessagesParams, CreateLogisticOrderIncidentThreadMessagesResponse, UpdateLogisticOrderIncidentThreadMessageParams, GetLogisticOrderThreadsParams, GetLogisticOrderThreadsResponse, CreateLogisticOrderThreadParametersV2, CreateLogisticOrderThreadResponseV2, GetLogisticOrderThreadParams, GetLogisticOrderThreadResponse, CreateLogisticOrderThreadMessagesParams, CreateLogisticOrderThreadMessagesResponse, UpdateLogisticOrderThreadMessageParams } from "./definitions";
|
|
2
2
|
/**
|
|
3
3
|
* @deprecated
|
|
4
4
|
* 🚚 Gets logistic orders.
|
|
@@ -639,6 +639,44 @@ export declare function getLogisticOrderLines({ orderId, page, size, sort, local
|
|
|
639
639
|
* @returns {Promise<UpdateOnHoldLogisticOrderLinesResponse>} A promise resolving to the response containing the error report.
|
|
640
640
|
*/
|
|
641
641
|
export declare function updateOnHoldLogisticOrderLines({ orderId, lines, }: UpdateOnHoldLogisticOrderLinesParameters): Promise<UpdateOnHoldLogisticOrderLinesResponse>;
|
|
642
|
+
/**
|
|
643
|
+
* 🚚 Bulk-updates custom field values on multiple lines of a logistic order (partial success).
|
|
644
|
+
*
|
|
645
|
+
* Each line is processed independently: valid lines are updated; failures appear in `warnings`.
|
|
646
|
+
* An empty `warnings` array means every line succeeded. Requires `dj-client: ACCOUNT`; the order
|
|
647
|
+
* must belong to the authenticated customer. `logisticOrderId` is the order **reference**
|
|
648
|
+
* (e.g. OL-2025-001234), not necessarily an internal id.
|
|
649
|
+
*
|
|
650
|
+
* 🛠 **Endpoint**: `PATCH /v1/shop/logistic-orders/${logisticOrderId}/lines [ORDER-251]`
|
|
651
|
+
*
|
|
652
|
+
* | Parameter | Type | Required | Description |
|
|
653
|
+
* |--------------------|---------------------------------------------------|----------|--------------------------------------------------|
|
|
654
|
+
* | `logisticOrderId` | `string` | ✅ | Logistic order reference. |
|
|
655
|
+
* | `lines` | `BulkUpdateLogisticOrderLinesCustomFieldsLineItem[]` | ✅ | Lines with `logisticOrderLineId` and `customFieldValues`. Max 100 entries, no duplicates (422 if invalid). |
|
|
656
|
+
*
|
|
657
|
+
* 📤 **Returns**:
|
|
658
|
+
* A `Promise` resolving to `BulkUpdateLogisticOrderLinesCustomFieldsResponse` (`warnings` only lists lines that failed validation).
|
|
659
|
+
*
|
|
660
|
+
* 🛠 **Example usage**:
|
|
661
|
+
* ```ts
|
|
662
|
+
* const { warnings } = await bulkUpdateLogisticOrderLinesCustomFields({
|
|
663
|
+
* logisticOrderId: "OL-2025-001234",
|
|
664
|
+
* lines: [
|
|
665
|
+
* {
|
|
666
|
+
* logisticOrderLineId: "LOG-LINE-001",
|
|
667
|
+
* customFieldValues: [
|
|
668
|
+
* { customFieldId: "cf-1", customFieldValue: "value1" },
|
|
669
|
+
* ],
|
|
670
|
+
* },
|
|
671
|
+
* ],
|
|
672
|
+
* });
|
|
673
|
+
* ```
|
|
674
|
+
*
|
|
675
|
+
* @param {BulkUpdateLogisticOrderLinesCustomFieldsParameters} params - Path id and line payloads.
|
|
676
|
+
* @throws {Error} If `logisticOrderId` or `lines` is missing.
|
|
677
|
+
* @returns {Promise<BulkUpdateLogisticOrderLinesCustomFieldsResponse>}
|
|
678
|
+
*/
|
|
679
|
+
export declare function bulkUpdateLogisticOrderLinesCustomFields({ logisticOrderId, lines, }: BulkUpdateLogisticOrderLinesCustomFieldsParameters): Promise<BulkUpdateLogisticOrderLinesCustomFieldsResponse>;
|
|
642
680
|
/**
|
|
643
681
|
* 🚚 Updates specific logistic order line's customFields.
|
|
644
682
|
*
|
|
@@ -19,6 +19,7 @@ exports.getLogisticOrderDocuments = getLogisticOrderDocuments;
|
|
|
19
19
|
exports.getLogisticOrderDocumentUrl = getLogisticOrderDocumentUrl;
|
|
20
20
|
exports.getLogisticOrderLines = getLogisticOrderLines;
|
|
21
21
|
exports.updateOnHoldLogisticOrderLines = updateOnHoldLogisticOrderLines;
|
|
22
|
+
exports.bulkUpdateLogisticOrderLinesCustomFields = bulkUpdateLogisticOrderLinesCustomFields;
|
|
22
23
|
exports.updateLogisticOrderLineCustomFields = updateLogisticOrderLineCustomFields;
|
|
23
24
|
exports.updateOnHoldLogisticOrderLine = updateOnHoldLogisticOrderLine;
|
|
24
25
|
exports.updateLogisticOrderShippingAddress = updateLogisticOrderShippingAddress;
|
|
@@ -900,6 +901,52 @@ async function updateOnHoldLogisticOrderLines({ orderId, lines, }) {
|
|
|
900
901
|
});
|
|
901
902
|
return data;
|
|
902
903
|
}
|
|
904
|
+
/**
|
|
905
|
+
* 🚚 Bulk-updates custom field values on multiple lines of a logistic order (partial success).
|
|
906
|
+
*
|
|
907
|
+
* Each line is processed independently: valid lines are updated; failures appear in `warnings`.
|
|
908
|
+
* An empty `warnings` array means every line succeeded. Requires `dj-client: ACCOUNT`; the order
|
|
909
|
+
* must belong to the authenticated customer. `logisticOrderId` is the order **reference**
|
|
910
|
+
* (e.g. OL-2025-001234), not necessarily an internal id.
|
|
911
|
+
*
|
|
912
|
+
* 🛠 **Endpoint**: `PATCH /v1/shop/logistic-orders/${logisticOrderId}/lines [ORDER-251]`
|
|
913
|
+
*
|
|
914
|
+
* | Parameter | Type | Required | Description |
|
|
915
|
+
* |--------------------|---------------------------------------------------|----------|--------------------------------------------------|
|
|
916
|
+
* | `logisticOrderId` | `string` | ✅ | Logistic order reference. |
|
|
917
|
+
* | `lines` | `BulkUpdateLogisticOrderLinesCustomFieldsLineItem[]` | ✅ | Lines with `logisticOrderLineId` and `customFieldValues`. Max 100 entries, no duplicates (422 if invalid). |
|
|
918
|
+
*
|
|
919
|
+
* 📤 **Returns**:
|
|
920
|
+
* A `Promise` resolving to `BulkUpdateLogisticOrderLinesCustomFieldsResponse` (`warnings` only lists lines that failed validation).
|
|
921
|
+
*
|
|
922
|
+
* 🛠 **Example usage**:
|
|
923
|
+
* ```ts
|
|
924
|
+
* const { warnings } = await bulkUpdateLogisticOrderLinesCustomFields({
|
|
925
|
+
* logisticOrderId: "OL-2025-001234",
|
|
926
|
+
* lines: [
|
|
927
|
+
* {
|
|
928
|
+
* logisticOrderLineId: "LOG-LINE-001",
|
|
929
|
+
* customFieldValues: [
|
|
930
|
+
* { customFieldId: "cf-1", customFieldValue: "value1" },
|
|
931
|
+
* ],
|
|
932
|
+
* },
|
|
933
|
+
* ],
|
|
934
|
+
* });
|
|
935
|
+
* ```
|
|
936
|
+
*
|
|
937
|
+
* @param {BulkUpdateLogisticOrderLinesCustomFieldsParameters} params - Path id and line payloads.
|
|
938
|
+
* @throws {Error} If `logisticOrderId` or `lines` is missing.
|
|
939
|
+
* @returns {Promise<BulkUpdateLogisticOrderLinesCustomFieldsResponse>}
|
|
940
|
+
*/
|
|
941
|
+
async function bulkUpdateLogisticOrderLinesCustomFields({ logisticOrderId, lines, }) {
|
|
942
|
+
(0, parameters_validation_1.required)({ logisticOrderId, lines });
|
|
943
|
+
const { data } = await (0, fetch_instance_1.enhancedFetch)({
|
|
944
|
+
method: "PATCH",
|
|
945
|
+
path: `/v1/shop/logistic-orders/${logisticOrderId}/lines`,
|
|
946
|
+
body: JSON.stringify(lines),
|
|
947
|
+
});
|
|
948
|
+
return data;
|
|
949
|
+
}
|
|
903
950
|
/**
|
|
904
951
|
* 🚚 Updates specific logistic order line's customFields.
|
|
905
952
|
*
|