@djust-b2b/djust-front-sdk 3.0.0-beta.2 → 3.0.0-beta.20
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/README.md +51 -7
- package/dist/.tsbuildinfo +1 -0
- package/dist/.tsbuildinfo-esm +1 -0
- package/dist/client/create-client.d.ts +248 -0
- package/dist/client/create-client.d.ts.map +1 -0
- package/dist/client/index.d.ts +14 -0
- package/dist/client/index.d.ts.map +1 -0
- package/dist/client/performance.d.ts +203 -0
- package/dist/client/performance.d.ts.map +1 -0
- package/dist/client/transport.d.ts +372 -0
- package/dist/client/transport.d.ts.map +1 -0
- package/dist/errors/base.d.ts +101 -0
- package/dist/errors/base.d.ts.map +1 -0
- package/dist/errors/classes/auth.error.d.ts +64 -0
- package/dist/errors/classes/auth.error.d.ts.map +1 -0
- package/dist/errors/classes/forbidden.error.d.ts +52 -0
- package/dist/errors/classes/forbidden.error.d.ts.map +1 -0
- package/dist/errors/classes/index.d.ts +17 -0
- package/dist/errors/classes/index.d.ts.map +1 -0
- package/dist/errors/classes/network.error.d.ts +63 -0
- package/dist/errors/classes/network.error.d.ts.map +1 -0
- package/dist/errors/classes/not-found.error.d.ts +58 -0
- package/dist/errors/classes/not-found.error.d.ts.map +1 -0
- package/dist/errors/classes/rate-limit.error.d.ts +49 -0
- package/dist/errors/classes/rate-limit.error.d.ts.map +1 -0
- package/dist/errors/classes/server.error.d.ts +63 -0
- package/dist/errors/classes/server.error.d.ts.map +1 -0
- package/dist/errors/classes/timeout.error.d.ts +64 -0
- package/dist/errors/classes/timeout.error.d.ts.map +1 -0
- package/dist/errors/classes/unexpected.error.d.ts +70 -0
- package/dist/errors/classes/unexpected.error.d.ts.map +1 -0
- package/dist/errors/classes/validation.error.d.ts +68 -0
- package/dist/errors/classes/validation.error.d.ts.map +1 -0
- package/dist/errors/codes.d.ts +111 -0
- package/dist/errors/codes.d.ts.map +1 -0
- package/dist/errors/compat.d.ts +99 -0
- package/dist/errors/compat.d.ts.map +1 -0
- package/dist/errors/factory.d.ts +33 -0
- package/dist/errors/factory.d.ts.map +1 -0
- package/dist/errors/guards.d.ts +142 -0
- package/dist/errors/guards.d.ts.map +1 -0
- package/dist/errors/index.d.ts +25 -0
- package/dist/errors/index.d.ts.map +1 -0
- package/dist/errors/types.d.ts +100 -0
- package/dist/errors/types.d.ts.map +1 -0
- package/dist/helpers/index.d.ts +42 -0
- package/dist/helpers/index.d.ts.map +1 -0
- package/dist/helpers/parameters-validation.d.ts +3 -0
- package/dist/helpers/parameters-validation.d.ts.map +1 -0
- package/dist/helpers/utils.d.ts +5 -0
- package/dist/helpers/utils.d.ts.map +1 -0
- package/dist/index.cjs +182 -0
- package/dist/index.d.ts +266 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.mjs +11611 -0
- package/dist/interfaces/index.d.ts +31 -0
- package/dist/interfaces/index.d.ts.map +1 -0
- package/dist/interfaces/models/address.d.ts +61 -0
- package/dist/interfaces/models/address.d.ts.map +1 -0
- package/dist/interfaces/models/attribute.d.ts +31 -0
- package/dist/interfaces/models/attribute.d.ts.map +1 -0
- package/dist/interfaces/models/auth.d.ts +37 -0
- package/dist/interfaces/models/auth.d.ts.map +1 -0
- package/dist/interfaces/models/cart.d.ts +64 -0
- package/dist/interfaces/models/cart.d.ts.map +1 -0
- package/dist/interfaces/models/common.d.ts +68 -0
- package/dist/interfaces/models/common.d.ts.map +1 -0
- package/dist/interfaces/models/custom-field.d.ts +57 -0
- package/dist/interfaces/models/custom-field.d.ts.map +1 -0
- package/dist/interfaces/models/customer-account.d.ts +52 -0
- package/dist/interfaces/models/customer-account.d.ts.map +1 -0
- package/dist/interfaces/models/customer-organisation.d.ts +14 -0
- package/dist/interfaces/models/customer-organisation.d.ts.map +1 -0
- package/dist/interfaces/models/customer-user.d.ts +114 -0
- package/dist/interfaces/models/customer-user.d.ts.map +1 -0
- package/dist/interfaces/models/incident.d.ts +37 -0
- package/dist/interfaces/models/incident.d.ts.map +1 -0
- package/dist/interfaces/models/navigation-category.d.ts +22 -0
- package/dist/interfaces/models/navigation-category.d.ts.map +1 -0
- package/dist/interfaces/models/offer.d.ts +151 -0
- package/dist/interfaces/models/offer.d.ts.map +1 -0
- package/dist/interfaces/models/order.d.ts +701 -0
- package/dist/interfaces/models/order.d.ts.map +1 -0
- package/dist/interfaces/models/payment.d.ts +20 -0
- package/dist/interfaces/models/payment.d.ts.map +1 -0
- package/dist/interfaces/models/price.d.ts +6 -0
- package/dist/interfaces/models/price.d.ts.map +1 -0
- package/dist/interfaces/models/product.d.ts +243 -0
- package/dist/interfaces/models/product.d.ts.map +1 -0
- package/dist/interfaces/models/quote.d.ts +77 -0
- package/dist/interfaces/models/quote.d.ts.map +1 -0
- package/dist/interfaces/models/searchProduct.d.ts +128 -0
- package/dist/interfaces/models/searchProduct.d.ts.map +1 -0
- package/dist/interfaces/models/supplier.d.ts +72 -0
- package/dist/interfaces/models/supplier.d.ts.map +1 -0
- package/dist/services/attributes/attributes.service.d.ts +18 -0
- package/dist/services/attributes/attributes.service.d.ts.map +1 -0
- package/dist/services/attributes/definitions.d.ts +28 -0
- package/dist/services/attributes/definitions.d.ts.map +1 -0
- package/dist/services/attributes/endpoints.d.ts +12 -0
- package/dist/services/attributes/endpoints.d.ts.map +1 -0
- package/dist/services/attributes/index.d.ts +33 -0
- package/dist/services/attributes/index.d.ts.map +1 -0
- package/dist/services/attributes/module.d.ts +11 -0
- package/dist/services/attributes/module.d.ts.map +1 -0
- package/dist/services/attributes/types.d.ts +35 -0
- package/dist/services/attributes/types.d.ts.map +1 -0
- package/dist/services/auth/__mocks__/auth.mocks.d.ts +249 -0
- package/dist/services/auth/__mocks__/auth.mocks.d.ts.map +1 -0
- package/dist/services/auth/auth.service.d.ts +286 -0
- package/dist/services/auth/auth.service.d.ts.map +1 -0
- package/dist/services/auth/definitions.d.ts +69 -0
- package/dist/services/auth/definitions.d.ts.map +1 -0
- package/dist/services/auth/definitions.requests.d.ts +25 -0
- package/dist/services/auth/definitions.requests.d.ts.map +1 -0
- package/dist/services/auth/endpoints.d.ts +30 -0
- package/dist/services/auth/endpoints.d.ts.map +1 -0
- package/dist/services/auth/index.d.ts +232 -0
- package/dist/services/auth/index.d.ts.map +1 -0
- package/dist/services/auth/module.d.ts +11 -0
- package/dist/services/auth/module.d.ts.map +1 -0
- package/dist/services/auth/types.d.ts +124 -0
- package/dist/services/auth/types.d.ts.map +1 -0
- package/dist/services/base.service.d.ts +83 -0
- package/dist/services/base.service.d.ts.map +1 -0
- package/dist/services/cart/cart.service.d.ts +443 -0
- package/dist/services/cart/cart.service.d.ts.map +1 -0
- package/dist/services/cart/definitions.d.ts +84 -0
- package/dist/services/cart/definitions.d.ts.map +1 -0
- package/dist/services/cart/endpoints.d.ts +24 -0
- package/dist/services/cart/endpoints.d.ts.map +1 -0
- package/dist/services/cart/index.d.ts +330 -0
- package/dist/services/cart/index.d.ts.map +1 -0
- package/dist/services/cart/module.d.ts +11 -0
- package/dist/services/cart/module.d.ts.map +1 -0
- package/dist/services/cart/types.d.ts +236 -0
- package/dist/services/cart/types.d.ts.map +1 -0
- package/dist/services/commercial-order/commercial-order.service.d.ts +435 -0
- package/dist/services/commercial-order/commercial-order.service.d.ts.map +1 -0
- package/dist/services/commercial-order/definitions.d.ts +181 -0
- package/dist/services/commercial-order/definitions.d.ts.map +1 -0
- package/dist/services/commercial-order/endpoints.d.ts +28 -0
- package/dist/services/commercial-order/endpoints.d.ts.map +1 -0
- package/dist/services/commercial-order/index.d.ts +712 -0
- package/dist/services/commercial-order/index.d.ts.map +1 -0
- package/dist/services/commercial-order/module.d.ts +11 -0
- package/dist/services/commercial-order/module.d.ts.map +1 -0
- package/dist/services/commercial-order/types.d.ts +244 -0
- package/dist/services/commercial-order/types.d.ts.map +1 -0
- package/dist/services/custom-field/custom-field.service.d.ts +23 -0
- package/dist/services/custom-field/custom-field.service.d.ts.map +1 -0
- package/dist/services/custom-field/definitions.d.ts +107 -0
- package/dist/services/custom-field/definitions.d.ts.map +1 -0
- package/dist/services/custom-field/endpoints.d.ts +13 -0
- package/dist/services/custom-field/endpoints.d.ts.map +1 -0
- package/dist/services/custom-field/index.d.ts +115 -0
- package/dist/services/custom-field/index.d.ts.map +1 -0
- package/dist/services/custom-field/module.d.ts +11 -0
- package/dist/services/custom-field/module.d.ts.map +1 -0
- package/dist/services/custom-field/types.d.ts +51 -0
- package/dist/services/custom-field/types.d.ts.map +1 -0
- package/dist/services/customer-account/customer-account.service.d.ts +387 -0
- package/dist/services/customer-account/customer-account.service.d.ts.map +1 -0
- package/dist/services/customer-account/definitions.d.ts +164 -0
- package/dist/services/customer-account/definitions.d.ts.map +1 -0
- package/dist/services/customer-account/endpoints.d.ts +25 -0
- package/dist/services/customer-account/endpoints.d.ts.map +1 -0
- package/dist/services/customer-account/index.d.ts +656 -0
- package/dist/services/customer-account/index.d.ts.map +1 -0
- package/dist/services/customer-account/module.d.ts +11 -0
- package/dist/services/customer-account/module.d.ts.map +1 -0
- package/dist/services/customer-account/types.d.ts +253 -0
- package/dist/services/customer-account/types.d.ts.map +1 -0
- package/dist/services/customer-user/customer-user.service.d.ts +280 -0
- package/dist/services/customer-user/customer-user.service.d.ts.map +1 -0
- package/dist/services/customer-user/definitions.d.ts +84 -0
- package/dist/services/customer-user/definitions.d.ts.map +1 -0
- package/dist/services/customer-user/endpoints.d.ts +19 -0
- package/dist/services/customer-user/endpoints.d.ts.map +1 -0
- package/dist/services/customer-user/index.d.ts +394 -0
- package/dist/services/customer-user/index.d.ts.map +1 -0
- package/dist/services/customer-user/module.d.ts +11 -0
- package/dist/services/customer-user/module.d.ts.map +1 -0
- package/dist/services/customer-user/types.d.ts +118 -0
- package/dist/services/customer-user/types.d.ts.map +1 -0
- package/dist/services/factory.d.ts +104 -0
- package/dist/services/factory.d.ts.map +1 -0
- package/dist/services/incident/definitions.d.ts +85 -0
- package/dist/services/incident/definitions.d.ts.map +1 -0
- package/dist/services/incident/endpoints.d.ts +17 -0
- package/dist/services/incident/endpoints.d.ts.map +1 -0
- package/dist/services/incident/incident.service.d.ts +24 -0
- package/dist/services/incident/incident.service.d.ts.map +1 -0
- package/dist/services/incident/index.d.ts +270 -0
- package/dist/services/incident/index.d.ts.map +1 -0
- package/dist/services/incident/module.d.ts +11 -0
- package/dist/services/incident/module.d.ts.map +1 -0
- package/dist/services/incident/types.d.ts +116 -0
- package/dist/services/incident/types.d.ts.map +1 -0
- package/dist/services/logistic-order/definitions.d.ts +296 -0
- package/dist/services/logistic-order/definitions.d.ts.map +1 -0
- package/dist/services/logistic-order/endpoints.d.ts +44 -0
- package/dist/services/logistic-order/endpoints.d.ts.map +1 -0
- package/dist/services/logistic-order/index.d.ts +1338 -0
- package/dist/services/logistic-order/index.d.ts.map +1 -0
- package/dist/services/logistic-order/logistic-order.service.d.ts +62 -0
- package/dist/services/logistic-order/logistic-order.service.d.ts.map +1 -0
- package/dist/services/logistic-order/module.d.ts +11 -0
- package/dist/services/logistic-order/module.d.ts.map +1 -0
- package/dist/services/logistic-order/types.d.ts +411 -0
- package/dist/services/logistic-order/types.d.ts.map +1 -0
- package/dist/services/module.d.ts +64 -0
- package/dist/services/module.d.ts.map +1 -0
- package/dist/services/navigation-category/definitions.d.ts +31 -0
- package/dist/services/navigation-category/definitions.d.ts.map +1 -0
- package/dist/services/navigation-category/endpoints.d.ts +15 -0
- package/dist/services/navigation-category/endpoints.d.ts.map +1 -0
- package/dist/services/navigation-category/index.d.ts +114 -0
- package/dist/services/navigation-category/index.d.ts.map +1 -0
- package/dist/services/navigation-category/module.d.ts +11 -0
- package/dist/services/navigation-category/module.d.ts.map +1 -0
- package/dist/services/navigation-category/navigation-category.service.d.ts +148 -0
- package/dist/services/navigation-category/navigation-category.service.d.ts.map +1 -0
- package/dist/services/navigation-category/types.d.ts +51 -0
- package/dist/services/navigation-category/types.d.ts.map +1 -0
- package/dist/services/offer-inventories/definitions.d.ts +73 -0
- package/dist/services/offer-inventories/definitions.d.ts.map +1 -0
- package/dist/services/offer-inventories/endpoints.d.ts +16 -0
- package/dist/services/offer-inventories/endpoints.d.ts.map +1 -0
- package/dist/services/offer-inventories/index.d.ts +120 -0
- package/dist/services/offer-inventories/index.d.ts.map +1 -0
- package/dist/services/offer-inventories/module.d.ts +11 -0
- package/dist/services/offer-inventories/module.d.ts.map +1 -0
- package/dist/services/offer-inventories/offer-inventories.service.d.ts +26 -0
- package/dist/services/offer-inventories/offer-inventories.service.d.ts.map +1 -0
- package/dist/services/offer-inventories/types.d.ts +85 -0
- package/dist/services/offer-inventories/types.d.ts.map +1 -0
- package/dist/services/offer-prices/__mocks__/offer-prices.mocks.d.ts +109 -0
- package/dist/services/offer-prices/__mocks__/offer-prices.mocks.d.ts.map +1 -0
- package/dist/services/offer-prices/definitions.d.ts +24 -0
- package/dist/services/offer-prices/definitions.d.ts.map +1 -0
- package/dist/services/offer-prices/endpoints.d.ts +12 -0
- package/dist/services/offer-prices/endpoints.d.ts.map +1 -0
- package/dist/services/offer-prices/index.d.ts +36 -0
- package/dist/services/offer-prices/index.d.ts.map +1 -0
- package/dist/services/offer-prices/module.d.ts +11 -0
- package/dist/services/offer-prices/module.d.ts.map +1 -0
- package/dist/services/offer-prices/offer-prices.service.d.ts +18 -0
- package/dist/services/offer-prices/offer-prices.service.d.ts.map +1 -0
- package/dist/services/offer-prices/types.d.ts +33 -0
- package/dist/services/offer-prices/types.d.ts.map +1 -0
- package/dist/services/operation/definitions.d.ts +280 -0
- package/dist/services/operation/definitions.d.ts.map +1 -0
- package/dist/services/operation/endpoints.d.ts +18 -0
- package/dist/services/operation/endpoints.d.ts.map +1 -0
- package/dist/services/operation/index.d.ts +520 -0
- package/dist/services/operation/index.d.ts.map +1 -0
- package/dist/services/operation/module.d.ts +11 -0
- package/dist/services/operation/module.d.ts.map +1 -0
- package/dist/services/operation/operation.service.d.ts +32 -0
- package/dist/services/operation/operation.service.d.ts.map +1 -0
- package/dist/services/operation/types.d.ts +174 -0
- package/dist/services/operation/types.d.ts.map +1 -0
- package/dist/services/payment/definitions.d.ts +79 -0
- package/dist/services/payment/definitions.d.ts.map +1 -0
- package/dist/services/payment/endpoints.d.ts +16 -0
- package/dist/services/payment/endpoints.d.ts.map +1 -0
- package/dist/services/payment/index.d.ts +150 -0
- package/dist/services/payment/index.d.ts.map +1 -0
- package/dist/services/payment/module.d.ts +11 -0
- package/dist/services/payment/module.d.ts.map +1 -0
- package/dist/services/payment/payment.service.d.ts +224 -0
- package/dist/services/payment/payment.service.d.ts.map +1 -0
- package/dist/services/payment/types.d.ts +93 -0
- package/dist/services/payment/types.d.ts.map +1 -0
- package/dist/services/product/definitions.d.ts +150 -0
- package/dist/services/product/definitions.d.ts.map +1 -0
- package/dist/services/product/endpoints.d.ts +40 -0
- package/dist/services/product/endpoints.d.ts.map +1 -0
- package/dist/services/product/index.d.ts +388 -0
- package/dist/services/product/index.d.ts.map +1 -0
- package/dist/services/product/module.d.ts +11 -0
- package/dist/services/product/module.d.ts.map +1 -0
- package/dist/services/product/product.service.d.ts +452 -0
- package/dist/services/product/product.service.d.ts.map +1 -0
- package/dist/services/product/types.d.ts +344 -0
- package/dist/services/product/types.d.ts.map +1 -0
- package/dist/services/product-variant/definitions.d.ts +172 -0
- package/dist/services/product-variant/definitions.d.ts.map +1 -0
- package/dist/services/product-variant/endpoints.d.ts +15 -0
- package/dist/services/product-variant/endpoints.d.ts.map +1 -0
- package/dist/services/product-variant/index.d.ts +123 -0
- package/dist/services/product-variant/index.d.ts.map +1 -0
- package/dist/services/product-variant/module.d.ts +11 -0
- package/dist/services/product-variant/module.d.ts.map +1 -0
- package/dist/services/product-variant/product-variant.service.d.ts +21 -0
- package/dist/services/product-variant/product-variant.service.d.ts.map +1 -0
- package/dist/services/product-variant/types.d.ts +73 -0
- package/dist/services/product-variant/types.d.ts.map +1 -0
- package/dist/services/quote/definitions.d.ts +102 -0
- package/dist/services/quote/definitions.d.ts.map +1 -0
- package/dist/services/quote/endpoints.d.ts +20 -0
- package/dist/services/quote/endpoints.d.ts.map +1 -0
- package/dist/services/quote/index.d.ts +378 -0
- package/dist/services/quote/index.d.ts.map +1 -0
- package/dist/services/quote/module.d.ts +11 -0
- package/dist/services/quote/module.d.ts.map +1 -0
- package/dist/services/quote/quote.service.d.ts +346 -0
- package/dist/services/quote/quote.service.d.ts.map +1 -0
- package/dist/services/quote/types.d.ts +160 -0
- package/dist/services/quote/types.d.ts.map +1 -0
- package/dist/services/supplier/__mocks__/supplier-mocks.d.ts +49 -0
- package/dist/services/supplier/__mocks__/supplier-mocks.d.ts.map +1 -0
- package/dist/services/supplier/definitions.d.ts +30 -0
- package/dist/services/supplier/definitions.d.ts.map +1 -0
- package/dist/services/supplier/endpoints.d.ts +14 -0
- package/dist/services/supplier/endpoints.d.ts.map +1 -0
- package/dist/services/supplier/index.d.ts +102 -0
- package/dist/services/supplier/index.d.ts.map +1 -0
- package/dist/services/supplier/module.d.ts +11 -0
- package/dist/services/supplier/module.d.ts.map +1 -0
- package/dist/services/supplier/supplier.service.d.ts +20 -0
- package/dist/services/supplier/supplier.service.d.ts.map +1 -0
- package/dist/services/supplier/types.d.ts +58 -0
- package/dist/services/supplier/types.d.ts.map +1 -0
- package/dist/services/types.d.ts +81 -0
- package/dist/services/types.d.ts.map +1 -0
- package/dist/settings/fetch-instance.d.ts +30 -0
- package/dist/settings/fetch-instance.d.ts.map +1 -0
- package/package.json +12 -10
- package/dist/djust-b2b-djust-front-sdk-3.0.0-beta.2.tgz +0 -0
|
@@ -0,0 +1,1338 @@
|
|
|
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";
|
|
2
|
+
/**
|
|
3
|
+
* @deprecated
|
|
4
|
+
* 🚚 Gets logistic orders.
|
|
5
|
+
*
|
|
6
|
+
* This function retrieves all logistic orders. The parameter locale is mandatory and validated
|
|
7
|
+
* before the request is executed.
|
|
8
|
+
*
|
|
9
|
+
* 🛠 **Endpoint**: `GET /v1/shop/logistic-orders [ORDER-550]`
|
|
10
|
+
*
|
|
11
|
+
* | Parameter | Type | Required | Description |
|
|
12
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
13
|
+
* | `approvalIds` | `string` | ❌ | The IDs of the users responsible for the approval of the logistic order. |
|
|
14
|
+
* | `locale` | `string` | ✅ | The locale in which to return the logistic order. |
|
|
15
|
+
* | `logisticStatus` | `OrderLogisticStatusType[]` | ❌ | The statuses of the logistic orders you want to retrieve . |
|
|
16
|
+
* | `incident` | `boolean` | ❌ | Whether you want to retrieve incidents or not. |
|
|
17
|
+
* | `paymentOptions` | `PaymentOption[]` | ❌ | The types of payment (e.g., `BANK WIRE`, `CREDIT_CARD`). |
|
|
18
|
+
* | `nbPreviewLines` | `integer` | ❌ | The number of lines to display in the logistic order. |
|
|
19
|
+
* | `page` | `integer` | ❌ | The page number you want to retrieve. |
|
|
20
|
+
* | `size` | `integer` | ❌ | The size of the page you want to retrieve. |
|
|
21
|
+
* | `sort` | `string` | ❌ | The order how you want to retrieve the custom fields. |
|
|
22
|
+
* | `suppliersIds` | `string[]` | ❌ | The list of supplier IDs for which you want to retrieve the logistic orders. |
|
|
23
|
+
* | `creationDateFrom`| `string` | ❌ | The creation date from which you want to retrieve the logistic orders. |
|
|
24
|
+
* | `creationDateTo` | `string` | ❌ | The creation date to which you want to retrieve the logistic orders. |
|
|
25
|
+
* | `updateDateFrom` | `string` | ❌ | The update date from which you want to retrieve the logistic orders. |
|
|
26
|
+
* | `updateDateTo` | `string` | ❌ | The update date to which you want to retrieve the logistic orders. |
|
|
27
|
+
*
|
|
28
|
+
* 📤 **Returns**:
|
|
29
|
+
* A `Promise` resolving to a single `GetLogisticOrdersResponse` object representing the page of logistic orders.
|
|
30
|
+
*
|
|
31
|
+
* 🛠 **Example usage**:
|
|
32
|
+
* ```ts
|
|
33
|
+
* const orders = await getLogisticOrders({
|
|
34
|
+
* locale: "fr",
|
|
35
|
+
* });
|
|
36
|
+
* ```
|
|
37
|
+
* @param {GetLogisticOrdersParameters} params - The parameters for the request.
|
|
38
|
+
* @throws {Error} If `locale` is missing.
|
|
39
|
+
* @returns {Promise<GetLogisticOrdersResponse>} A promise resolving to the response containing page object.
|
|
40
|
+
*/
|
|
41
|
+
export declare function getLogisticOrders({ approvalIds, locale, logisticStatus, incident, paymentOptions, connectedUserOnly, nbPreviewLines, page, size, sort, suppliersIds, creationDateFrom, creationDateTo, updateDateFrom, updateDateTo, }: GetLogisticOrdersParameters): Promise<GetLogisticOrdersResponse>;
|
|
42
|
+
/**
|
|
43
|
+
* 🚚 Get paginated and filtered Order logistics.
|
|
44
|
+
*
|
|
45
|
+
* 🛠 **Endpoint**: `POST /v1/shop/logistic-orders` [ORDER-550]
|
|
46
|
+
*
|
|
47
|
+
* | Parameter | Type | Required | Description |
|
|
48
|
+
* |-----------------------------------------|----------------------------|-----------|--------------------------------------------------------|
|
|
49
|
+
* | `page` | `number` | ❌ | Current Page |
|
|
50
|
+
* | `size` | `number` | ❌ | The size of the page to be returned |
|
|
51
|
+
* | `sort` | `string` | ❌ | Sorting criteria in the format: property,(asc|desc) |
|
|
52
|
+
* | `nbPreviewLines` | `number` | ❌ | The number of lines to display in the logistic order. |
|
|
53
|
+
* | `accountCustomFieldValueCriteria` | `CustomFieldValueObject[]` | ❌ | Account custom field value criteria |
|
|
54
|
+
* | `approvalIds` | `string[]` | ❌ | Approval IDs |
|
|
55
|
+
* | `connectedUserOnly` | `boolean` | ❌ | Connected user only |
|
|
56
|
+
* | `creationDateFrom` | `string` | ❌ | Creation date from |
|
|
57
|
+
* | `creationDateTo` | `string` | ❌ | Creation date to |
|
|
58
|
+
* | `customerAccountIds` | `string[]` | ❌ | Customer account IDs |
|
|
59
|
+
* | `incident` | `boolean` | ❌ | Incident |
|
|
60
|
+
* | `locale` | `string` | ✅ | Locale |
|
|
61
|
+
* | `logisticStatus` | `string[]` | ❌ | Logistic status |
|
|
62
|
+
* | `offerCustomFieldValueCriteria` | `CustomFieldValueObject[]` | ❌ | Offer custom field value criteria |
|
|
63
|
+
* | `orderLogisticCustomFieldValueCriteria` | `CustomFieldValueObject[]` | ❌ | Order logistic custom field value criteria |
|
|
64
|
+
* | `paymentOptions` | `string[]` | ❌ | Payment options |
|
|
65
|
+
* | `supplierIds` | `string[]` | ❌ | Supplier IDs |
|
|
66
|
+
* | `updateDateFrom` | `string` | ❌ | Update date from |
|
|
67
|
+
* | `updateDateTo` | `string` | ❌ | Update date to |
|
|
68
|
+
*
|
|
69
|
+
* 📤 **Returns**:
|
|
70
|
+
* A `Promise` resolving to a `GetPaginatedLogisticOrdersResponse`.
|
|
71
|
+
*
|
|
72
|
+
* 🛠 **Example usage**:
|
|
73
|
+
* ```ts
|
|
74
|
+
* await logisticOrdersPaginatedList({
|
|
75
|
+
* 1,
|
|
76
|
+
* 10,
|
|
77
|
+
* 'asc|desc',
|
|
78
|
+
* 20,
|
|
79
|
+
* {
|
|
80
|
+
* "accountCustomFieldValueCriteria": [
|
|
81
|
+
* {
|
|
82
|
+
* "customFieldId": "string",
|
|
83
|
+
* "customFieldValue": "string"
|
|
84
|
+
* }
|
|
85
|
+
* ],
|
|
86
|
+
* "approvalIds": [ "string" ],
|
|
87
|
+
* "connectedUserOnly": true,
|
|
88
|
+
* "creationDateFrom": "2025-03-26T15:38:31.964Z",
|
|
89
|
+
* "creationDateTo": "2025-03-26T15:38:31.964Z",
|
|
90
|
+
* "incident": true,
|
|
91
|
+
* "locale": "string",
|
|
92
|
+
* "logisticStatus": [ "CREATING" ],
|
|
93
|
+
* "offerCustomFieldValueCriteria": [
|
|
94
|
+
* {
|
|
95
|
+
* "customFieldId": "string",
|
|
96
|
+
* "customFieldValue": "string"
|
|
97
|
+
* }
|
|
98
|
+
* ],
|
|
99
|
+
* "customerAccountIds": [ "string" ],
|
|
100
|
+
* "orderLogisticCustomFieldValueCriteria": [
|
|
101
|
+
* {
|
|
102
|
+
* "customFieldId": "string",
|
|
103
|
+
* "customFieldValue": "string"
|
|
104
|
+
* }
|
|
105
|
+
* ],
|
|
106
|
+
* "paymentOptions": [ "BANK_WIRE" ],
|
|
107
|
+
* "supplierIds": [ "string" ],
|
|
108
|
+
* "updateDateFrom": "2025-03-26T15:38:31.964Z",
|
|
109
|
+
* "updateDateTo": "2025-03-26T15:38:31.964Z"
|
|
110
|
+
* }
|
|
111
|
+
* });
|
|
112
|
+
* ```
|
|
113
|
+
*
|
|
114
|
+
* @param {GetPaginatedLogisticOrdersParameters} params - The parameters for the request.
|
|
115
|
+
* @throws {Error} If `locale` is missing.
|
|
116
|
+
* @returns {Promise<GetPaginatedLogisticOrdersResponse>}
|
|
117
|
+
*/
|
|
118
|
+
export declare function logisticOrdersPaginatedList({ page, size, sort, nbPreviewLines, accountCustomFieldValueCriteria, approvalIds, connectedUserOnly, creationDateFrom, creationDateTo, customerAccountIds, incident, locale, logisticStatus, offerCustomFieldValueCriteria, orderLogisticCustomFieldValueCriteria, paymentOptions, supplierIds, updateDateFrom, updateDateTo, }: GetPaginatedLogisticOrdersParameters): Promise<GetPaginatedLogisticOrdersResponse>;
|
|
119
|
+
/**
|
|
120
|
+
* 🚚 Get logistic order's custom fields.
|
|
121
|
+
*
|
|
122
|
+
* This function retrieves custom fields of logistic orders, identified by
|
|
123
|
+
* the `customFieldIds`. This parameter is mandatory and validated
|
|
124
|
+
* before the request is executed.
|
|
125
|
+
*
|
|
126
|
+
* 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/custom-fields [ORDER-553]`
|
|
127
|
+
*
|
|
128
|
+
* | Parameter | Type | Required | Description |
|
|
129
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
130
|
+
* | `customFieldIds` | `string[]` | ✅ | The list of custom fields' ID you want to retrieve. |
|
|
131
|
+
* | `page` | `integer` | ❌ | The page number you want to retrieve. |
|
|
132
|
+
* | `size` | `integer` | ❌ | The size of the page you want to retrieve. |
|
|
133
|
+
* | `sort` | `string` | ❌ | The order how you want to retrieve the custom fields. |
|
|
134
|
+
* | `idType` | `IdType` | ❌ | The type of the ID you want to retrieve. |
|
|
135
|
+
*
|
|
136
|
+
* 📤 **Returns**:
|
|
137
|
+
* A `Promise` resolving to a single `GetLogisticOrderCustomFieldsResponse` object representing the page of custom fields.
|
|
138
|
+
*
|
|
139
|
+
* 🛠 **Example usage**:
|
|
140
|
+
* ```ts
|
|
141
|
+
* const customFields = await getLogisticOrderCustomFields({
|
|
142
|
+
* customFieldIds: ["customFieldId1", "customFieldId2"],
|
|
143
|
+
* page: 1,
|
|
144
|
+
* size: 20,
|
|
145
|
+
* });
|
|
146
|
+
* ```
|
|
147
|
+
*
|
|
148
|
+
* @param {GetLogisticOrderCustomFieldsParameters} params - The parameters for the request.
|
|
149
|
+
* @throws {Error} If `customFieldIds` is missing.
|
|
150
|
+
* @returns {Promise<GetLogisticOrderCustomFieldsResponse>} A promise resolving to the response containing the page object.
|
|
151
|
+
*/
|
|
152
|
+
export declare function getLogisticOrderCustomFields({ customFieldIds, page, size, sort, idType, }: GetLogisticOrderCustomFieldsParameters): Promise<GetLogisticOrderCustomFieldsResponse>;
|
|
153
|
+
/**
|
|
154
|
+
* 🚚 Get logistic order lines' custom fields.
|
|
155
|
+
*
|
|
156
|
+
* This function retrieves custom fields of logistic order lines, identified by
|
|
157
|
+
* the `customFieldIds`. This parameter is mandatory and validated
|
|
158
|
+
* before the request is executed.
|
|
159
|
+
*
|
|
160
|
+
* 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/lines/custom-fields [ORDER-554]`
|
|
161
|
+
*
|
|
162
|
+
* | Parameter | Type | Required | Description |
|
|
163
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
164
|
+
* | `customFieldIds` | `string[]` | ✅ | The list of custom fields' ID you want to retrieve. |
|
|
165
|
+
* | `page` | `integer` | ❌ | The page number you want to retrieve. |
|
|
166
|
+
* | `size` | `integer` | ❌ | The size of the page you want to retrieve. |
|
|
167
|
+
* | `sort` | `string` | ❌ | The order how you want to retrieve the custom fields. |
|
|
168
|
+
* | `idType` | `IdType` | ❌ | The type of the ID you want to retrieve. |
|
|
169
|
+
* 📤 **Returns**:
|
|
170
|
+
* A `Promise` resolving to a single `GetLogisticOrderLineCustomFieldsResponse` object representing the page of custom fields.
|
|
171
|
+
*
|
|
172
|
+
* 🛠 **Example usage**:
|
|
173
|
+
* ```ts
|
|
174
|
+
* const customFields = await updateLogisticOrderCustomFields({
|
|
175
|
+
* customFieldIds: ["customFieldId1", "customFieldId2"],
|
|
176
|
+
* page: 1,
|
|
177
|
+
* size: 20,
|
|
178
|
+
* });
|
|
179
|
+
* ```
|
|
180
|
+
*
|
|
181
|
+
* @param {GetLogisticOrderLineCustomFieldsParameters} params - The parameters for the request.
|
|
182
|
+
* @throws {Error} If `customFieldIds` is missing.
|
|
183
|
+
* @returns {Promise<GetLogisticOrderLineCustomFieldsResponse>} A promise resolving to the response containing the page object.
|
|
184
|
+
*/
|
|
185
|
+
export declare function getLogisticOrderLineCustomFields({ customFieldIds, page, size, sort, idType, }: GetLogisticOrderLineCustomFieldsParameters): Promise<GetLogisticOrderLineCustomFieldsResponse>;
|
|
186
|
+
/**
|
|
187
|
+
* 🚚 Gets a specific logistic order.
|
|
188
|
+
*
|
|
189
|
+
* This function retrieves a specific logistic order, identified by
|
|
190
|
+
* the `orderId`. This parameter is mandatory and validated
|
|
191
|
+
* before the request is executed.
|
|
192
|
+
*
|
|
193
|
+
* 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId} [ORDER-501]`
|
|
194
|
+
*
|
|
195
|
+
* | Parameter | Type | Required | Description |
|
|
196
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
197
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order you want to retrieve. |
|
|
198
|
+
* | `locale` | `string` | ✅ | The locale in which to return the logistic order. |
|
|
199
|
+
* | `nbPreviewLines` | `integer` | ❌ | The number of lines to display in the logistic order. |
|
|
200
|
+
*
|
|
201
|
+
* 📤 **Returns**:
|
|
202
|
+
* A `Promise` resolving to a single `GetLogisticOrderResponse` object representing the logistic order.
|
|
203
|
+
*
|
|
204
|
+
* 🛠 **Example usage**:
|
|
205
|
+
* ```ts
|
|
206
|
+
* const order = await getLogisticOrder({
|
|
207
|
+
* orderId: "logisticOrder1",
|
|
208
|
+
* locale: "fr",
|
|
209
|
+
* });
|
|
210
|
+
* ```
|
|
211
|
+
*
|
|
212
|
+
* @param {GetLogisticOrderParameters} params - The parameters for the request.
|
|
213
|
+
* @throws {Error} If `orderId` is missing.
|
|
214
|
+
* @returns {Promise<GetLogisticOrderResponse>} A promise resolving to the response containing the logistic order.
|
|
215
|
+
*/
|
|
216
|
+
export declare function getLogisticOrder({ orderId, locale, nbPreviewLines, }: GetLogisticOrderParameters): Promise<GetLogisticOrderResponse>;
|
|
217
|
+
/**
|
|
218
|
+
* 🚚 Updates a specific logistic order's custom fields.
|
|
219
|
+
*
|
|
220
|
+
* This function updates the custom fields of a specific logistic order, identified by
|
|
221
|
+
* the `orderId`. This parameter is mandatory and validated
|
|
222
|
+
* before the request is executed.
|
|
223
|
+
*
|
|
224
|
+
* 🛠 **Endpoint**: `PATCH /v1/shop/logistic-orders/${orderId} [ORDER-205]`
|
|
225
|
+
*
|
|
226
|
+
* | Parameter | Type | Required | Description |
|
|
227
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
228
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order of which you want to update the custom fields. |
|
|
229
|
+
* | `customFields` | `CustomFieldValueObject[]` | ✅ | The custom fields with value and externalId. |
|
|
230
|
+
* | `locale` | `string` | ❌ | The locale in which to return the logistic order. |
|
|
231
|
+
* | `nbPreviewLines` | `integer` | ❌ | The number of lines to display in the logistic order. |
|
|
232
|
+
*
|
|
233
|
+
* 📤 **Returns**:
|
|
234
|
+
* A `Promise` resolving to a single `UpdateOrderLogisticCustomFieldResponse` object representing the logistic order.
|
|
235
|
+
*
|
|
236
|
+
* 🛠 **Example usage**:
|
|
237
|
+
* ```ts
|
|
238
|
+
* const order = await updateLogisticOrderCustomFields({
|
|
239
|
+
* orderId: "logisticOrder1",
|
|
240
|
+
* customFields: [{ customFieldId: "externalId1", customFieldValue: "value1" }, { customFieldId: "externalId2", customFieldValue: "value2" }],
|
|
241
|
+
* });
|
|
242
|
+
* ```
|
|
243
|
+
*
|
|
244
|
+
* @param {UpdateOrderLogisticCustomFieldParameters} params - The parameters for the request.
|
|
245
|
+
* @throws {Error} If `orderId` or `customFields` is missing.
|
|
246
|
+
* @returns {Promise<UpdateOrderLogisticCustomFieldResponse>} A promise resolving to the response containing the logistic order.
|
|
247
|
+
*/
|
|
248
|
+
export declare function updateLogisticOrderCustomFields({ orderId, locale, nbPreviewLines, customFields, }: UpdateLogisticOrderCustomFieldsParameters): Promise<UpdateLogisticOrderCustomFieldsResponse>;
|
|
249
|
+
/**
|
|
250
|
+
* 🚚 Updates a specific logistic order's data (custom fields and externalId).
|
|
251
|
+
*
|
|
252
|
+
* This function updates the custom fields and externalId of a specific logistic order, identified by
|
|
253
|
+
* the `orderId`. This parameter is mandatory and validated
|
|
254
|
+
* before the request is executed.
|
|
255
|
+
*
|
|
256
|
+
* 🛠 **Endpoint**: `PATCH /v1/shop/logistic-orders/${orderId} [ORDER-205]`
|
|
257
|
+
*
|
|
258
|
+
* | Parameter | Type | Required | Description |
|
|
259
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
260
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order of which you want to update the custom fields. |
|
|
261
|
+
* | `customFields` | `CustomFieldValueObject[]` | ❌ | The custom fields with value and externalId. |
|
|
262
|
+
* | `externalId` | `string` | ❌ | The externalId of the logistic order. |
|
|
263
|
+
* | `locale` | `string` | ❌ | The locale in which to return the logistic order. |
|
|
264
|
+
* | `nbPreviewLines` | `integer` | ❌ | The number of lines to display in the logistic order. |
|
|
265
|
+
*
|
|
266
|
+
* 📤 **Returns**:
|
|
267
|
+
* A `Promise` resolving to a single `UpdateOrderLogisticCustomFieldResponse` object representing the logistic order.
|
|
268
|
+
*
|
|
269
|
+
* 🛠 **Example usage**:
|
|
270
|
+
* ```ts
|
|
271
|
+
* const order = await updateLogisticOrderData({
|
|
272
|
+
* orderId: "logisticOrder1",
|
|
273
|
+
* customFields: [
|
|
274
|
+
* { customFieldId: "id1", customFieldValue: "value1" },
|
|
275
|
+
* { customFieldId: "id2", customFieldValue: "value2" },
|
|
276
|
+
* ],
|
|
277
|
+
* externalId: "id",
|
|
278
|
+
* });
|
|
279
|
+
* ```
|
|
280
|
+
* Body sent: `{ customFieldValueRequest: customFields, externalId? }`.
|
|
281
|
+
*
|
|
282
|
+
* @param {UpdateLogisticOrderCustomFieldsParameters} params - The parameters for the request.
|
|
283
|
+
* @throws {Error} If `orderId` or `customFields` is missing.
|
|
284
|
+
* @returns {Promise<UpdateLogisticOrderCustomFieldsResponse>} A promise resolving to the response containing the logistic order.
|
|
285
|
+
*/
|
|
286
|
+
export declare function updateLogisticOrderData({ orderId, locale, nbPreviewLines, customFields, externalId, }: UpdateLogisticOrderCustomFieldsParameters): Promise<UpdateLogisticOrderCustomFieldsResponse>;
|
|
287
|
+
/**
|
|
288
|
+
* 🚚 Gets a specific logistic order's accounting documents.
|
|
289
|
+
*
|
|
290
|
+
* This function retrieves the accounting documents of a specific logistic order, identified by
|
|
291
|
+
* the `orderId`. This parameter is mandatory and validated
|
|
292
|
+
* before the request is executed.
|
|
293
|
+
*
|
|
294
|
+
* 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId}/accounting-documents [ORDER-551]`
|
|
295
|
+
*
|
|
296
|
+
* | Parameter | Type | Required | Description |
|
|
297
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
298
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the accounting documents. |
|
|
299
|
+
*
|
|
300
|
+
* 📤 **Returns**:
|
|
301
|
+
* A `Promise` resolving to a single `GetLogisticOrderAccountingDocumentsResponse` object representing the list of accounting documents of the logistic order.
|
|
302
|
+
*
|
|
303
|
+
* 🛠 **Example usage**:
|
|
304
|
+
* ```ts
|
|
305
|
+
* const accountingDocuments = await getLogisticOrderAccountingDocuments({
|
|
306
|
+
* orderId: "logisticOrder1",
|
|
307
|
+
* });
|
|
308
|
+
* ```
|
|
309
|
+
*
|
|
310
|
+
* @param {GetLogisticOrderAccountingDocumentsParameters} params - The parameters for the request.
|
|
311
|
+
* @throws {Error} If `orderId` is missing.
|
|
312
|
+
* @returns {Promise<GetLogisticOrderAccountingDocumentsResponse>} A promise resolving to the response containing the list of accounting documents.
|
|
313
|
+
*/
|
|
314
|
+
export declare function getLogisticOrderAccountingDocuments({ orderId, }: GetLogisticOrderAccountingDocumentsParameters): Promise<GetLogisticOrderAccountingDocumentsResponse>;
|
|
315
|
+
/**
|
|
316
|
+
* 🚚 Gets specific accounting document urls of a specific logistic order.
|
|
317
|
+
*
|
|
318
|
+
* This function retrieves specific accounting document urls of a specific logistic order, both identified by
|
|
319
|
+
* the `orderId` and the `documentId`. Both parameters are mandatory and validated
|
|
320
|
+
* before the request is executed.
|
|
321
|
+
*
|
|
322
|
+
* 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId}/accounting-documents/{documentId} [ORDER-506]`
|
|
323
|
+
*
|
|
324
|
+
* | Parameter | Type | Required | Description |
|
|
325
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
326
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the accounting documents. |
|
|
327
|
+
* | `documentId` | `string` | ✅ | The ID of the accounting document to be downloaded. |
|
|
328
|
+
*
|
|
329
|
+
* 📤 **Returns**:
|
|
330
|
+
* A `Promise` resolving to a single `GetLogisticOrderAccountingDocumentsResponse` object representing the list of accounting document's urls.
|
|
331
|
+
*
|
|
332
|
+
* 🛠 **Example usage**:
|
|
333
|
+
* ```ts
|
|
334
|
+
* const accountingDocumentUrls = await getLogisticOrderAccountingDocumentUrl({
|
|
335
|
+
* orderId: "logisticOrder1",
|
|
336
|
+
* documentId: "document1",
|
|
337
|
+
* });
|
|
338
|
+
* ```
|
|
339
|
+
*
|
|
340
|
+
* @param {GetLogisticOrderAccountingDocumentUrlParameters} params - The parameters for the request.
|
|
341
|
+
* @throws {Error} If `orderId` or `documentId` is missing.
|
|
342
|
+
* @returns {Promise<string[]>} A promise resolving to the response containing the list of document's urls.
|
|
343
|
+
*/
|
|
344
|
+
export declare function getLogisticOrderAccountingDocumentUrl({ orderId, documentId, }: GetLogisticOrderAccountingDocumentUrlParameters): Promise<string[]>;
|
|
345
|
+
/**
|
|
346
|
+
* 🚚 Approves a logistic order.
|
|
347
|
+
*
|
|
348
|
+
* This function approves a specific logistic order, identified by the `orderId`. The parameters `orderId` and `locale` are mandatory and validated
|
|
349
|
+
* before the request is executed.
|
|
350
|
+
*
|
|
351
|
+
* 🛠 **Endpoint**: `PUT /v1/shop/logistic-orders/${orderId}/approve [ORDER-200]`
|
|
352
|
+
*
|
|
353
|
+
* | Parameter | Type | Required | Description |
|
|
354
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
355
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order you want to approve. |
|
|
356
|
+
* | `locale` | `string` | ✅ | The locale in which to return the logistic order. |
|
|
357
|
+
* | `nbPreviewLines` | `integer` | ❌ | The number of lines to display in the logistic order. |
|
|
358
|
+
*
|
|
359
|
+
* 📤 **Returns**:
|
|
360
|
+
* A `Promise` resolving to a single `ApproveLogisticOrderResponse` object representing the logistic order approved.
|
|
361
|
+
*
|
|
362
|
+
* 🛠 **Example usage**:
|
|
363
|
+
* ```ts
|
|
364
|
+
* const order = await approveLogisticOrder({
|
|
365
|
+
* orderId: "logisticOrder1",
|
|
366
|
+
* locale: "fr",
|
|
367
|
+
* });
|
|
368
|
+
* ```
|
|
369
|
+
*
|
|
370
|
+
* @param {ApproveLogisticOrderParameters} params - The parameters for the request.
|
|
371
|
+
* @throws {Error} If `orderId` or `locale` is missing.
|
|
372
|
+
* @returns {Promise<ApproveLogisticOrderResponse>} A promise resolving to the response containing the logistic order.
|
|
373
|
+
*/
|
|
374
|
+
export declare function approveLogisticOrder({ orderId, locale, nbPreviewLines, }: ApproveLogisticOrderParameters): Promise<ApproveLogisticOrderResponse>;
|
|
375
|
+
/**
|
|
376
|
+
* 🚚 Gets a logistic order's approvers.
|
|
377
|
+
*
|
|
378
|
+
* This function retrieves the users able to approve a specific logistic order, identified by the `orderId`. This parameter is mandatory and validated
|
|
379
|
+
* before the request is executed.
|
|
380
|
+
*
|
|
381
|
+
* 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId}/approvers [ORDER-556]`
|
|
382
|
+
*
|
|
383
|
+
* | Parameter | Type | Required | Description |
|
|
384
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
385
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the approvers. |
|
|
386
|
+
*
|
|
387
|
+
* 📤 **Returns**:
|
|
388
|
+
* A `Promise` resolving to a single `ApproveLogisticOrderResponse` object representing a list of approval objects, a combination of a user, the logistic order and an approval status.
|
|
389
|
+
*
|
|
390
|
+
* 🛠 **Example usage**:
|
|
391
|
+
* ```ts
|
|
392
|
+
* const approvalObjects = await getLogisticOrderApprovers({
|
|
393
|
+
* orderId: "logisticOrder1",
|
|
394
|
+
* });
|
|
395
|
+
* ```
|
|
396
|
+
*
|
|
397
|
+
* @param {GetLogisticOrderApproversParameters} params - The parameters for the request.
|
|
398
|
+
* @throws {Error} If `orderId` is missing.
|
|
399
|
+
* @returns {Promise<GetLogisticOrderApproversResponse>} A promise resolving to the response containing a list of approval objects.
|
|
400
|
+
*/
|
|
401
|
+
export declare function getLogisticOrderApprovers({ orderId, }: GetLogisticOrderApproversParameters): Promise<GetLogisticOrderApproversResponse>;
|
|
402
|
+
/**
|
|
403
|
+
* 🚚 Updates a logistic order's billing information.
|
|
404
|
+
*
|
|
405
|
+
* This function updates the billing information of a specific logistic order, both identified by the `orderId` and the `billingAddressId`. Both parameters are mandatory and validated
|
|
406
|
+
* before the request is executed.
|
|
407
|
+
*
|
|
408
|
+
* 🛠 **Endpoint**: `PUT /v1/shop/logistic-orders/${orderId}/billing-information [ORDER-209]`
|
|
409
|
+
*
|
|
410
|
+
* | Parameter | Type | Required | Description |
|
|
411
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
412
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order of which you want to update the billing information. |
|
|
413
|
+
* | `billingAddressId`| `string` | ✅ | The ID of the billing address you want to add to the logistic order. |
|
|
414
|
+
*
|
|
415
|
+
* 📤 **Returns**:
|
|
416
|
+
* A `Promise` resolving when the billing information of the logistic order is updated.
|
|
417
|
+
*
|
|
418
|
+
* 🛠 **Example usage**:
|
|
419
|
+
* ```ts
|
|
420
|
+
* await updateLogisticOrderBillingInformation({
|
|
421
|
+
* orderId: "logisticOrder1",
|
|
422
|
+
* billingAddressId: "address1",
|
|
423
|
+
* });
|
|
424
|
+
* ```
|
|
425
|
+
*
|
|
426
|
+
* @param {UpdateLogisticOrderBillingInformationParameters} params - The parameters for the request.
|
|
427
|
+
* @throws {Error} If `orderId` or `billingAddressId` is missing.
|
|
428
|
+
* @returns {Promise<void>} A promise resolving when the billing information is updated.
|
|
429
|
+
*/
|
|
430
|
+
export declare function updateLogisticOrderBillingInformation({ orderId, billingAddressId, }: UpdateLogisticOrderBillingInformationParameters): Promise<void>;
|
|
431
|
+
/**
|
|
432
|
+
* 🚚 Cancels a logistic order.
|
|
433
|
+
*
|
|
434
|
+
* This function cancels a specific logistic order, identified by the `orderId`. The parameters `orderId` and `locale` are mandatory and validated
|
|
435
|
+
* before the request is executed.
|
|
436
|
+
*
|
|
437
|
+
* 🛠 **Endpoint**: `PUT /v1/shop/logistic-orders/${orderId}/cancel [ORDER-201]`
|
|
438
|
+
*
|
|
439
|
+
* | Parameter | Type | Required | Description |
|
|
440
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
441
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order you want to cancel. |
|
|
442
|
+
* | `locale` | `string` | ✅ | The locale in which to return the logistic order. |
|
|
443
|
+
* | `nbPreviewLines` | `integer` | ❌ | The number of lines to display in the logistic order. |
|
|
444
|
+
*
|
|
445
|
+
* 📤 **Returns**:
|
|
446
|
+
* A `Promise` resolving to a single `CancelLogisticOrderResponse` object representing the logistic order cancelled.
|
|
447
|
+
*
|
|
448
|
+
* 🛠 **Example usage**:
|
|
449
|
+
* ```ts
|
|
450
|
+
* const order = await cancelLogisticOrder({
|
|
451
|
+
* orderId: "logisticOrder1",
|
|
452
|
+
* locale: "fr",
|
|
453
|
+
* });
|
|
454
|
+
* ```
|
|
455
|
+
*
|
|
456
|
+
* @param {CancelLogisticOrderParameters} params - The parameters for the request.
|
|
457
|
+
* @throws {Error} If `orderId` or `locale` is missing.
|
|
458
|
+
* @returns {Promise<CancelLogisticOrderResponse>} A promise resolving to the response containing the logistic order.
|
|
459
|
+
*/
|
|
460
|
+
export declare function cancelLogisticOrder({ orderId, locale, nbPreviewLines, }: CancelLogisticOrderParameters): Promise<CancelLogisticOrderResponse>;
|
|
461
|
+
/**
|
|
462
|
+
* 🚚 Confirms reception of logistic order.
|
|
463
|
+
*
|
|
464
|
+
* This function confirms the reception of a specific logistic order, identified by the `orderId`. The parameters `orderId` and `locale` are mandatory and validated
|
|
465
|
+
* before the request is executed.
|
|
466
|
+
*
|
|
467
|
+
* 🛠 **Endpoint**: `PUT /v1/shop/logistic-orders/${orderId}/confirm-reception [ORDER-203]`
|
|
468
|
+
*
|
|
469
|
+
* | Parameter | Type | Required | Description |
|
|
470
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
471
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order you want to confirm reception. |
|
|
472
|
+
* | `locale` | `string` | ✅ | The locale in which to return the logistic order. |
|
|
473
|
+
* | `nbPreviewLines` | `integer` | ❌ | The number of lines to display in the logistic order. |
|
|
474
|
+
*
|
|
475
|
+
* 📤 **Returns**:
|
|
476
|
+
* A `Promise` resolving to a single `ConfirmLogisticOrderReceptionResponse` object representing the logistic order received.
|
|
477
|
+
*
|
|
478
|
+
* 🛠 **Example usage**:
|
|
479
|
+
* ```ts
|
|
480
|
+
* const order = await confirmLogisticOrderReception({
|
|
481
|
+
* orderId: "logisticOrder1",
|
|
482
|
+
* locale: "fr",
|
|
483
|
+
* });
|
|
484
|
+
* ```
|
|
485
|
+
*
|
|
486
|
+
* @param {ConfirmLogisticOrderReceptionParameters} params - The parameters for the request.
|
|
487
|
+
* @throws {Error} If `orderId` or `locale` is missing.
|
|
488
|
+
* @returns {Promise<ConfirmLogisticOrderReceptionResponse>} A promise resolving to the response containing the logistic order.
|
|
489
|
+
*/
|
|
490
|
+
export declare function confirmLogisticOrderReception({ orderId, locale, nbPreviewLines, }: ConfirmLogisticOrderReceptionParameters): Promise<ConfirmLogisticOrderReceptionResponse>;
|
|
491
|
+
/**
|
|
492
|
+
* 🚚 Update a DRAFT_ORDER_ON_HOLD logistic order to CREATED.
|
|
493
|
+
*
|
|
494
|
+
* This function updates the status of a specific logistic order, identified by the `orderId`, from DRAFT_ORDER_ON_HOLD to CREATED. The parameter `orderId` is mandatory and validated
|
|
495
|
+
* before the request is executed.
|
|
496
|
+
*
|
|
497
|
+
* 🛠 **Endpoint**: `PUT /v1/shop/logistic-orders/${orderId}/created [ORDER-220]`
|
|
498
|
+
*
|
|
499
|
+
* | Parameter | Type | Required | Description |
|
|
500
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
501
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order you want to pass to CREATED. |
|
|
502
|
+
*
|
|
503
|
+
* 📤 **Returns**:
|
|
504
|
+
* A `Promise` resolving when the logistic order's status is passed to CREATED.
|
|
505
|
+
*
|
|
506
|
+
* 🛠 **Example usage**:
|
|
507
|
+
* ```ts
|
|
508
|
+
* await createLogisticOrder({
|
|
509
|
+
* orderId: "logisticOrder1",
|
|
510
|
+
* });
|
|
511
|
+
* ```
|
|
512
|
+
*
|
|
513
|
+
* @param {CreateLogisticOrderParameters} params - The parameters for the request.
|
|
514
|
+
* @throws {Error} If `orderId` or `locale` is missing.
|
|
515
|
+
* @returns {Promise<void>} A promise resolving when the logistic order is created.
|
|
516
|
+
*/
|
|
517
|
+
export declare function createLogisticOrder({ orderId, }: CreateLogisticOrderParameters): Promise<void>;
|
|
518
|
+
/**
|
|
519
|
+
* 🚚 Disapproves a logistic order.
|
|
520
|
+
*
|
|
521
|
+
* This function disapproves a specific logistic order, identified by the `orderId`. The parameters `orderId` and `locale` are mandatory and validated
|
|
522
|
+
* before the request is executed.
|
|
523
|
+
*
|
|
524
|
+
* 🛠 **Endpoint**: `PUT /v1/shop/logistic-orders/${orderId}/disapprove [ORDER-204]`
|
|
525
|
+
*
|
|
526
|
+
* | Parameter | Type | Required | Description |
|
|
527
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
528
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order you want to disapprove. |
|
|
529
|
+
* | `locale` | `string` | ✅ | The locale in which to return the logistic order. |
|
|
530
|
+
* | `nbPreviewLines` | `integer` | ❌ | The number of lines to display in the logistic order. |
|
|
531
|
+
*
|
|
532
|
+
* 📤 **Returns**:
|
|
533
|
+
* A `Promise` resolving to a single `DisapproveLogisticOrderResponse` object representing the logistic order disapproved.
|
|
534
|
+
*
|
|
535
|
+
* 🛠 **Example usage**:
|
|
536
|
+
* ```ts
|
|
537
|
+
* const order = await disapproveLogisticOrder({
|
|
538
|
+
* orderId: "logisticOrder1",
|
|
539
|
+
* locale: "fr",
|
|
540
|
+
* });
|
|
541
|
+
* ```
|
|
542
|
+
*
|
|
543
|
+
* @param {DisapproveLogisticOrderParameters} params - The parameters for the request.
|
|
544
|
+
* @throws {Error} If `orderId` or `locale` is missing.
|
|
545
|
+
* @returns {Promise<DisapproveLogisticOrderResponse>} A promise resolving to the response containing the logistic order.
|
|
546
|
+
*/
|
|
547
|
+
export declare function disapproveLogisticOrder({ orderId, locale, nbPreviewLines, }: DisapproveLogisticOrderParameters): Promise<DisapproveLogisticOrderResponse>;
|
|
548
|
+
/**
|
|
549
|
+
* 🚚 Gets a specific logistic order's documents.
|
|
550
|
+
*
|
|
551
|
+
* This function retrieves the documents of a specific logistic order, identified by
|
|
552
|
+
* the `orderId`. This parameter is mandatory and validated
|
|
553
|
+
* before the request is executed.
|
|
554
|
+
*
|
|
555
|
+
* 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId}/documents [ORDER-552]`
|
|
556
|
+
*
|
|
557
|
+
* | Parameter | Type | Required | Description |
|
|
558
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
559
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the documents. |
|
|
560
|
+
* | `idType` | `OrderIdType` | ❌ | The type of order ID (e.g., `DJUST_ID`, `EXTERNAL_ID`, `REFERENCE`). |
|
|
561
|
+
*
|
|
562
|
+
* 📤 **Returns**:
|
|
563
|
+
* A `Promise` resolving to a single `GetLogisticOrderDocumentsParameters` object representing the list of documents of the logistic order.
|
|
564
|
+
*
|
|
565
|
+
* 🛠 **Example usage**:
|
|
566
|
+
* ```ts
|
|
567
|
+
* const documents = await getLogisticOrderDocuments({
|
|
568
|
+
* orderId: "logisticOrder1",
|
|
569
|
+
* });
|
|
570
|
+
* ```
|
|
571
|
+
*
|
|
572
|
+
* @param {GetLogisticOrderDocumentsParameters} params - The parameters for the request.
|
|
573
|
+
* @throws {Error} If `orderId` is missing.
|
|
574
|
+
* @returns {Promise<GetLogisticOrderDocumentsParameters>} A promise resolving to the response containing the list of documents.
|
|
575
|
+
*/
|
|
576
|
+
export declare function getLogisticOrderDocuments({ orderId, idType, }: GetLogisticOrderDocumentsParameters): Promise<GetLogisticOrderDocumentsResponse>;
|
|
577
|
+
/**
|
|
578
|
+
* 🚚 Gets specific document urls of a specific logistic order.
|
|
579
|
+
*
|
|
580
|
+
* This function retrieves specific document urls of a specific logistic order, both identified by
|
|
581
|
+
* the `orderId` and the `documentId`. Both parameters are mandatory and validated
|
|
582
|
+
* before the request is executed.
|
|
583
|
+
*
|
|
584
|
+
* 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId}/documents/{documentId} [ORDER-508]`
|
|
585
|
+
*
|
|
586
|
+
* | Parameter | Type | Required | Description |
|
|
587
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
588
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the documents. |
|
|
589
|
+
* | `documentId` | `string` | ✅ | The ID of the document to be downloaded. |
|
|
590
|
+
*
|
|
591
|
+
* 📤 **Returns**:
|
|
592
|
+
* A `Promise` resolving to a single `GetLogisticOrderAccountingDocumentsResponse` object representing the list of document's urls.
|
|
593
|
+
*
|
|
594
|
+
* 🛠 **Example usage**:
|
|
595
|
+
* ```ts
|
|
596
|
+
* const documentUrls = await getLogisticOrderDocumentUrl({
|
|
597
|
+
* orderId: "logisticOrder1",
|
|
598
|
+
* documentId: "document1",
|
|
599
|
+
* });
|
|
600
|
+
* ```
|
|
601
|
+
*
|
|
602
|
+
* @param {GetLogisticOrderAccountingDocumentUrlParameters} params - The parameters for the request.
|
|
603
|
+
* @throws {Error} If `orderId` or `documentId` is missing.
|
|
604
|
+
* @returns {Promise<string[]>} A promise resolving to the response containing the list of document's urls.
|
|
605
|
+
*/
|
|
606
|
+
export declare function getLogisticOrderDocumentUrl({ orderId, documentId, }: GetLogisticOrderDocumentUrlParameters): Promise<string[]>;
|
|
607
|
+
/**
|
|
608
|
+
* 🚚 Gets order lines of a specific logistic order.
|
|
609
|
+
*
|
|
610
|
+
* This function retrieves the order lines of a specific logistic order, identified by
|
|
611
|
+
* the `orderId`. This parameter is mandatory and validated
|
|
612
|
+
* before the request is executed.
|
|
613
|
+
*
|
|
614
|
+
* 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId}/lines [ORDER-555]`
|
|
615
|
+
*
|
|
616
|
+
* | Parameter | Type | Required | Description |
|
|
617
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
618
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the order lines. |
|
|
619
|
+
* | `page` | `integer` | ❌ | The page number you want to retrieve. |
|
|
620
|
+
* | `size` | `integer` | ❌ | The size of the page you want to retrieve. |
|
|
621
|
+
* | `sort` | `string` | ❌ | The order how you want to retrieve the custom fields. |
|
|
622
|
+
* | `locale` | `string` | ❌ | The locale in which to return the logistic order lines. |
|
|
623
|
+
*
|
|
624
|
+
* 📤 **Returns**:
|
|
625
|
+
* A `Promise` resolving to a single `GetLogisticOrderLinesResponse` object representing the page of logistic order lines.
|
|
626
|
+
*
|
|
627
|
+
* 🛠 **Example usage**:
|
|
628
|
+
* ```ts
|
|
629
|
+
* const logisticOrderLines = await getLogisticOrderLines({
|
|
630
|
+
* orderId: "logisticOrder1",
|
|
631
|
+
* });
|
|
632
|
+
* ```
|
|
633
|
+
*
|
|
634
|
+
* @param {GetLogisticOrderLinesParameters} params - The parameters for the request.
|
|
635
|
+
* @throws {Error} If `orderId` is missing.
|
|
636
|
+
* @returns {Promise<GetLogisticOrderLinesResponse>} A promise resolving to the response containing the page object.
|
|
637
|
+
*/
|
|
638
|
+
export declare function getLogisticOrderLines({ orderId, page, size, sort, locale, }: GetLogisticOrderLinesParameters): Promise<GetLogisticOrderLinesResponse>;
|
|
639
|
+
/**
|
|
640
|
+
* 🚚 Updates order lines of a specific DRAFT_ORDER_ON_HOLD logistic order.
|
|
641
|
+
*
|
|
642
|
+
* This function updates the confirmed quantity and custom field values of the order lines of a specific logistic order, identified by
|
|
643
|
+
* the `orderId`. This parameter, as well as the `lines`, is mandatory and validated before the request is executed.
|
|
644
|
+
*
|
|
645
|
+
* 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId}/lines [ORDER-250]`
|
|
646
|
+
*
|
|
647
|
+
* | Parameter | Type | Required | Description |
|
|
648
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
649
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order of which you want to update the lines. |
|
|
650
|
+
* | `lines` | `OrderLogisticLineUpdate[]` | ✅ | The lines you want to update. |
|
|
651
|
+
*
|
|
652
|
+
* 📤 **Returns**:
|
|
653
|
+
* A `Promise` resolving to a single `UpdateOnHoldLogisticOrderLinesResponse` object representing the error report for each lines that failed to update.
|
|
654
|
+
*
|
|
655
|
+
* 🛠 **Example usage**:
|
|
656
|
+
* ```ts
|
|
657
|
+
* const errorReport = await updateOnHoldLogisticOrderLines({
|
|
658
|
+
* orderId: "logisticOrder1",
|
|
659
|
+
* lines: [
|
|
660
|
+
{
|
|
661
|
+
"customFields": [
|
|
662
|
+
{
|
|
663
|
+
"customFieldId": "customField1",
|
|
664
|
+
"customFieldValue": "value1"
|
|
665
|
+
}
|
|
666
|
+
],
|
|
667
|
+
"id": "orderLine1",
|
|
668
|
+
"quantity": 1,
|
|
669
|
+
"updateAction": "ADD_QUANTITY"
|
|
670
|
+
}
|
|
671
|
+
]
|
|
672
|
+
* });
|
|
673
|
+
* ```
|
|
674
|
+
*
|
|
675
|
+
* @param {UpdateOnHoldLogisticOrderLinesParameters} params - The parameters for the request.
|
|
676
|
+
* @throws {Error} If `orderId` or `lines` is missing.
|
|
677
|
+
* @returns {Promise<UpdateOnHoldLogisticOrderLinesResponse>} A promise resolving to the response containing the error report.
|
|
678
|
+
*/
|
|
679
|
+
export declare function updateOnHoldLogisticOrderLines({ orderId, lines, }: UpdateOnHoldLogisticOrderLinesParameters): Promise<UpdateOnHoldLogisticOrderLinesResponse>;
|
|
680
|
+
/**
|
|
681
|
+
* 🚚 Updates specific logistic order line's customFields.
|
|
682
|
+
*
|
|
683
|
+
* This function updates a specific logistic order line's customFields, identified by both
|
|
684
|
+
* the `orderId` and the `lineId`. These parameters, as well as the `customFields` is mandatory and validated
|
|
685
|
+
* before the request is executed.
|
|
686
|
+
*
|
|
687
|
+
* 🛠 **Endpoint**: `PATCH /v1/shop/logistic-orders/${orderId}/lines/${lineId} [ORDER-206]`
|
|
688
|
+
*
|
|
689
|
+
* | Parameter | Type | Required | Description |
|
|
690
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
691
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order of which you want to update an order line. |
|
|
692
|
+
* | `lineId` | `string` | ✅ | The ID of the logistic order line you want to update. |
|
|
693
|
+
* | `customFields` | `CustomFieldValueObject[]` | ✅ | The custom fields to add with value and externalId. |
|
|
694
|
+
* | `locale` | `string` | ❌ | The locale in which to return the logistic order lines. |
|
|
695
|
+
*
|
|
696
|
+
* 📤 **Returns**:
|
|
697
|
+
* A `Promise` resolving to a single `UpdateLogisticOrderLineCustomFieldsResponse` object representing the updated logistic order line.
|
|
698
|
+
*
|
|
699
|
+
* 🛠 **Example usage**:
|
|
700
|
+
* ```ts
|
|
701
|
+
* const newLogisticOrderLine = await updateLogisticOrderLineCustomFields({
|
|
702
|
+
* orderId: "logisticOrder1",
|
|
703
|
+
* lineId: "logisticOrderLine1",
|
|
704
|
+
* customFields: [{externalId: "cf1", value: "value1"}, {externalId: "cf2", value: "value2"}]
|
|
705
|
+
* });
|
|
706
|
+
* ```
|
|
707
|
+
*
|
|
708
|
+
* @param {UpdateLogisticOrderLineCustomFieldsParameters} params - The parameters for the request.
|
|
709
|
+
* @throws {Error} If `orderId` or `lineId` is missing.
|
|
710
|
+
* @returns {Promise<UpdateLogisticOrderLineCustomFieldsResponse>} A promise resolving to the response containing the logistic order line.
|
|
711
|
+
*/
|
|
712
|
+
export declare function updateLogisticOrderLineCustomFields({ orderId, lineId, locale, customFields, }: UpdateLogisticOrderLineCustomFieldsParameters): Promise<UpdateLogisticOrderLineCustomFieldsResponse>;
|
|
713
|
+
/**
|
|
714
|
+
* 🚚 Updates order line of a specific DRAFT_ORDER_ON_HOLD logistic order.
|
|
715
|
+
*
|
|
716
|
+
* This function updates the confirmed quantity of a specific order line of a specific logistic order, both identified by
|
|
717
|
+
* the `orderId` and the `orderLineId`. Both parameters, as well as the `quantity`, are mandatory and validated before the request is executed.
|
|
718
|
+
*
|
|
719
|
+
* 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId}/lines/${orderLineId} [ORDER-218]`
|
|
720
|
+
*
|
|
721
|
+
* | Parameter | Type | Required | Description |
|
|
722
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
723
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order of which you want to update the lines. |
|
|
724
|
+
* | `orderLineId` | `string` | ✅ | The ID of the logistic order line you want to update. |
|
|
725
|
+
* | `quantity` | `number` | ✅ | The lines you want to update. |
|
|
726
|
+
*
|
|
727
|
+
* 📤 **Returns**:
|
|
728
|
+
* A `Promise` resolving when the logistic order line is updated.
|
|
729
|
+
*
|
|
730
|
+
* 🛠 **Example usage**:
|
|
731
|
+
* ```ts
|
|
732
|
+
* await updateOnHoldLogisticOrderLine({
|
|
733
|
+
* orderId: "logisticOrder1",
|
|
734
|
+
* orderLineId: "logisticOrderLine1",
|
|
735
|
+
* quantity: 1
|
|
736
|
+
* ```
|
|
737
|
+
*
|
|
738
|
+
* @param {UpdateOnHoldLogisticOrderLineParameters} params - The parameters for the request.
|
|
739
|
+
* @throws {Error} If `orderId`, `orderLineId` or `quantity` is missing.
|
|
740
|
+
* @returns {Promise<void>} A promise resolving when the logistic order line is updated.
|
|
741
|
+
*/
|
|
742
|
+
export declare function updateOnHoldLogisticOrderLine({ orderId, orderLineId, quantity, }: UpdateOnHoldLogisticOrderLineParameters): Promise<void>;
|
|
743
|
+
/**
|
|
744
|
+
* 🚚 Updates a logistic order's shipping address.
|
|
745
|
+
*
|
|
746
|
+
* This function updates the shipping address of a specific logistic order, both identified by the `orderId` and the `shippingAddressId`. Both parameters are mandatory and validated
|
|
747
|
+
* before the request is executed.
|
|
748
|
+
*
|
|
749
|
+
* 🛠 **Endpoint**: `PUT /v1/shop/logistic-orders/${orderId}/shipping-address [ORDER-210]`
|
|
750
|
+
*
|
|
751
|
+
* | Parameter | Type | Required | Description |
|
|
752
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
753
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order of which you want to update the shipping address. |
|
|
754
|
+
* | `shippingAddressId`| `string` | ✅ | The ID of the shipping address you want to set to the logistic order. |
|
|
755
|
+
*
|
|
756
|
+
* 📤 **Returns**:
|
|
757
|
+
* A `Promise` resolving when the shipping address of the logistic order is set.
|
|
758
|
+
*
|
|
759
|
+
* 🛠 **Example usage**:
|
|
760
|
+
* ```ts
|
|
761
|
+
* await updateLogisticOrderShippingAddress({
|
|
762
|
+
* orderId: "logisticOrder1",
|
|
763
|
+
* shippingAddressId: "address1",
|
|
764
|
+
* });
|
|
765
|
+
* ```
|
|
766
|
+
*
|
|
767
|
+
* @param {UpdateLogisticOrderShippingInformationParameters} params - The parameters for the request.
|
|
768
|
+
* @throws {Error} If `orderId` or `shippingAddressId` is missing.
|
|
769
|
+
* @returns {Promise<void>} A promise resolving when the shipping address of the logistic order is set.
|
|
770
|
+
*/
|
|
771
|
+
export declare function updateLogisticOrderShippingAddress({ orderId, shippingAddressId, }: UpdateLogisticOrderShippingAddressParameters): Promise<void>;
|
|
772
|
+
/**
|
|
773
|
+
* 🚚 Gets a logistic order's shipping information.
|
|
774
|
+
*
|
|
775
|
+
* This function retrieves the shipping information of a specific logistic order, identified by the `orderId`. This parameter is mandatory and validated
|
|
776
|
+
* before the request is executed.
|
|
777
|
+
*
|
|
778
|
+
* 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId}/shipping-information [ORDER-502]`
|
|
779
|
+
*
|
|
780
|
+
* | Parameter | Type | Required | Description |
|
|
781
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
782
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the shipping information. |
|
|
783
|
+
*
|
|
784
|
+
* 📤 **Returns**:
|
|
785
|
+
* A `Promise` resolving to a single `GetLogisticOrderShippingAddressResponse` object representing the array of the logistic order's shipping information.
|
|
786
|
+
*
|
|
787
|
+
* 🛠 **Example usage**:
|
|
788
|
+
* ```ts
|
|
789
|
+
* const shippingInformation = await getLogisticOrderShippingInformation({
|
|
790
|
+
* orderId: "logisticOrder1",
|
|
791
|
+
* });
|
|
792
|
+
* ```
|
|
793
|
+
*
|
|
794
|
+
* @param {GetLogisticOrderShippingAddressParameters} params - The parameters for the request.
|
|
795
|
+
* @throws {Error} If `orderId` is missing.
|
|
796
|
+
* @returns {Promise<GetLogisticOrderShippingAddressResponse>} A promise resolving to the response containing the array of shipping information.
|
|
797
|
+
*/
|
|
798
|
+
export declare function getLogisticOrderShippingInformation({ orderId, }: GetLogisticOrderShippingAddressParameters): Promise<GetLogisticOrderShippingAddressResponse>;
|
|
799
|
+
/**
|
|
800
|
+
* 🚚 Updates a logistic order's shipping information.
|
|
801
|
+
*
|
|
802
|
+
* This function updates the shipping information of a specific logistic order, identified by the `orderId`. This parameter, as well as the `shippingAddressId` and the `shippingType`, are mandatory and validated
|
|
803
|
+
* before the request is executed.
|
|
804
|
+
*
|
|
805
|
+
* 🛠 **Endpoint**: `PUT /v1/shop/logistic-orders/${orderId}/shipping-information [ORDER-214]`
|
|
806
|
+
*
|
|
807
|
+
* | Parameter | Type | Required | Description |
|
|
808
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
809
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order of which you want to update the shipping information. |
|
|
810
|
+
* | `shippingAddressId`| `string` | ✅ | The ID of the shipping address you want to add to the logistic order. |
|
|
811
|
+
* | `shippingType` | `string` | ✅ | The type of shipping address to be added with the shipping address. |
|
|
812
|
+
*
|
|
813
|
+
* 📤 **Returns**:
|
|
814
|
+
* A `Promise` resolving when the shipping information of the logistic order is updated.
|
|
815
|
+
*
|
|
816
|
+
* 🛠 **Example usage**:
|
|
817
|
+
* ```ts
|
|
818
|
+
* await updateLogisticOrderShippingInformation({
|
|
819
|
+
* orderId: "logisticOrder1",
|
|
820
|
+
* shippingAddressId: "address1",
|
|
821
|
+
* });
|
|
822
|
+
* ```
|
|
823
|
+
*
|
|
824
|
+
* @param {UpdateLogisticOrderShippingInformationParameters} params - The parameters for the request.
|
|
825
|
+
* @throws {Error} If `orderId` or `shippingAddressId` is missing.
|
|
826
|
+
* @returns {Promise<void>} A promise resolving when the shipping information is updated.
|
|
827
|
+
*/
|
|
828
|
+
export declare function updateLogisticOrderShippingInformation({ orderId, shippingAddressId, shippingType, }: UpdateLogisticOrderShippingInformationParameters): Promise<void>;
|
|
829
|
+
/**
|
|
830
|
+
* 🚚 Updates a logistic order's shipping type.
|
|
831
|
+
*
|
|
832
|
+
* This function updates the shipping type of a specific logistic order, both identified by the `orderId` and the `shippingType`. Both parameters are mandatory and validated
|
|
833
|
+
* before the request is executed.
|
|
834
|
+
*
|
|
835
|
+
* 🛠 **Endpoint**: `PUT /v1/shop/logistic-orders/${orderId}/shipping-information [ORDER-211]`
|
|
836
|
+
*
|
|
837
|
+
* | Parameter | Type | Required | Description |
|
|
838
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
839
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order of which you want to update the shipping type. |
|
|
840
|
+
* | `shippingType` | `string` | ✅ | The shipping type you want to set to the logistic order. |
|
|
841
|
+
*
|
|
842
|
+
* 📤 **Returns**:
|
|
843
|
+
* A `Promise` resolving when the shipping type of the logistic order is set.
|
|
844
|
+
*
|
|
845
|
+
* 🛠 **Example usage**:
|
|
846
|
+
* ```ts
|
|
847
|
+
* await updateLogisticOrderShippingType({
|
|
848
|
+
* orderId: "logisticOrder1",
|
|
849
|
+
* shippingType: "shipping_type",
|
|
850
|
+
* });
|
|
851
|
+
* ```
|
|
852
|
+
*
|
|
853
|
+
* @param {UpdateLogisticOrderShippingTypeParameters} params - The parameters for the request.
|
|
854
|
+
* @throws {Error} If `orderId` or `shippingType` is missing.
|
|
855
|
+
* @returns {Promise<void>} A promise resolving when the shipping type of the logistic order is set.
|
|
856
|
+
*/
|
|
857
|
+
export declare function updateLogisticOrderShippingType({ orderId, shippingType, }: UpdateLogisticOrderShippingTypeParameters): Promise<void>;
|
|
858
|
+
/**
|
|
859
|
+
* 🚚 Creates a thread on a specific logistic order.
|
|
860
|
+
*
|
|
861
|
+
* This function creates a thread on a specific logistic order, identified by
|
|
862
|
+
* the `orderId`. This parameter, as well as the `lineId`, the `message` and the `reasonCode`, is mandatory and validated
|
|
863
|
+
* before the request is executed.
|
|
864
|
+
*
|
|
865
|
+
* 🛠 **Endpoint**: `POST /v1/shop/logistic-orders/${orderId}/threads [THREAD-100]`
|
|
866
|
+
*
|
|
867
|
+
* | Parameter | Type | Required | Description |
|
|
868
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
869
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order for which you want to create a thread. |
|
|
870
|
+
* | `lineId` | `string` | ❌ | The ID of the logistic order line involved in the thread. |
|
|
871
|
+
* | `message` | `string` | ❌ | A message to add comments on the thread. |
|
|
872
|
+
* | `reasonCode` | `string` | ❌ | The code indentifying the type of thread. |
|
|
873
|
+
*
|
|
874
|
+
* 📤 **Returns**:
|
|
875
|
+
* A `Promise` resolving to a `CreateLogisticOrderThreadResponse` object when the thread is created.
|
|
876
|
+
*
|
|
877
|
+
* 🛠 **Example usage**:
|
|
878
|
+
* ```ts
|
|
879
|
+
* await createLogisticOrderThread({
|
|
880
|
+
* orderId: "logisticOrder1",
|
|
881
|
+
* lineId: "logisticOrderLine1",
|
|
882
|
+
* message: "This is a message",
|
|
883
|
+
* reasonCode: "REFUND"
|
|
884
|
+
* });
|
|
885
|
+
* ```
|
|
886
|
+
*
|
|
887
|
+
* @param {CreateLogisticOrderThreadParameters} params - The parameters for the request.
|
|
888
|
+
* @throws {Error} If `orderId` is missing.
|
|
889
|
+
* @returns {Promise<CreateLogisticOrderThreadResponse>} A promise resolving when the thread is created.
|
|
890
|
+
*/
|
|
891
|
+
export declare function createLogisticOrderThread({ orderId, lineId, message, reasonCode, }: CreateLogisticOrderThreadParameters): Promise<CreateLogisticOrderThreadResponse>;
|
|
892
|
+
/**
|
|
893
|
+
* 🚚 Creates a thread on a specific logistic order V2.
|
|
894
|
+
*
|
|
895
|
+
* This function creates a thread on a specific logistic order, identified by (Version 2)
|
|
896
|
+
* the `logisticOrderId` and `reasonCode`, are mandatory and validated
|
|
897
|
+
* before the request is executed.
|
|
898
|
+
*
|
|
899
|
+
* 🛠 **Endpoint**: `POST /v2/shop/logistic-orders/${logisticOrderId}/threads [THREAD-101]`
|
|
900
|
+
*
|
|
901
|
+
* | Parameter | Type | Required | Description |
|
|
902
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
903
|
+
* | `logisticOrderId` | `string` | ✅ | The ID of the logistic order for which you want to create a thread. |
|
|
904
|
+
* | `idType` | `IdType` | ❌ | The type of the id. |
|
|
905
|
+
* | `message` | `string` | ❌ | A message to add comments on the thread. |
|
|
906
|
+
* | `name` | `string` | ❌ | The name of the thread. |
|
|
907
|
+
* | `reasonCode` | `string` | ✅ | The code indentifying the type of thread. |
|
|
908
|
+
*
|
|
909
|
+
* 📤 **Returns**:
|
|
910
|
+
* A `Promise` resolving to a `CreateLogisticOrderThreadResponseV2` object when the threads are created.
|
|
911
|
+
*
|
|
912
|
+
* 🛠 **Example usage**:
|
|
913
|
+
* ```ts
|
|
914
|
+
* await createLogisticOrderThreadV2({
|
|
915
|
+
* logisticOrderId: "logisticOrder1",
|
|
916
|
+
* idType: "DJUST_ID",
|
|
917
|
+
* name: "This is a test thread",
|
|
918
|
+
* message: "This is a message",
|
|
919
|
+
* reasonCode: "REFUND"
|
|
920
|
+
* });
|
|
921
|
+
* ```
|
|
922
|
+
*
|
|
923
|
+
* @param {CreateLogisticOrderThreadParametersV2} params - The parameters for the request.
|
|
924
|
+
* @throws {Error} If `logisticOrderId`, `reasonCode` is missing.
|
|
925
|
+
* @returns {Promise<CreateLogisticOrderThreadResponseV2>} A promise resolving when the thread is created.
|
|
926
|
+
*/
|
|
927
|
+
export declare function createLogisticOrderThreadV2({ logisticOrderId, idType, message, reasonCode, }: CreateLogisticOrderThreadParametersV2): Promise<CreateLogisticOrderThreadResponseV2>;
|
|
928
|
+
/**
|
|
929
|
+
* 🚚 Get order logistic threads.
|
|
930
|
+
*
|
|
931
|
+
* This function return the list of threads related to a specific logistic order.
|
|
932
|
+
*
|
|
933
|
+
* 🛠 **Endpoint**: `GET /v2/shop/logistic-orders/${logisticOrderId}/threads [ORDER-558]`
|
|
934
|
+
*
|
|
935
|
+
* | Parameter | Type | Required | Description |
|
|
936
|
+
* |-------------------|-------------|----------|------------------------------------------------------------------------|
|
|
937
|
+
* | `logisticOrderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the review. |
|
|
938
|
+
* | `pageable.page` | `number` | ❌ | The page number |
|
|
939
|
+
* | `pageable.size` | `number` | ❌ | The number of items per page. |
|
|
940
|
+
*
|
|
941
|
+
* 📤 **Returns**:
|
|
942
|
+
* A `Promise` resolving to a `GetLogisticOrderThreadsResponse`.
|
|
943
|
+
*
|
|
944
|
+
* 🛠 **Example usage**:
|
|
945
|
+
* ```ts
|
|
946
|
+
* const threads = await getLogisticOrderThreads({
|
|
947
|
+
* logisticOrderId: "logisticOrder1",
|
|
948
|
+
* pageable: { page: 1, size: 10 },
|
|
949
|
+
* });
|
|
950
|
+
* ```
|
|
951
|
+
*
|
|
952
|
+
* @param {GetLogisticOrderThreadsParams} params - The parameters for the request.
|
|
953
|
+
* @throws {Error} If `logisticOrderId` is missing.
|
|
954
|
+
* @returns {Promise<GetLogisticOrderThreadsResponse>} A promise resolving when the thread is created.
|
|
955
|
+
*/
|
|
956
|
+
export declare function getLogisticOrderThreads({ logisticOrderId, pageable, idType, }: GetLogisticOrderThreadsParams): Promise<GetLogisticOrderThreadsResponse>;
|
|
957
|
+
/**
|
|
958
|
+
* 🚚 Get a logistic order thread.
|
|
959
|
+
*
|
|
960
|
+
* This function retrieves a specific logistic order thread, identified by
|
|
961
|
+
* the `logisticOrderId` and `threadId`. Both parameters are mandatory and validated
|
|
962
|
+
* before the request is executed.
|
|
963
|
+
*
|
|
964
|
+
* 🛠 **Endpoint**: `GET /v2/shop/logistic-orders/${logisticOrderId}/threads/${threadId} [ORDER-509]`
|
|
965
|
+
*
|
|
966
|
+
* | Parameter | Type | Required | Description |
|
|
967
|
+
* |-------------------|-------------|----------|------------------------------------------------------------------------|
|
|
968
|
+
* | `logisticOrderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the review. |
|
|
969
|
+
* | `threadId` | `string` | ✅ | The ID of the thread of which you want to retrieve the review. |
|
|
970
|
+
*
|
|
971
|
+
* 📤 **Returns**:
|
|
972
|
+
* A `Promise` resolving to a `GetLogisticOrderThreadResponse`.
|
|
973
|
+
*
|
|
974
|
+
* 🛠 **Example usage**:
|
|
975
|
+
* ```ts
|
|
976
|
+
* const threads = await getLogisticOrderThread({
|
|
977
|
+
* logisticOrderId: "logisticOrder1",
|
|
978
|
+
* threadId: "thread1",
|
|
979
|
+
* });
|
|
980
|
+
* ```
|
|
981
|
+
*
|
|
982
|
+
* @param {GetLogisticOrderThreadsParams} params - The parameters for the request.
|
|
983
|
+
* @throws {Error} If `logisticOrderId` or `threadId` is missing.
|
|
984
|
+
* @returns {Promise<GetLogisticOrderThreadResponse>} A promise resolving when the thread is found.
|
|
985
|
+
*/
|
|
986
|
+
export declare function getLogisticOrderThread({ logisticOrderId, threadId, idType, }: GetLogisticOrderThreadParams): Promise<GetLogisticOrderThreadResponse>;
|
|
987
|
+
/**
|
|
988
|
+
* 🚚 Create messages for a specific logistic order thread.
|
|
989
|
+
* This function retrieves a specific logistic order thread, identified by
|
|
990
|
+
* the `logisticOrderId` and `threadId`. Both parameters are mandatory and validated
|
|
991
|
+
* before the request is executed.
|
|
992
|
+
*
|
|
993
|
+
* 🛠 **Endpoint**: `GET /v2/shop/logistic-orders/${logisticOrderId}/threads/${threadId}/messages [ORDER-217]`
|
|
994
|
+
*
|
|
995
|
+
* | Parameter | Type | Required | Description |
|
|
996
|
+
* |-------------------|---------------------------------------------------------|----------|------------------------------------------------------------------------|
|
|
997
|
+
* | `logisticOrderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the review. |
|
|
998
|
+
* | `threadId` | `string` | ✅ | The ID of the thread of which you want to retrieve the review. |
|
|
999
|
+
* | `body` | `string` | ❌ | The body of the message to be added to the thread. |
|
|
1000
|
+
* | `customField` | `logisticOrderIncidentThreadsCustomFieldValueRequest[]` | ❌ | The custom fields to add to the created incident threads messages |
|
|
1001
|
+
*
|
|
1002
|
+
* 📤 **Returns**:
|
|
1003
|
+
* A `Promise` resolving to a `CreateLogisticOrderThreadMessagesResponse`.
|
|
1004
|
+
*
|
|
1005
|
+
* 🛠 **Example usage**:
|
|
1006
|
+
* ```ts
|
|
1007
|
+
* const threads = await createOrderLogisticThreadMessages({
|
|
1008
|
+
* logisticOrderId: "logisticOrder1",
|
|
1009
|
+
* threadId: "thread1",
|
|
1010
|
+
* body: "This is a message",
|
|
1011
|
+
* customField: {
|
|
1012
|
+
* customFieldValues: [{ customFieldId: "cf1", customFieldValue: "value1" }],
|
|
1013
|
+
* idType: "EXTERNAL_ID",
|
|
1014
|
+
* },
|
|
1015
|
+
* });
|
|
1016
|
+
* ```
|
|
1017
|
+
*
|
|
1018
|
+
* @param {GetLogisticOrderThreadsParams} params - The parameters for the request.
|
|
1019
|
+
* @throws {Error} If `logisticOrderId` or `threadId` is missing.
|
|
1020
|
+
* @returns {Promise<CreateLogisticOrderThreadMessagesResponse>} A promise resolving when the thread is found.
|
|
1021
|
+
*/
|
|
1022
|
+
export declare function createOrderLogisticThreadMessages({ logisticOrderId, threadId, body, customField, idType, }: CreateLogisticOrderThreadMessagesParams): Promise<CreateLogisticOrderThreadMessagesResponse>;
|
|
1023
|
+
/**
|
|
1024
|
+
* 🚚 Update messages for a specific logistic order thread.
|
|
1025
|
+
*
|
|
1026
|
+
* This function retrieves a specific logistic order thread, identified by
|
|
1027
|
+
* the `logisticOrderId` and `threadId`. Both parameters are mandatory and validated
|
|
1028
|
+
* before the request is executed.
|
|
1029
|
+
*
|
|
1030
|
+
* 🛠 **Endpoint**: `PATCH /v2/shop/logistic-orders/${logisticOrderId}/threads/${threadId}/messages/${messageId} [ORDER-216]`
|
|
1031
|
+
*
|
|
1032
|
+
* | Parameter | Type | Required | Description |
|
|
1033
|
+
* |---------------------|-----------------------------|----------|------------------------------------------------------------------------|
|
|
1034
|
+
* | `logisticOrderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the review. |
|
|
1035
|
+
* | `threadId` | `string` | ✅ | The ID of the thread of which you want to retrieve the review. |
|
|
1036
|
+
* | `messageId` | `string` | ✅ | The ID of the message to be updated. |
|
|
1037
|
+
* | `customFieldValues` | `CustomFieldValueRequest[]` | ❌ | The custom fields to add to the created incident threads messages |
|
|
1038
|
+
* | `idType` | `IdType` | ❌ | The type of the id. |
|
|
1039
|
+
*
|
|
1040
|
+
* 📤 **Returns**:
|
|
1041
|
+
* A `Promise` resolving when the message is updated.
|
|
1042
|
+
|
|
1043
|
+
*
|
|
1044
|
+
* 🛠 **Example usage**:
|
|
1045
|
+
* ```ts
|
|
1046
|
+
* const threads = await updateOrderLogisticThreadMessage({
|
|
1047
|
+
* logisticOrderId: "logisticOrder1",
|
|
1048
|
+
* threadId: "thread1",
|
|
1049
|
+
* body: "This is a message",
|
|
1050
|
+
* customField: {
|
|
1051
|
+
* customFieldValues: [{ customFieldId: "cf1", customFieldValue: "value1" }],
|
|
1052
|
+
* idType: "EXTERNAL_ID",
|
|
1053
|
+
* },
|
|
1054
|
+
* });
|
|
1055
|
+
* ```
|
|
1056
|
+
*
|
|
1057
|
+
* @param {GetLogisticOrderThreadsParams} params - The parameters for the request.
|
|
1058
|
+
* @throws {Error} If `logisticOrderId`, `threadId`, `messageId` is missing.
|
|
1059
|
+
* @returns {Promise<void>} A promise resolving when the message updated.
|
|
1060
|
+
*/
|
|
1061
|
+
export declare function updateOrderLogisticThreadMessage({ logisticOrderId, threadId, messageId, customFieldValues, idType, }: UpdateLogisticOrderThreadMessageParams): Promise<void>;
|
|
1062
|
+
/**
|
|
1063
|
+
* 🚚 Creates a thread on a specific incident on a specific logistic order.
|
|
1064
|
+
*
|
|
1065
|
+
* This function creates a thread on a specific incident on a specific logistic order, identified by ``
|
|
1066
|
+
* `logisticOrderId`, incidentId, reasonCode, the parameters required and validated before the request is executed.
|
|
1067
|
+
*
|
|
1068
|
+
* 🛠 **Endpoint**: `POST /v2/shop/logistic-orders/${logisticOrderId}/incidents/${incidentId}/threads [ORDER-106]`
|
|
1069
|
+
*
|
|
1070
|
+
* | Parameter | Type | Required | Description |
|
|
1071
|
+
* |-------------------|---------------------------------------------------------|----------------------------|----------------------------------------------------------|
|
|
1072
|
+
* | `logisticOrderId` | `string` | ✅ | The ID of the logistic order |
|
|
1073
|
+
* | `incidentId` | `string` | ✅ | The ID of the incident |
|
|
1074
|
+
* | `customField` | `logisticOrderIncidentThreadsCustomFieldValueRequest[]` | ❌ | The custom fields to add to the created incident threads |
|
|
1075
|
+
* | `message` | `string` | ❌ | A message to add comments on the thread. |
|
|
1076
|
+
* | `name` | `string` | ❌ | The name of the thread |
|
|
1077
|
+
* | `reasonCode` | `string` | ✅ | The code indentifying the type of thread. |
|
|
1078
|
+
* | `idType` | `IdType` | ❌ | The type of the id. |
|
|
1079
|
+
*
|
|
1080
|
+
* 📤 **Returns**:
|
|
1081
|
+
* A `Promise` resolving to a `CreateLogisticOrderIncidentThreadsResponse` object when the thread is created.
|
|
1082
|
+
*
|
|
1083
|
+
* 🛠 **Example usage**:
|
|
1084
|
+
* ```ts
|
|
1085
|
+
* await createLogisticOrderIncidentThreads({
|
|
1086
|
+
* logisticOrderId: "logisticOrder1",
|
|
1087
|
+
* incidentId: "logisticOrderLine1",
|
|
1088
|
+
* customField: [
|
|
1089
|
+
* {
|
|
1090
|
+
* customFieldValues: [
|
|
1091
|
+
* {
|
|
1092
|
+
* "customFieldId": "string",
|
|
1093
|
+
* "customFieldValue": "string",
|
|
1094
|
+
* }
|
|
1095
|
+
* ],
|
|
1096
|
+
* "idType": "DJUST_ID"
|
|
1097
|
+
* }
|
|
1098
|
+
* ],
|
|
1099
|
+
* message: "string",
|
|
1100
|
+
* name: "string",
|
|
1101
|
+
* reasonCode: "string"
|
|
1102
|
+
* });
|
|
1103
|
+
* ```
|
|
1104
|
+
*
|
|
1105
|
+
* @param {CreateLogisticOrderIncidentThreadsParams} params - The parameters for the request.
|
|
1106
|
+
* @throws {Error} If `logisticOrderId`, `incidentId`, `reasonCode` is missing.
|
|
1107
|
+
* @returns {Promise<CreateLogisticOrderIncidentThreadsResponse>} A promise resolving when the thread is created.
|
|
1108
|
+
*/
|
|
1109
|
+
export declare function createLogisticOrderIncidentThreads({ logisticOrderId, incidentId, customField, message, name, reasonCode, idType, }: CreateLogisticOrderIncidentThreadsParams): Promise<CreateLogisticOrderIncidentThreadsResponse>;
|
|
1110
|
+
/**
|
|
1111
|
+
* 🚚 Gets a specific thread of specific incident of a specific logistic order.
|
|
1112
|
+
*
|
|
1113
|
+
* This function retrieves a specific logistic order line's review, identified by
|
|
1114
|
+
* The `orderId`, `incidentId` and `threadId` parameters are mandatory and validated
|
|
1115
|
+
* before the request is executed.
|
|
1116
|
+
*
|
|
1117
|
+
* 🛠 **Endpoint**: `GET /v2/shop/logistic-orders/${logisticOrderId}/incidents/${incidentId}/threads/${threadId} [ORDER-510]`
|
|
1118
|
+
*
|
|
1119
|
+
* | Parameter | Type | Required | Description |
|
|
1120
|
+
* |-------------------|---------------------------------|------------|------------------------------------------------------------------------|
|
|
1121
|
+
* | `logisticOrderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the review. |
|
|
1122
|
+
* | `incidentId` | `string` | ✅ | The ID of the incident of which you want to retrieve the review. |
|
|
1123
|
+
* | `threadId` | `string` | ✅ | The ID of the thread of which you want to retrieve the review. |
|
|
1124
|
+
* | `idType` | `IdType` | ❌ | The type of the id. |
|
|
1125
|
+
*
|
|
1126
|
+
* 📤 **Returns**:
|
|
1127
|
+
* A `Promise` resolving to a single `GetLogisticOrderIncidentThreadResponse` object representing the review of the thread.
|
|
1128
|
+
*
|
|
1129
|
+
* 🛠 **Example usage**:
|
|
1130
|
+
* ```ts
|
|
1131
|
+
* const review = await getLogisticOrderIncidentThread({
|
|
1132
|
+
* orderId: "logisticOrder1",
|
|
1133
|
+
* incidentId: "logisticOrderLine1",
|
|
1134
|
+
* threadId: "thread1",
|
|
1135
|
+
* });
|
|
1136
|
+
* ```
|
|
1137
|
+
*
|
|
1138
|
+
* @param {GetLogisticOrderIncidentThreadParams} params - The parameters for the request.
|
|
1139
|
+
* @throws {Error} If `logisticOrderId`, or `incidentId`, or `threadId` is missing.
|
|
1140
|
+
* @returns {Promise<GetLogisticOrderIncidentThreadResponse>} A promise resolving to a response containing the review of the thread.
|
|
1141
|
+
*/
|
|
1142
|
+
export declare function getLogisticOrderIncidentThread({ logisticOrderId, incidentId, threadId, idType, }: GetLogisticOrderIncidentThreadParams): Promise<GetLogisticOrderIncidentThreadResponse>;
|
|
1143
|
+
/**
|
|
1144
|
+
* 🚚 Creates messages for a specific incident thread of a specific logistic order.
|
|
1145
|
+
*
|
|
1146
|
+
* This function creates a thread on a specific incident on a specific logistic order, identified by
|
|
1147
|
+
* `logisticOrderId`, incidentId, threadId parameters are required and validated before the request is executed.
|
|
1148
|
+
*
|
|
1149
|
+
* 🛠 **Endpoint**: `POST /v2/shop/logistic-orders/${logisticOrderId}/incidents/${incidentId}/threads/messages [ORDER-103]`
|
|
1150
|
+
*
|
|
1151
|
+
* | Parameter | Type | Required | Description |
|
|
1152
|
+
* |-------------------|---------------------------------------------------------|------------|------------------------------------------------------------------------|
|
|
1153
|
+
* | `logisticOrderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the review. |
|
|
1154
|
+
* | `incidentId` | `string` | ✅ | The ID of the incident of which you want to retrieve the review. |
|
|
1155
|
+
* | `threadId` | `string` | ✅ | The ID of the thread of which you want to retrieve the review. |
|
|
1156
|
+
* | `body` | `string` | ❌ | The body of the message to be added to the thread. |
|
|
1157
|
+
* | `customField` | `logisticOrderIncidentThreadsCustomFieldValueRequest[]` | ❌ | The custom fields to add to the created incident threads messages |
|
|
1158
|
+
* | `idType` | `IdType` | ❌ | The type of the id. |
|
|
1159
|
+
*
|
|
1160
|
+
* 📤 **Returns**:
|
|
1161
|
+
* A `Promise` resolving to a `CreateLogisticOrderIncidentThreadMessagesResponse` object when the message is created.
|
|
1162
|
+
*
|
|
1163
|
+
* 🛠 **Example usage**:
|
|
1164
|
+
* ```ts
|
|
1165
|
+
* await createLogisticOrderIncidentThreadMessages({
|
|
1166
|
+
* logisticOrderId: "logisticOrder1",
|
|
1167
|
+
* incidentId: "logisticOrderLine1",
|
|
1168
|
+
* threadId: "thread1",
|
|
1169
|
+
* body: "This is a message",
|
|
1170
|
+
* customField: {
|
|
1171
|
+
* customFieldValues: [
|
|
1172
|
+
* {
|
|
1173
|
+
* "customFieldId": "string",
|
|
1174
|
+
* "customFieldValue": "string"
|
|
1175
|
+
* }
|
|
1176
|
+
* ],
|
|
1177
|
+
* idType: "EXTERNAL_ID",
|
|
1178
|
+
* },
|
|
1179
|
+
* });
|
|
1180
|
+
* ```
|
|
1181
|
+
*
|
|
1182
|
+
* @param {CreateLogisticOrderIncidentThreadsParams} params - The parameters for the request.
|
|
1183
|
+
* @throws {Error} If `logisticOrderId`, or `incidentId`, or `threadId` is missing.
|
|
1184
|
+
* @returns {Promise<CreateLogisticOrderIncidentThreadsResponse>} A promise resolving when the message is created for the logistic order incident thread.
|
|
1185
|
+
*/
|
|
1186
|
+
export declare function createLogisticOrderIncidentThreadMessages({ logisticOrderId, incidentId, threadId, body, customField, idType, }: CreateLogisticOrderIncidentThreadMessagesParams): Promise<CreateLogisticOrderIncidentThreadMessagesResponse>;
|
|
1187
|
+
/**
|
|
1188
|
+
* 🚚 Updadate a message for a specific incident thread of a specific logistic order.
|
|
1189
|
+
*
|
|
1190
|
+
* This function allow to update a message of a thread on a specific incident on a specific logistic order
|
|
1191
|
+
* `logisticOrderId`, incidentId, threadId, messageId parameters are required and validated before the request is executed.
|
|
1192
|
+
*
|
|
1193
|
+
* 🛠 **Endpoint**: `POST /v2/shop/logistic-orders/${logisticOrderId}/incidents/${incidentId}/threads/${threadId}/messages/${messageId} [ORDER-221]`
|
|
1194
|
+
*
|
|
1195
|
+
* | Parameter | Type | Required | Description |
|
|
1196
|
+
* |-------------------|---------------------------------------------------------|------------|----------------------------------------------------------------------|
|
|
1197
|
+
* | `logisticOrderId` | `string` | ✅ | The ID of the logistic order of which you want to update |
|
|
1198
|
+
* | `incidentId` | `string` | ✅ | The ID of the incident of which you want to update |
|
|
1199
|
+
* | `threadId` | `string` | ✅ | The ID of the thread of which you want to update |
|
|
1200
|
+
* | `messageId` | `string` | ✅ | The ID of the message of the thread to update. |
|
|
1201
|
+
* | `body` | `string` | ❌ | The body of the message to update |
|
|
1202
|
+
* | `customField` | `logisticOrderIncidentThreadsCustomFieldValueRequest[]` | ❌ | The custom fields to update to the created incident threads messages |
|
|
1203
|
+
*
|
|
1204
|
+
* 📤 **Returns**:
|
|
1205
|
+
* A `Promise` resolving when the message is updated.
|
|
1206
|
+
*
|
|
1207
|
+
* 🛠 **Example usage**:
|
|
1208
|
+
* ```ts
|
|
1209
|
+
* await updateLogisticOrderIncidentThreadMessage({
|
|
1210
|
+
* logisticOrderId: "logisticOrder1",
|
|
1211
|
+
* incidentId: "logisticOrderLine1",
|
|
1212
|
+
* threadId: "thread1",
|
|
1213
|
+
* messageId: "message1",
|
|
1214
|
+
* body: "string",
|
|
1215
|
+
* customField: {
|
|
1216
|
+
* customFieldValues: [
|
|
1217
|
+
* {
|
|
1218
|
+
* "customFieldId": "string",
|
|
1219
|
+
* "customFieldValue": "string"
|
|
1220
|
+
* }
|
|
1221
|
+
* ],
|
|
1222
|
+
* idType: "EXTERNAL_ID",
|
|
1223
|
+
* }
|
|
1224
|
+
* });
|
|
1225
|
+
* ```
|
|
1226
|
+
*
|
|
1227
|
+
* @param {CreateLogisticOrderIncidentThreadsParams} params - The parameters for the request.
|
|
1228
|
+
* @throws {Error} If `logisticOrderId`, `incidentId`, `threadId`, `messageId` is missing.
|
|
1229
|
+
* @returns {Promise<void>} A promise resolving when the message is updated.
|
|
1230
|
+
*/
|
|
1231
|
+
export declare function updateLogisticOrderIncidentThreadMessage({ logisticOrderId, incidentId, threadId, messageId, customFieldValues, idType, }: UpdateLogisticOrderIncidentThreadMessageParams): Promise<void>;
|
|
1232
|
+
/**
|
|
1233
|
+
* 🚚 Gets a specific logistic order's review.
|
|
1234
|
+
*
|
|
1235
|
+
* This function retrieves a specific logistic order line's review, identified by
|
|
1236
|
+
* the `orderId`. This parameter is mandatory and validated
|
|
1237
|
+
* before the request is executed.
|
|
1238
|
+
*
|
|
1239
|
+
* 🛠 **Endpoint**: `GET /v1/shop/rating-orders/${orderId} [ORDER-504]`
|
|
1240
|
+
*
|
|
1241
|
+
* | Parameter | Type | Required | Description |
|
|
1242
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
1243
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the review. |
|
|
1244
|
+
*
|
|
1245
|
+
* 📤 **Returns**:
|
|
1246
|
+
* A `Promise` resolving to a single `GetLogisticOrderReviewResponse` object representing the review of the logistic order.
|
|
1247
|
+
*
|
|
1248
|
+
* 🛠 **Example usage**:
|
|
1249
|
+
* ```ts
|
|
1250
|
+
* const review = await getLogisticOrderReview({
|
|
1251
|
+
* orderId: "logisticOrder1",
|
|
1252
|
+
* });
|
|
1253
|
+
* ```
|
|
1254
|
+
*
|
|
1255
|
+
* @param {GetLogisticOrderReviewParameters} params - The parameters for the request.
|
|
1256
|
+
* @throws {Error} If `orderId` is missing.
|
|
1257
|
+
* @returns {Promise<GetLogisticOrderReviewResponse>} A promise resolving to a response containing the review of the logistic order.
|
|
1258
|
+
*/
|
|
1259
|
+
export declare function getLogisticOrderReview({ orderId, }: GetLogisticOrderReviewParameters): Promise<GetLogisticOrderReviewResponse>;
|
|
1260
|
+
/**
|
|
1261
|
+
* 🚚 Adds a rewiew on a specific logistic order.
|
|
1262
|
+
*
|
|
1263
|
+
* This function adds a review on a specific logistic order, identified by
|
|
1264
|
+
* the `orderId`. This parameter, as well as the `comment` and `grade`, is mandatory and validated
|
|
1265
|
+
* before the request is executed.
|
|
1266
|
+
*
|
|
1267
|
+
* 🛠 **Endpoint**: `PUT /v1/shop/rating-orders/${orderId} [ORDER-219]`
|
|
1268
|
+
*
|
|
1269
|
+
* | Parameter | Type | Required | Description |
|
|
1270
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
1271
|
+
* | `orderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the review. |
|
|
1272
|
+
* | `comment` | `string` | ✅ | A comment on how the logistic order as realized. |
|
|
1273
|
+
* | `grade` | `number` | ✅ | A grade to rate the logistic order. |
|
|
1274
|
+
*
|
|
1275
|
+
* 📤 **Returns**:
|
|
1276
|
+
* A `Promise` resolving to a single `AddLogisticOrderReviewResponse` object representing the review of the logistic order.
|
|
1277
|
+
*
|
|
1278
|
+
* 🛠 **Example usage**:
|
|
1279
|
+
* ```ts
|
|
1280
|
+
* const review = await addLogisticOrderReview({
|
|
1281
|
+
* orderId: "logisticOrder1",
|
|
1282
|
+
* comment: "This was a bad order",
|
|
1283
|
+
* grade: 0,
|
|
1284
|
+
* });
|
|
1285
|
+
* ```
|
|
1286
|
+
*
|
|
1287
|
+
* @param {AddLogisticOrderReviewParameters} params - The parameters for the request.
|
|
1288
|
+
* @throws {Error} If `orderId`, `comment` or `grade` is missing.
|
|
1289
|
+
* @returns {Promise<AddLogisticOrderReviewResponse>} A promise resolving to a response containing the review of the logistic order.
|
|
1290
|
+
*/
|
|
1291
|
+
export declare function addLogisticOrderReview({ orderId, comment, grade, }: AddLogisticOrderReviewParameters): Promise<AddLogisticOrderReviewResponse>;
|
|
1292
|
+
/**
|
|
1293
|
+
* 🚚 Gets thread reason types.
|
|
1294
|
+
*
|
|
1295
|
+
* This function retrieves all the thread reason types. No parameters for this request.
|
|
1296
|
+
*
|
|
1297
|
+
* 🛠 **Endpoint**: `GET /v1/shop/threads/reason-types [THREAD-550]`
|
|
1298
|
+
*
|
|
1299
|
+
* 📤 **Returns**:
|
|
1300
|
+
* A `Promise` resolving to a single `GetThreadReasonTypesResponse` object representing the array of reason types.
|
|
1301
|
+
*
|
|
1302
|
+
* 🛠 **Example usage**:
|
|
1303
|
+
* ```ts
|
|
1304
|
+
* const reasonTypes = await getThreadReasonTypes();
|
|
1305
|
+
* ```
|
|
1306
|
+
*
|
|
1307
|
+
* @returns {Promise<GetThreadReasonTypesResponse>} A promise resolving to a response containing the array of reason types.
|
|
1308
|
+
*/
|
|
1309
|
+
export declare function getThreadReasonTypes(): Promise<GetThreadReasonTypesResponse>;
|
|
1310
|
+
/**
|
|
1311
|
+
* 🚚 Gets thread subreasons.
|
|
1312
|
+
*
|
|
1313
|
+
* This function retrieves all the subreasons under a reason type, identified by
|
|
1314
|
+
* the `reasonType`. This parameter is mandatory and validated
|
|
1315
|
+
* before the request is executed.
|
|
1316
|
+
*
|
|
1317
|
+
* 🛠 **Endpoint**: `GET /v1/shop/threads/reason-types/${reasonType}/sub-reasons [THREAD-551]`
|
|
1318
|
+
*
|
|
1319
|
+
* | Parameter | Type | Required | Description |
|
|
1320
|
+
* |-------------------|---------------------------------|------------|------------------------------------------|
|
|
1321
|
+
* | `reasonType` | `string` | ✅ | The type of thread reasons. |
|
|
1322
|
+
*
|
|
1323
|
+
* 📤 **Returns**:
|
|
1324
|
+
* A `Promise` resolving to a single `GetThreadSubReasonsResponse` object representing the array of subreasons.
|
|
1325
|
+
*
|
|
1326
|
+
* 🛠 **Example usage**:
|
|
1327
|
+
* ```ts
|
|
1328
|
+
* const subreasons = await getThreadSubReasons({
|
|
1329
|
+
* reasonType: "REFUND",
|
|
1330
|
+
* });
|
|
1331
|
+
* ```
|
|
1332
|
+
*
|
|
1333
|
+
* @param {GetThreadSubReasonsParameters} params - The parameters for the request.
|
|
1334
|
+
* @throws {Error} If `reasonType` is missing.
|
|
1335
|
+
* @returns {Promise<GetThreadSubReasonsResponse>} A promise resolving to a response containing the array of subreasons.
|
|
1336
|
+
*/
|
|
1337
|
+
export declare function getThreadSubReasons({ reasonType, }: GetThreadSubReasonsParameters): Promise<GetThreadSubReasonsResponse>;
|
|
1338
|
+
//# sourceMappingURL=index.d.ts.map
|