Setting the file. One moment.
Subchapter 2.47
references/dashboard-page/ECOM_NAVIGATION.mdMarkdown4 KBView on GitHub
Ecom Extensions Dashboard Pages destination builders for navigating to ecom-related dashboard pages (use with @wix/dashboard navigate).
Ecom Extensions Dashboard Pages ‘deliveryProfile()’ destination builder for navigating to the Delivery Profile dashboard page.
Method parameters:
options: deliveryProfileOptionsDelivery profile options:
deliveryProfileId (string): The ID of the delivery profile to open in the dashboard.Example:
import { dashboard } from "@wix/dashboard";
import { pages } from "@wix/ecom/dashboard";
dashboard.navigate(
pages.deliveryProfile({
deliveryProfileId: "delivery-profile-id",
}),
);Ecom Extensions Dashboard Pages ‘deliveryProfiles()’ destination builder for navigating to the Delivery Profiles dashboard page.
Request: This method does not take any parameters.
Example:
import { dashboard } from "@wix/dashboard";
import { pages } from "@wix/ecom/dashboard";
dashboard.navigate(
pages.deliveryProfiles(),
);Ecom Extensions Dashboard Pages ‘editDraftOrder()’ destination builder for navigating to the Edit Draft Order dashboard page.
Method parameters:
options: editDraftOrderOptionsEdit draft order options:
draftOrderId (string): The ID of the draft order to open for editing in the dashboard.Example:
import { dashboard } from "@wix/dashboard";
import { pages } from "@wix/ecom/dashboard";
dashboard.navigate(
pages.editDraftOrder({
draftOrderId: "draft-order-id",
}),
);Ecom Extensions Dashboard Pages ‘editOrder()’ destination builder for navigating to the Edit Order dashboard page.
Method parameters:
options: editOrderOptionsEdit order options:
orderId (string): The ID of the order to open for editing in the dashboard.Example:
import { dashboard } from "@wix/dashboard";
import { pages } from "@wix/ecom/dashboard";
dashboard.navigate(
pages.editOrder({
orderId: "order-id",
}),
);Ecom Extensions Dashboard Pages ‘newOrder()’ destination builder for navigating to the New Order dashboard page.
Request: This method does not take any parameters.
Example:
import { dashboard } from "@wix/dashboard";
import { pages } from "@wix/ecom/dashboard";
dashboard.navigate(
pages.newOrder(),
);Ecom Extensions Dashboard Pages ‘orderDetails()’ destination builder for navigating to the Order Details dashboard page.
Method parameters:
options: orderDetailsOptionsOrder details options:
id (string): The ID of the order whose details page to open in the dashboard.Example:
import { dashboard } from "@wix/dashboard";
import { pages } from "@wix/ecom/dashboard";
dashboard.navigate(
pages.orderDetails({
id: "order-id",
}),
);Ecom Extensions Dashboard Pages ‘orderList()’ destination builder for navigating to the Order List dashboard page.
Request: This method does not take any parameters.
Example:
import { dashboard } from "@wix/dashboard";
import { pages } from "@wix/ecom/dashboard";
dashboard.navigate(
pages.orderList(),
);Ecom Extensions Dashboard Pages ‘orderRefund()’ destination builder for navigating to the Order Refund dashboard page.
Method parameters:
options: orderRefundOptionsOrder refund options:
orderId (string): The ID of the order to open the refund page for in the dashboard.Example:
import { dashboard } from "@wix/dashboard";
import { pages } from "@wix/ecom/dashboard";
dashboard.navigate(
pages.orderRefund({
orderId: "order-id",
}),
);