REST Resource: accounts.lfpStores

  • LfpStore allows merchants to match their store with a Google Business Profile for inventory and sales data usage.

  • If a matching store isn't found, submitted data associated with the store code won't be used.

  • LfpStore matching can result in success, failure, or an unverified state, each with specific reasons for the outcome.

  • Merchants can manage their LfpStores by deleting, retrieving, inserting, or listing them via available methods.

Resource: LfpStore

A store for the merchant. This will be used to match to a store under the Google Business Profile of the target merchant. If a matching store can't be found, the inventories or sales submitted with the store code will not be used.

JSON representation 
{
  "name": string,
  "targetAccount": string,
  "storeCode": string,
  "storeAddress": string,
  "gcidCategory": [
    string
  ],
  "matchingState": enum (StoreMatchingState),
  "storeName": string,
  "phoneNumber": string,
  "websiteUri": string,
  "placeId": string,
  "matchingStateHint": string
}
Fields
name

string

Output only. Identifier. The name of the LfpStore resource. Format: accounts/{account}/lfpStores/{target_merchant}~{storeCode}
targetAccount

string (int64 format)

Required. The Merchant Center id of the merchant to submit the store for.
storeCode

string

Required. Immutable. A store identifier that is unique for the target merchant.
storeAddress

string

Required. The street address of the store. Example: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA.
gcidCategory[]

string

Optional. Google My Business category id.
matchingState

enum (StoreMatchingState)

Optional. Output only. The state of matching to a Google Business Profile. See matchingStateHint for further details if no match is found.
storeName

string

Optional. The merchant or store name.
phoneNumber

string

Optional. The store phone number in E.164 format. Example: +15556767888
websiteUri

string

Optional. The website URL for the store or merchant.
placeId

string

Optional. The Google Place Id of the store location.
matchingStateHint

string

Optional. Output only. The hint of why the matching has failed. This is only set when matchingState=STORE_MATCHING_STATE_FAILED.

Possible values are:

  • "linked-store-not-found": There aren't any Google Business Profile stores available for matching.
  • "store-match-not-found": The provided LfpStore couldn't be matched to any of the connected Google Business Profile stores. Merchant Center account is connected correctly and stores are available on Google Business Profile, but the LfpStore location address does not match with Google Business Profile stores' addresses. Update the LfpStore address or Google Business Profile store address to match correctly.
  • "store-match-unverified": The provided LfpStore couldn't be matched to any of the connected Google Business Profile stores, as the matched Google Business Profile store is unverified. Go through the Google Business Profile verification process to match correctly.

StoreMatchingState

The state of matching LfpStore to a Google Business Profile.

Enums
STORE_MATCHING_STATE_UNSPECIFIED Store matching state unspecified.
STORE_MATCHING_STATE_MATCHED The LfpStore is successfully matched with a Google Business Profile store.
STORE_MATCHING_STATE_FAILED The LfpStore is not matched with a Google Business Profile store.

Methods

delete

 Deletes a store for a target merchant.

get

 Retrieves information about a store.

insert

 Inserts a store for the target merchant.

list

 Lists the stores of the target merchant, specified by the filter in ListLfpStoresRequest.