# REST Resource: accounts.omnichannelSettings

- [Resource: OmnichannelSetting](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#OmnichannelSetting)
  - [JSON representation](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#OmnichannelSetting.SCHEMA_REPRESENTATION)
- [LsfType](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#LsfType)
- [InStock](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#InStock)
  - [JSON representation](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#InStock.SCHEMA_REPRESENTATION)
- [State](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#State)
- [Pickup](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#Pickup)
  - [JSON representation](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#Pickup.SCHEMA_REPRESENTATION)
- [LfpLink](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#LfpLink)
  - [JSON representation](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#LfpLink.SCHEMA_REPRESENTATION)
- [OnDisplayToOrder](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#OnDisplayToOrder)
  - [JSON representation](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#OnDisplayToOrder.SCHEMA_REPRESENTATION)
- [About](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#About)
  - [JSON representation](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#About.SCHEMA_REPRESENTATION)
- [InventoryVerification](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#InventoryVerification)
  - [JSON representation](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#InventoryVerification.SCHEMA_REPRESENTATION)
- [State](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#State_1)
- [Methods](https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#METHODS_SUMMARY)

## Resource: OmnichannelSetting

Collection of information related to the omnichannel settings of a merchant.

| JSON representation |
|---|
| ``` { "name": string, "regionCode": string, "lsfType": enum (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#LsfType`), "inStock": { object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#InStock`) }, "pickup": { object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#Pickup`) }, "lfpLink": { object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#LfpLink`) }, "odo": { object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#OnDisplayToOrder`) }, "about": { object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#About`) }, "inventoryVerification": { object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#InventoryVerification`) } } ``` |

| Fields ||
|---|---|
| `name` | `string` Identifier. The resource name of the omnichannel setting. Format: `accounts/{account}/omnichannelSettings/{omnichannelSetting}` |
| `regionCode` | `string` Required. Immutable. Region code defined by [CLDR](https://cldr.unicode.org/). Must be provided in the Create method, and is immutable. |
| `lsfType` | ``enum (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#LsfType`)`` Required. The Local Store Front type for this country. |
| `inStock` | ``object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#InStock`)`` Optional. The InStock URI and state for this country. |
| `pickup` | ``object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#Pickup`)`` Optional. The Pickup URI and state for this country. |
| `lfpLink` | ``object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#LfpLink`)`` Output only. The established link to a LFP provider. |
| `odo` | ``object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#OnDisplayToOrder`)`` Optional. The On Display to Order (ODO) policy URI and state for this country. |
| `about` | ``object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#About`)`` Optional. The about page URI and state for this country. |
| `inventoryVerification` | ``object (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#InventoryVerification`)`` Optional. The inventory verification contact and state for this country. |

## LsfType

The product page experience type, which is also called the Local Store Front (LSF) type. Check the [HC article](https://support.google.com/merchants/answer/7178526) for more details.

| Enums ||
|---|---|
| `LSF_TYPE_UNSPECIFIED` | Default value. This value is unused. |
| `GHLSF` | Google-Hosted Local Store Front. Check the [HC article](https://support.google.com/merchants/answer/14869424) for more details. |
| `MHLSF_BASIC` | Merchant-Hosted Local Store Front Basic. Check the [HC article](https://support.google.com/merchants/answer/14615867) for more details. |
| `MHLSF_FULL` | Merchant-Hosted Local Store Front Full. Check the [HC article](https://support.google.com/merchants/answer/14617076) for more details. |

## InStock

Collection of information related to InStock.

| JSON representation |
|---|
| ``` { "uri": string, "state": enum (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#State`) } ``` |

| Fields ||
|---|---|
| `uri` | `string` Optional. Product landing page URI. It is only used for the review of MHLSF in-stock serving. This URI domain should match with the business's homepage. Required to be empty if the lsfType is GHLSF, and required when the lsfType is MHLSF_FULL or MHLSF_BASIC. |
| `state` | ``enum (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#State`)`` Output only. The state of the in-stock serving. |

## State

The state of the review process.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Default value. This value is unused. |
| `ACTIVE` | The review process has concluded successfully. The reviewed item is active. |
| `FAILED` | The review process failed. |
| `RUNNING` | The review process is running. |
| `ACTION_REQUIRED` | The review process is waiting for the merchant to take action. |

## Pickup

Collection of information related to Pickup.

| JSON representation |
|---|
| ``` { "uri": string, "state": enum (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#State`) } ``` |

| Fields ||
|---|---|
| `uri` | `string` Required. Pickup product page URI. It is only used for the review of pickup serving. This URI domain should match with the business's homepage. |
| `state` | ``enum (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#State`)`` Output only. The state of the pickup serving. |

## LfpLink

Collection of information related to the LFP link.

| JSON representation |
|---|
| ``` { "lfpProvider": string, "externalAccountId": string, "state": enum (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#State`) } ``` |

| Fields ||
|---|---|
| `lfpProvider` | `string` Required. The resource name of the LFP provider. Format: `lfpProviders/{lfpProvider}` |
| `externalAccountId` | `string` Required. The account ID by which this merchant is known to the LFP provider. |
| `state` | ``enum (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#State`)`` Output only. The state of the LFP link. |

## OnDisplayToOrder

Collection of information related to the on display to order ([ODO](https://support.google.com/merchants/answer/14615056?ref_topic=15145747&sjid=6892280366904591178-NC)).

| JSON representation |
|---|
| ``` { "uri": string, "state": enum (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#State`) } ``` |

| Fields ||
|---|---|
| `uri` | `string` Required. The on display to order (ODO) policy URI. |
| `state` | ``enum (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#State`)`` Output only. The state of the URI. |

## About

Collection of information related to the about page ([impressum](https://support.google.com/merchants/answer/14675634?ref_topic=15145634&sjid=6892280366904591178-NC)).

| JSON representation |
|---|
| ``` { "uri": string, "state": enum (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#State`) } ``` |

| Fields ||
|---|---|
| `uri` | `string` Required. The about page URI. |
| `state` | ``enum (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#State`)`` Output only. The state of the URI. |

## InventoryVerification

Collection of information related to [inventory verification](https://support.google.com/merchants/answer/14684499?ref_topic=15145634&sjid=6892280366904591178-NC).

| JSON representation |
|---|
| ``` { "state": enum (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#State_1`), "contact": string, "contactEmail": string, "contactState": enum (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#State`) } ``` |

| Fields ||
|---|---|
| `state` | ``enum (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#State_1`)`` Output only. The state of the inventory verification process. |
| `contact` | `string` Required. The name of the contact for the inventory verification process. |
| `contactEmail` | `string` Required. The email address of the contact for the inventory verification process. |
| `contactState` | ``enum (`https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings#State`)`` Output only. The state of the contact verification. |

## State

The state of the [inventory verification](https://support.google.com/merchants/answer/14684499?ref_topic=15145634&sjid=6892280366904591178-NC) process.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Default value. This value is unused. |
| `ACTION_REQUIRED` | When the merchant needs to initiate the inventory verification process. The next state is INACTIVE. |
| `INACTIVE` | When the merchant is ready to request inventory verification. |
| `RUNNING` | The inventory verification process is running. If the merchant is rejected, the next state is INACTIVE. |
| `SUCCEEDED` | The inventory verification process succeeded. |
| `SUSPENDED` | When merchant fails the inventory verification process and all attempts are exhausted. |

| ## Methods ||
|---|---|
| ### `https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings/create` | Create the omnichannel settings for a given merchant. |
| ### `https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings/get` | Get the omnichannel settings for a given merchant. |
| ### `https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings/list` | List all the omnichannel settings for a given merchant. |
| ### `https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings/patch` | Update the omnichannel setting for a given merchant in a given country. |
| ### `https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings/requestInventoryVerification` | Requests inventory verification for a given merchant in a given country. |