VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Fluxos de automação

GETCatálogo de gatilhos e ações

Lista os gatilhos e as ações que o editor de fluxos oferece ao seller.

Use para montar o editor de fluxos. A lista de ações já está filtrada para o que o seller pode usar. A lista de gatilhos é a completa do editor e inclui dois que não executam para sellers (veja a home da seção).

GET/api/v1/vendor/flows/catalogSeller

Consultar o catálogo

Cabeçalhos

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

Exemplo de requisição

bash
curl -X GET "$BASE_URL/api/v1/vendor/flows/catalog" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Catálogo
json
{
  "actions": [
    "set_order_status",
    "set_product_status",
    "notify_inbox"
  ],
  "triggers": [
    "order.created",
    "order.statusChanged",
    "order.paymentStatusChanged",
    "order.chargeback",
    "product.stockChanged",
    "product.pending_moderation",
    "return.statusChanged",
    "user.registered"
  ]
}

Campos da resposta

actionsstring[]
Ações permitidas ao seller. A ordem varia de uma chamada para outra.
triggersstring[]
Gatilhos do editor.

Erros

StatusQuandoCorpo de exemplo
401Token ausente, inválido, expirado ou revogado.invalid or expired token
403O 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

  • Fluxos
Anterior
Execuções
Próxima
Operação da loja do seller
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também