Skip to main content
A comanda (tab) é o cartão ou ficha que acompanha o cliente no salão. Cada uma tem um nome que a equipe vê, um código e um QR Code. O cliente lê o QR Code, faz os pedidos e eles ficam ligados à comanda.

​
O objeto comanda

​
uuid
Identificador da comanda. É o tabId das rotas e dos eventos.
​
datetime
Quando a comanda foi cadastrada.
​
string
Identificação que a equipe vê, como 0013 ou Comanda 13.
​
string
Código da comanda, único na loja. Vem null depois que a comanda é removida.
​
string
URL que o QR Code impresso na comanda deve conter. Ela usa o id da comanda, então não muda quando você altera name ou code.
​
string
AVAILABLE ou UNAVAILABLE. Campo legado: só muda pelas rotas descontinuadas ou quando a comanda é removida. Comandas UNAVAILABLE não aceitam pedidos.
​
string
OPENED ou CLOSED. Diz se a comanda está aberta para consumo. É o campo que você controla pelas ações.
Comanda

​
Ciclo de vida

Toda comanda nasce AVAILABLE e OPENED. Daí em diante, você alterna a situação entre aberta e fechada.
A comanda nasce OPENED no cadastro, alterna entre OPENED e CLOSED e é removida com DELETEA comanda nasce OPENED no cadastro, alterna entre OPENED e CLOSED e é removida com DELETE

Ciclo de vida de uma comanda

Com a comanda CLOSED, o cliente que lê o QR Code vê o aviso de comanda fechada e não consegue finalizar pedidos nem pedir a conta com ela.

​
Endpoints

Todas as rotas ficam em https://api.deliveryvip.com.br/merchant/v3/{merchantId}/tabs.

​
Rotas descontinuadas

POST /tabs/{tabId}/available e POST /tabs/{tabId}/unavailable estão em deprecação. Use opened e closed. Veja ativar e desativar.

​
Erros comuns

Os erros seguem o formato padrão: { "status": "...", "title": ... }.