Obtenir des établissements par code de magasin

Nom	Type	Obligatoire	Description	Par défaut
storeCodes	string	obligatoire	JSON-encoded array of store code strings, e.g. `["ACME01","jio678"]`. URL-encode the value.	—

Nom

Type

Obligatoire

Description

Par défaut

storeCodes

string

obligatoire

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

—

Réponses

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.

Associe les codes de magasin aux enregistrements complets des établissements : l’inverse du suivi des établissements par l’identifiant interne de Listings API. Utilisez cette méthode lorsque vos propres systèmes (POS, registre des franchises, PIM) identifient les établissements par code de magasin et que vous devez récupérer l’établissement correspondant dans Listings API ou effectuer un rapprochement avec celui-ci. Transmettez les codes sous forme de tableau encodé en JSON dans le paramètre de requête storeCodes et appliquez-lui un encodage URL.

Cas d’utilisation : rapprocher un registre de franchises. À partir des codes de magasin de votre liste de référence, appelez ?storeCodes=["ACME01","ACME02","ACME03"] et rapprochez le champ storeId de chaque objet renvoyé de votre enregistrement pour confirmer quels magasins sont déjà intégrés à Listings API. Les codes sans correspondance sont simplement absents du tableau renvoyé.

Point d’attention : vide ou absent. Lorsqu’aucun des codes fournis ne correspond à un établissement du compte, getLocationsByStoreCodes vaut null (et non un tableau vide) ; vérifiez donc la présence de null avant de parcourir le résultat. Un établissement ne possède un code de magasin que si storeId a été défini lors de la création ou via une mise à jour ; les établissements sans code de magasin ne peuvent être récupérés que par identifiant. Regroupez les codes dans un seul appel pour rester sous la limite de débit et respectez l’en-tête Retry-After en cas de 429.

Chaque établissement renvoie placeActionLinks (les liens d’action Google gérés par Listings API) et discoveredPlaceActionLinks (les liens trouvés directement sur la fiche Google de l’entreprise qui ne sont pas encore gérés). Consultez le guide des liens d’action pour les établissements.

Obtenir des établissements par code de magasin

Paramètres

Chaîne de requête

Réponses