/Orders/Workflow

Esse recurso gerencia o fluxo de execução de um determinado pedido.

Siga os passos:

1. Consulte a ações disponíveis para execução e apresente ao usuário;

2. O usuário escolherá (botões) qual ação deverá ser executada;

3. Envie a requisição da ação escolhida para atualizar o pedido;

4. Comandos fora do contexto (ciclo do pedido) serão recusados;

Fluxos

Ação	Função
accept	Comando para aceitar um determinado pedido após conferência.
cancel	Comando de recusa de um determinado pedido. Estará disponível junto com o comando de aceite, no início do fluxo de trabalho. Texto de justificativa nessa ação é obrigatório.
pickup	* Comando usado para informar que o pedido está pronto para coleta.
delivery	** Comando usado para informar que o pedido saiu para entrega.
finish	** Comando usado para informar que um pedido foi entregue/concluído.

Em todos os fluxos o consumidor é notificado via push e e-mail. * Disponível para estabelecimentos que o Tonolucro gerencia a entrega; ** Disponível para estabelecimentos que fazem a própria entrega;

Fluxos do pedido

GET /v1/merchant/orders/{order_id}/workflow

Método retorna o fluxo de trabalho de um determinado pedido.

Path Parameters

Name	Type	Description
order_id	integer	Código do pedido

200

{
    "next": [
        {
            "id": 2,
            "action": "accept",
            "title": "Aceitar",
            "active": false,
            "done": false,
            "doneAt": null,
            "object": "Flow"
        },
        {
            "id": 7,
            "action": "cancel",
            "title": "Recusar",
            "active": false,
            "done": false,
            "doneAt": null,
            "object": "Flow"
        }
    ],
    "waiting": [
        {
            "id": 13,
            "action": "pickup",
            "title": "Coletar",
            "active": false,
            "done": false,
            "doneAt": null,
            "object": "Flow"
        },
        {
            "id": 3,
            "action": "delivery",
            "title": "Entregar",
            "active": false,
            "done": false,
            "doneAt": null,
            "object": "Flow"
        },
        {
            "id": 4,
            "action": "finish",
            "title": "Finalizar",
            "active": false,
            "done": false,
            "doneAt": null,
            "object": "Flow"
        }
    ],
    "done": [],
    "object": "Workflow"
}

400

{
    "errors": [
        {
            "status": 400,
            "title": "Objeto não encontrado",
            "code": "not_found"
        }
    ]
}

Executar fluxos

PUT /v1/merchant/orders/{order_id}/workflow

Path Parameters

Name	Type	Description
order_id	integer	Código do pedido

Request Body

Name	Type	Description
action	string	Comando disponível para execução
notes	string	Motivo do cancelamento (obrigatório ao cancelar)

200

{
    "success": true
}

400

{
    "errors": [
        {
            "status": 400,
            "title": "Ação não disponível para contexto atual do pedido",
            "code": "action_forbidden"
        }
    ]
}

Exemplo:

Request

{
    "action": "cancel",
    "notes": "Motivo do cancelamento (obrigatório para cancelar)"
}

Response | 200: OK

{
    "success": true
}