매장 코드로 사업장 조회

이름	유형	필수	설명	기본값
storeCodes	string	필수	JSON-encoded array of store code strings, e.g. `["ACME01","jio678"]`. URL-encode the value.	—

이름

유형

필수

설명

기본값

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.

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.

매장 코드로 전체 사업장 레코드를 조회합니다. 이는 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 프로필에서 직접 발견된, 아직 관리되지 않는 링크)를 반환합니다. 장소 작업 링크 가이드를 참조하세요.