/api/v4/locations-by-store-codesRecupera le sedi tramite i codici negozio
Restituisce i dettagli completi di una o più sedi identificate dai rispettivi codici negozio.
Parametri
Query
| Nome | Tipo | Obbligatorio | Descrizione | Predefinito |
|---|---|---|---|---|
| storeCodes | string | obbligatorio | JSON-encoded array of store code strings, e.g. `["ACME01","jio678"]`. URL-encode the value. | — |
Risposte
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.
Risolve i codici negozio nei record completi delle sedi: l'operazione inversa rispetto al tracciamento delle sedi tramite l'ID interno di Listings API. Usalo quando i tuoi sistemi (POS, elenco degli affiliati, PIM) identificano le sedi tramite il codice negozio e devi recuperare o riconciliare la sede corrispondente in Listings API. Passa i codici come array codificato in JSON nel parametro di query storeCodes e applica la codifica URL all'array.
Caso d'uso: riconciliare un elenco di affiliati. Partendo dai codici negozio del tuo elenco principale, chiama ?storeCodes=["ACME01","ACME02","ACME03"] e confronta il valore di storeId di ciascun oggetto restituito con il tuo record per confermare quali negozi sono già stati inseriti in Listings API. I codici senza corrispondenza semplicemente non sono presenti nell'array restituito.
Punto da tenere presente: vuoto o assente. Quando nessuno dei codici forniti corrisponde a una sede nell'account, getLocationsByStoreCodes è null (non un array vuoto), quindi verifica la presenza di null prima di iterare. Una sede ha un codice negozio solo se storeId è stato impostato al momento della creazione o tramite un aggiornamento; le sedi senza codice negozio possono essere recuperate solo tramite ID. Raggruppa i codici in un'unica chiamata per rimanere al di sotto del limite di richieste e rispetta l'header Retry-After quando ricevi una risposta 429.
Per ogni sede vengono restituiti placeActionLinks (i link di azione Google gestiti da Listings API) e discoveredPlaceActionLinks (i link trovati direttamente sul profilo Google dell'attività che non sono ancora gestiti). Consulta la guida ai link di azione per i luoghi.
curl -X GET 'https://listingsapi.com/api/v4/locations-by-store-codes?storeCodes=<storeCodes>' \ -H "Authorization: API $LISTINGSAPI_KEY"