GET/api/v4/locations-by-store-codes

Obtener ubicaciones por códigos de tienda

Devuelve los detalles completos de una o varias ubicaciones identificadas por sus códigos de tienda.

Requiere una clave de API. Consulta Autenticación para conocer el formato del encabezado y la rotación de claves.

Parámetros

Consulta

NombreTipoObligatorioDescripciónPredeterminado
storeCodesstringobligatorioJSON-encoded array of store code strings, e.g. `["ACME01","jio678"]`. URL-encode the value.—

Respuestas

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.

Resuelve códigos de tienda para obtener registros completos de ubicación: la operación inversa a hacer un seguimiento de las ubicaciones mediante el ID interno de Listings API. Úsalo cuando tus propios sistemas (POS, registro de franquicias, PIM) identifiquen las ubicaciones por código de tienda y necesites obtener o conciliar la ubicación correspondiente de Listings API. Pasa los códigos como un array codificado en JSON en el parámetro de consulta storeCodes y aplícale la codificación URL.

Caso de uso: conciliar un registro de franquicias. A partir de los códigos de tienda de tu lista maestra, llama a ?storeCodes=["ACME01","ACME02","ACME03"] y compara el storeId de cada objeto devuelto con tu registro para confirmar qué tiendas ya están incorporadas en Listings API. Los códigos sin coincidencias simplemente no aparecen en el array devuelto.

Ten en cuenta: vacío frente a ausente. Cuando ninguno de los códigos proporcionados coincide con una ubicación de la cuenta, getLocationsByStoreCodes es null (no un array vacío), así que comprueba si es null antes de iterar. Una ubicación solo tiene un código de tienda si se estableció storeId al crearla o mediante una actualización; las ubicaciones sin código de tienda solo se pueden obtener por ID. Agrupa los códigos en una sola llamada para mantenerte por debajo del límite de solicitudes y respeta el encabezado Retry-After cuando recibas un 429.

Cada ubicación devuelve placeActionLinks (los enlaces de acción de Google que gestiona Listings API) y discoveredPlaceActionLinks (enlaces que se encuentran directamente en el perfil de Google del negocio y que aún no se gestionan). Consulta la guía de enlaces de acción de lugares.

Request
curl -X GET 'https://listingsapi.com/api/v4/locations-by-store-codes?storeCodes=<storeCodes>' \  -H "Authorization: API $LISTINGSAPI_KEY"