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

Ligar, pausar e testar

Valida o grafo de um fluxo, liga e desliga a execução automática.

Testar fluxo

Confere o grafo do fluxo sem executá-lo. Diferente das outras rotas, um grafo inválido volta 200 com ok: false, para o editor mostrar os passos com problema.

POST/api/v1/vendor/flows/{id}/testSeller

Testar 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).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/flows/52cb85db-b3fd-4683-b9db-efd8b6940c96/test" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Grafo válido

json

{
  "ok": true
}

200Grafo inválido

json

{
  "ok": false,
  "invalid_nodes": [
    "n_extra"
  ],
  "reason": "orphan nodes with no incoming edge"
}

Campos da resposta

okboolean

true se o grafo passa nas regras.

invalid_nodesstring[]

Ids dos passos com problema, quando se aplica.

reasonstring

Motivo, em inglês: flow must have exactly one trigger, flow must have at least one exit, orphan nodes with no incoming edge ou too many nodes.

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"]}`

Ativar fluxo

Revalida o grafo e a lista de ações e liga o fluxo. Ativar um fluxo já ativo não faz mal. Cada seller pode ter no máximo 20 fluxos ativos.

POST/api/v1/vendor/flows/{id}/activateSeller

Ativar 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).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/flows/52cb85db-b3fd-4683-b9db-efd8b6940c96/activate" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Ativo

json

{
  "status": "active"
}

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"}`
422	Grafo inválido ou ação fora da lista permitida ao seller.	`{"error":"invalid_graph","invalid_nodes":["n_action"],"reason":"action not allowed for vendor flows"}`
422	Já existem 20 fluxos ativos.	`{"error":"failed","detail":"active flow limit (20) reached"}`
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"]}`

Pausar fluxo

Desliga o fluxo. Eventos que chegarem enquanto ele está pausado não geram execuções, e execuções que estavam em andamento ficam paradas até a reativação.

POST/api/v1/vendor/flows/{id}/pauseSeller

Pausar 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).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/flows/52cb85db-b3fd-4683-b9db-efd8b6940c96/pause" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Pausado

json

{
  "status": "paused"
}

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"}`
422	Falha ao gravar.	`{"error":"failed","detail":"..."}`
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

Ligar, pausar e testar

Valida o grafo de um fluxo, liga e desliga a execução automática.

Testar fluxo

Confere o grafo do fluxo sem executá-lo. Diferente das outras rotas, um grafo inválido volta 200 com ok: false, para o editor mostrar os passos com problema.

POST/api/v1/vendor/flows/{id}/testSeller

Testar 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).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/flows/52cb85db-b3fd-4683-b9db-efd8b6940c96/test" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Grafo válido

json

{
  "ok": true
}

200Grafo inválido

json

{
  "ok": false,
  "invalid_nodes": [
    "n_extra"
  ],
  "reason": "orphan nodes with no incoming edge"
}

Campos da resposta

okboolean

true se o grafo passa nas regras.

invalid_nodesstring[]

Ids dos passos com problema, quando se aplica.

reasonstring

Motivo, em inglês: flow must have exactly one trigger, flow must have at least one exit, orphan nodes with no incoming edge ou too many nodes.

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"]}`

Ativar fluxo

Revalida o grafo e a lista de ações e liga o fluxo. Ativar um fluxo já ativo não faz mal. Cada seller pode ter no máximo 20 fluxos ativos.

POST/api/v1/vendor/flows/{id}/activateSeller

Ativar 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).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/flows/52cb85db-b3fd-4683-b9db-efd8b6940c96/activate" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Ativo

json

{
  "status": "active"
}

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"}`
422	Grafo inválido ou ação fora da lista permitida ao seller.	`{"error":"invalid_graph","invalid_nodes":["n_action"],"reason":"action not allowed for vendor flows"}`
422	Já existem 20 fluxos ativos.	`{"error":"failed","detail":"active flow limit (20) reached"}`
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"]}`

Pausar fluxo

Desliga o fluxo. Eventos que chegarem enquanto ele está pausado não geram execuções, e execuções que estavam em andamento ficam paradas até a reativação.

POST/api/v1/vendor/flows/{id}/pauseSeller

Pausar 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).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/flows/52cb85db-b3fd-4683-b9db-efd8b6940c96/pause" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Pausado

json

{
  "status": "paused"
}

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"}`
422	Falha ao gravar.	`{"error":"failed","detail":"..."}`
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"]}`