API atual/Referência completa/Fluxos de automação

Execuções

Lista as execuções de um fluxo e os passos que cada execução percorreu.

Quando algo não saiu como esperado, estas duas rotas respondem "o fluxo disparou?" e "o que ele fez?".

Listar execuções do fluxo

Devolve até 200 execuções, da mais recente para a mais antiga.

GET/api/v1/vendor/flows/{id}/runsSeller

Listar execuções do fluxo

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

iduuidobrigatório

Id do fluxo (UUID).

Parâmetros de consulta

statusstring

activedonefailed

Filtra por estado da execução.

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/flows/52cb85db-b3fd-4683-b9db-efd8b6940c96/runs?status=done" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Execuções

json

{
  "runs": [
    {
      "id": "95e8ab18-7733-4017-89b7-bf9832d4cfe3",
      "flow_id": "52cb85db-b3fd-4683-b9db-efd8b6940c96",
      "event_id": "order.created:50831d01-b990-4cd8-afde-c04fead85604",
      "entity_type": "order",
      "entity_id": "50831d01-b990-4cd8-afde-c04fead85604",
      "status": "done",
      "current_node": "",
      "context": {
        "order.total": 11246,
        "order.item_count": 1,
        "order.customer_id": "3093f506-d6af-4c27-9ef6-c245e8e602f9",
        "order.payment_method": "pix"
      },
      "created_at": "2026-07-21T01:12:53.681459Z"
    }
  ],
  "total": 1
}

Campos da resposta

runsobject[]

As execuções.

runs[].iduuid

Id da execução (UUID).

runs[].flow_iduuid

Fluxo.

runs[].event_idstring

Identifica o evento que disparou. O mesmo evento não gera duas execuções do mesmo fluxo.

runs[].entity_typestring

orderproductreturn

order, product ou return.

runs[].entity_iduuid

Pedido, produto ou devolução do evento.

runs[].statusstring

activedonefailed

Estado.

runs[].current_nodestring

Passo em que a execução está, se ainda não terminou.

runs[].contextobject

Dados do evento (os campos usados nas condições).

runs[].errorstring

Motivo da falha, em failed. Ausente nos demais.

runs[].created_atstring

Quando a execução foi criada, RFC 3339 em UTC.

totalinteger

Quantidade devolvida.

Erros

Status	Quando	Corpo de exemplo
404	O fluxo não existe ou é de outro seller. Os dois casos dão `404`.	`{"error":"not found"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, a loja está em análise de cadastro ou falta o privilégio de ajustes (`vendor_settings` ou equivalente).	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_settings","vendor_view_settings","vendor_manage_delivery_areas","vendor_manage_whatsapp","vendor_manage_documents","vendor_manage_kyc","vendor_view_plan","vendor_manage_application","vendor_manage_vacation"]}`

Passos de uma execução

Mostra, em ordem, cada passo executado: a decisão de uma condição, o resultado ou o erro de uma ação.

GET/api/v1/vendor/flows/runs/{runId}/stepsSeller

Passos de uma execução

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

runIduuidobrigatório

Id da execução (UUID), de Listar execuções.

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/flows/runs/95e8ab18-7733-4017-89b7-bf9832d4cfe3/steps" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Passos

json

{
  "steps": [
    {
      "id": "77705b79-c48c-4b15-b55b-6888d12419c9",
      "run_id": "95e8ab18-7733-4017-89b7-bf9832d4cfe3",
      "node_id": "n_action",
      "kind": "action",
      "result": {
        "notified": true
      },
      "created_at": "2026-07-21T01:13:10.755799Z"
    }
  ],
  "total": 1
}

Campos da resposta

stepsobject[]

Os passos.

steps[].iduuid

Id do registro (UUID).

steps[].run_iduuid

Execução.

steps[].node_idstring

Id do passo no grafo.

steps[].kindstring

conditionaction

Tipo do passo.

steps[].resultobject

Resultado: {"branch":"yes"} numa condição; numa ação, por exemplo {"notified":true}.

steps[].errorstring

Erro da ação. Ausente quando deu certo.

steps[].created_atstring

Quando, RFC 3339 em UTC.

totalinteger

Quantidade devolvida.

Erros

Status	Quando	Corpo de exemplo
404	A execução não existe, ou é de um fluxo de outro seller (ou apagado).	`{"error":"not found"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, a loja está em análise de cadastro ou falta o privilégio de ajustes (`vendor_settings` ou equivalente).	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_settings","vendor_view_settings","vendor_manage_delivery_areas","vendor_manage_whatsapp","vendor_manage_documents","vendor_manage_kyc","vendor_view_plan","vendor_manage_application","vendor_manage_vacation"]}`

Veja também

API atual/Referência completa/Fluxos de automação

Execuções

Lista as execuções de um fluxo e os passos que cada execução percorreu.

Quando algo não saiu como esperado, estas duas rotas respondem "o fluxo disparou?" e "o que ele fez?".

Listar execuções do fluxo

Devolve até 200 execuções, da mais recente para a mais antiga.

GET/api/v1/vendor/flows/{id}/runsSeller

Listar execuções do fluxo

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

iduuidobrigatório

Id do fluxo (UUID).

Parâmetros de consulta

statusstring

activedonefailed

Filtra por estado da execução.

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/flows/52cb85db-b3fd-4683-b9db-efd8b6940c96/runs?status=done" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Execuções

json

{
  "runs": [
    {
      "id": "95e8ab18-7733-4017-89b7-bf9832d4cfe3",
      "flow_id": "52cb85db-b3fd-4683-b9db-efd8b6940c96",
      "event_id": "order.created:50831d01-b990-4cd8-afde-c04fead85604",
      "entity_type": "order",
      "entity_id": "50831d01-b990-4cd8-afde-c04fead85604",
      "status": "done",
      "current_node": "",
      "context": {
        "order.total": 11246,
        "order.item_count": 1,
        "order.customer_id": "3093f506-d6af-4c27-9ef6-c245e8e602f9",
        "order.payment_method": "pix"
      },
      "created_at": "2026-07-21T01:12:53.681459Z"
    }
  ],
  "total": 1
}

Campos da resposta

runsobject[]

As execuções.

runs[].iduuid

Id da execução (UUID).

runs[].flow_iduuid

Fluxo.

runs[].event_idstring

Identifica o evento que disparou. O mesmo evento não gera duas execuções do mesmo fluxo.

runs[].entity_typestring

orderproductreturn

order, product ou return.

runs[].entity_iduuid

Pedido, produto ou devolução do evento.

runs[].statusstring

activedonefailed

Estado.

runs[].current_nodestring

Passo em que a execução está, se ainda não terminou.

runs[].contextobject

Dados do evento (os campos usados nas condições).

runs[].errorstring

Motivo da falha, em failed. Ausente nos demais.

runs[].created_atstring

Quando a execução foi criada, RFC 3339 em UTC.

totalinteger

Quantidade devolvida.

Erros

Status	Quando	Corpo de exemplo
404	O fluxo não existe ou é de outro seller. Os dois casos dão `404`.	`{"error":"not found"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, a loja está em análise de cadastro ou falta o privilégio de ajustes (`vendor_settings` ou equivalente).	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_settings","vendor_view_settings","vendor_manage_delivery_areas","vendor_manage_whatsapp","vendor_manage_documents","vendor_manage_kyc","vendor_view_plan","vendor_manage_application","vendor_manage_vacation"]}`

Passos de uma execução

Mostra, em ordem, cada passo executado: a decisão de uma condição, o resultado ou o erro de uma ação.

GET/api/v1/vendor/flows/runs/{runId}/stepsSeller

Passos de uma execução

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

runIduuidobrigatório

Id da execução (UUID), de Listar execuções.

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/flows/runs/95e8ab18-7733-4017-89b7-bf9832d4cfe3/steps" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Passos

json

{
  "steps": [
    {
      "id": "77705b79-c48c-4b15-b55b-6888d12419c9",
      "run_id": "95e8ab18-7733-4017-89b7-bf9832d4cfe3",
      "node_id": "n_action",
      "kind": "action",
      "result": {
        "notified": true
      },
      "created_at": "2026-07-21T01:13:10.755799Z"
    }
  ],
  "total": 1
}

Campos da resposta

stepsobject[]

Os passos.

steps[].iduuid

Id do registro (UUID).

steps[].run_iduuid

Execução.

steps[].node_idstring

Id do passo no grafo.

steps[].kindstring

conditionaction

Tipo do passo.

steps[].resultobject

Resultado: {"branch":"yes"} numa condição; numa ação, por exemplo {"notified":true}.

steps[].errorstring

Erro da ação. Ausente quando deu certo.

steps[].created_atstring

Quando, RFC 3339 em UTC.

totalinteger

Quantidade devolvida.

Erros

Status	Quando	Corpo de exemplo
404	A execução não existe, ou é de um fluxo de outro seller (ou apagado).	`{"error":"not found"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, a loja está em análise de cadastro ou falta o privilégio de ajustes (`vendor_settings` ou equivalente).	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_settings","vendor_view_settings","vendor_manage_delivery_areas","vendor_manage_whatsapp","vendor_manage_documents","vendor_manage_kyc","vendor_view_plan","vendor_manage_application","vendor_manage_vacation"]}`