Skip to main content
GET
/
ecommerce
/
v2
/
apps
/
{app_id}
/
branches
curl "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/branches?page=1&limit=20&include=products" \
  -H "x-api-key: YOUR_API_KEY"
{
  "data": [
    {
      "id": "9e3f2c1a-8b7d-4e6f-a5c4-d3b2a1e0f9c8",
      "name": "Downtown Branch",
      "code": "SUC-CENTRO",
      "address": "Av. Principal 123, Quito",
      "phone": "+593991234567",
      "status": true,
      "properties": {
        "language": "en",
        "horario": "09:00 - 18:00"
      },
      "products_count": 42,
      "created_at": "2026-02-19T15:30:00.000000Z",
      "updated_at": "2026-02-19T15:30:00.000000Z"
    }
  ],
  "links": {
    "first": "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/branches?page=1",
    "last": "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/branches?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}
app_id
string
required
Your store ID in Jelou Shop.
page
integer
default:"1"
Page number to return.
limit
integer
default:"15"
Number of results per page (max. 100).
include
string
Comma-separated list of relations to include. Available: products.
paginate
boolean
default:"true"
Send false to retrieve all branches without pagination.
The listing is ordered by created_at ascending. To sort by other fields (name, code, updated_at) use the Search branches endpoint with the sort parameter.

Response fields

Each branch in data contains the following fields:
FieldTypeDescription
idstringBranch UUID
namestringBranch name
codestringUnique code within the store
addressstring | nullBranch address
phonestring | nullBranch phone
statusbooleanWhether the branch is active
propertiesobject | nullCustom properties (includes language if set)
products_countintegerNumber of active products linked to the branch
created_atstringCreation date
updated_atstringLast update date
curl "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/branches?page=1&limit=20&include=products" \
  -H "x-api-key: YOUR_API_KEY"
{
  "data": [
    {
      "id": "9e3f2c1a-8b7d-4e6f-a5c4-d3b2a1e0f9c8",
      "name": "Downtown Branch",
      "code": "SUC-CENTRO",
      "address": "Av. Principal 123, Quito",
      "phone": "+593991234567",
      "status": true,
      "properties": {
        "language": "en",
        "horario": "09:00 - 18:00"
      },
      "products_count": 42,
      "created_at": "2026-02-19T15:30:00.000000Z",
      "updated_at": "2026-02-19T15:30:00.000000Z"
    }
  ],
  "links": {
    "first": "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/branches?page=1",
    "last": "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/branches?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}