Magento 2 REST API — produtos, clientes e pedidos.
Nó Magento
O nó de workflow Magento é um cliente REST para a Adobe Commerce / Magento 2 REST API. Use-o para consultar e gerenciar pedidos, produtos e clientes.
Node ID no editor: magento_request
URL padrão: GET https://{{magento_store}}/rest/V1/orders
O que faz
- Envia requisições HTTP autenticadas para a REST API da sua loja Magento
- Suporta GET, POST, PUT e DELETE
- Retorna HTTP
status,datada resposta eheadersda resposta - Auth padrão:
Authorization: Bearer {{magento_access_token}}
Pré-requisitos
- Instalação Magento 2 / Adobe Commerce com REST API habilitada
- Admin integration ou customer/admin token para acesso à API
- Integration keys em Configurações → API Keys:
magento_store— domínio da loja (ex.:loja.example.com)magento_access_token— Bearer token da integração Magento
Como configurar
Passo 1 — Obter access token
Crie uma Integration no admin Magento (System → Extensions → Integrations) ou obtenha admin token via POST /rest/V1/integration/admin/token. Copie o access token.
Passo 2 — Definir credenciais
Adicione magento_store e magento_access_token como integration keys.
Passo 3 — Configurar o nó
| Campo | Obrigatório | Descrição |
|---|---|---|
| URL / Endpoint | Sim | URL REST completa (ex.: https://loja.com/rest/V1/orders) |
| Method | Não | GET, POST, PUT, DELETE (padrão: GET) |
| Headers (JSON) | Não | Sobrescrever headers se necessário |
| Body (JSON) | Não | Request body para POST/PUT |
Templates de operação integrados
| Operação | Method | Endpoint |
|---|---|---|
| List products | GET | /rest/V1/products?searchCriteria[pageSize]=20 |
| Get product by SKU | GET | /rest/V1/products/{sku} |
| Search customers | GET | /rest/V1/customers/search?searchCriteria[pageSize]=20 |
| Create customer | POST | /rest/V1/customers |
| Update customer | PUT | /rest/V1/customers/{customer_id} |
| List orders | GET | /rest/V1/orders?searchCriteria[pageSize]=20 |
| Get order | GET | /rest/V1/orders/{order_id} |
| Create order | POST | /rest/V1/carts/mine/order |
Exemplo — criar cliente (POST body):
{
"customer": {
"email": "{{contact.email}}",
"firstname": "{{contact.first_name}}",
"lastname": "{{contact.last_name}}"
},
"password": "{{variables.temp_password}}"
}
O Magento usa searchCriteria para filtragem e paginação em endpoints de listagem.
Passo 4 — Usar dados da resposta
Order increment ID: {{magento_1.data.increment_id}}
Customer email: {{magento_1.data.customer_email}}
Saídas do nó
| Campo de saída | Descrição |
|---|---|
status | HTTP status code |
data | Corpo da resposta JSON parseado |
headers | Response headers |
Dicas e boas práticas
- Tokens Magento expiram — renove via integração ou endpoint de token antes de workflows agendados de longa duração
- Use
searchCriteria[filterGroups]para filtragem avançada conforme documentação search criteria Magento - Lookups de produto usam SKU (string), não ID numérico, no endpoint
/products/{sku} - Combine com webhooks Magento ou cron externo + este nó para notificações de status de pedido
- Teste em staging antes de chamar endpoints de escrita (
POST,PUT) em produção
Exemplos de uso
Alerta de estoque baixo
- Schedule — diário
- Magento GET — produtos com filtro de estoque
- Loop — itens abaixo do limite
- Send WhatsApp — alerta para equipe de operações
Mensagem de confirmação de pedido
- Webhook — notificação externa de pedido
- Magento GET —
/orders/{order_id} - Send WhatsApp — resumo do pedido para
{{magento_1.data.billing_address.telephone}}
FAQ
Por que 401 Unauthorized?
Token expirado ou integração não ativada. Reautorize a integração no admin Magento.
Como filtrar pedidos por status?
Adicione searchCriteria[filterGroups][0][filters][0][field]=status nos query params conforme sintaxe REST search do Magento.
Posso usar customer token em vez de admin token?
Alguns endpoints exigem admin/integration tokens. Tokens com escopo de cliente funcionam apenas em endpoints /carts/mine/*.
Qual a diferença do nó HTTP?
Pré-configurado com base paths Magento, template Bearer auth e atalhos de operação comuns.
Referência da API
| Item | Valor |
|---|---|
| Base URL | https://{store}/rest/V1/ |
| Auth | Bearer token |
| Docs oficiais | Adobe Commerce REST API |
| Search | Performing searches |
Relacionado
Este artigo foi útil?
Precisa de mais ajuda? Falar com suporte