Skip to content

getOrderDetails(orderId: number): Promise<UserOrderDetails | null>

The getOrderDetails method allows you to get detailed information about a specific order of a currently authenticated user.

Parameters

orderId: number

The ID of the order to retrieve details for.

Returned value

A returned value has a type of Promise<UserOrderDetails | null> where UserOrderDetails represents the UserOrderDetails model.

Example

In this example we make a UserApi call to get detailed information about a specific order.

    useStorefront(async (storefront) => {
        const userApi = await storefront.getApi('UserApi');

        const orderDetail = await userApi.getOrderDetails(12345);

        if(orderDetail) {
            const orderedProducts = orderDetail.products;
            console.log('ordered products list:', orderedProducts)
        }
    });

User API methods reference

Models reference