Listar opções

GET

Markdown (LLM)

Lista as opções da empresa.

Escopo:catalog:read

Limite:300 requisições a cada 3 minutos.

Parâmetros de query

pageinteger

Página (padrão 1).

1

limitinteger

Itens por página, de 1 a 100 (padrão 20).

20

groupIdinteger

Filtra as opções pertencentes a determinado grupo.

264428

namestring

Filtra pelo nome da opção.

onion

typestring

Filtra pelo tipo: productcomplement

product

activeboolean

Filtra opções ativas ou inativas.

true

deliveryboolean

Filtra opções do delivery.

true

dineInboolean

Filtra opções do presencial.

true

Parâmetros da resposta

pagenumber

page da paginação.

1

limitnumber

limit da paginação.

20

totalnumber

total da paginação.

1

pagesnumber

pages da paginação.

1

Linguagem

Produção

Requisição

GET /v1/catalog/options

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

Resposta

json

12345678910111213141516171819202122232425262728{
  "items": [
    {
      "groupId": 264428,
      "optionId": 5689346,
      "productId": 2586945,
      "name": "Onion rings",
      "type": "product",
      "active": true,
      "delivery": true,
      "dineIn": true,
      "minQuantity": 1,
      "maxQuantity": 1,
      "price": 5.5,
      "sortOrder": 1,
      "image": {
        "original": "https://cdn.beefood.com.br/products/2586945.jpg",
        "thumbnail60": "https://cdn.beefood.com.br/products/2586945_60.jpg",
        "thumbnail120": "https://cdn.beefood.com.br/products/2586945_120.jpg",
        "thumbnailWeb": "https://cdn.beefood.com.br/products/2586945_web.jpg"
      }
    }
  ],
  "page": 1,
  "limit": 20,
  "total": 1,
  "pages": 1
}