/api/v4/locations-by-store-codesStandorte anhand von Filialcodes abrufen
Gibt vollständige Standortdetails für einen oder mehrere Standorte zurück, die anhand ihrer Filialcodes identifiziert werden.
Parameter
Query
| Name | Typ | Erforderlich | Beschreibung | Standard |
|---|---|---|---|---|
| storeCodes | string | erforderlich | JSON-encoded array of store code strings, e.g. `["ACME01","jio678"]`. URL-encode the value. | — |
Antworten
200Array of full location objects matching the provided store codes. Returns `null` when no store codes match.
{ "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.
Löst Filialcodes in vollständige Standortdatensätze auf: der umgekehrte Weg zur Zuordnung von Standorten anhand der internen ID der Listings API. Verwenden Sie diese Funktion, wenn Ihre eigenen Systeme (POS, Franchise-Verzeichnis, PIM) Standorte anhand des Filialcodes identifizieren und Sie den entsprechenden Standort in der Listings API abrufen oder abgleichen müssen. Übergeben Sie die Codes als JSON-kodiertes Array im Abfrageparameter storeCodes und kodieren Sie es für die URL.
Anwendungsfall: ein Franchise-Verzeichnis abgleichen. Rufen Sie ?storeCodes=["ACME01","ACME02","ACME03"] mit den Filialcodes aus Ihrer Stammliste auf und gleichen Sie storeId jedes zurückgegebenen Objekts mit Ihrem Datensatz ab, um zu bestätigen, welche Filialen bereits in der Listings API aufgenommen wurden. Codes ohne Übereinstimmung sind im zurückgegebenen Array einfach nicht enthalten.
Fallstrick: leer oder fehlend. Wenn keiner der übergebenen Codes einem Standort im Konto entspricht, ist getLocationsByStoreCodes gleich null (kein leeres Array). Prüfen Sie daher vor dem Iterieren auf null. Ein Standort hat nur dann einen Filialcode, wenn storeId beim Erstellen oder über eine Aktualisierung gesetzt wurde; Standorte ohne Filialcode können nur anhand ihrer ID abgerufen werden. Bündeln Sie Codes in einem Aufruf, um unter dem Ratenlimit zu bleiben, und beachten Sie bei einer 429-Antwort den Header Retry-After.
Für jeden Standort werden placeActionLinks (die von der Listings API verwalteten Google-Aktionslinks) und discoveredPlaceActionLinks (Links, die direkt im Google-Profil des Unternehmens gefunden wurden und noch nicht verwaltet werden) zurückgegeben. Weitere Informationen finden Sie im Leitfaden zu Place Action Links.
curl -X GET 'https://listingsapi.com/api/v4/locations-by-store-codes?storeCodes=<storeCodes>' \ -H "Authorization: API $LISTINGSAPI_KEY"