List stores - Fire spark

{
  "data": [
    {
      "id": "pos-location-01",
      "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "brand_id": "0001",
      "name": "Main Street",
      "status": "ACTIVE",
      "timezone": "America/Guayaquil",
      "contact": {
        "email": "main@merchant.com",
        "phone": "+593991234567",
        "name": "Main Street"
      },
      "location": {
        "latitude": -2.1894,
        "longitude": -79.8891,
        "address_line_1": "Calle Principal 456",
        "city": "Guayaquil",
        "country": "Ecuador",
        "postal_code": "090101",
        "business_name": "Main Street Restaurant"
      },
      "instructions": null,
      "coverage_zones": [],
      "availability": {
        "schedules": null,
        "temporary_closed_reason": null,
        "temporary_closed_until": null,
        "status": "OPEN"
      },
      "channel_ids": ["web", "app"],
      "fulfillment_ids": ["delivery", "pickup"],
      "labels": [],
      "tags": {},
      "cms_template_id": null,
      "cms": null
    }
  ],
  "pagination": {
    "next_cursor": null,
    "prev_cursor": null
  }
}

Returns stores for the authenticated merchant. Use this to map Fire spark stores to POS or RMS locations before syncing menus.

Requires an access token with the stores:read scope. See Token to obtain a token.

Request

curl "https://firespark.cloud/api/integrations/v1/stores?brand_id=0001&limit=20" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Query parameters

Parameter	Type	Default	Description
`brand_id`	string	—	Filter stores by brand. External brand identifier — alphanumeric characters, `_`, and `-` only. 1–64 characters. When omitted, all stores for the merchant are returned.
`channel_id`	string	—	Only returns stores that have this channel enabled in `channel_ids`.
`fulfillment_id`	string	—	Only returns stores that have this fulfillment enabled in `fulfillment_ids`.
`limit`	integer	`20`	Maximum stores per page. Minimum `1`, maximum `100`.
`cursor`	string	—	Cursor from `pagination.next_cursor` of a previous response. Omit on the first page.

Response

The response wraps a page of store objects in data and pagination in pagination. Each store includes contact, location, availability, enabled channels and fulfillments, coverage zones, and CMS template metadata.

{
  "data": [
    {
      "id": "pos-location-01",
      "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "brand_id": "0001",
      "name": "Main Street",
      "status": "ACTIVE",
      "timezone": "America/Guayaquil",
      "contact": {
        "email": "main@merchant.com",
        "phone": "+593991234567",
        "name": "Main Street"
      },
      "location": {
        "latitude": -2.1894,
        "longitude": -79.8891,
        "address_line_1": "Calle Principal 456",
        "city": "Guayaquil",
        "country": "Ecuador",
        "postal_code": "090101",
        "business_name": "Main Street Restaurant"
      },
      "instructions": null,
      "coverage_zones": [],
      "availability": {
        "schedules": null,
        "temporary_closed_reason": null,
        "temporary_closed_until": null,
        "status": "OPEN"
      },
      "channel_ids": ["web", "app"],
      "fulfillment_ids": ["delivery", "pickup"],
      "labels": [],
      "tags": {},
      "cms_template_id": null,
      "cms": null
    }
  ],
  "pagination": {
    "next_cursor": null,
    "prev_cursor": null
  }
}