/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. استخدمه عندما تعتمد أنظمتك (POS أو سجل أصحاب الامتياز أو PIM) على رمز المتجر لتحديد المواقع، وتحتاج إلى جلب الموقع المطابق في Listings API أو مطابقة بياناته. مرّر الرموز في مصفوفة مرمّزة بصيغة JSON في معامل الاستعلام storeCodes، وطبّق عليها ترميز URL.
حالة استخدام: مطابقة سجل أصحاب الامتياز. باستخدام رموز المتاجر من قائمتك الرئيسية، استدعِ ?storeCodes=["ACME01","ACME02","ACME03"] وطابق قيمة storeId في كل كائن مُرجَع مع سجلك للتأكد من المتاجر التي أُضيفت بالفعل إلى Listings API. الرموز التي لا تطابق أي موقع لا تظهر في المصفوفة المُرجَعة.
تنبيه: الفرق بين الفارغ وغير الموجود. عندما لا يطابق أيٌّ من الرموز المقدَّمة موقعًا في الحساب، تكون قيمة getLocationsByStoreCodes هي null (وليست مصفوفة فارغة)، لذا تحقّق من null قبل المرور على العناصر. لا يكون للموقع رمز متجر إلا إذا ضُبط storeId عند الإنشاء أو عبر التحديث؛ ولا يمكن جلب المواقع التي ليس لها رمز متجر إلا بواسطة المعرّف. اجمع الرموز في استدعاء واحد لتجنّب تجاوز حد معدل الطلبات، والتزم بترويسة Retry-After عند تلقي 429.
يُرجع كل موقع placeActionLinks (روابط إجراءات Google التي تديرها Listings API) وdiscoveredPlaceActionLinks (الروابط الموجودة مباشرةً في ملف النشاط التجاري على Google والتي لا تُدار بعد). راجع دليل روابط إجراءات الأماكن.
curl -X GET 'https://listingsapi.com/api/v4/locations-by-store-codes?storeCodes=<storeCodes>' \ -H "Authorization: API $LISTINGSAPI_KEY"