GOgoogle
pos

GET /{merchantId}/pos/{targetMerchantId}/store/{storeCode}

Retrieves information about the given store.

Request

  • Base URL
    https://shoppingcontent.googleapis.com/content/v2.1
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/content
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/content
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

merchantIdstring required

The ID of the POS or inventory data provider.

targetMerchantIdstring required

The ID of the target merchant.

storeCodestring required

A store code that is unique per merchant.

Response

Successful response

storeNamestring

The merchant or store name.

websiteUrlstring

The website url for the store or merchant.

gcidCategorystring[]

The business type of the store.

matchingStatusstring

Output only. The matching status of POS store and Google Business Profile store. Possible values are: - "matched": The POS store is successfully matched with the Google Business Profile store. - "failed": The POS store is not matched with the Google Business Profile store. See matching_status_hint for further details. Note that there is up to 48 hours propagation delay for changes in Merchant Center (e.g. creation of new account, accounts linking) and Google Business Profile (e.g. store address update) which may affect the matching status. In such cases, after a delay call pos.list to retrieve the updated matching status.

placeIdstring

The Google Place Id of the store location.

storeAddressstring

Required. The street address of the store.

kindstring

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

matchingStatusHintstring

Output only. The hint of why the matching has failed. This is only set when matching_status=failed. Possible values are: - "linked-store-not-found": There aren't any Google Business Profile stores available for matching. Connect your Merchant Center account with the Google Business Profile account. Or add a new Google Business Profile store corresponding to the POS store. - "store-match-not-found": The provided POS store 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 POS store location address does not match with Google Business Profile stores' addresses. Update POS store address or Google Business Profile store address to match correctly. - "store-match-unverified": The provided POS store 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.

storeCodestring

Required. A store identifier that is unique for the given merchant.

phoneNumberstring

The store phone number.

Changes

No recorded changes to this operation across all 1 revision of this API.