Obter locais por códigos de loja

Nome	Tipo	Obrigatório	Descrição	Padrão
storeCodes	string	obrigatório	JSON-encoded array of store code strings, e.g. `["ACME01","jio678"]`. URL-encode the value.	—

Nome

Tipo

Obrigatório

Descrição

Padrão

storeCodes

string

obrigatório

JSON-encoded array of store code strings, e.g. `["ACME01","jio678"]`. URL-encode the value.

—

Respostas

200Array of full location objects matching the provided store codes. Returns `null` when no store codes match.

Response

{  "data": {    "getLocationsByStoreCodes": [      {        "id": "TG9jYXRpb246MTgwMDI4OQ==",        "databaseId": 1800289,        "accountId": 12345,        "storeId": "ACME01",        "name": "Jenny Home",        "archived": false,        "street": "600 Congress Ave, Suite 200",        "city": "Austin",        "stateIso": "TX",        "postalCode": "78701",        "countryIso": "US",        "phone": "5125550142",        "categoryId": 15,        "subCategoryId": 1432,        "subCategoryName": "Restaurants",        "package": "PREMIUM",        "planId": 3797,        "planName": "Launch",        "placeActionLinks": [          {            "placeActionType": "FOOD_ORDERING",            "uri": "https://order.example.com",            "isPreferred": true,            "name": "locations/1944.../placeActionLinks/54ada85bc246058a",            "submissionStatus": "success"          }        ],        "discoveredPlaceActionLinks": []      }    ]  }}

401Unauthenticated, missing or invalid API key.

429Rate limit exceeded. Retry after the `Retry-After` header value.

Converte códigos de loja em registros completos de locais: o inverso de rastrear locais pelo ID interno da Listings API. Use quando seus próprios sistemas (POS, cadastro de franquias, PIM) identificam locais por código de loja e você precisa buscar ou reconciliar o local correspondente na Listings API. Passe os códigos como um array codificado em JSON no parâmetro de consulta storeCodes e aplique a codificação de URL a esse array.

Caso de uso: reconciliar um cadastro de franquias. Com os códigos de loja da sua lista principal, chame ?storeCodes=["ACME01","ACME02","ACME03"] e compare o storeId de cada objeto retornado com o seu registro para confirmar quais lojas já estão cadastradas na Listings API. Os códigos sem correspondência simplesmente não aparecem no array retornado.

Atenção: vazio versus ausente. Quando nenhum dos códigos fornecidos corresponde a um local na conta, getLocationsByStoreCodes é null (e não um array vazio), portanto, verifique se o valor é null antes de iterar. Um local só tem um código de loja se storeId tiver sido definido na criação ou por meio de uma atualização; locais sem código de loja só podem ser buscados por ID. Agrupe os códigos em uma única chamada para ficar abaixo do limite de requisições e respeite o cabeçalho Retry-After ao receber um 429.

Cada local retorna placeActionLinks (os links de ação do Google gerenciados pela Listings API) e discoveredPlaceActionLinks (links encontrados diretamente no perfil da empresa no Google que ainda não são gerenciados). Consulte o guia de links de ação de locais.

Obter locais por códigos de loja

Parâmetros

Query

Respostas