Pular para o conteúdo principal

Webhooks

Os webhooks permitem que você obtenha notificações programáticas em tempo real sobre alterações em seus dados à medida que elas acontecem. Em vez de extrair informações por meio de nossa API, os webhooks enviarão informações ao seu endpoint. Para registrar um webhook é necessário seguir os passos existentes na documentação.

Dos produtos que ainda não foram publicados​

Para o canal Magalu, existe ainda a possibilidade de o produto estar com o status Draft, que indica que ele permanece em fase de edição e, portanto, ainda não foi publicado. Por meio das notificações, torna-se possível acompanhar tanto a criação quanto a atualização de produtos que ainda não estão publicados, permitindo monitorar todo o ciclo de preparação desses itens.

Tópicos de Inscrição e Exemplos de Notificações​

Ao se inscrever para receber notificações do nosso webhook, sua URL receberá mensagens referentes a diferentes tópicos, cada um relacionado a um recurso específico. Abaixo está a definição de cada tópico disponível, juntamente com seus possíveis status e um exemplo de mensagem.

Tópico Descrição Possíveis Status Exemplo de Mensagem
portfolios_sku Eventos gerados durante o ciclo de vida do SKU. Escopo: open:portfolio-skus-seller:read new, draft, policies_approved, policies_blocked, policies_blocked_price, policies_info, policies_warn, promotion_finished, promotion_started, published, publishing_error, unpublished, inactivated 
{
  "data": {
    "status": "new",
    "params": {
      "sku": "<código sku>"
    },
    "resource": "/seller/v1/portfolios/skus/{sku}"
  },
  "tenant_id": "3b5cf468-c858-404b-9e53-630e3df9d74a",
  "topic": "portfolios_sku"
}


portfolios_price Eventos gerados para criação e atualização de preços. Escopo: open:portfolio-prices-seller:read updated, policies_blocked_price 
{
  "data": {
    "status": "updated",
    "params": {
      "sku": "<código sku>"
    },
    "resource": "/seller/v1/portfolios/prices/{sku}"
  },
  "tenant_id": "3b5cf468-c858-404b-9e53-630e3df9d74a",
  "topic": "portfolios_price"
}


portfolios_stock Eventos gerados para criação e atualização de estoques. Escopo: open:portfolio-stocks-seller:read updated 
{
  "data": {
    "status": "updated",
    "params": {
      "sku": "<código sku>"
    },
    "resource": "/seller/v1/portfolios/stocks/{sku}"
  },
  "tenant_id": "3b5cf468-c858-404b-9e53-630e3df9d74a",
  "topic": "portfolios_stock"
}

Receba Atualizações por Webhook​

Para configurar um webhook, siga a documentação do portal de desenvolvedores