/api/v4/locations-by-store-codesDapatkan lokasi berdasarkan kode toko
Mengembalikan detail lengkap untuk satu atau beberapa lokasi yang diidentifikasi berdasarkan kode tokonya.
Parameter
Query
| Nama | Tipe | Wajib | Deskripsi | Default |
|---|---|---|---|---|
| storeCodes | string | wajib | JSON-encoded array of store code strings, e.g. `["ACME01","jio678"]`. URL-encode the value. | — |
Respons
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.
Memetakan kode toko ke rekaman lokasi lengkap: kebalikan dari melacak lokasi berdasarkan ID internal Listings API. Gunakan saat sistem Anda sendiri (POS, daftar waralaba, PIM) menggunakan kode toko sebagai kunci lokasi dan Anda perlu mengambil atau merekonsiliasi lokasi yang sesuai di Listings API. Kirim kode sebagai array yang dikodekan dalam JSON melalui parameter kueri storeCodes dan terapkan pengodean URL pada array tersebut.
Kasus penggunaan: merekonsiliasi daftar waralaba. Dengan kode toko dari daftar induk Anda, panggil ?storeCodes=["ACME01","ACME02","ACME03"] dan cocokkan storeId dari setiap objek yang dikembalikan dengan rekaman Anda untuk memastikan toko mana yang sudah ditambahkan ke Listings API. Kode yang tidak memiliki kecocokan tidak disertakan dalam array yang dikembalikan.
Hal yang perlu diperhatikan: kosong vs. tidak ada. Jika tidak ada kode yang diberikan yang cocok dengan lokasi dalam akun, getLocationsByStoreCodes bernilai null (bukan array kosong), jadi periksa null sebelum melakukan iterasi. Lokasi hanya memiliki kode toko jika storeId ditetapkan saat pembuatan atau melalui pembaruan; lokasi tanpa kode toko hanya dapat diambil berdasarkan ID. Gabungkan kode dalam satu panggilan agar tetap di bawah batas laju, dan patuhi header Retry-After saat menerima 429.
Setiap lokasi mengembalikan placeActionLinks (tautan tindakan Google yang dikelola Listings API) dan discoveredPlaceActionLinks (tautan yang ditemukan langsung di profil Google bisnis tersebut yang belum dikelola). Lihat panduan Place Action Links.
curl -X GET 'https://listingsapi.com/api/v4/locations-by-store-codes?storeCodes=<storeCodes>' \ -H "Authorization: API $LISTINGSAPI_KEY"