Composables

The Account Area feature offers composable and utilities that makes accessing different properties of the order details data easier.

Composables

useOrderProductDetails

A composable that provides easier access to different properties of order product details data.

Parameters

orderProduct

DescriptionTypeDefinition

Copy

(Required) Order product used as a data source

orderVariant

DescriptionTypeDefinition

Copy

(Required) Order variant used as a data source

Returns

UseOrderProductDetailsReturn

DescriptionTyp Definition

Copy

An object containing computed properties for various product details, such as name, image, color, brand ,size, link, alt and lowest prior price.

Utilities & Helpers

getOrderDeliveries

A utility that groups order items by their package and returns the grouped items along with their shipment details.

Parameters

order

DescriptionTypeDefinition

Copy

(Required) Order used as a data source

Returns

OrderDelivery

DescriptionTyp Definition

Copy

Return grouped order items by package.

mapAttributes

Maps the attributes of an order product to a new format.

Parameters

attributes

DescriptionTypeDefinition

Copy

(Required) The attributes of the order product.

Returns

Attributes

DescriptionTypeDefinition

Copy

Returns mapped attributes.