catalog_supplemental
List local stores
Fetch local stores for a catalog owned by the "operation user_account".
- By default, the "operation user_account" is the token user_account.
- Supports optional filtering by store codes.
Optional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager.
Learn more
get/catalogs/{catalog_id}/local_stores
Path parameters
catalog_idstring required
Unique identifier of a catalog.
Query parameters
idsLocalStoreId[]
List of local store IDs to filter by.
ad_account_idstring
Unique identifier of an ad account.
bookmarkstring
Cursor used to fetch the next page of items
page_sizeinteger
Maximum number of items to include in a single page. See documentation on Pagination for more information.
Response
The request has succeeded.
Example response
{
"items": [
{
"address_primary": "123 Johnson St",
"address_secondary": "Suite 100",
"city": "Sunnyvale",
"created_at": "2022-03-14T15:15:22Z",
"id": "1234567890",
"latitude": -30.21,
"longitude": 50.45,
"name": "Sunnyvale Store",
"postal_code": "94043",
"region": "CA",
"store_code": "store_1",
"updated_at": "2022-03-14T15:16:34Z"
}
]
}