Partner API
API Endpoints
Channels
Google Local Listings

Google Local Listings

Channel ID: google

By default, NearSt fully automates the setup of any required Google properties required to run local listings (Free Local Listings and See What's In Store). This includes a NearSt-managed Google Merchant Center account, which is linked to a Google Business Profile you own.

Parameters

  • string locationId: specify a Google Location ID to identify the correct Google Business Profile to link to.
  • string storeCode (optional): the store code for the GBP listing you are linking. If you leave this empty, NearSt will automatically generate and set a store code for the GBP listing once it gains access.

Providing access to GBP

There are several methods to provide NearSt with the required access to the Google Business Profile.

The most straightforward one is to add Google Business Group 5529104367 as a location manager or owner. This will show up as "Local Inventory Integration" (no NearSt branding).

Google Business Group

You can either ask customers to do this manually from their Business Listing (opens in a new tab) in Google, or through the Google Business Profile API (opens in a new tab). In this case, we recommend adding the Business Group rather than the email address.

Once completed, it might take up to 5 minutes before NearSt auto-accepts the invitation to the account.

Examples

Giving NearSt access to GBP listing

Given Google location ID 17036025138653420081:

POST https://mybusinessaccountmanagement.googleapis.com/v1/locations/17036025138653420081/admins
Content-Type: application/json
 
{
  "account": "5529104367", // The NearSt Business Group
  "role": "MANAGER"
}

Setting up the channel

After creating a retailer and creating a store within the retailer account, you can enable the Google channel by doing a POST request to the /channels endpoint:

POST https://partner-api.near.st/retailers/{retailerId}/stores/{storeId}/channels
Content-Type: application/json
 
{
  "type": "google",
  "parameters": {
    "locationId": "17036025138653420081",
    "storeCode": "loc001"
  }
}

Checking setup status

After executing the above API call, the NearSt platform will start setting up the integration with Google. This on average takes around 4 days, but might take up to 14 days depending on the business location, the amount of products and the POS integration type.

To check the status, do a GET request on the /channels endpoint:

GET https://partner-api.near.st/retailers/{retailerId}/stores/{storeId}/channels
 
[
  {
    "id": "google",
    "channel": {
    "id": "google",
    "label": "Google Local Listings",
    "description": "Show your products..."
  },
    "status": "pending",
    "warnings": [
  {
    "id": "GoogleMerchantCenterPending",
    "message": "We've now started..."
  }
    ],
    "parameters": {
    "locationId": "17036025138653420081",
    "storeCode": "loc001"
  },
    "storefrontUrl": "https://google.com/..."
  }
]

Statuses and warnings

The following statuses can be returned for this channel:

  • connected: the channel is active. See the storefrontUrl if you want to link directly to the store's Google hosted storefront.
  • pending: the channel is not yet active. See the warnings array for details.

The warnings array can have the following entries:

  • AwaitingGoogleBusinessAccess
    "Waiting for access to Google Business Profile."
  • GoogleMerchantCenterPending
    "We've now started sending data to Google. It might take up to 5 days for products to start showing in Google."
  • SwisWidgetNotSeenRecently
    "Your Google See What's In Store Widget has not been seen in the last week. Check your GBP access and POS connection."
ChannelsMeta Commerce