Introduction

Aplicação para gestão de pedidos de comida, comanda e mesa.

Api em desenvolvimento por Gestor Food.

Autenticando REQUISIÇÕES

Autenticação API (Sanctum)

Esta api utiliza autenticação via token, Sanctum biblioteca oficial de autenticação do framework Laravel, para obter o token é necessário realizar uma requisição POST para o endpoint /auth/login com os dados de acesso.

  • Primeiramente é necessário criar um mercado, para isso acesse o endpoint /markets e crie um mercado, após isso acesse o endpoint /auth/login e crie um usuário para o mercado criado anteriormente, após isso você terá o token para realizar as requisições.
  • O MARKET_TOKEN esá disponpivel no cadastro do market no campo api_token
  • O token é válido por 5 minutos, após isso é necessário realizar uma nova requisição para obter um novo token.
POST /auth/login HTTP/1.1
Host: api.gestorfood.shop
Content-Type: application/json
token: MARKET_TOKEN (token do mercado)
{
    "uuid": "uuid-do-usuário",
    "password": "senha-do-usuário"
}

Autenticação Web (Session)

Esta api utiliza autenticação via sessão, para obter o token é necessário realizar uma requisição POST para o endpoint /auth/login com os dados de acesso.

  • Primeiramente é necessário criar um mercado, para isso acesse o endpoint /markets e crie um mercado, após isso acesse o endpoint /auth/login e crie um usuário para o mercado criado anteriormente, após isso você terá o token para realizar as requisições.
POST /login HTTP/1.1
Host: api.gestorfood.shop
{
    "email": "email-do-usuário",
    "password": "senha-do-usuário"
}

Autenticação Integrador

Api para autenticação do usuário integrador

Registrar novo usuário integrador

POST
https://gestorfood.shop
/api/v1/integration/auth/register

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/integration/auth/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"brbmiwrvdocyoopnbosxdlaaqgnaepqx\",
    \"email\": \"eriberto08@example.com\",
    \"password\": \"[m1|DO_xAd\'n^\"
}"

Login como usuário integrador

POST
https://gestorfood.shop
/api/v1/integration/auth/login

Esta função é responsável por realizar o login do usuário integrador.

Esta função não está funcionando corretamente.

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/integration/auth/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"client_id\": \"qui\",
    \"client_secret\": \"corrupti\",
    \"grant_type\": \"client_credentials\",
    \"scope\": \"market\"
}"

Autenticação Mobile

APIs para gerenciamento de Autenticação Mobile

Login de Usuário e retorno do token

POST
https://gestorfood.shop
/api/v1/auth/login

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/auth/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"873028f9-26a8-311c-8baf-7140e6a3ea25\",
    \"password\": \"*3r#Xw9CM1@Pr#\"
}"

Buscando usuário logado

GET
https://gestorfood.shop
/api/v1/auth/me

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/auth/me" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

GET api/v1/auth/market

GET
https://gestorfood.shop
/api/v1/auth/market

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/auth/market" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Atualiza o token de acesso

GET
https://gestorfood.shop
/api/v1/auth/refresh

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/auth/refresh" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Logout do usuário

POST
https://gestorfood.shop
/api/v1/auth/logout

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/auth/logout" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Bem vindo

Aprendendo a usar o Gestor Food API

GET
https://gestorfood.shop
/api/v1

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 58
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
"Bem vindo ao Gestor Food API."

Categorias

APIs para gerenciamento de Categorias

Listando todas as Categorias

GET
https://gestorfood.shop
/api/v1/categories

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Criando uma Categoria

POST
https://gestorfood.shop
/api/v1/categories

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"zwdveisnoseubrhjjkr\",
    \"reference_id\": \"soluta\"
}"

Buscando uma Categoria

GET
https://gestorfood.shop
/api/v1/categories/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the category.

Example:
2fd6b3b2-168f-420e-8461-4d7328f7ec8b
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/categories/2fd6b3b2-168f-420e-8461-4d7328f7ec8b" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Atualizando uma Categoria

PUT
PATCH
https://gestorfood.shop
/api/v1/categories/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the category.

Example:
2fd6b3b2-168f-420e-8461-4d7328f7ec8b

Body Parameters

Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/categories/2fd6b3b2-168f-420e-8461-4d7328f7ec8b" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"gjonzpkkelbopzrtzmmpupu\"
}"

Deletando uma Categoria

DELETE
https://gestorfood.shop
/api/v1/categories/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the category.

Example:
2fd6b3b2-168f-420e-8461-4d7328f7ec8b
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/categories/2fd6b3b2-168f-420e-8461-4d7328f7ec8b" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Categorias de Complementos

APIs para gerenciamento de Categorias de Complementos

Listando todas as categorias de complementos

GET
https://gestorfood.shop
/api/v1/complement_groups

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/complement_groups" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Criando uma categoria de complemento

POST
https://gestorfood.shop
/api/v1/complement_groups

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/complement_groups" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"gfsmjacjxcadpggwqmwnqduuxmhxlqxjrcztlfnhkdirqgzpglnpsfrapftmabuaqofiqkouyywsiyaxhqe\",
    \"description\": \"Doloremque omnis sit in quia.\",
    \"reference_id\": \"reprehenderit\",
    \"min\": 2,
    \"max\": 6,
    \"priority\": 2,
    \"market_id\": 2
}"

Buscando uma categoria de complemento

GET
https://gestorfood.shop
/api/v1/complement_groups/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the complement group.

Example:
totam
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/complement_groups/totam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Atualizando uma categoria de complemento

PUT
PATCH
https://gestorfood.shop
/api/v1/complement_groups/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the complement group.

Example:
harum
Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/complement_groups/harum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Deletando uma categoria de complemento

DELETE
https://gestorfood.shop
/api/v1/complement_groups/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the complement group.

Example:
sed
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/complement_groups/sed" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Criando uma categoria de complemento

POST
https://gestorfood.shop
/api/v1/queue/complement_groups

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/queue/complement_groups" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ctsowjbjevjxtteggbzrpkxktmhiavprrzdjpphjmjueevxwuiwtqlpop\",
    \"description\": \"In cumque voluptatum voluptatibus ratione accusantium nostrum veritatis.\",
    \"reference_id\": \"voluptas\",
    \"min\": 11,
    \"max\": 6,
    \"priority\": 19,
    \"market_id\": 8
}"

Atualizando uma categoria de complemento

PUT
PATCH
https://gestorfood.shop
/api/v1/queue/complement_groups/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the complement group.

Example:
quia

Body Parameters

Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/queue/complement_groups/quia" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vhcxktudpjczuduwsbdefbpaznvptiqkopjobnevwv\",
    \"description\": \"Aut perferendis rerum et.\",
    \"reference_id\": \"quo\",
    \"min\": 9,
    \"max\": 4,
    \"priority\": 17,
    \"market_id\": 20
}"

Deletando uma categoria de complemento

DELETE
https://gestorfood.shop
/api/v1/queue/complement_groups/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the complement group.

Example:
illum
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/queue/complement_groups/illum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Comandas e Mesas

APIs para gerenciamento de Comandas e Mesas

Buscando uma Comanda ou Mesa pelo Status

GET
https://gestorfood.shop
/api/v1/cards/by-status/{status}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

status
string
required
Example:
impedit
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/cards/by-status/impedit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Buscando uma Comanda ou Mesa pelo Tipo

GET
https://gestorfood.shop
/api/v1/cards/by-type/{type}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

type
string
required
Example:
et
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/cards/by-type/et" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Atualizando o Status de uma Comanda ou Mesa

PUT
https://gestorfood.shop
/api/v1/cards/{card_uuid}/status

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

card_uuid
string
required
Example:
1
Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/cards/1/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Adicionando uma Taxa a uma Comanda ou Mesa

POST
https://gestorfood.shop
/api/v1/cards/{card_uuid}/fees

Adicionando uma Taxa a uma Comanda ou Mesa pelo ID

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

card_uuid
string
required
Example:
1
Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/cards/1/fees" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Removendo uma Taxa de uma Comanda ou Mesa

DELETE
https://gestorfood.shop
/api/v1/cards/{card_uuid}/fees

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

card_uuid
string
required
Example:
1
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/cards/1/fees" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Listando todas as Comandas e Mesas

GET
https://gestorfood.shop
/api/v1/cards

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/cards" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Criando uma Comanda ou Mesa

POST
https://gestorfood.shop
/api/v1/cards

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/cards" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"number\": 2,
    \"reference_id\": \"expedita\",
    \"type\": \"table\",
    \"status\": \"officiis\",
    \"fees\": [
        \"libero\"
    ]
}"

Buscando uma Comanda ou Mesa pelo ID

GET
https://gestorfood.shop
/api/v1/cards/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the card.

Example:
1
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/cards/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Atualizando uma Comanda ou Mesa pelo ID

PUT
PATCH
https://gestorfood.shop
/api/v1/cards/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the card.

Example:
1

Body Parameters

Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/cards/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"number\": 4,
    \"type\": \"card\",
    \"fees\": [
        {
            \"code\": []
        }
    ]
}"

Deletando uma Comanda ou Mesa

DELETE
https://gestorfood.shop
/api/v1/cards/{id}

Deletando uma Comanda ou Mesa pelo ID

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the card.

Example:
1
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/cards/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Buscando uma Comanda ou Mesa pelo Número

GET
https://gestorfood.shop
/api/v1/cards/by-number/{number}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

number
string
required
Example:
veniam
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/cards/by-number/veniam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Complementos

APIs para gerenciamento de Complementos

Buscando um Complemento por Produto

GET
https://gestorfood.shop
/api/v1/complements/by-product/{product_uuid}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

product_uuid
string
required
Example:
18a4636d-969e-4aa8-886c-0ccadcaee0ff
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/complements/by-product/18a4636d-969e-4aa8-886c-0ccadcaee0ff" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Buscando um Complemento por Categoria

GET
https://gestorfood.shop
/api/v1/complements/by-category/{category_uuid}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

category_uuid
string
required
Example:
2fd6b3b2-168f-420e-8461-4d7328f7ec8b
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/complements/by-category/2fd6b3b2-168f-420e-8461-4d7328f7ec8b" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Listando todos os Complementos

GET
https://gestorfood.shop
/api/v1/complements

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/complements" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

POST api/v1/queue/complements

POST
https://gestorfood.shop
/api/v1/queue/complements

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/queue/complements" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"r\",
    \"description\": \"Omnis rerum fugiat consectetur consequatur.\",
    \"price\": 665.406764,
    \"reference_id\": \"culpa\",
    \"complement_group_id\": \"sed\",
    \"type\": \"additional\"
}"

PUT api/v1/queue/complements/{id}

PUT
PATCH
https://gestorfood.shop
/api/v1/queue/complements/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the complement.

Example:
1

Body Parameters

Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/queue/complements/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ddsrxvnlhommgqzbtlxtymzu\",
    \"description\": \"Accusamus et earum eos magni fuga nemo quibusdam deleniti.\",
    \"price\": 79406.8,
    \"reference_id\": \"odio\",
    \"complement_group_id\": \"harum\",
    \"type\": \"additional\"
}"

DELETE api/v1/queue/complements/{id}

DELETE
https://gestorfood.shop
/api/v1/queue/complements/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the complement.

Example:
1
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/queue/complements/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Dispositivos

APIs para gerenciamento de Dispositivos

Listando os Logs de um Dispositivo

GET
https://gestorfood.shop
/api/v1/devices/{device_uuid}/logs

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

device_uuid
string
required
Example:
298e5cfa-ce2c-39a5-b011-93054759b706
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/devices/298e5cfa-ce2c-39a5-b011-93054759b706/logs" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Buscando usuário ativo no Dispositivo

GET
https://gestorfood.shop
/api/v1/devices/{device_uuid}/user

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

device_uuid
string
required
Example:
cfcd8f6b-97cf-396e-8878-955f3baaea47
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/devices/cfcd8f6b-97cf-396e-8878-955f3baaea47/user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Listando todos os Dispositivos

GET
https://gestorfood.shop
/api/v1/devices

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/devices" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Cadastrando um novo Dispositivo

POST
https://gestorfood.shop
/api/v1/devices

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/devices" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"eos\",
    \"code\": \"et\",
    \"status\": \"qui\",
    \"manufacturer\": \"possimus\",
    \"model\": \"atque\",
    \"os\": \"qui\",
    \"os_version\": \"ab\"
}"

Buscando um Dispositivo

GET
https://gestorfood.shop
/api/v1/devices/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the device.

Example:
est
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/devices/est" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Atualizando um Dispositivo

PUT
PATCH
https://gestorfood.shop
/api/v1/devices/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the device.

Example:
quia

Body Parameters

Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/devices/quia" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"culpa\",
    \"code\": \"veniam\",
    \"status\": \"totam\",
    \"manufacturer\": \"deserunt\",
    \"model\": \"aspernatur\",
    \"os\": \"rerum\",
    \"os_version\": \"ratione\"
}"

Deletando um Dispositivo

DELETE
https://gestorfood.shop
/api/v1/devices/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the device.

Example:
nulla
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/devices/nulla" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Endpoints

GET api/v1/unauthorized

GET
https://gestorfood.shop
/api/v1/unauthorized

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/unauthorized" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 57
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
[Empty response]

Mercados

APIs para gerenciamento de Mercados

Registrando dispositivo e vinculando ao estabelecimento

POST
https://gestorfood.shop
/api/v1/markets/register

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/markets/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"officiis\",
    \"manufacturer\": \"unde\",
    \"model\": \"autem\",
    \"os\": \"nihil\",
    \"os_version\": \"reiciendis\"
}"

Listando todos os estabelecimentos

GET
https://gestorfood.shop
/api/v1/markets

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/markets" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Criando um novo estabelecimento

POST
https://gestorfood.shop
/api/v1/markets

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/markets" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"mvdzvstiqstyjmm\",
    \"document\": \"fuga\",
    \"reference\": \"quibusdam\"
}"

Buscando estabelecimento por ID

GET
https://gestorfood.shop
/api/v1/markets/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the market.

Example:
1
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/markets/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

PUT api/v1/markets/{id}

PUT
PATCH
https://gestorfood.shop
/api/v1/markets/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the market.

Example:
1

Body Parameters

Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/markets/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"rtwg\",
    \"document\": \"sit\",
    \"reference\": \"odit\"
}"

Validando estabelecimento por UUID

POST
https://gestorfood.shop
/api/v1/validate/{token}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

token
string
required
Example:
error
Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/validate/error" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Métodos de Pagamento

APIs para gerenciamento de Métodos de Pagamento

Listando todos os métodos de pagamento

GET
https://gestorfood.shop
/api/v1/payment_methods

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/payment_methods" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Craiando um novo método de pagamento

POST
https://gestorfood.shop
/api/v1/payment_methods

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/payment_methods" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"reprehenderit\",
    \"code\": \"dolores\"
}"

Buscando um método de pagamento

GET
https://gestorfood.shop
/api/v1/payment_methods/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the payment method.

Example:
hic
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/payment_methods/hic" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Atualizando um método de pagamento

PUT
PATCH
https://gestorfood.shop
/api/v1/payment_methods/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the payment method.

Example:
architecto

Body Parameters

Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/payment_methods/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"non\",
    \"code\": \"repudiandae\"
}"

Deletando um método de pagamento

DELETE
https://gestorfood.shop
/api/v1/payment_methods/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the payment method.

Example:
soluta
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/payment_methods/soluta" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Pedidos

APIs para gerenciamento de Pedidos

GET api/v1/kafka

GET
https://gestorfood.shop
/api/v1/kafka

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/kafka" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 59
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Produtos cancelados com sucesso."
}

Adicionando um produto ao Pedido

POST
https://gestorfood.shop
/api/v1/orders/{order_uuid}/products

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

order_uuid
string
required
Example:
1
Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/orders/1/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Removendo um produto do Pedido

DELETE
https://gestorfood.shop
/api/v1/orders/{order_uuid}/products/{products_uuid}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

order_uuid
string
required
Example:
1
products_uuid
string
required
Example:
18a4636d-969e-4aa8-886c-0ccadcaee0ff
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/orders/1/products/18a4636d-969e-4aa8-886c-0ccadcaee0ff" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Adicionando um pagamento ao Pedido

POST
https://gestorfood.shop
/api/v1/orders/{order_uuid}/payments

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

order_uuid
string
required
Example:
1
Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/orders/1/payments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Adicionando um cliente ao Pedido

POST
https://gestorfood.shop
/api/v1/orders/{order_uuid}/clients

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

order_uuid
string
required
Example:
1
Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/orders/1/clients" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Removendo um cliente do Pedido

DELETE
https://gestorfood.shop
/api/v1/orders/{order_uuid}/clients/{client_uuid}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

order_uuid
string
required
Example:
1
client_uuid
string
required
Example:
8b90d70d-7c08-3b05-a916-6968b383b508
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/orders/1/clients/8b90d70d-7c08-3b05-a916-6968b383b508" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Listando os produtos de um Pedido

GET
https://gestorfood.shop
/api/v1/orders/{id}/products

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the order.

Example:
1
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/orders/1/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Cancelando um Pedido

POST
https://gestorfood.shop
/api/v1/orders/{order_uuid}/cancel

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

order_uuid
string
required
Example:
1
Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/orders/1/cancel" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Transferindo um Produto para outra comanda/mesa

POST
https://gestorfood.shop
/api/v1/orders/{order_uuid}/cards/{id}/products/{productId}/transfer

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

order_uuid
string
required
Example:
1
id
string
required

The ID of the card.

Example:
1
productId
string
required
Example:
18a4636d-969e-4aa8-886c-0ccadcaee0ff
Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/orders/1/cards/1/products/18a4636d-969e-4aa8-886c-0ccadcaee0ff/transfer" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Transferindo todos os Produtos em aberto para outra comanda/mesa

POST
https://gestorfood.shop
/api/v1/orders/{order_uuid}/cards/{id}/transfer

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

order_uuid
string
required
Example:
1
id
string
required

The ID of the card.

Example:
1
Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/orders/1/cards/1/transfer" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Cancelando Produtos do Pedido

POST
https://gestorfood.shop
/api/v1/orders/{order_uuid}/products/cancel

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

order_uuid
string
required
Example:
1

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/orders/1/products/cancel" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"products\": []
}"

Listando todos os Pedidos

GET
https://gestorfood.shop
/api/v1/orders

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/orders" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Criando um Pedido

POST
https://gestorfood.shop
/api/v1/orders

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/orders" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"amount_people\": 4,
    \"card_id\": \"6bcd8f47-4014-3f47-a3aa-0c5f3603a1a6\",
    \"products\": [
        \"asperiores\"
    ],
    \"complements\": [
        \"voluptates\"
    ]
}"

Buscando um Pedido pelo UUID

GET
https://gestorfood.shop
/api/v1/orders/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the order.

Example:
1
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/orders/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Atualizando um Pedido

PUT
PATCH
https://gestorfood.shop
/api/v1/orders/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the order.

Example:
1

Body Parameters

Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/orders/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"amount_people\": 17,
    \"card_id\": \"18465889-1f4c-3339-924e-3d30dfe0777f\",
    \"products\": [
        \"qui\"
    ],
    \"complements\": [
        \"rerum\"
    ]
}"

Deletando um Pedido

DELETE
https://gestorfood.shop
/api/v1/orders/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the order.

Example:
1
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/orders/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Produtos

APIs para gerenciamento de Produtos

Pesquisa de produtos

GET
https://gestorfood.shop
/api/v1/products/search/{query}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

query
string
required
Example:
eos
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/products/search/eos" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Pesquisando por Categoria

GET
https://gestorfood.shop
/api/v1/products/search/{category_uuid}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

category_uuid
string
required
Example:
2fd6b3b2-168f-420e-8461-4d7328f7ec8b
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/products/search/2fd6b3b2-168f-420e-8461-4d7328f7ec8b" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Buscando por Categoria

GET
https://gestorfood.shop
/api/v1/products/by-category/{categoryId}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

categoryId
string
required
Example:
recusandae
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/products/by-category/recusandae" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Buscando por Referência

GET
https://gestorfood.shop
/api/v1/products/by-reference/{referenceId}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

referenceId
string
required
Example:
officiis
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/products/by-reference/officiis" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Adicionando Complementos ao Produto

POST
https://gestorfood.shop
/api/v1/products/{product_uuid}/complements

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

product_uuid
string
required
Example:
18a4636d-969e-4aa8-886c-0ccadcaee0ff

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/products/18a4636d-969e-4aa8-886c-0ccadcaee0ff/complements" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"pp\",
    \"description\": \"Esse nihil voluptatum molestiae aut.\",
    \"price\": 166622.6119261,
    \"reference_id\": \"cum\",
    \"complement_group_id\": \"atque\",
    \"type\": \"additional\"
}"

Atualizando Complementos do Produto

PUT
https://gestorfood.shop
/api/v1/products/{product_uuid}/complements

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

product_uuid
string
required
Example:
18a4636d-969e-4aa8-886c-0ccadcaee0ff
Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/products/18a4636d-969e-4aa8-886c-0ccadcaee0ff/complements" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Removendo Complementos do Produto

DELETE
https://gestorfood.shop
/api/v1/products/{product_uuid}/complements

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

product_uuid
string
required
Example:
18a4636d-969e-4aa8-886c-0ccadcaee0ff
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/products/18a4636d-969e-4aa8-886c-0ccadcaee0ff/complements" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Validando um Produto

POST
https://gestorfood.shop
/api/v1/products/{product_uuid}/validate

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

product_uuid
string
required
Example:
18a4636d-969e-4aa8-886c-0ccadcaee0ff
Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/products/18a4636d-969e-4aa8-886c-0ccadcaee0ff/validate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Listando todos os Produtos

GET
https://gestorfood.shop
/api/v1/products

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Criando um novo Produto

POST
https://gestorfood.shop
/api/v1/products

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"zkeirsxvlburpsusfqihsymhy\",
    \"description\": \"Rerum molestias reprehenderit nostrum necessitatibus consequatur.\",
    \"barcode\": \"v\",
    \"price\": \"fugit\",
    \"stock\": \"dolorem\",
    \"measurement_unit_id\": \"corrupti\",
    \"reference_id\": 19,
    \"category_id\": 4,
    \"complements\": [
        \"dolores\"
    ]
}"

Buscando um Produto pelo ID

GET
https://gestorfood.shop
/api/v1/products/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the product.

Example:
18a4636d-969e-4aa8-886c-0ccadcaee0ff
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/products/18a4636d-969e-4aa8-886c-0ccadcaee0ff" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Atualizando um Produto

PUT
PATCH
https://gestorfood.shop
/api/v1/products/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the product.

Example:
18a4636d-969e-4aa8-886c-0ccadcaee0ff

Body Parameters

Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/products/18a4636d-969e-4aa8-886c-0ccadcaee0ff" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"cr\",
    \"description\": \"Cumque debitis officiis magnam incidunt quisquam at.\",
    \"barcode\": \"manlvzzfeaxwziroo\",
    \"price\": \"voluptas\",
    \"stock\": \"qui\",
    \"measurement_unit_id\": \"id\",
    \"reference_id\": 4,
    \"category_id\": 1,
    \"complements\": [
        \"laboriosam\"
    ]
}"

Deletando um Produto

DELETE
https://gestorfood.shop
/api/v1/products/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the product.

Example:
18a4636d-969e-4aa8-886c-0ccadcaee0ff
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/products/18a4636d-969e-4aa8-886c-0ccadcaee0ff" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Queue Categorias

APIs para gerenciamento de filas de Categorias

Criando nova Categoria

POST
https://gestorfood.shop
/api/v1/queue/categories

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/queue/categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"zmysrherlugwvnlh\",
    \"reference_id\": \"et\"
}"

Atualizando a Categoria

PUT
PATCH
https://gestorfood.shop
/api/v1/queue/categories/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the category.

Example:
2fd6b3b2-168f-420e-8461-4d7328f7ec8b

Body Parameters

Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/queue/categories/2fd6b3b2-168f-420e-8461-4d7328f7ec8b" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"asjnmjahsfu\",
    \"reference_id\": \"labore\"
}"

Deletando a Categoria

DELETE
https://gestorfood.shop
/api/v1/queue/categories/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the category.

Example:
2fd6b3b2-168f-420e-8461-4d7328f7ec8b
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/queue/categories/2fd6b3b2-168f-420e-8461-4d7328f7ec8b" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Queue Comandas e Mesas

APIs para gerenciamento de filas de Comandas e Mesas

Criando uma nova Coamanda ou Mesa

POST
https://gestorfood.shop
/api/v1/queue/cards

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/queue/cards" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"number\": 11,
    \"reference_id\": \"omnis\",
    \"type\": \"card\",
    \"status\": \"nulla\",
    \"fees\": [
        \"quidem\"
    ]
}"

Atualizando uma Coamanda ou Mesa

PUT
PATCH
https://gestorfood.shop
/api/v1/queue/cards/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the card.

Example:
1

Body Parameters

Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/queue/cards/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"number\": 3,
    \"reference_id\": \"dolore\",
    \"type\": \"table\",
    \"status\": \"ut\",
    \"fees\": [
        \"excepturi\"
    ]
}"

Deletando uma Coamanda ou Mesa

DELETE
https://gestorfood.shop
/api/v1/queue/cards/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the card.

Example:
1
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/queue/cards/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Queue Markets

APIs para gerenciamento de filas de Markets

POST api/v1/queue/markets

POST
https://gestorfood.shop
/api/v1/queue/markets

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/queue/markets" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"gsnbt\",
    \"document\": \"ullam\",
    \"reference\": \"aut\"
}"

PUT api/v1/queue/markets/{id}

PUT
PATCH
https://gestorfood.shop
/api/v1/queue/markets/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the market.

Example:
1

Body Parameters

Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/queue/markets/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"gyzoxsqpxixpqqmsxvqtcqmw\",
    \"document\": \"yjxelhbiosbuqslaiphlrzsj\"
}"

DELETE api/v1/queue/markets/{id}

DELETE
https://gestorfood.shop
/api/v1/queue/markets/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the market.

Example:
1
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/queue/markets/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Queue Produtos

APIs para gerenciamento de filas de Produtos

Criação de um novo Produto

POST
https://gestorfood.shop
/api/v1/queue/products

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/queue/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"lozvrskpxkscvzwopyh\",
    \"description\": \"Aut sunt numquam enim.\",
    \"barcode\": \"uuorgqwapaqkronictc\",
    \"price\": \"ab\",
    \"stock\": \"provident\",
    \"measurement_unit_id\": \"est\",
    \"reference_id\": 9,
    \"category_id\": 8,
    \"complements\": [
        \"dolorem\"
    ]
}"

Atualizando o Produto

PUT
PATCH
https://gestorfood.shop
/api/v1/queue/products/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the product.

Example:
18a4636d-969e-4aa8-886c-0ccadcaee0ff
Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/queue/products/18a4636d-969e-4aa8-886c-0ccadcaee0ff" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Removendo o Produto

DELETE
https://gestorfood.shop
/api/v1/queue/products/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the product.

Example:
18a4636d-969e-4aa8-886c-0ccadcaee0ff
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/queue/products/18a4636d-969e-4aa8-886c-0ccadcaee0ff" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Atualizando imagem do produto

PUT
https://gestorfood.shop
/api/v1/queue/products/{product_uuid}/image

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

product_uuid
string
required
Example:
18a4636d-969e-4aa8-886c-0ccadcaee0ff

Body Parameters

Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/queue/products/18a4636d-969e-4aa8-886c-0ccadcaee0ff/image" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"image\": \"ipsam\"
}"

Queue Taxas

APIs para gerenciamento de Taxas

Criando uma Taxa

POST
https://gestorfood.shop
/api/v1/queue/fees

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/queue/fees" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ccwzqft\",
    \"code\": \"lmkamvqbxf\",
    \"description\": \"Omnis fuga veniam sit aperiam at soluta eaque.\",
    \"value\": 4276803.86640059,
    \"type\": \"mwfaunrivgnilo\",
    \"mode\": \"qexhahxofxoq\",
    \"individual\": true,
    \"reference_id\": \"corrupti\"
}"

Atualizando uma Taxa

PUT
PATCH
https://gestorfood.shop
/api/v1/queue/fees/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the fee.

Example:
1
Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/queue/fees/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Deletando uma Taxa

DELETE
https://gestorfood.shop
/api/v1/queue/fees/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the fee.

Example:
1
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/queue/fees/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Queue Unidades de Medidas

APIs para gerenciamento de Unidades de Medidas

Criando uma Unidade de Medida

POST
https://gestorfood.shop
/api/v1/queue/measurement_unit

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/queue/measurement_unit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"iusto\",
    \"code\": \"dolores\",
    \"fraction\": \"maiores\",
    \"reference_id\": \"aut\",
    \"market_id\": 13
}"

Atualizando uma Unidade de Medida

PUT
PATCH
https://gestorfood.shop
/api/v1/queue/measurement_unit/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the measurement unit.

Example:
1
Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/queue/measurement_unit/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Deletando uma Unidade de Medida

DELETE
https://gestorfood.shop
/api/v1/queue/measurement_unit/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the measurement unit.

Example:
1
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/queue/measurement_unit/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Queue Usuários

APIs para gerenciamento de filas de Usuários

Criando novo Usuário

POST
https://gestorfood.shop
/api/v1/queue/users

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/queue/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"aperiam\",
    \"email\": \"fidel63@example.net\",
    \"password\": \"sV]ne4\\\"|*X,\\\"`9\",
    \"market_id\": \"ducimus\",
    \"username\": \"bhnyefjxmxcqjmbjrtzzc\",
    \"reference_id\": \"quisquam\"
}"

Atualizando o Usuário

PUT
PATCH
https://gestorfood.shop
/api/v1/queue/users/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the user.

Example:
1

Body Parameters

Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/queue/users/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"pmdzpvuremnredjailfrzeuiboqxqocfdmmgfwsiqtjkrbcdltcpzzlxcudtjpkifxczpfbskueqxvmcazwuawn\",
    \"email\": \"noemie.torphy@example.net\",
    \"password\": \"U`Z?k-DUtZAok\\\"N\\\\\",
    \"market_id\": \"laborum\",
    \"username\": \"igdoptfengtbhmlibozsffeqcnibgznztwxlztii\",
    \"reference_id\": \"et\",
    \"id\": 10
}"

Deletando o Usuário

DELETE
https://gestorfood.shop
/api/v1/queue/users/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the user.

Example:
1
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/queue/users/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Taxas

APIs para gerenciamento de Taxas

Listando todas as Taxas

GET
https://gestorfood.shop
/api/v1/fees
requires authentication

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/fees" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Criando uma Taxa

POST
https://gestorfood.shop
/api/v1/fees

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/fees" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ihfakekmrxxhhkc\",
    \"code\": \"qyffhqtx\",
    \"description\": \"Facilis nostrum quia ea asperiores non sint laborum.\",
    \"value\": 106534353,
    \"type\": \"lrdtfqjijqlr\",
    \"mode\": \"ajvssaqf\",
    \"individual\": false,
    \"reference_id\": \"corrupti\"
}"

Buscando uma Taxa pelo ID

GET
https://gestorfood.shop
/api/v1/fees/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the fee.

Example:
1
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/fees/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Atualizando uma Taxa

PUT
PATCH
https://gestorfood.shop
/api/v1/fees/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the fee.

Example:
1
Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/fees/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Deletando uma Taxa

DELETE
https://gestorfood.shop
/api/v1/fees/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the fee.

Example:
1
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/fees/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Tipos de Complementos

APIs para gerenciamento de Tipos de Complementos

Listando todos os tipos de complementos

GET
https://gestorfood.shop
/api/v1/complement_types

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/complement_types" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Criando um tipo de complemento

POST
https://gestorfood.shop
/api/v1/complement_types

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/complement_types" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"i\",
    \"description\": \"Atque quasi id modi unde ut.\",
    \"reference_id\": \"cum\",
    \"min\": 62,
    \"max\": 89,
    \"priority\": 18
}"

Buscando um tipo de complemento

GET
https://gestorfood.shop
/api/v1/complement_types/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the complement type.

Example:
nisi
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/complement_types/nisi" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Atualizando um tipo de complemento

PUT
PATCH
https://gestorfood.shop
/api/v1/complement_types/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the complement type.

Example:
eveniet
Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/complement_types/eveniet" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Deletando um tipo de complemento

DELETE
https://gestorfood.shop
/api/v1/complement_types/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the complement type.

Example:
et
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/complement_types/et" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Tipos de Pagamentos

APIs para gerenciamento de Tipos de Pagamentos

Listando todos os tipos de pagamentos

GET
https://gestorfood.shop
/api/v1/payment_types

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/payment_types" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Criando um tipo de pagamento

POST
https://gestorfood.shop
/api/v1/payment_types

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/payment_types" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"voluptatem\",
    \"code\": \"omnis\"
}"

Exibindo um tipo de pagamento

GET
https://gestorfood.shop
/api/v1/payment_types/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the payment type.

Example:
temporibus
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/payment_types/temporibus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Atualizando um tipo de pagamento

PUT
PATCH
https://gestorfood.shop
/api/v1/payment_types/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the payment type.

Example:
nihil

Body Parameters

Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/payment_types/nihil" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"deleniti\",
    \"code\": \"quo\"
}"

Deletando um tipo de pagamento

DELETE
https://gestorfood.shop
/api/v1/payment_types/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the payment type.

Example:
ipsa
Example request:
curl --request DELETE \
    "https://gestorfood.shop/api/v1/payment_types/ipsa" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Usuários

APIs para gerenciamento de Usuários

Listando todos os Usuários

GET
https://gestorfood.shop
/api/v1/markets/users

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

filter
string

Filtra os usuários por nome ou email. Exemplo: filter[search]=joao

Example:
error
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/markets/users?filter=error" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 56
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Market token não é válido."
}

Listando todos os Usuários

GET
https://gestorfood.shop
/api/v1/users

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

filter
string

Filtra os usuários por nome ou email. Exemplo: filter[name]=joao

Example:
architecto
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/users?filter=architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Cadastrando um novo Usuário

POST
https://gestorfood.shop
/api/v1/users

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://gestorfood.shop/api/v1/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"dolores\",
    \"email\": \"kirlin.adrain@example.com\",
    \"password\": \"poixlWG7f1MTfjG;\",
    \"market_id\": \"voluptatem\",
    \"username\": \"rfklodagiyzsuvtxruj\"
}"

Listando um Usuário

GET
https://gestorfood.shop
/api/v1/users/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

ID do usuário

Example:
fuga
Example request:
curl --request GET \
    --get "https://gestorfood.shop/api/v1/users/fuga" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Atualizando um Usuário

PUT
PATCH
https://gestorfood.shop
/api/v1/users/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

ID do usuário

Example:
officiis
Example request:
curl --request PUT \
    "https://gestorfood.shop/api/v1/users/officiis" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"