Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

GraphQL (Alpha)

Retrieves the sites' order settings.


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

import { createClient, OAuthStrategy } from '@wix/sdk';
import { ordersSettings } from '@wix/ecom';

const wixClient = createClient({
  modules: { ordersSettings } ,
  auth: OAuthStrategy({ clientId: 'MY-CLIENT-ID' })
});

async function getOrdersSettings() {
  const response = await wixClient.ordersSettings.getOrdersSettings();
}

getOrdersSettings() with visitor/member access

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { ordersSettings } from '@wix/ecom';

const wixClient = createClient({
  modules: { ordersSettings },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function getOrdersSettings() {
  const response = await wixClient.ordersSettings.getOrdersSettings();
}

getOrdersSettings() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { ordersSettings } from '@wix/ecom';

const wixClient = createClient({
  modules: { ordersSettings },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function getOrdersSettings() {
  const response = await wixClient.ordersSettings.getOrdersSettings();
}

getOrdersSettings() with Dashboard app access

getOrdersSettings

GetOrdersSettingsResponse

ordersSettings

OrdersSettings

Updates the sites' orders settings.


The `updateOrdersSettings()` function returns a Promise that resolves to the newly updated orders settings.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { ordersSettings } from '@wix/ecom';

const wixClient = createClient({
  modules: { ordersSettings },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function updateOrdersSettings(ordersSettings, options) {
  const response = await wixClient.ordersSettings.updateOrdersSettings(ordersSettings, options);
}

updateOrdersSettings() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { ordersSettings } from '@wix/ecom';

const wixClient = createClient({
  modules: { ordersSettings },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function updateOrdersSettings(ordersSettings, options) {
  const response = await wixClient.ordersSettings.updateOrdersSettings(ordersSettings, options);
}

updateOrdersSettings() with Dashboard app access

updateOrdersSettings

UpdateOrdersSettingsResponse

To use the OrdersSettings API, install the `@wix/ecom` package using npm or Yarn:
  ```console
npm install @wix/ecom
```

or

```console
yarn add @wix/ecom
```

Then import `{ ordersSettings }` from `@wix/ecom`:

```js
import { ordersSettings } from '@wix/ecom'
```
  

ecom_orders-settings

InventoryUpdateTrigger

Whether to automatically create invoices for every new order paid online.
Default: `false`

createInvoice

boolean

Defines when to update the store inventory.

- `ON_ORDER_PAID`: Stock quantities will update only after the payment is approved.
 - `ON_ORDER_PLACED`: Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock.

Default: `ON_ORDER_PLACED`

Setup

Permission Scopes

Permission Scopes