REST Resource: pos

Resource: PosStore

Store resource.

JSON representation 
{
  "storeCode": string,
  "storeAddress": string,
  "kind": string,
  "storeName": string,
  "phoneNumber": string,
  "websiteUrl": string,
  "gcidCategory": [
    string
  ],
  "placeId": string,
  "matchingStatus": string,
  "matchingStatusHint": string
}
Fields
storeCode

string

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

string

Required. The street address of the store.
kind

string

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

string

The merchant or store name.
phoneNumber

string

The store phone number.
websiteUrl

string

The website url for the store or merchant.
gcidCategory[]

string

The business type of the store.
placeId

string

The Google Place Id of the store location.
matchingStatus

string

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 matchingStatusHint 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.
matchingStatusHint

string

Output only. The hint of why the matching has failed. This is only set when matchingStatus=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.

Methods

custombatch

 Batches multiple POS-related calls in a single request.

delete

 Deletes a store for the given merchant.

get

 Retrieves information about the given store.

insert

 Creates a store for the given merchant.

inventory

 Submit inventory for the given merchant.

list

 Lists the stores of the target merchant.

sale

 Submit a sale event for the given merchant.