Skip to Content
Documentação de integração da plataforma — em evolução contínua.
ReferênciaEventos de webhook

Eventos de webhook

Os eventos abaixo são os valores válidos do campo eventTypes no registro do webhook.

Nome ou código. No registro, eventTypes aceita tanto o nome ("Order_Created") quanto o código numérico (13). Já a notificação entregue a você traz sempre o nome — um consumidor que compara eventType com número nunca casa. Os códigos abaixo servem de referência e aparecem em relatórios internos.

Produtos e SKUs

CódigoEvento
26ProductWithSKUs_Created
27ProductWithSKUs_Updated
28ProductWithSKUs_CreationFailed
29ProductWithSKUs_UpdateFailed
30ProductWithSKUs_PartiallyFailed

ProductWithSKUs_PartiallyFailed (30) merece atenção: o produto foi criado, mas parte dos SKUs falhou. Ignorar esse evento deixa variações faltando na vitrine sem nenhum sinal de erro.

Marcas

CódigoEvento
7Brand_Created
8Brand_Updated
9Brand_Deleted
102Brand_CreationFailed
112Brand_UpdateFailed
122Brand_DeletionFailed

Categorias

CódigoEvento
10Category_Created
11Category_Updated
12Category_Deleted
103Category_CreationFailed
113Category_UpdateFailed
123Category_DeletionFailed

Pedidos

CódigoEvento
13Order_Created
14Order_Updated
15Order_Deleted
25Order_Cancelled
131Order_CancelRequested
133Order_StatusUpdated
129Order_InvoiceCreated
32Order_InvoiceUploaded
33Order_StorageDeleted
104Order_CreationFailed
114Order_UpdateFailed
118Order_StatusUpdateFailed
124Order_DeletionFailed
132Order_CancelFailed

Preços

CódigoEvento
16SKUPricing_Created
17SKUPricing_Updated
18SKUPricing_Deleted
105SKUPricing_CreationFailed
115SKUPricing_UpdateFailed
125SKUPricing_DeletionFailed

Estoque

CódigoEvento
19Warehouse_Created
20Warehouse_Updated
21Warehouse_Deleted
106Warehouse_CreationFailed
116Warehouse_UpdateFailed
126Warehouse_DeletionFailed
22WarehouseSKU_Created
23WarehouseSKU_Updated
24WarehouseSKU_Deleted
107WarehouseSKU_CreationFailed
117WarehouseSKU_UpdateFailed
127WarehouseSKU_DeletionFailed

Estoque notifica sucesso. POST /v1/batch/Warehouses/sku devolve WarehouseSKU_Created (22) quando o core aceita o lote, e DELETE /v1/batch/Warehouses/sku devolve WarehouseSKU_Deleted (24) quando a remoção é concluída. Assine os dois — sem eles você não tem confirmação nenhuma de que a publicação de estoque chegou ao fim.

O data desses eventos é o lote, não o item: o mesmo array de blocos { warehouseExternalReference, items } que você enviou, fatiado em grupos de até 100 blocos. Não espere uma notificação por SKU.

Usuários

CódigoEvento
130User_Created
128User_Updated

Falha genérica

CódigoEvento
999Operation_Failed

Assine Operation_Failed (999) mesmo que você já assine os eventos de falha específicos. Ele cobre erros que acontecem antes da plataforma conseguir classificar a operação.

Assinatura mínima recomendada

Para uma integração de supermercado padrão:

{ "eventTypes": [ "Order_Created", "Order_Updated", "Order_Cancelled", "Order_CancelRequested", "Order_StatusUpdated", "Order_InvoiceCreated", "Order_InvoiceUploaded", "Order_CreationFailed", "Order_UpdateFailed", "Order_StatusUpdateFailed", "Order_CancelFailed", "ProductWithSKUs_Created", "ProductWithSKUs_Updated", "ProductWithSKUs_CreationFailed", "ProductWithSKUs_UpdateFailed", "ProductWithSKUs_PartiallyFailed", "Brand_Created", "Brand_Updated", "Brand_Deleted", "Brand_CreationFailed", "Brand_UpdateFailed", "Brand_DeletionFailed", "Category_Created", "Category_Updated", "Category_Deleted", "Category_CreationFailed", "Category_UpdateFailed", "Category_DeletionFailed", "Warehouse_Created", "Warehouse_Updated", "Warehouse_Deleted", "Warehouse_CreationFailed", "Warehouse_UpdateFailed", "Warehouse_DeletionFailed", "WarehouseSKU_Created", "WarehouseSKU_Updated", "WarehouseSKU_Deleted", "WarehouseSKU_CreationFailed", "WarehouseSKU_UpdateFailed", "WarehouseSKU_DeletionFailed", "SKUPricing_Created", "SKUPricing_Updated", "SKUPricing_Deleted", "SKUPricing_CreationFailed", "SKUPricing_UpdateFailed", "SKUPricing_DeletionFailed", "User_Created", "User_Updated", "Operation_Failed" ] }

Pedidos completos (incluindo falhas), resultado das cargas de catálogo, marcas, categorias, warehouses, estoque, preço e usuários, e o evento genérico de falha.

Brand_*, Category_* e Warehouse_* entram nessa lista por um motivo concreto: não existe rota de consulta para marcas, categorias nem warehouses (Endpoints). Sem o evento, você não tem nenhuma forma de saber se o passo 1 da carga funcionou — e é o passo do qual todo o resto depende. A ativação da loja instrui explicitamente a esperar Warehouse_CreationFailed (Ativar uma loja).

SKUPricing_Deleted (18) e SKUPricing_DeletionFailed (125) entram pelo mesmo raciocínio: DELETE /v1/batch/Pricing existe e é assíncrono, preço não tem rota de consulta, e a exclusão de preço tira o produto da vitrine. Sem esses dois eventos você não sabe se a exclusão foi aplicada — e descobrir pelo app do cliente é caro.

User_Created (130) e User_Updated (128) são publicados pelo core sempre que um cliente é criado ou alterado, inclusive pelo seu próprio PUT /v1/Users. Assine se você mantém cadastro de clientes espelhado no ERP. O id e os campos de senha são removidos do data antes do envio — a identidade utilizável é o data.email.