Example request for brand with company ID 31:

curl --request GET \
  --url https://www.locally.com/api/v2/brand/31/stores \
  --header 'Locally-Api-Token: <API_TOKEN>'

The request will return a list of 10 results. To fetch the next page, you can specify an offset parameter.

Example request for fetching results 10 - 20 of brand company ID 31:

curl --request GET \
  --url https://www.locally.com/api/v2/brand/31/stores?offset=10 \
  --header 'Locally-Api-Token: <API_TOKEN>'

The request will return results 10 to 20. To request more than 10 results at a time, you can specify the limit parameter. The maximum limit is 100 results at a time. You can also combine the two parameters as desired.

Example request for page 2 when fetching 50 results at a time for brand company ID 31:

curl --request GET \
  --url https://www.locally.com/api/v2/brand/31/stores?limit=50&offset=50 \
  --header 'Locally-Api-Token: <API_TOKEN>'

The request will return a list of 50 results on page 2. For page 3 you would specify an offset of 100.

Sample, abbreviated payload:

{
	"total": 2514,
	"offset": 0,
	"results": [
		{
			"zip": "000",
			"store_id": 208952,
			"country": "CT",
			"address": "No. 66, Sec. 1, Datong Rd.,",
			"company_id": 31,
			"lng": "120.29298520",
			"city": "Tainan",
			"rating": "",
			"brand_slug": "arcteryx",
			"phone": "",
			"company_name": "Viking Chalet Outdoors",
			"name": "Viking Chalet Outdoors",
			"state": "Chinese TW",
			"categories": "",
			"brand_bw_logo": "ArcteryxLogo_2015-09-16-15-_2017-04-01-12-46-28.jpg",
			"lat": "22.96787140",
			"is_hold_capable": null,
			"is_dropship_capable": null,
			"is_delivery_capable": null,
			"is_charge_capable": null,
			"slug": "",
			"store_url": "https:\/\/www.locally.com\/sapi\/s\/31\/208952"
		},
…