@plentymarkets/shop-api 0.168.1 → 0.170.0

package/lib/getters/orderGetters.d.ts

@@ -1,114 +1,681 @@
 import { AgnosticPagination } from './agnostic';
 import { type AddressData, type GetOrdersResponse, Order, OrderItem, OrderItemAttribute, OrderTotals, OrderDocument, OrderTotalsVat, OrderItemOrderProperty, Availability, ProductProperty, OrderPaymentBankDetails, ImagesData } from '../types';
+/**
+ * Returns the creation date of an order as a localised date-time string.
+ * @param order - The order object.
+ * @param locale - The BCP 47 locale string used for formatting (defaults to `"en"`).
+ * @returns The formatted date-time string, or an empty string if the date is not available.
+ */
 declare function getDate(order: Order, locale?: string): string;
+/**
+ * Returns the shipping date of an order (date type ID `5`) as a localised date string.
+ * @param order - The order object.
+ * @param locale - The BCP 47 locale string used for formatting (defaults to `""`).
+ * @returns The formatted date string, or `null` if the shipping date is not available.
+ */
 declare function getShippingDate(order: Order, locale?: string): string | null;
+/**
+ * Finds an order by its numeric ID in a list of orders.
+ * @param orders - The array of order objects.
+ * @param id - The order ID to search for (as a string).
+ * @returns The matching {@link Order} object, or `null` if not found.
+ */
 declare function getById(orders: Order[], id: string): Order | null;
+/**
+ * Returns the numeric ID of an order as a string.
+ * @param order - The order object.
+ * @returns The order ID string, or an empty string if not set.
+ */
 declare function getId(order: Order): string;
+/**
+ * Returns the email address from the order's delivery address options (option type ID `5`).
+ * @param order - The order object.
+ * @returns The email address string, or an empty string if not found.
+ */
 declare function getOrderEmail(order: Order): string;
+/**
+ * Returns the billing address of an order.
+ * @param order - The order object.
+ * @returns The {@link AddressData} billing address, or `null` if not set.
+ */
 declare function getBillingAddress(order: Order): AddressData | null;
+/**
+ * Returns the shipping/delivery address of an order.
+ * @param order - The order object.
+ * @returns The {@link AddressData} delivery address, or `null` if not set.
+ */
 declare function getShippingAddress(order: Order): AddressData | null;
+/**
+ * Returns the display name of the payment method used for an order.
+ * @param order - The order object.
+ * @returns The payment method name string, or an empty string if not set.
+ */
 declare function getPaymentMethodName(order: Order): string;
+/**
+ * Returns the payment status of an order (e.g. `"paid"`, `"unpaid"`, `"partial"`).
+ * @param order - The order object.
+ * @returns The payment status string, or an empty string if not set.
+ */
 declare function getPaymentStatus(order: Order): string;
+/**
+ * Returns the payment status key of an order (machine-readable identifier).
+ * @param order - The order object.
+ * @returns The payment status key string, or an empty string if not set.
+ */
 declare function getPaymentStatusKey(order: Order): string;
+/**
+ * Returns the shipping profile name of an order.
+ * @param order - The order object.
+ * @returns The shipping profile name string, or an empty string if not set.
+ */
 declare function getShippingProfileName(order: Order): string;
+/**
+ * Returns the shipping provider name of an order.
+ * @param order - The order object.
+ * @returns The shipping provider name string, or an empty string if not set.
+ */
 declare function getShippingProvider(order: Order): string;
+/**
+ * Returns the human-readable status name of an order.
+ * @param order - The order object.
+ * @returns The status name string, or an empty string if not set.
+ */
 declare function getStatus(order: Order): string;
+/**
+ * Returns the gross total price of an order.
+ * @param order - The order object.
+ * @returns The gross total as a number, or `0` if not set.
+ */
 declare function getPrice(order: Order): number;
+/**
+ * Returns the order items with a positive variation ID (i.e. real product items, not surcharges).
+ * @param order - The order object.
+ * @returns An array of {@link OrderItem} objects, or an empty array if none exist.
+ */
 declare function getItems(order: Order): OrderItem[];
+/**
+ * @deprecated Not yet implemented — always returns an empty string.
+ * @param item - The order item (currently unused).
+ * @returns An empty string.
+ */
 declare function getItemSku(item: OrderItem): string;
+/**
+ * Returns the display name of an order item.
+ * @param item - The order item.
+ * @returns The order item name string, or an empty string if not set.
+ */
 declare function getItemName(item: OrderItem): string;
+/**
+ * Returns the short description of the product variation linked to an order item.
+ * @param order - The order object containing variation data.
+ * @param item - The order item.
+ * @returns The short description string, or an empty string if not set.
+ */
 declare function getItemShortDescription(order: Order, item: OrderItem): string;
+/**
+ * Returns the quantity of an order item.
+ * @param item - The order item.
+ * @returns The item quantity, or `0` if not set.
+ */
 declare function getItemQty(item: OrderItem): number;
+/**
+ * Returns the quantity of an order item that is eligible for return.
+ * @param item - The order item.
+ * @returns The returnable quantity, or `0` if not set.
+ */
 declare function getItemReturnableQty(item: OrderItem): number;
+/**
+ * Returns the variation ID of an order item.
+ * @param item - The order item.
+ * @returns The variation ID, or `0` if not set.
+ */
 declare function getItemVariationId(item: OrderItem): number;
+/**
+ * Returns the original gross unit price of an order item (from the first amount entry).
+ * @param item - The order item.
+ * @returns The gross unit price, or `0` if not set.
+ */
 declare function getItemPrice(item: OrderItem): number;
+/**
+ * Returns the gross unit price of an order item for a specific currency.
+ * @param item - The order item.
+ * @param currency - The ISO 4217 currency code to filter by.
+ * @returns The gross price for the specified currency, or `null` if not found.
+ */
 declare function getItemPriceByCurrency(item: OrderItem, currency: string): number | null;
+/**
+ * Returns the original gross unit price of an order item, preferring a non-system currency amount.
+ * @param item - The order item.
+ * @returns The original gross price (in the non-system currency if available), or `0` if not set.
+ */
 declare function getOriginalItemPrice(item: OrderItem): number;
+/**
+ * Returns the original net unit price of an order item (from the first amount entry).
+ * @param item - The order item.
+ * @returns The net unit price, or `0` if not set.
+ */
 declare function getItemNetPrice(item: OrderItem): number;
+/**
+ * Returns the net unit price of an order item for a specific currency.
+ * @param item - The order item.
+ * @param currency - The ISO 4217 currency code to filter by.
+ * @returns The net price for the specified currency, or `null` if not found.
+ */
 declare function getItemNetPriceByCurrency(item: OrderItem, currency: string): number | null;
+/**
+ * Returns the original net unit price of an order item, preferring a non-system currency amount.
+ * @param item - The order item.
+ * @returns The original net price (in the non-system currency if available), or `0` if not set.
+ */
 declare function getOriginalItemNetPrice(item: OrderItem): number;
+/**
+ * Returns the order properties (additional options/surcharges) for an order item.
+ * @param item - The order item.
+ * @returns An array of {@link OrderItemOrderProperty} objects.
+ */
 declare function getItemOrderProperties(item: OrderItem): OrderItemOrderProperty[];
+/**
+ * Returns the display name of an order item property.
+ * @param property - The order item order property.
+ * @returns The property name string.
+ */
 declare function getItemOrderPropertyName(property: OrderItemOrderProperty): string;
+/**
+ * Returns the type of an order item property (e.g. `"text"`, `"selection"`, `"file"`).
+ * @param property - The order item order property.
+ * @returns The property type string.
+ */
 declare function getItemOrderPropertyType(property: OrderItemOrderProperty): string;
+/**
+ * Returns the file URL of a file-type order item property.
+ * @param property - The order item order property.
+ * @returns The file URL string.
+ */
 declare function getItemOrderPropertyFileUrl(property: OrderItemOrderProperty): string;
+/**
+ * Returns whether an order item property is of type `"file"`.
+ * @param property - The order item order property.
+ * @returns `true` if the type is `"file"`, otherwise `false`.
+ */
 declare function isItemOrderPropertyFile(property: OrderItemOrderProperty): boolean;
+/**
+ * Returns the value of an order item property.
+ * For `"selection"` and `"multiSelection"` types, joins all selected values into a comma-separated string.
+ * Falls back to the raw value string if JSON parsing fails.
+ * @param property - The order item order property.
+ * @returns The formatted value string.
+ */
 declare function getItemOrderPropertyValue(property: OrderItemOrderProperty): string;
+/**
+ * Returns whether an order item property value should be displayed in the UI.
+ * A value is shown when it is non-empty and the property type is not `"empty"`.
+ * @param property - The order item order property.
+ * @returns `true` if the value should be shown, otherwise `false`.
+ */
 declare function showItemOrderPropertyValue(property: OrderItemOrderProperty): boolean;
+/**
+ * Returns the price as a formatted string.
+ * @param price - The numeric price value.
+ * @returns The price as a string, or `"0"` if falsy.
+ */
 declare function getFormattedPrice(price: number): string;
+/**
+ * Returns the total count of orders from a paginated orders response.
+ * @param orders - The paginated orders response object.
+ * @returns The total order count, or `0` if not set.
+ */
 declare function getOrdersTotal(orders: GetOrdersResponse): number;
+/**
+ * Returns the access key of an order (used for guest order access links).
+ * @param order - The order object.
+ * @returns The access key string, or an empty string if not set.
+ */
 declare function getAccessKey(order: Order): string;
+/**
+ * Returns the totals summary for an order.
+ * @param order - The order object.
+ * @returns The {@link OrderTotals} object.
+ */
 declare function getTotals(order: Order): OrderTotals;
+/**
+ * Returns all order item properties across the order that have no VAT (tax-exempt additional costs).
+ * @param order - The order object.
+ * @returns An array of {@link OrderItemOrderProperty} objects with aggregated surcharges.
+ */
 declare function getAdditionalCostsWithoutTax(order: Order): OrderItemOrderProperty[];
+/**
+ * Returns all order item properties across the order that are marked as additional costs with VAT.
+ * @param order - The order object.
+ * @returns An array of {@link OrderItemOrderProperty} objects with aggregated surcharges.
+ */
 declare function getAdditionalCostsWithTax(order: Order): OrderItemOrderProperty[];
+/**
+ * Returns the gross surcharge amount of an order item property.
+ * @param item - The order item order property.
+ * @returns The surcharge amount as a number.
+ */
 declare function getOrderItemOrderPropertySurcharge(item: OrderItemOrderProperty): number;
+/**
+ * Returns the net surcharge amount of an order item property.
+ * @param item - The order item order property.
+ * @returns The net surcharge amount as a number.
+ */
 declare function getOrderItemOrderPropertyNetSurcharge(item: OrderItemOrderProperty): number;
+/**
+ * Returns the display name of an order item property.
+ * @param item - The order item order property.
+ * @returns The property name string.
+ */
 declare function getOrderItemOrderPropertyName(item: OrderItemOrderProperty): string;
+/**
+ * Returns the gross subtotal (item sum) from an order totals object.
+ * @param totals - The order totals object.
+ * @returns The gross item sum.
+ */
 declare function getSubTotal(totals: OrderTotals): number;
+/**
+ * Returns the net subtotal (item sum) from an order totals object.
+ * @param totals - The order totals object.
+ * @returns The net item sum.
+ */
 declare function getSubTotalNet(totals: OrderTotals): number;
+/**
+ * Returns the gross shipping amount from an order totals object.
+ * @param totals - The order totals object.
+ * @returns The gross shipping cost.
+ */
 declare function getShippingAmount(totals: OrderTotals): number;
+/**
+ * Returns the net shipping amount from an order totals object.
+ * @param totals - The order totals object.
+ * @returns The net shipping cost.
+ */
 declare function getShippingAmountNet(totals: OrderTotals): number;
+/**
+ * Returns the currency code used in the order totals.
+ * @param order - The order object.
+ * @returns The ISO 4217 currency code string (e.g. `"EUR"`).
+ */
 declare function getCurrency(order: Order): string;
+/**
+ * Returns the gross shipping cost of an order (from the first amount entry).
+ * @param order - The order object.
+ * @returns The gross shipping cost, or `0` if not set.
+ */
 declare function getShippingCost(order: Order): number;
+/**
+ * Returns the net shipping cost of an order (from the first amount entry).
+ * @param order - The order object.
+ * @returns The net shipping cost, or `0` if not set.
+ */
 declare function getShippingCostNet(order: Order): number;
+/**
+ * Returns the original gross shipping cost, preferring a non-system-currency amount entry.
+ * Falls back to the system currency shipping cost if no alternative is found.
+ * @param order - The order object.
+ * @returns The gross shipping cost, or `0` if not set.
+ */
 declare function getOriginalShippingCost(order: Order): number;
+/**
+ * Returns the original net shipping cost, preferring a non-system-currency amount entry.
+ * Falls back to the system currency shipping cost if no alternative is found.
+ * @param order - The order object.
+ * @returns The net shipping cost, or `0` if not set.
+ */
 declare function getOriginalShippingCostNet(order: Order): number;
+/**
+ * Returns the VAT rate (percentage) from the first VAT entry of an order totals object.
+ * @param totals - The order totals object.
+ * @returns The VAT rate.
+ */
 declare function getVatRate(totals: OrderTotals): number;
+/**
+ * Returns the VAT amount (monetary value) from the first VAT entry of an order totals object.
+ * @param totals - The order totals object.
+ * @returns The VAT amount.
+ */
 declare function getVatAmount(totals: OrderTotals): number;
+/**
+ * Returns the gross total from an order totals object.
+ * @param totals - The order totals object.
+ * @returns The gross total amount.
+ */
 declare function getTotal(totals: OrderTotals): number;
+/**
+ * Returns the net total from an order totals object.
+ * @param totals - The order totals object.
+ * @returns The net total amount.
+ */
 declare function getTotalNet(totals: OrderTotals): number;
+/**
+ * Returns the coupon discount value from an order totals object.
+ * @param totals - The order totals object.
+ * @returns The coupon discount amount.
+ */
 declare function getCouponValue(totals: OrderTotals): number;
+/**
+ * Returns the coupon type from an order totals object.
+ * @param totals - The order totals object.
+ * @returns The coupon type string, or an empty string if not set.
+ */
 declare function getCouponType(totals: OrderTotals): string;
+/**
+ * Returns the outstanding open amount from an order totals object.
+ * @param totals - The order totals object.
+ * @returns The open amount, or `null` if not set.
+ */
 declare function getOpenAmount(totals: OrderTotals): number | null;
+/**
+ * Returns the total paid amount from an order totals object.
+ * @param totals - The order totals object.
+ * @returns The paid amount, or `0` if not set.
+ */
 declare function getPaidAmount(totals: OrderTotals): number;
+/**
+ * Returns whether the order is eligible for a return.
+ * @param order - The order object.
+ * @returns `true` if the order can be returned, otherwise `false`.
+ */
 declare function isReturnable(order: Order): boolean;
+/**
+ * Returns whether the order has any items with a returnable quantity greater than zero.
+ * @param order - The order object.
+ * @returns `true` if at least one item has returnable quantity, otherwise `false`.
+ */
 declare function hasReturnableItems(order: Order): boolean;
+/**
+ * Returns the origin order ID from the first order reference (e.g. the original order for a return).
+ * @param order - The order object.
+ * @returns The origin order ID string, or `undefined` if not set.
+ */
 declare function getOrderReferenceOriginId(order: Order): string | undefined;
+/**
+ * Returns whether the order is a return (type ID `3`).
+ * @param order - The order object.
+ * @returns `true` if the order type is return, otherwise `false`.
+ */
 declare function isReturn(order: Order): boolean;
+/**
+ * Returns the attribute entries of an order item.
+ * @param order - The order item (despite the parameter name).
+ * @returns An array of {@link OrderItemAttribute} objects, or an empty array if not set.
+ */
 declare function getOrderAttributes(order: OrderItem): OrderItemAttribute[];
+/**
+ * Returns the name of an order item attribute.
+ * @param attribute - The order item attribute.
+ * @returns The attribute name string, or `null` if not set.
+ */
 declare function getOrderItemAttributeName(attribute: OrderItemAttribute): string | null;
+/**
+ * Returns the value of an order item attribute.
+ * @param attribute - The order item attribute.
+ * @returns The attribute value string, or `null` if not set.
+ */
 declare function getOrderItemAttributeValue(attribute: OrderItemAttribute): string | null;
+/**
+ * Returns the pagination data for an orders response.
+ * @param orders - The paginated orders response object.
+ * @returns An {@link AgnosticPagination} object with current page, total pages, total items, items per page, and page options.
+ */
 declare function getPagination(orders: GetOrdersResponse): AgnosticPagination;
+/**
+ * Returns the order documents (e.g. invoices, delivery notes) attached to an order.
+ * @param order - The order object.
+ * @returns An array of {@link OrderDocument} objects, or an empty array if none exist.
+ */
 declare function getDocuments(order: Order): OrderDocument[];
+/**
+ * Returns the URL path to the product page for an order item.
+ * @param order - The order object containing variation data.
+ * @param productId - The numeric ID of the product.
+ * @returns The product URL path string.
+ */
 declare function getOrderItemLink(order: Order, productId: number): string;
+/**
+ * Returns the cover image URL for the variation of an order item.
+ * @param order - The order object containing item image data.
+ * @param item - The order item.
+ * @returns The image URL string, or `null` if not available.
+ */
 declare function getOrderVariationImage(order: Order, item: OrderItem): string;
+/**
+ * Returns the first image data object for the variation of an order item.
+ * @param order - The order object containing variation data.
+ * @param item - The order item.
+ * @returns The first {@link ImagesData} object for the variation, or `null` if not available.
+ */
 declare function getOrderVariationFirstImage(order: Order, item: OrderItem): ImagesData;
+/**
+ * Returns the URL path to the product page for an order item.
+ * @param order - The order object containing item URL data.
+ * @param item - The order item.
+ * @returns The product URL path string, or `null` if not available.
+ */
 declare function getOrderVariationPath(order: Order, item: OrderItem): string;
+/**
+ * Returns the VAT entries from the order totals.
+ * @param order - The order object.
+ * @returns An array of {@link OrderTotalsVat} objects.
+ */
 declare function getOrderVats(order: Order): OrderTotalsVat[];
+/**
+ * Returns the VAT entries from the original (non-system) currency of the order.
+ * Falls back to the system currency VAT entries if no non-system currency amounts exist.
+ * @param order - The order object.
+ * @returns An array of {@link OrderTotalsVat} objects with `rate` and `value` properties.
+ */
 declare function getOriginalOrderVats(order: Order): OrderTotalsVat[];
+/**
+ * Returns the VAT rate of an order totals VAT entry.
+ * @param vat - The order totals VAT entry.
+ * @returns The VAT rate.
+ */
 declare function getOrderVatRate(vat: OrderTotalsVat): number;
+/**
+ * Returns the VAT amount (monetary value) of an order totals VAT entry.
+ * @param vat - The order totals VAT entry.
+ * @returns The VAT amount.
+ */
 declare function getOrderVatValue(vat: OrderTotalsVat): number;
+/**
+ * Returns whether an order item is a bundle item (type ID `3`).
+ * @param orderItem - The order item.
+ * @returns `true` if the item is a bundle, otherwise `false`.
+ */
 declare function isBundleItem(orderItem: OrderItem): boolean;
+/**
+ * Returns whether an order item is a coupon (type ID `4`).
+ * @param orderItem - The order item.
+ * @returns `true` if the item is a coupon, otherwise `false`.
+ */
 declare function isCouponItem(orderItem: OrderItem): boolean;
+/**
+ * Returns whether an order item is a bundle component (type ID `2`).
+ * @param orderItem - The order item.
+ * @returns `true` if the item is a bundle component, otherwise `false`.
+ */
 declare function isBundleComponents(orderItem: OrderItem): boolean;
+/**
+ * Returns the total surcharge from order properties that are included in the order-again price.
+ * Only includes properties with `surchargeType === "incl"` that are not shown as additional costs.
+ * @param orderItem - The order item.
+ * @returns The total order property surcharge as a number.
+ */
 declare function getOrderAgainOrderPropertiesPrice(orderItem: OrderItem): number;
+/**
+ * Returns the recalculated unit price for ordering the item again ("order again" feature).
+ * Uses the applicable graduated price, falling back to default, then RRP, then zero.
+ * Adds any included order property surcharges.
+ * @param orderItem - The order item.
+ * @returns The recalculated unit price as a number.
+ */
 declare function getOrderAgainInformationPrice(orderItem: OrderItem): number;
+/**
+ * Returns the current availability information for an order item (for "order again").
+ * @param orderItem - The order item.
+ * @returns The {@link Availability} object, or `null` if not available.
+ */
 declare function getOrderAgainAvailability(orderItem: OrderItem): Availability | null;
+/**
+ * Returns the average delivery days for the variation of an order item (for "order again").
+ * @param orderItem - The order item.
+ * @returns The average delivery days, or `0` if not set.
+ */
 declare function getOrderAgainAvailabilityAverageDays(orderItem: OrderItem): number;
+/**
+ * Returns the availability name for the variation of an order item (for "order again").
+ * @param orderItem - The order item.
+ * @returns The availability name string, or an empty string if not set.
+ */
 declare function getOrderAgainAvailabilityName(orderItem: OrderItem): string;
+/**
+ * Returns a CSS class name derived from the availability ID of an order item variation (for "order again").
+ * @param orderItem - The order item.
+ * @returns The CSS class name string (e.g. `"availability-2"`).
+ */
 declare function getOrderAgainAvailabilityClass(orderItem: OrderItem): string;
+/**
+ * Returns the background color for the availability state of an order item variation (for "order again").
+ * @param orderItem - The order item.
+ * @returns The background color value from {@link AvailabilityBackgroundColor}.
+ */
 declare function getOrderAgainAvailabilityBackgroundColor(orderItem: OrderItem): string;
+/**
+ * Returns the text color for the availability state of an order item variation (for "order again").
+ * @param orderItem - The order item.
+ * @returns The text color value from {@link AvailabilityTextColor}.
+ */
 declare function getOrderAgainAvailabilityTextColor(orderItem: OrderItem): string;
+/**
+ * Returns whether the variation of an order item is both salable and active.
+ * @param order - The order object containing variation data.
+ * @param orderItem - The order item.
+ * @returns `true` if the variation is salable and active, otherwise `false`.
+ */
 declare function isItemSalableAndActive(order: Order, orderItem: OrderItem): boolean;
+/**
+ * Returns the order items sorted so that changed items (price difference or no longer salable) appear first.
+ * @param order - The order object.
+ * @returns The sorted array of {@link OrderItem} objects.
+ */
 declare function getOrderAgainSortedChangedItems(order: Order): OrderItem[];
+/**
+ * Returns whether the order has any items that have changed since the original order
+ * (i.e. items that are no longer salable or whose price has changed).
+ * @param order - The order object.
+ * @returns `true` if any item has changed, otherwise `false`.
+ */
 declare function hasOrderAgainChangedItems(order: Order): boolean;
+/**
+ * Returns the value of an order item property formatted for the "order again" basket parameter.
+ * For `"selection"` types, extracts the first selected key. For `"empty"` types, returns `"true"`.
+ * Falls back to the raw value string if JSON parsing fails.
+ * @param property - The order item order property.
+ * @returns The formatted property value string.
+ */
 declare function getOrderAgainPropertyValue(property: OrderItemOrderProperty): string;
+/**
+ * Returns whether all order properties of an order item are still available and compatible
+ * with their current definitions (used to validate "order again" feasibility).
+ * @param orderItem - The order item.
+ * @returns `true` if all properties are valid and available, otherwise `false`.
+ */
 declare function hasAllOrderPropertiesAvailable(orderItem: OrderItem): boolean;
+/**
+ * Finds the current product property definition that corresponds to an existing order item property.
+ * @param orderItem - The order item to look up properties for.
+ * @param property - The existing order item order property to match against.
+ * @returns The matching {@link ProductProperty}, or `null` if not found.
+ */
 declare function getOrderAgainOrderProperty(orderItem: OrderItem, property: OrderItemOrderProperty): ProductProperty | null;
+/**
+ * Returns the surcharge for an order property in the context of "order again".
+ * @param orderItem - The order item.
+ * @param property - The existing order item order property.
+ * @returns The surcharge amount, or `0` if the property is not found.
+ */
 declare function getOrderAgainOrderPropertySurcharge(orderItem: OrderItem, property: OrderItemOrderProperty): number;
+/**
+ * Returns the current stock level for an order item's variation (for "order again").
+ * @param orderItem - The order item.
+ * @returns The stock quantity, or `0` if not set.
+ */
 declare function getOrderAgainOrderItemStock(orderItem: OrderItem): number;
+/**
+ * Returns the bank transfer payment details for an order.
+ * @param order - The order object.
+ * @returns The {@link OrderPaymentBankDetails} object, or `null` if not set.
+ */
 declare function getOrderPaymentBankDetails(order: Order): OrderPaymentBankDetails | null;
+/**
+ * Returns the bank account number from payment bank details.
+ * @param bankDetails - The order payment bank details object.
+ * @returns The account number string, or an empty string if not set.
+ */
 declare function getOrderPaymentBankDetailsAccountNumber(bankDetails: OrderPaymentBankDetails): string;
+/**
+ * Returns the account holder name from payment bank details.
+ * @param bankDetails - The order payment bank details object.
+ * @returns The account owner name string, or an empty string if not set.
+ */
 declare function getOrderPaymentBankDetailsHolder(bankDetails: OrderPaymentBankDetails): string;
+/**
+ * Returns the bank name from payment bank details.
+ * @param bankDetails - The order payment bank details object.
+ * @returns The bank name string, or an empty string if not set.
+ */
 declare function getOrderPaymentBankDetailsBankName(bankDetails: OrderPaymentBankDetails): string;
+/**
+ * Returns the IBAN from payment bank details.
+ * @param bankDetails - The order payment bank details object.
+ * @returns The IBAN string, or an empty string if not set.
+ */
 declare function getOrderPaymentBankDetailsIban(bankDetails: OrderPaymentBankDetails): string;
+/**
+ * Returns the BIC/SWIFT code from payment bank details.
+ * @param bankDetails - The order payment bank details object.
+ * @returns The SWIFT code string, or an empty string if not set.
+ */
 declare function getOrderPaymentBankDetailsSwift(bankDetails: OrderPaymentBankDetails): string;
+/**
+ * Returns the bank sort code from payment bank details.
+ * @param bankDetails - The order payment bank details object.
+ * @returns The bank code string, or an empty string if not set.
+ */
 declare function getOrderPaymentBankDetailsBankCode(bankDetails: OrderPaymentBankDetails): string;
+/**
+ * Returns the preferred delivery services (e.g. DHL Preferred Neighbour) from an order.
+ * Normalises both array and object formats into a single key-value record.
+ * @param order - The order object.
+ * @returns A record of preferred delivery service options, or `null` if none are set.
+ */
 declare function getPreferredDeliveryServices(order: Order): {
     [key: string]: string;
 } | null;
+/**
+ * Returns the customer contact wish (special delivery instruction) from an order.
+ * @param order - The order object.
+ * @returns The contact wish string, or `null` if not set.
+ */
 declare function getOrderContactWish(order: Order): string | null;
+/**
+ * Returns the customer sign (reference/note) from an order.
+ * @param order - The order object.
+ * @returns The customer sign string, or `null` if not set.
+ */
 declare function getOrderCustomerSign(order: Order): string | null;
+/**
+ * Returns the first parcel tracking URL for an order.
+ * @param order - The order object.
+ * @returns The tracking URL string, or an empty string if not set.
+ */
 declare function getOrderTrackingUrl(order: Order): string;
+/**
+ * Returns all parcel tracking numbers for an order.
+ * @param order - The order object.
+ * @returns An array of tracking number strings, or an empty array if none exist.
+ */
 declare function getOrderTrackingNumbers(order: Order): string[];
 export declare const orderGetters: {
     getAccessKey: typeof getAccessKey;