/api/v4/locations-by-store-codesKonumları mağaza kodlarına göre getirin
Mağaza kodlarıyla tanımlanan bir veya daha fazla konumun tüm ayrıntılarını döndürür.
Parametreler
Sorgu
| Ad | Tür | Zorunlu | Açıklama | Varsayılan |
|---|---|---|---|---|
| storeCodes | string | zorunlu | JSON-encoded array of store code strings, e.g. `["ACME01","jio678"]`. URL-encode the value. | — |
Yanıtlar
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.
Mağaza kodlarını tam konum kayıtlarına dönüştürür: bu, konumları Listings API'nin dahili kimliğiyle takip etmenin tersidir. Kendi sistemleriniz (POS, franchise listesi, PIM) konumları mağaza koduyla tanımladığında ve eşleşen Listings API konumunu getirmeniz veya kayıtlarınızla karşılaştırıp uzlaştırmanız gerektiğinde kullanın. Kodları storeCodes sorgu parametresinde JSON olarak kodlanmış bir dizi biçiminde iletin ve bu diziyi URL kodlamasından geçirin.
Kullanım senaryosu: franchise listesini uzlaştırma. Ana listenizdeki mağaza kodlarıyla ?storeCodes=["ACME01","ACME02","ACME03"] çağrısı yapın ve hangi mağazaların Listings API'ye zaten dahil edildiğini doğrulamak için döndürülen her nesnenin storeId alanını kendi kaydınızla eşleştirin. Eşleşmesi olmayan kodlar döndürülen dizide yer almaz.
Dikkat: boş ile eksik arasındaki fark. Sağlanan kodların hiçbiri hesaptaki bir konumla eşleşmediğinde getLocationsByStoreCodes, null olur (boş bir dizi olmaz); bu nedenle yinelemeye başlamadan önce null kontrolü yapın. Bir konumun mağaza kodu olması için storeId alanının oluşturma sırasında veya güncelleme yoluyla ayarlanmış olması gerekir; mağaza kodu olmayan konumlar yalnızca kimlikle getirilebilir. İstek hızı sınırının altında kalmak için kodları tek bir çağrıda toplu olarak gönderin ve 429 durumunda Retry-After üst bilgisini dikkate alın.
Her konum için placeActionLinks (Listings API'nin yönettiği Google işlem bağlantıları) ve discoveredPlaceActionLinks (doğrudan işletmenin Google profilinde bulunan ve henüz yönetilmeyen bağlantılar) döndürülür. Yer işlem bağlantıları kılavuzuna bakın.
curl -X GET 'https://listingsapi.com/api/v4/locations-by-store-codes?storeCodes=<storeCodes>' \ -H "Authorization: API $LISTINGSAPI_KEY"