Pular para o conteúdo principal
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": "Filial Centro",
      "code": "SUC-CENTRO",
      "address": "Av. Principal 123, Quito",
      "phone": "+593991234567",
      "status": true,
      "properties": {
        "language": "pt",
        "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
obrigatório
O ID da sua loja no Jelou Shop.
page
integer
padrão:"1"
Número da página a retornar.
limit
integer
padrão:"15"
Quantidade de resultados por página (máx. 100).
include
string
Lista de relações a incluir, separadas por vírgula. Disponíveis: products.
paginate
boolean
padrão:"true"
Envie false para recuperar todas as filiais sem paginação.
A listagem é ordenada por created_at ascendente. Para ordenar por outros campos (name, code, updated_at) use o endpoint Buscar filiais com o parâmetro sort.

Campos da resposta

Cada filial em data contém os seguintes campos:
CampoTipoDescrição
idstringUUID da filial
namestringNome da filial
codestringCódigo único dentro da loja
addressstring | nullEndereço da filial
phonestring | nullTelefone da filial
statusbooleanSe a filial está ativa
propertiesobject | nullPropriedades personalizadas (inclui language se definido)
products_countintegerQuantidade de produtos ativos associados à filial
created_atstringData de criação
updated_atstringData da última atualização
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": "Filial Centro",
      "code": "SUC-CENTRO",
      "address": "Av. Principal 123, Quito",
      "phone": "+593991234567",
      "status": true,
      "properties": {
        "language": "pt",
        "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
  }
}