REST Resource: liasettings

  • This page documents Local Inventory Ads (LIA) settings, including configuration for inventory, on-display-to-order, and omnichannel experiences.

  • It outlines resources like LiaSettings, LiaCountrySettings, LiaInventorySettings, and others with their respective JSON representations and field descriptions.

  • LIA settings can be managed using various methods like get, update, requestinventoryverification, and more, with most requiring admin privileges.

  • LiaPosDataProvider details POS data provider integration, while LiaOmnichannelExperience defines the local store experience type and pickup options.

  • Merchants can retrieve and manage LIA settings for multiple accounts or sub-accounts, request access to Business Profiles, and set inventory verification contacts.

Resource: LiaSettings

Local pos.inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.

JSON representation 
{
  "accountId": string,
  "countrySettings": [
    {
      object (LiaCountrySettings)
    }
  ],
  "kind": string
}
Fields
accountId

string

The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
countrySettings[]

object (LiaCountrySettings)

The LIA settings for each country.
kind

string

Identifies what kind of resource this is. Value: the fixed string "content#liaSettings"

LiaCountrySettings

JSON representation 
{
  "country": string,
  "inventory": {
    object (LiaInventorySettings)
  },
  "onDisplayToOrder": {
    object (LiaOnDisplayToOrderSettings)
  },
  "hostedLocalStorefrontActive": boolean,
  "storePickupActive": boolean,
  "about": {
    object (LiaAboutPageSettings)
  },
  "posDataProvider": {
    object (LiaPosDataProvider)
  },
  "omnichannelExperience": {
    object (LiaOmnichannelExperience)
  }
}
Fields
country

string

Required. CLDR country code (for example, "US").
inventory

object (LiaInventorySettings)

LIA inventory verification settings.
onDisplayToOrder

object (LiaOnDisplayToOrderSettings)

LIA "On Display To Order" settings.
hostedLocalStorefrontActive

boolean

The status of the "Merchant hosted local storefront" feature.
storePickupActive

boolean

The status of the "Store pickup" feature.
about

object (LiaAboutPageSettings)

The settings for the About page.
posDataProvider

object (LiaPosDataProvider)

The POS data provider linked with this country.
omnichannelExperience

object (LiaOmnichannelExperience)

The omnichannel experience configured for this country.

LiaInventorySettings

JSON representation 
{
  "status": string,
  "inventoryVerificationContactName": string,
  "inventoryVerificationContactEmail": string,
  "inventoryVerificationContactStatus": string
}
Fields
status

string

The status of the inventory verification process.

Acceptable values are:

  • "active"
  • "inactive"
  • "pending"
inventoryVerificationContactName

string

The name of the contact for the inventory verification process.
inventoryVerificationContactEmail

string

The email of the contact for the inventory verification process.
inventoryVerificationContactStatus

string

The status of the verification contact.

Acceptable values are:

  • "active"
  • "inactive"
  • "pending"

LiaOnDisplayToOrderSettings

JSON representation 
{
  "status": string,
  "shippingCostPolicyUrl": string
}
Fields
status

string

The status of the ?On display to order? feature.

Acceptable values are:

  • "active"
  • "inactive"
  • "pending"
shippingCostPolicyUrl

string

Shipping cost and policy URL.

LiaAboutPageSettings

JSON representation 
{
  "status": string,
  "url": string
}
Fields
status

string

The status of the verification process for the About page.

Supported values are:

  • "active"
  • "inactive"
  • "pending"
url

string

The URL for the About page.

LiaPosDataProvider

JSON representation 
{
  "posDataProviderId": string,
  "posExternalAccountId": string
}
Fields
posDataProviderId

string

The ID of the POS data provider.
posExternalAccountId

string

The account ID by which this merchant is known to the POS data provider.

LiaOmnichannelExperience

Omnichannel experience details.

JSON representation 
{
  "country": string,
  "lsfType": string,
  "pickupTypes": [
    string
  ]
}
Fields
country

string

The CLDR country code (for example, "US").
lsfType

string

The Local Store Front (LSF) type for this country.

Acceptable values are:

  • "ghlsf" (Google-Hosted Local Store Front)
  • "mhlsfBasic" (Merchant-Hosted Local Store Front Basic)
  • "mhlsfFull" (Merchant-Hosted Local Store Front Full)
More details about these types can be found here.
pickupTypes[]

string

The Pickup types for this country.

Acceptable values are:

  • "pickupToday"
  • "pickupLater"

Methods

custombatch

 Retrieves and/or updates the LIA settings of multiple accounts in a single request.

get

 Retrieves the LIA settings of the account.

getaccessiblegmbaccounts

 Retrieves the list of accessible Business Profiles.

list

 Lists the LIA settings of the sub-accounts in your Merchant Center account.

listposdataproviders

 Retrieves the list of POS data providers that have active settings for the all eiligible countries.

requestgmbaccess

 Requests access to a specified Business Profile.

requestinventoryverification

 Requests inventory validation for the specified country.

setinventoryverificationcontact

 Sets the inventory verification contact for the specified country.

setomnichannelexperience

 Sets the omnichannel experience for the specified country.

setposdataprovider

 Sets the POS data provider for the specified country.

update

 Updates the LIA settings of the account.