Catalogo

Listar complementos por categoria

Retorna as categorias de complementos disponíveis no restaurante, com os complementos associados a cada uma. Um complemento pode estar em mais de uma categoria. **Observações** - `available` indica disponibilidade presencial; `available_in_delivery` a disponibilidade no delivery/retirada. - `question` é a pergunta exibida ao cliente ao apresentar a categoria. - `minimum` é a quantidade mínima e `limit` (na categoria) a quantidade máxima de complementos que podem ser adicionados naquela categoria. - `optional` indica se a categoria é opcional; se `false`, é obrigatória. - `additional` indica se os valores dos complementos são cobrados; se `false`, os complementos não são cobrados mesmo tendo valor. - `use_average` cobra a média dos complementos selecionados; `more_expensive_only` cobra apenas o complemento mais caro. - `is_exclusive` indica categorias/complementos de uso exclusivo do restaurante. - `limit` no complemento é a quantidade máxima daquele complemento. - `price` é o preço presencial; `delivery_price` o de delivery/retirada. Sem `delivery_price`, usa-se `price`.

GET
/api/v1/complements

Retorna as categorias de complementos disponíveis no restaurante, com os complementos associados a cada uma. Um complemento pode estar em mais de uma categoria.

Observações

  • available indica disponibilidade presencial; available_in_delivery a disponibilidade no delivery/retirada.
  • question é a pergunta exibida ao cliente ao apresentar a categoria.
  • minimum é a quantidade mínima e limit (na categoria) a quantidade máxima de complementos que podem ser adicionados naquela categoria.
  • optional indica se a categoria é opcional; se false, é obrigatória.
  • additional indica se os valores dos complementos são cobrados; se false, os complementos não são cobrados mesmo tendo valor.
  • use_average cobra a média dos complementos selecionados; more_expensive_only cobra apenas o complemento mais caro.
  • is_exclusive indica categorias/complementos de uso exclusivo do restaurante.
  • limit no complemento é a quantidade máxima daquele complemento.
  • price é o preço presencial; delivery_price o de delivery/retirada. Sem delivery_price, usa-se price.

Authorization

bearerAuth
AuthorizationBearer <token>

Token JWT obtido em POST /public/api/sessions. Envie como Authorization: Bearer {token}.

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/complements"
[  {    "id": 101186,    "name": "Adicionais burguer",    "available": false,    "available_in_delivery": true,    "question": "Algum adicional?",    "limit": 100,    "minimum": 1,    "optional": true,    "additional": false,    "use_average": false,    "single_choice": false,    "more_expensive_only": false,    "is_ifood": false,    "enable_times": false,    "translations": {},    "is_exclusive": false,    "complements": [      {        "id": 332498,        "name": "Carne 100g",        "description": "",        "price": "0.00",        "limit": 10,        "available": true,        "available_in_delivery": true,        "delivery_price": "string",        "created_at": "2019-08-24T14:15:22Z",        "active_days": "ttttttt",        "enable_times": false,        "translations": {},        "cccs": {          "custom_order": 0        }      }    ]  }]
{  "error": "token_invalid",  "message": "Token inválido ou expirado."}