GET
/api/v4/locations-by-store-codes按门店代码获取地点
返回通过门店代码标识的一个或多个地点的完整详情。
参数
查询
| 名称 | 类型 | 必填 | 描述 | 默认值 |
|---|---|---|---|---|
| storeCodes | string | 必填 | JSON-encoded array of store code strings, e.g. `["ACME01","jio678"]`. URL-encode the value. | — |
响应
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.
将门店代码解析为完整的地点记录,与按 Listings API 内部 ID 跟踪地点的方向相反。当您自己的系统(POS、加盟门店名册、PIM)以门店代码作为地点的键,而您需要获取或核对匹配的 Listings API 地点时,可使用此操作。请将代码作为 JSON 编码的数组传入 storeCodes 查询参数,并对其进行 URL 编码。
使用场景:核对加盟门店名册。 使用您主列表中的门店代码调用 ?storeCodes=["ACME01","ACME02","ACME03"],并将每个返回对象的 storeId 与您的记录对应,以确认哪些门店已接入 Listings API。没有匹配项的代码不会出现在返回的数组中。
注意事项:空值与缺失的区别。 当提供的所有代码均未匹配到该账户中的地点时,getLocationsByStoreCodes 为 null(而非空数组),因此请在遍历前检查是否为 null。只有在创建时或通过更新设置了 storeId,地点才会具有门店代码;没有门店代码的地点只能通过 ID 获取。请将多个代码合并到一次调用中,以避免超出速率限制,并在收到 429 时遵循 Retry-After 响应头。
每个地点都会返回 placeActionLinks(由 Listings API 管理的 Google 操作链接)和 discoveredPlaceActionLinks(直接在该商家的 Google 商家资料中发现、尚未纳入管理的链接)。请参阅地点操作链接指南。
Request
curl -X GET 'https://listingsapi.com/api/v4/locations-by-store-codes?storeCodes=<storeCodes>' \ -H "Authorization: API $LISTINGSAPI_KEY"