REST Resource: accounts.omnichannelSettings

Resource: OmnichannelSetting

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

JSON representation 
{
  "name": string,
  "regionCode": string,
  "lsfType": enum (LsfType),
  "inStock": {
    object (InStock)
  },
  "pickup": {
    object (Pickup)
  },
  "lfpLink": {
    object (LfpLink)
  },
  "odo": {
    object (OnDisplayToOrder)
  },
  "about": {
    object (About)
  },
  "inventoryVerification": {
    object (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. Must be provided in the Create method, and is immutable.
lsfType

enum (LsfType)

Required. The Local Store Front type for this country.
inStock

object (InStock)

Optional. The InStock URI and state for this country.
pickup

object (Pickup)

Optional. The Pickup URI and state for this country.
odo

object (OnDisplayToOrder)

Optional. The On Display to Order (ODO) policy URI and state for this country.
about

object (About)

Optional. The about page URI and state for this country.
inventoryVerification

object (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 for more details.

Enums
LSF_TYPE_UNSPECIFIED Default value. This value is unused.
GHLSF Google-Hosted Local Store Front. Check the HC article for more details.
MHLSF_BASIC Merchant-Hosted Local Store Front Basic. Check the HC article for more details.
MHLSF_FULL Merchant-Hosted Local Store Front Full. Check the HC article for more details.

InStock

Collection of information related to InStock.

JSON representation 
{
  "uri": string,
  "state": enum (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 (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 (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 (State)

Output only. The state of the pickup serving.

OnDisplayToOrder

Collection of information related to the on display to order (ODO).

JSON representation 
{
  "uri": string,
  "state": enum (State)
}
Fields
uri

string

Required. The on display to order (ODO) policy URI.
state

enum (State)

Output only. The state of the URI.

About

Collection of information related to the about page (impressum).

JSON representation 
{
  "uri": string,
  "state": enum (State)
}
Fields
uri

string

Required. The about page URI.
state

enum (State)

Output only. The state of the URI.

InventoryVerification

Collection of information related to inventory verification.

JSON representation 
{
  "state": enum (State),
  "contact": string,
  "contactEmail": string,
  "contactState": enum (State)
}
Fields
state

enum (State)

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 (State)

Output only. The state of the contact verification.

State

The state of the inventory verification 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

create

 Create the omnichannel settings for a given merchant.

get

 Get the omnichannel settings for a given merchant.

list

 List all the omnichannel settings for a given merchant.

patch

 Update the omnichannel setting for a given merchant in a given country.

requestInventoryVerification

 Requests inventory verification for a given merchant in a given country.