getOrdersSettings( )

Developer Preview

Retrieves the sites' order settings.

Description

The getOrdersSettings() function returns a Promise that resolves to orders settings.

Syntax

function getOrdersSettings(): Promise<GetOrdersSettingsResponse>

getOrdersSettings Parameters

This function does not take any parameters.

Returns

The requested orders settings.

Return Type:

Promise<

GetOrdersSettingsResponse

NAME

TYPE

DESCRIPTION

ordersSettings

OrdersSettings

Orders settings.

Was this helpful?

Get orders settings without elevated permissions

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { ordersSettings } from 'wix-ecom-backend';
3
4export const myGetOrdersSettingsFunction = webMethod(Permissions.Anyone, async () => {
5  try {
6    const settings = await ordersSettings.getOrdersSettings();
7    console.log('Success! OrdersSettings:', settings);
8    return settings;
9  } catch (error) {
10    console.error(error);
11    // Handle the error
12  }
13});
14
15/* Promise resolves to:
16 * {
17 *   "ordersSettings": {
18 *     "inventoryUpdateTrigger": "ON_ORDER_PLACED",
19 *     "createInvoice": false
20 *   }
21 * }
22 */

Get orders settings with elevated permissions

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { ordersSettings } from 'wix-ecom-backend';
3import { elevate } from 'wix-auth';
4
5export const myGetOrdersSettingsFunction = webMethod(Permissions.Anyone, async () => {
6  try {
7    const elevatedGetOrdersSettings = elevate(ordersSettings.getOrdersSettings);
8    const getOrdersSettings = await elevatedGetOrdersSettings();
9    console.log('Success! Orders settings:', getOrdersSettings);
10    return getOrdersSettings;
11  } catch (error) {
12    console.error(error);
13    // Handle the error
14  }
15});
16
17/*Promise resolves to:
18 * {
19 *   "ordersSettings": {
20 *     "inventoryUpdateTrigger": "ON_ORDER_PLACED",
21 *     "createInvoice": false
22 *   }
23 * }
24 */