Listar merchants

GET

Markdown (LLM)

Lista as filiais ativas do restaurante (matriz e demais), com ou sem cardápio de delivery.

Escopo:store:read

Limite:15 requisições por minuto.

Parâmetros de query

pageinteger

Página atual da lista.

1

limitinteger

Quantidade de itens por página.

20

sortstring

Ordem da lista: mais recentes (desc) ou mais antigos (asc).

Enum

ascCrescente
descDecrescente (padrão)

"desc"

mainboolean

Filtra a matriz (true) ou os demais cardápios (false). Ausente = todos.

true

citystring

Filtra pela cidade do cardápio.

"São Paulo"

statestring

Filtra pelo estado (UF) do cardápio.

"SP"

Parâmetros da resposta

pagenumber

Página atual da lista.

1

limitnumber

Quantidade de itens por página.

20

totalnumber

Total de registros encontrados.

2

pagesnumber

Total de páginas.

1

Linguagem

Produção

Requisição

GET /v1/store/merchants

12345678import axios from "axios";
const { data } = await axios({
  method: "get",
  url: "https://api.beefood.app/v1/store/merchants?page=1&limit=20&sort=desc",
  headers: {
    Authorization: `Bearer ${accessToken}`,
  },
});

Resposta

json

12345678910111213141516171819202122{
  "items": [
    {
      "storeId": 38311,
      "merchantId": 50502,
      "tradeName": "Restaurante Exemplo - Sushi",
      "main": false
    },
    {
      "storeId": 38311,
      "merchantId": 39202,
      "tradeName": "Restaurante Exemplo",
      "main": true,
      "city": "Sorocaba",
      "state": "SP"
    }
  ],
  "page": 1,
  "limit": 20,
  "total": 2,
  "pages": 1
}